Package index • tiledbcloud

Manual layer

These are manually written/curated functions which wrap some of the key calls into the OpenAPI autogen layer. They’re more user-friendly and better documented. See also the Article on Package Status.

array_info(): Show information about an array on TileDB Cloud

compute(): Launch a task graph from a given terminal node in the task graph

compute_sequentially(): Test/debug entrypoint for local/sequential compute.

configure(): Configure TileDB Cloud

delayed(): Define a function to be executed within a task graph

`delayed_args<-`(): Set arguments for a delayed function.

delayed_args(): Get arguments for a delayed function, as a list.

delayed_array_udf(): Define a single-array UDF to be executed within a task graph

delayed_generic_udf(): Define a generic UDF to be executed within a task graph

delayed_sql(): Define a SQL query function to be executed within a task graph

deregister_array(): Deregister an array from TileDB Cloud

deregister_group(): De-register a 'Group' object recursively

deregister_udf(): Deregister a UDF from TileDB Cloud

execute_array_udf(): Execute a single-array UDF on TileDB Cloud

execute_generic_udf(): Execute a generic UDF on TileDB Cloud

execute_multi_array_udf(): Execute a multi-array UDF on TileDB Cloud

execute_sql_query(): Execute a SQL query on TileDB Cloud

get_api_client_instance(): Access cached API-client object

get_udf_info(): Get information about a UDF on TileDB Cloud

group_info(): Group Information

list_arrays(): Show listing of arrays

list_groups(): Show listing of groups

login(): Log in to TileDB Cloud

register_array(): Register an existing array on TileDB Cloud

register_udf(): Register a UDF on TileDB Cloud

update_udf_info(): Update a UDF on TileDB Cloud

user_profile(): Show information from user TileDB Cloud user profile

Autogen layer

These are functions autogenerated by the OpenAPI tool from the TileDB-Cloud API specification. They are thorough, but less user-friendly than the manual-layer functions.

AWSAccessCredentials: AWSAccessCredentials

ActivityEventType: ActivityEventType

ApiClient: ApiClient

ApiResponse: ApiResponse

Array: Array

ArrayActions: ArrayActions

ArrayActivityLog: ArrayActivityLog

ArrayApi: Array operations

ArrayBrowserData: ArrayBrowserData

ArrayBrowserSidebar: ArrayBrowserSidebar

ArrayEndTimestampData: ArrayEndTimestampData

ArrayFavorite: ArrayFavorite

ArrayFavoritesData: ArrayFavoritesData

ArrayInfo: ArrayInfo

ArrayInfoUpdate: ArrayInfoUpdate

ArrayMetadata: ArrayMetadata

ArrayMetadataEntry: ArrayMetadataEntry

ArraySample: ArraySample

ArraySchema: ArraySchema

ArraySharing: ArraySharing

ArrayTask: ArrayTask

ArrayTaskBrowserSidebar: ArrayTaskBrowserSidebar

ArrayTaskData: ArrayTaskData

ArrayTaskLog: ArrayTaskLog

ArrayTaskStatus: ArrayTaskStatus

ArrayTaskType: ArrayTaskType

ArrayTasksApi: ArrayTasks operations

ArrayType: ArrayType

Attribute: Attribute

AttributeBufferHeader: AttributeBufferHeader

AttributeBufferSize: AttributeBufferSize

Datatype: Datatype

Dimension: Dimension

DimensionCoordinate: DimensionCoordinate

DimensionTileExtent: DimensionTileExtent

Domain: Domain

DomainArray: DomainArray

Error: Error

FavoritesApi: Favorites operations

FileCreate: FileCreate

FileCreated: FileCreated

FileExport: FileExport

FileExported: FileExported

FilePropertyName: FilePropertyName

FileType: FileType

FilesApi: Files operations

Filter: Filter

FilterData: FilterData

FilterOption: FilterOption

FilterPipeline: FilterPipeline

FilterType: FilterType

GenericUDF: GenericUDF

Group: Group

GroupActions: GroupActions

GroupBrowserData: GroupBrowserData

GroupBrowserFilterData: GroupBrowserFilterData

GroupChanges: GroupChanges

GroupContents: GroupContents

GroupContentsFilterData: GroupContentsFilterData

GroupCreate: GroupCreate

GroupEntry: GroupEntry

GroupInfo: GroupInfo

GroupListing: GroupListing

GroupListingAllOf: GroupListingAllOf

GroupMember: GroupMember

GroupMemberAssetType: GroupMemberAssetType

GroupMemberType: GroupMemberType

GroupRegister: GroupRegister

GroupSharing: GroupSharing

GroupSharingRequest: GroupSharingRequest

GroupUpdate: GroupUpdate

GroupsApi: Groups operations

InlineObject: InlineObject

InlineResponse200: InlineResponse200

Invitation: Invitation

InvitationApi: Invitation operations

InvitationArrayShareEmail: InvitationArrayShareEmail

InvitationData: InvitationData

InvitationOrganizationJoinEmail: InvitationOrganizationJoinEmail

InvitationStatus: InvitationStatus

InvitationType: InvitationType

LastAccessedArray: LastAccessedArray

Layout: Layout

MLModelFavorite: MLModelFavorite

MLModelFavoritesData: MLModelFavoritesData

MaxBufferSizes: MaxBufferSizes

MultiArrayUDF: MultiArrayUDF

NamespaceActions: NamespaceActions

NonEmptyDomain: NonEmptyDomain

NotebookApi: Notebook operations

NotebookFavorite: NotebookFavorite

NotebookFavoritesData: NotebookFavoritesData

NotebookStatus: NotebookStatus

NotebooksApi: Notebooks operations

Organization: Organization

OrganizationApi: Organization operations

OrganizationRoles: OrganizationRoles

OrganizationUser: OrganizationUser

PaginationMetadata: PaginationMetadata

Pricing: Pricing

PricingAggregateUsage: PricingAggregateUsage

PricingCurrency: PricingCurrency

PricingInterval: PricingInterval

PricingType: PricingType

PricingUnitLabel: PricingUnitLabel

PublicShareFilter: PublicShareFilter

Query: Query

QueryApi: Query operations

QueryJson: QueryJson

QueryRanges: QueryRanges

QueryReader: QueryReader

Querystatus: Querystatus

Querytype: Querytype

ReadState: ReadState

ResultFormat: ResultFormat

SQLParameters: SQLParameters

SSOProvider: SSOProvider

SqlApi: Sql operations

StatsApi: Stats operations

Subarray: Subarray

SubarrayPartitioner: SubarrayPartitioner

SubarrayPartitionerCurrent: SubarrayPartitionerCurrent

SubarrayPartitionerState: SubarrayPartitionerState

SubarrayRanges: SubarrayRanges

Subscription: Subscription

TaskGraphLog: TaskGraphLog

TaskGraphLogStatus: TaskGraphLogStatus

TaskGraphLogsApi: TaskGraphLogs operations

TaskGraphLogsData: TaskGraphLogsData

TaskGraphNodeMetadata: TaskGraphNodeMetadata

TasksApi: Tasks operations

TileDBConfig: TileDBConfig

Token: Token

TokenRequest: TokenRequest

TokenScope: TokenScope

UDFActions: UDFActions

UDFArrayDetails: UDFArrayDetails

UDFFavorite: UDFFavorite

UDFFavoritesData: UDFFavoritesData

UDFImage: UDFImage

UDFImageVersion: UDFImageVersion

UDFInfo: UDFInfo

UDFInfoUpdate: UDFInfoUpdate

UDFLanguage: UDFLanguage

UDFSharing: UDFSharing

UDFSubarray: UDFSubarray

UDFSubarrayRange: UDFSubarrayRange

UDFType: UDFType

UdfApi: Udf operations

User: User

UserApi: User operations

Writer: Writer

Package-internal layer

These are functions intended to be invoked by the manual-layer functions, as implementation details beneath the interest of most users of the API.

.get_decoded_response_body_or_stop(): Package-internal HTTP-response helper

.get_empty_response_body_or_stop(): Package-internal HTTP-response helper

.get_raw_response_body_or_stop(): Package-internal HTTP-response helper

.wrap_as_api_response(): Package-internal HTTP-response helper