Mirrored Database

Warning

The functions are not fully tested yet. Use with caution. Please report any issues to the GitHub repository.

mirrored_database_create

mirrored_database_create(workspace_id: str, display_name: str, mirrored_database_path: str, description: str = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Create a mirrored database.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to create the mirrored database in.	required
display_name	str	The display name of the mirrored database.	required
mirrored_database_path	str	The path to the mirrored database to load content from.	required
description	str | None	The description of the mirrored database.	None
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

mirrored_database_get

mirrored_database_get(workspace_id: str, mirrored_database_id: str, preview: bool = True) -> requests.Response

Get a mirrored database.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to get the mirrored database from.	required
mirrored_database_id	str	The id of the mirrored database to get.	required
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

mirrored_database_list

mirrored_database_list(workspace_id: str, continuation_token: str = None, preview: bool = True) -> requests.Response

List mirrored databases for a workspace.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to list mirrored databases for.	required
continuation_token	str | None	A token for retrieving the next page of results.	None
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

mirrored_database_update

mirrored_database_update(workspace_id: str, mirrored_database_id: str, display_name: str = None, description: str = None, preview: bool = True) -> requests.Response

Update a mirrored database.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update.	required
mirrored_database_id	str	The id of the mirrored database to update.	required
display_name	str | None	The display name of the mirrored database.	None
description	str | None	The description of the mirrored database.	None
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

mirrored_database_delete

mirrored_database_delete(workspace_id: str, mirrored_database_id: str, preview: bool = True) -> requests.Response

Delete a mirrored database.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to delete.	required
mirrored_database_id	str	The id of the mirrored database to delete.	required
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

mirrored_database_get_definition

mirrored_database_get_definition(workspace_id: str, mirrored_database_id: str, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Get the definition of a mirrored database.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to get the mirrored database definition from.	required
mirrored_database_id	str	The id of the mirrored database to get the definition from.	required
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

mirrored_database_update_definition

mirrored_database_update_definition(workspace_id: str, mirrored_database_id: str, mirrored_database_path: str, update_metadata: bool = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Update the definition of a mirrored database.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update.	required
mirrored_database_id	str	The id of the mirrored database to update.	required
mirrored_database_path	str	The path to the mirrored database to load content from.	required
update_metadata	bool | None	When set to true, the item's metadata is updated using the metadata in the .platform file.	None
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.