generated from ydataai/opensource-template
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update multi-table related documentation (#83)
* docs: update multi-table examples * docs: update SDK mainpage * docs: update sdk installation step by step guide. * docs: new quickstart tutorial. * docs: update multitable example. * fix(linting): code formatting --------- Co-authored-by: Fabiana Clemente <[email protected]> Co-authored-by: Azory YData Bot <[email protected]>
- Loading branch information
1 parent
e15e427
commit fadeed9
Showing
21 changed files
with
114 additions
and
57 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file added
BIN
+841 KB
docs/assets/quickstart/create_relational_database/database_schema_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+382 KB
docs/assets/quickstart/create_relational_database/mysql_credentials.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+392 KB
docs/assets/quickstart/create_relational_database/mysql_dataset_creation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# How to create your first Relational database in Fabric's Catalog | ||
|
||
To create your first multi-table dataset in the **Data Catalog**, you can start by clicking on **"Add Dataset"** from the Home section. | ||
Or click to **Data Catalog** (on the left side menu) and click **“Add Dataset”**. | ||
|
||
![Create dataset with upload csv](../assets/quickstart/upload_csv/welcome_add_dataset.png){: style="width:75%"} | ||
|
||
After that the below modal will be shown. You will need to select a connector. To create a multi-table dataset, we need to choose an RDBMS connector like Azure SQL, Snowflake or MySQL. | ||
In this case let's select MySQL. | ||
|
||
![Data Catalog connectors](../assets/quickstart/upload_csv/data_catalog_connectors.png){: style="width:40%"} | ||
|
||
Once you've selected the **“MySQL”** connector, a new screen will appear, enabling you to introduce the connection details such as database username, host, password as well as the database name. | ||
|
||
![MySQL credentials](../assets/quickstart/create_relational_database/mysql_credentials.png){: style="width:60%"} | ||
|
||
With the *Connector* created, you'll be able to add a dataset and specify its properties: | ||
|
||
- **Name:** The name of your dataset; | ||
- **Table:** You can create a dataset with all the tables from the schema or select the tables that you need in your project. | ||
- **Query:** Create a single table dataset by providing a query | ||
|
||
![Add dataset details](../assets/quickstart/create_relational_database/mysql_dataset_creation.png){: style="width:45%"} | ||
|
||
Now both the Connector to the MySQL Berka database and Berka dataset will be added to our Catalog. | ||
As soon as the status is green, you can navigate your Dataset. Click in **Open** dataset as per the image below. | ||
|
||
![Explore dataset](../assets/quickstart/create_relational_database/open_dataset.png){: style="width:75%"} | ||
|
||
Within the **Dataset** details, you can gain valuable insights like your database schema. | ||
|
||
![Database schema overview ](../assets/quickstart/create_relational_database/database_schema_overview.png){: style="width:75%"} | ||
|
||
For each an every table you can explore the both an overview on the structure (number of columns, number of rows, etc.) but also a useful | ||
summary of the quality and warnings regarding your dataset behaviour. | ||
|
||
![Dataset profiling](../assets/quickstart/create_relational_database/table_overview.png){: style="width:75%"} | ||
|
||
**Congrats!** 🚀 You have now successfully created your first **Connector** and **Multi-table Dataset** in Fabric’s Data Catalog. | ||
To get the both the ID of your database and project you can decompose the URL from the Database schema overview page. The structure is as follows: | ||
|
||
``` | ||
https://fabric.ydata.ai/rdbms/{your-dataset-id}?ns={your-project-id} | ||
``` | ||
|
||
Get ready for your journey of improved quality data for AI. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Synthesize Relational databases | ||
|
||
**Integrate Fabric's *MultiTableSynthesizer* in your data flows and generate synthetic relational databases or multi-table datasets** | ||
|
||
The capability to generate synthetic data from relational databases is a powerful and innovative approach to | ||
streamline the access to data and improve data democratization strategy within the organization. | ||
Fabric's SDK makes available an easy-to-use code interface to integrate the process of generating synthetic multi-table databases | ||
into your existing data flows. | ||
|
||
!!! tip "How to get your datasource?" | ||
Learn how to create your multi-table data in Fabric <a href="/get-started/create_multitable_dataset"><u>here</u></a> before creating your first multi-table synthetic data generator! | ||
|
||
**Get your datasource and connector ID** | ||
|
||
*Datasource uid:* You can find your datasource ID through Fabric UI. Open your relational dataset and click in the "Explore in Labs" button. | ||
Copy the uid that you find available in the code snippet. | ||
|
||
*Connector uid:* You can find your connector ID through Fabric UI. Open the connector tab from your Data Catalog. Under the connector "Actions" | ||
select "Explore in Lab". Copy the uid available in the code snippet. | ||
|
||
Quickstart example: | ||
|
||
```python | ||
--8<-- "examples/synthesizers/multi_table_quickstart.py" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters