groups

cloud.groups

Functions for managing TileDB Cloud groups.

Functions

Name	Description
contents	Get a group’s contents.
create	Creates a new TileDB Cloud group.
delete	Deletes a group.
deregister	Deregisters the given group from TileDB Cloud.
info	Gets metadata about the named TileDB Cloud group.
list_shared_with	List a group’s sharing policies.
register	Registers a pre-existing group.
share_group	Shares group with given namespace and permissions.
unshare_group	Removes sharing of a group from given namespace
update_info	Update Group Attributes

contents

cloud.groups.contents(
    uri,
    async_req=None,
    page=None,
    per_page=None,
    namespace=None,
    search=None,
    orderby=None,
    tag=None,
    exclude_tag=None,
    member_type=None,
    exclude_member_type=None,
)

Get a group’s contents.

Parameters

Name	Type	Description	Default
bool	async_req	execute request asynchronously	required
page	int	pagination offset for assets	None
per_page	int	pagination limit for assets	None
namespace	str	namespace to search for	None
search	str	search string that will look at name, namespace or description fields	None
orderby	str	sort by which field valid values include last_accessed, size, name	None
tag	list[str]	tag to search for, more than one can be included	None
exclude_tag	list[str]	tags to exclude matching array in results, more than one can be included	None
member_type	list[str]	member type to search for, more than one can be included	None
exclude_member_type	list[str]	member type to exclude matching groups in results, more than one can be included	None

Returns

Name	Type	Description
	rest_api.GroupContents	GroupContents If the method is called asynchronously, returns the request thread.

create

cloud.groups.create(
    name,
    *,
    namespace=None,
    parent_uri=None,
    storage_uri=None,
    credentials_name=None,
)

Creates a new TileDB Cloud group.

Parameters

Name	Type	Description	Default
name	str	The name of the group to create, or its URI.	required
namespace	Optional[str]	The namespace to create the group in. If name is a URI, this must not be provided. If not provided, the current logged-in user will be used.	None
parent_uri	Optional[str]	The parent URI to add the group to, if desired.	None
storage_uri	Optional[str]	The backend URI where the group will be stored. If not provided, uses the namespace’s default storage path for groups.	None
credentials_name	Optional[str]	The name of the storage credential to use for creating the group. If not provided, uses the namespace’s default credential for groups.	None

delete

cloud.groups.delete(uri, recursive=False)

Deletes a group.

Parameters

Name	Type	Description	Default
uri	str	TileDB Group URI.	required
recursive	bool	Delete all off the group’s contents, defaults to False	False

deregister

cloud.groups.deregister(uri, *, recursive=False)

Deregisters the given group from TileDB Cloud.

Parameters

Name	Type	Description	Default
uri	str	The URI of the group to deregister.	required
recursive	bool	If true, deregister the group recursively by deregistering all of the elements of the group (and all elements of those groups, recursively) before deregistering the group itself.	False

info

cloud.groups.info(uri)

Gets metadata about the named TileDB Cloud group.

list_shared_with

cloud.groups.list_shared_with(uri, async_req=False)

List a group’s sharing policies.

Parameters

Name	Type	Description	Default
uri	str	tiledb URI of the asset.	required
async_req		return future instead of results for async support.	False

Returns

Name	Type	Description
		a list of GroupSharing objects.

register

cloud.groups.register(
    storage_uri,
    *,
    dest_uri=None,
    name=None,
    namespace=None,
    credentials_name=None,
    parent_uri=None,
)

Registers a pre-existing group.

share_group

cloud.groups.share_group(uri, namespace, permissions, async_req=False)

Shares group with given namespace and permissions.

Parameters

Name	Type	Description	Default
uri	str	tiledb URI of the asset.	required
namespace	str		required
permissions	list(str)		required
async_req		return future instead of results for async support.	False

Returns

Name	Type	Description
		None.

unshare_group

cloud.groups.unshare_group(uri, namespace, async_req=False)

Removes sharing of a group from given namespace

Parameters

Name	Type	Description	Default
namespace	str	namespace to remove shared access to the group	required
async_req		return future instead of results for async support	False

Returns

Name	Type	Description

update_info

cloud.groups.update_info(
    uri,
    *,
    description=None,
    name=None,
    logo=None,
    tags=None,
)

Update Group Attributes

Parameters

Name	Type	Description	Default
uri	str	URI of the group in the form ‘tiledb:///’	required
description	Optional[str]	Group description, defaults to None	None
name	Optional[str]	Group’s name, defaults to None	None
logo	Optional[str]	Group’s logo, defaults to None	None
tags	Optional[List[str]]	Group tags, defaults to None	None

Returns

Name	Type	Description
	None	None