storagesettings

client.storagesettings

TileDB Storage Settings.

Classes

Name	Description
StorageSettingsError	Raised when storage settings can not be accessed.

StorageSettingsError

client.storagesettings.StorageSettingsError()

Raised when storage settings can not be accessed.

Functions

Name	Description
create_storage_setting	Create a storage setting.
delete_storage_setting	Delete a storage setting.
get_storage_setting	Get a credential by name.
list_storage_settings	List storage settings.
update_storage_setting	Update a storage setting.

create_storage_setting

client.storagesettings.create_storage_setting(
    name,
    is_default,
    path,
    credentials_name,
    teamspace=None,
    _test_settings=True,
)

Create a storage setting.

Parameters

Name	Type	Description	Default
name	str	A unique short name for the storage setting.	required
is_default	bool	Whether the storage setting is to be the default for its workspace or teamspace.	required
path	str	URI containing the VFS path of where assets will be stored. Local file paths must start with file://.	required
credentials_name	str	Name of the saved credential for access to path.	required
teamspace	TeamspaceLike	The teamspace of the storage setting, specified by object or id. Omit this parameter to create a workspace storage setting.	None

Returns

Name	Type	Description
	StorageSetting

Raises

Name	Type	Description
	StorageSettingsError	If the storage setting can not be created.

Examples

>>> setting = create_storage_setting(
...     name="storage_setting1",
...     is_default=True,
...     path="s3://bucket/prefix",
...     credentials_name="cred1",
...     teamspace="teamspace1",
... )
>>> setting.name
'storage_setting1'

delete_storage_setting

client.storagesettings.delete_storage_setting(
    storage_setting,
    *,
    teamspace=None,
)

Delete a storage setting.

Parameters

Name	Type	Description	Default
storage_setting	str	The storage setting identified by id or object.	required
teamspace	TeamspaceLike	The teamspace of the storage setting. Omit this parameter to specify a workspace storage setting.	None

Raises

Name	Type	Description
	StorageSettingsError	If the storage setting can not be deleted.

Examples

>>> delete_storage_setting("storage_setting1", teamspace="teamspace1")

get_storage_setting

client.storagesettings.get_storage_setting(storage_setting, *, teamspace=None)

Get a credential by name.

Parameters

Name	Type	Description	Default
storage_setting	str	The storage setting identified by id or object.	required
teamspace	TeamspaceLike	The teamspace of the storage setting. Omit this parameter to specify a workspace storage setting.	None

Returns

Name	Type	Description
	StorageSetting

Raises

Name	Type	Description
	StorageSettingsError	If the storage setting can not be retrieved.

Examples

>>> storage_setting = get_storage_setting(
...     "storage_setting1",
...     teamspace="teamspace1"
... )
>>> storage_setting.path
's3://bucket/prefix'

list_storage_settings

client.storagesettings.list_storage_settings(
    teamspace=None,
    page=1,
    per_page=None,
)

List storage settings.

Parameters

Name	Type	Description	Default
teamspace	TeamspaceLike	The teamspace of the storage settings, specified by object or id. Omit this parameter to list workspace storage settings.	None
page	int	Which page of results to retrieve. 1-based.	1
per_page	int	How many results to include on each page.	None

Returns

Name	Type	Description
	Pager for StorageSettings

Raises

Name	Type	Description
	StorageSettingsError	Raised when storage settings can not be listed.

Examples

update_storage_setting

client.storagesettings.update_storage_setting(
    storage_setting,
    *,
    name=None,
    is_default=None,
    path=None,
    credentials_name=None,
    teamspace=None,
    _test_settings=True,
)

Update a storage setting.

Parameters

Name	Type	Description	Default
storage_setting	str	The storage setting identified by id or object.	required
name	str	A unique short name for the storage setting.	None
is_default	bool	Whether the storage setting is to be the default for its workspace or teamspace.	None
path	str	URI containing the VFS path of where assets will be stored. Local file paths must start with file://.	None
credentials_name	str	Name of the saved credential for access to path.	None
teamspace	TeamspaceLike	The teamspace of the storage setting, specified by object or id. Omit this parameter to create a workspace storage setting.	None

Raises

Name	Type	Description
	StorageSettingsError	If the credential can not be updated.

Examples

>>> update_storage_setting(
...     "storage_setting1",
...     credentials_name="cred2",
...     teamspace="teamspace1",
... )

Updates the storage_setting1 of teamspace1 to use a new credential.