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.

load_and_put_declarative_workspaces

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.

Parameters

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

Returns

None

Example

The load and put can be done two ways.

Either by one call:

# Load and put on server the stored layout
sdk.catalog_workspace.load_and_put_declarative_workspaces(
    layout_root_path=Path.cwd()
)

Or by two separate calls:

# Load a declarative workspace
declarative_workspaces = sdk.catalog_workspace.load_declarative_workspaces(
    layout_root_path=Path.cwd()
)
# Set the layout
sdk.catalog_workspace.put_declarative_workspaces(declarative_workspaces)

The result is identical.

load_declarative_workspaces
get_declarative_workspace