catalog_workspace.

store_declarative_workspace

store_declarative_workspace(workspace_id: str, layout_root_path: Path = Path.cwd())

Stores the workspace layout in a directory 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

Parameters

nametypedescription
workspace_idstringWorkspace identification string e.g. "demo"
layout_root_pathOptional[Path]Path to the root of the layout directory. Defaults to Path.cwd().

Returns

None

Example

# Store workspace layout
sdk.catalog_workspace.store_declarative_workspace(workspace_id="123",layout_root_path=Path.cwd())