This documentation is for the unstable version of GoodData, currrently in development.
For stable version, go to the latest stable version of this article.
catalog_workspace.

store_declarative_workspaces

store_declarative_workspaces(layout_root_path: Path = Path.cwd())

Stores declarative workspaces in a given path, as folder hierarchy.

gooddata_layouts
└── organization_id
        ├── workspaces
        │       ├── workspace_a
        │       │       ├── analytics_model
        │       │       │   ├── analytical_dashboards
        │       │       │   │       └── analytical_dashboard.yaml
        │       │       │   ├── dashboard_plugins
        │       │       │   │       └── dashboard_plugin.yaml
        │       │       │   ├── filter_contexts
        │       │       │   │       └── filter_context.yaml
        │       │       │   ├── metrics
        │       │       │   │       └── metric.yaml
        │       │       │   └── visualization_objects
        │       │       │           └── visualization_object.yaml
        │       │       ├── ldm
        │       │       │   ├── datasets
        │       │       │   │       └── dataset.yaml
        │       │       │   └── date_instances
        │       │       │           └── date_instance.yaml
        │       │       └── workspace_a.yaml
        │       └── workspace_b
        │               └── ...
        │
        └── workspaces_data_filters
                ├── filter_1.yaml
                └── filter_2.yaml

Parameters

nametypedescription
layout_root_pathOptional[Path]Path to the root of the layout directory. Defaults to Path.cwd().

Returns

None

Example

# Store workspace layout and hierarchy
sdk.catalog_workspace.store_declarative_workspaces(layout_root_path=Path.cwd())