workspaces

client.workspaces

TileDB workspaces and workspace users.

Classes

Name	Description
WorkspacesError	Raised when workspaces can not be accessed.

WorkspacesError

client.workspaces.WorkspacesError()

Raised when workspaces can not be accessed.

Functions

Name	Description
add_workspace_member	Add members to a workspace.
get_workspace	Get the representation of a workspace by its name or id.
list_workspace_members	List workspace members.
remove_workspace_member	Remove members from a workspace.
update_workspace_member_role	Update member roles for a workspace.

add_workspace_member

client.workspaces.add_workspace_member(member, *, role=WorkspaceRole.MEMBER)

Add members to a workspace.

Parameters

Name	Type	Description	Default
member	UserLike	An instance of User or WorkspaceUser, or a TileDB user id string.	required
role	WorkspaceRole	A role for the new member. Default: “member”.	WorkspaceRole.MEMBER

Raises

Name	Type	Description
	WorkspacesError	When members can not be added.

Examples

>>> add_workspace_member(
...     "usr_123",
...     role=WorkspaceRole.ADMIN
... )

Adds the user with id “usr_123” to the current workspace with an admin role.

get_workspace

client.workspaces.get_workspace(name_or_id=None)

Get the representation of a workspace by its name or id.

Parameters

Name	Type	Description	Default
name_or_id	str	The name or id of the workspace. Defaults to the current session’s workspace.	None

Returns

Name	Type	Description
	Workspace

Raises

Name	Type	Description
	WorkspacesError	If the retrieval request fails.

list_workspace_members

client.workspaces.list_workspace_members(query=None, page=1, per_page=None)

List workspace members.

Parameters

Name	Type	Description	Default
query	str	Match users by name or email address.	None

Returns

Name	Type	Description
	Pager for WorkspaceUsers

Raises

Name	Type	Description
	WorkspaceError:	If the workspace members listing request failed.

Examples

>>> for user in list_workspace_members():
...     print(user.display_name)
...
A User

remove_workspace_member

client.workspaces.remove_workspace_member(member)

Remove members from a workspace.

Parameters

Name	Type	Description	Default
member	UserLike	An instance of User or WorkspaceUser, or a TileDB user id string.	required

Raises

Name	Type	Description
	WorkspacesError	When members can not be removed.

Examples

>>> remove_workspace_member("usr_123")

Removes the user with id “usr_123” from the current workspace.

update_workspace_member_role

client.workspaces.update_workspace_member_role(member, role)

Update member roles for a workspace.

Parameters

Name	Type	Description	Default
member	UserLike	An instance of User or WorkspaceUser, or a TileDB user id string.	required
role	WorkspaceRole	A role for the new member. Default: “member”.	required

Raises

Name	Type	Description
	WorkspacesError	When members can not be updated.

Examples

>>> update_workspace_member_role(
...     "usr_123",
...     role=WorkspaceRole.ADMIN
... )

Gives the user with id “usr_123” an admin role for the current workspace.