Merge pull request #97 from hkad98/NAS-3694

NAS-3694 finalizing documentation for release

Reviewed-by: Jan Soubusta
             https://github.com/jaceksan

Author: gdgate

gooddata-sdk/docs/services/catalog-data-source.rst

@@ -159,7 +159,7 @@ The *gooddata_sdk.catalog_data_source* supports the following declarative API ca
 
     Set all data sources, including their related physical model.
 
-* ``store_declarative_data_sources(layout_root_path: Path = Path(os.path.curdir))``
+* ``store_declarative_data_sources(layout_root_path: Path = Path.cwd())``
 
     Store data sources layouts in directory hierarchy.
 
@@ -179,13 +179,13 @@ The *gooddata_sdk.catalog_data_source* supports the following declarative API ca
                                 │   └── table_Y.yaml
                                 └── data_source_b.yaml
 
-* ``load_declarative_data_sources(layout_root_path: Path = Path(os.path.curdir))``
+* ``load_declarative_data_sources(layout_root_path: Path = Path.cwd())``
 
     Returns *CatalogDeclarativeDataSources*.
 
     Load declarative data sources layout, which was stored using *store_declarative_data_sources*.
 
-* ``load_and_put_declarative_data_sources(layout_root_path: Path = Path(os.path.curdir), credentials_path: Optional[Path] = None, test_data_sources: bool = False)``
+* ``load_and_put_declarative_data_sources(layout_root_path: Path = Path.cwd(), credentials_path: Optional[Path] = None, test_data_sources: bool = False)``
 
     This method combines *load_declarative_data_sources* and
     *put_declarative_data_sources* methods to load and set
@@ -228,6 +228,22 @@ The *gooddata_sdk.catalog_data_source* supports the following action API calls:
 
     Invalidate cache of your computed reports to force your analytics to be recomputed.
 
+* ``scan_data_source(data_source_id: str, scan_request: CatalogScanModelRequest = CatalogScanModelRequest(), report_warnings: bool = False)``
+
+    Returns *CatalogScanResultPdm*.
+
+    Scan data source specified by its id and optionally by specified scan request. *CatalogScanResultPdm* contains PDM and warnings. Warnings contain information about columns which were not added to the PDM because their data types are not supported. Additional parameter report_warnings can be passed to suppress or to report warnings. By default warnings are returned but not reported to STDOUT. If you set report_warnings to True, warnings are reported to STDOUT.
+
+* ``scan_and_put_pdm(data_source_id: str, scan_request: CatalogScanModelRequest = CatalogScanModelRequest())``
+
+    This method combines *scan_data_source* and *put_declarative_pdm* methods.
+
+* ``scan_schemata(data_source_id: str)``
+
+    Returns *list[str]*.
+
+    Returns a list of schemas that exist in the database and can be configured in the data source entity. Data source managers like Dremio or Drill can work with multiple schemas and schema names can be injected into scan_request to filter out tables stored in the different schemas.
+
 **Example usage:**
 
 .. code-block:: python
@@ -240,6 +256,14 @@ The *gooddata_sdk.catalog_data_source* supports the following action API calls:
     token = "some_user_token"
     sdk = GoodDataSdk.create(host, token)
 
+    # Scan schemata of the data source
+    schemata = sdk.catalog_data_source.scan_schemata("demo-test-ds")
+    print(schemata)
+    # ['demo']
+
+    # Scan and put pdm
+    sdk.catalog_data_source.scan_and_put_pdm("demo-test-ds")
+
     # Define request for generating ldm
     generate_ldm_request = CatalogGenerateLdmRequest(separator="__")
 

gooddata-sdk/docs/services/catalog-workspace-content.rst

@@ -69,13 +69,13 @@ The *gooddata_sdk.catalog_workspace_content* supports the following declarative
 
     Returns *CatalogDeclarativeModel*.
 
-    Retrieve a logical model layout. On CatalogDeclarativeModel user can call ``modify_mapped_data_source(data_source_mapping: dict)`` method, which substitues data source id in datasets.
+    Retrieve a logical model layout. On CatalogDeclarativeModel user can call ``modify_mapped_data_source(data_source_mapping: dict)`` method, which substitutes data source id in datasets.
 
-* ``put_declarative_ldm(workspace_id: str, ldm: CatalogDeclarativeModel)``
+* ``put_declarative_ldm(workspace_id: str, ldm: CatalogDeclarativeModel, validator: Optional[DataSourceValidator])``
 
-    Set a logical model layout.
+    Put a logical data model into a given workspace. You can pass an additional validator parameter which checks that for every data source id in the logical data model the corresponding data source exists.
 
-* ``store_declarative_ldm(workspace_id: str, layout_root_path: Path = Path(os.path.curdir))``
+* ``store_declarative_ldm(workspace_id: str, layout_root_path: Path = Path.cwd())``
 
     Store logical data model layout in directory hierarchy.
 
@@ -86,22 +86,22 @@ The *gooddata_sdk.catalog_workspace_content* supports the following declarative
                 └── workspaces
                         └── workspace_id
                                 └── analytics_model
-                                        ├── ldm
-                                        │    └── datasets
-                                        │           └── dataset.yaml
-                                        └── date_instaces
-                                                    └── date_instace.yaml
+                                        └── ldm
+                                            ├── datasets
+                                            │       └── dataset.yaml
+                                            └── date_instances
+                                                    └── date_instance.yaml
 
-* ``load_declarative_ldm(workspace_id: str, layout_root_path: Path = Path(os.path.curdir))``
+* ``load_declarative_ldm(workspace_id: str, layout_root_path: Path = Path.cwd())``
 
     Returns *CatalogDeclarativeModel*.
 
     Load declarative LDM layout, which was stored using *store_declarative_ldm*.
 
-* ``load_and_put_declarative_ldm(workspace_id: str, layout_root_path: Path = Path(os.path.curdir))``
+* ``load_and_put_declarative_ldm(workspace_id: str, layout_root_path: Path = Path.cwd(), validator: Optional[DataSourceValidator])``
 
     This method combines *load_declarative_ldm* and *put_declarative_ldm*
-    methods to load and set layouts stored using *store_declarative_ldm*.
+    methods to load and set layouts stored using *store_declarative_ldm*. You can pass an additional validator parameter which checks that for every data source id in the logical data model the corresponding data source exists.
 
 **Analytics Model:**
 
@@ -113,9 +113,9 @@ The *gooddata_sdk.catalog_workspace_content* supports the following declarative
 
 * ``put_declarative_analytics_model(workspace_id: str, analytics_model: CatalogDeclarativeAnalytics)``
 
-    Set an analytics model layout.
+    Put an analytics model into a given workspace.
 
-* ``store_declarative_analytics_model(workspace_id: str, layout_root_path: Path = Path(os.path.curdir))``
+* ``store_declarative_analytics_model(workspace_id: str, layout_root_path: Path = Path.cwd())``
 
     Store declarative analytics model layout in directory hierarchy.
 
@@ -139,13 +139,13 @@ The *gooddata_sdk.catalog_workspace_content* supports the following declarative
 
 
 
-* ``load_declarative_analytics_model(workspace_id: str, layout_root_path: Path = Path(os.path.curdir))``
+* ``load_declarative_analytics_model(workspace_id: str, layout_root_path: Path = Path.cwd())``
 
     Returns *CatalogDeclarativeAnalytics*.
 
     Load declarative LDM layout, which was stored using *store_declarative_analytics_model*.
 
-* ``load_and_put_declarative_analytics_model(workspace_id: str, layout_root_path: Path = Path(os.path.curdir))``
+* ``load_and_put_declarative_analytics_model(workspace_id: str, layout_root_path: Path = Path.cwd())``
 
     This method combines *load_declarative_analytics_model* and
     *put_declarative_analytics_model* methods to load and set

gooddata-sdk/docs/services/catalog-workspace.rst

@@ -12,7 +12,7 @@ on workspaces:
 The service supports two types of methods:
 
 * Entity methods let you work with workspaces on a high level using simplified *CatalogWorkspace* entities.
-* Declarative methods allow you to work with workpaces on a more granular level by fetching entire workspace layouts, including all of their nested objects.
+* Declarative methods allow you to work with workspaces on a more granular level by fetching entire workspace layouts, including all of their nested objects.
 
 Entity methods
 ^^^^^^^^^^^^^^
@@ -67,7 +67,7 @@ The *gooddata_sdk.catalog_workspace* supports the following entity API calls:
     # Create workspace
     sdk.catalog_workspace.create_or_update(my_workspace_object)
 
-    # Edit locak workspace entity
+    # Edit local workspace entity
     my_workspace_object.name = "Test"
 
     # Update workspace
@@ -107,7 +107,7 @@ The *gooddata_sdk.catalog_workspace* supports the following declarative API call
 
     Set layout of all workspaces and their hierarchy.
 
-* ``store_declarative_workspaces(layout_root_path: Path = Path(os.path.curdir))``
+* ``store_declarative_workspaces(layout_root_path: Path = Path.cwd())``
 
     Store workspaces layouts in directory hierarchy.
 
@@ -131,8 +131,8 @@ The *gooddata_sdk.catalog_workspace* supports the following declarative API call
                 │       │       ├── ldm
                 │       │       │   ├── datasets
                 │       │       │   │       └── dataset.yaml
-                │       │       │   └── date_instaces
-                │       │       │           └── date_instace.yaml
+                │       │       │   └── date_instances
+                │       │       │           └── date_instance.yaml
                 │       │       └── workspace_a.yaml
                 │       └── workspace_b
                 │               └── ...
@@ -142,13 +142,13 @@ The *gooddata_sdk.catalog_workspace* supports the following declarative API call
                         └── filter_2.yaml
 
 
-* ``load_declarative_workspaces(layout_root_path: Path = Path(os.path.curdir))``
+* ``load_declarative_workspaces(layout_root_path: Path = Path.cwd())``
 
     Returns *CatalogDeclarativeWorkspaces*.
 
     Load declarative workspaces layout, which was stored using *store_declarative_workspaces*.
 
-* ``load_and_put_declarative_workspaces(layout_root_path: Path = Path(os.path.curdir))``
+* ``load_and_put_declarative_workspaces(layout_root_path: Path = Path.cwd())``
 
     This method combines *load_declarative_workspaces* and *put_declarative_workspaces* methods to load and
     set layouts stored using *store_declarative_workspaces*.