Array operations

tiledbcloud.Array

Format

An R6Class generator object

Methods

ArrayActivityLog get array activity logs @param namespace character @param array character @param start integer @param end integer @param event.types character @param task.id character @param has.task.id character @returnType list( ArrayActivityLog )
status code : 200 | log of array activity return type : array[ArrayActivityLog] response headers : status code : 0 | error response return type : Error response headers : ArraysBrowserOwnedGet Fetch a list of all arrays that are owned directly by user or user's organizations @param page integer @param per.page integer @param search character @param namespace character @param orderby character @param permissions character @param tag list( character ) @param exclude.tag list( character ) @param file.type list( character ) @param exclude.file.type list( character ) @param file.property list( character ) @returnType ArrayBrowserData
status code : 200 | Array of array info that are owned directly by user or user's organizations return type : ArrayBrowserData response headers : status code : 0 | error response return type : Error response headers : ArraysBrowserOwnedSidebarGet Fetch a sidebar for arrays that are owned directly by user or user's organizations @returnType ArrayBrowserSidebar
status code : 200 | Array of array info that are owned directly by user or user's organizations return type : ArrayBrowserSidebar response headers : status code : 0 | error response return type : Error response headers : ArraysBrowserPublicGet Fetch a list of all arrays that have been shared publically @param page integer @param per.page integer @param search character @param namespace character @param orderby character @param permissions character @param tag list( character ) @param exclude.tag list( character ) @param file.type list( character ) @param exclude.file.type list( character ) @param file.property list( character ) @returnType ArrayBrowserData
status code : 200 | Array of array info that has been shared publically return type : ArrayBrowserData response headers : status code : 0 | error response return type : Error response headers : ArraysBrowserPublicSidebarGet Fetch a sidebar of all arrays that have been shared publically @returnType ArrayBrowserSidebar
status code : 200 | Array of array info that has been shared publically return type : ArrayBrowserSidebar response headers : status code : 0 | error response return type : Error response headers : ArraysBrowserSharedGet Fetch a list of all arrays that have been shared with the user @param page integer @param per.page integer @param search character @param namespace character @param orderby character @param permissions character @param tag list( character ) @param exclude.tag list( character ) @param file.type list( character ) @param exclude.file.type list( character ) @param file.property list( character ) @returnType ArrayBrowserData
status code : 200 | Array of array info that has been shared with the user return type : ArrayBrowserData response headers : status code : 0 | error response return type : Error response headers : ArraysBrowserSharedSidebarGet Fetch a list of all arrays that have been shared with the user @returnType ArrayBrowserSidebar
status code : 200 | Array of array info that has been shared with the user return type : ArrayBrowserSidebar response headers : status code : 0 | error response return type : Error response headers : ArraysNamespaceArrayEndTimestampsGet retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated @param namespace character @param array character @param page integer @param per.page integer @returnType ArrayEndTimestampData
status code : 200 | list of timestamps in milliseconds, paginated return type : ArrayEndTimestampData response headers : status code : 0 | error response return type : Error response headers : ConsolidateArray consolidate an array at a specified URI @param namespace character @param array character @param tiledb.config TileDBConfig status code : 204 | array consolidated successfully response headers : status code : 0 | error response return type : Error response headers : CreateArray create a array schema at a specified URI registered to a group/project @param namespace character @param array character @param content.type character @param array.schema ArraySchema @param X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME character status code : 204 | schema created successfully response headers : status code : 0 | error response return type : Error response headers : DeleteArray delete a array @param namespace character @param array character @param content.type character status code : 204 | delete array successful response headers : status code : 0 | error response return type : Error response headers : DeregisterArray deregister a array @param namespace character @param array character status code : 204 | deregistered array successful response headers : status code : 0 | error response return type : Error response headers : GetActivityLogById get activity log by ID @param namespace character @param array character @param id character @returnType ArrayActivityLog
status code : 200 | array activity return type : ArrayActivityLog response headers : status code : 0 | error response return type : Error response headers : GetAllArrayMetadata get all array metadata user has access to @param public.share character @returnType list( ArrayInfo )
status code : 200 | array metadata for all arrays user has access to return type : array[ArrayInfo] response headers : status code : 0 | error response return type : Error response headers : GetArray get an ArraySchema using a url encoded uri @param namespace character @param array character @param content.type character @returnType ArraySchema
status code : 200 | get ArraySchema return type : ArraySchema response headers : status code : 0 | error response return type : Error response headers : GetArrayMaxBufferSizes get the max buffer sizes of an array for a subarray @param namespace character @param array character @param subarray character @param content.type character @param x.payer character @returnType MaxBufferSizes
status code : 200 | get the max buffer sizes of an array for a subarray return type : MaxBufferSizes response headers : status code : 0 | error response return type : Error response headers : GetArrayMetaDataJson get metadata from the array in JSON format @param namespace character @param array character @param length integer @param end.timestamp integer status code : 200 | get array metadata return type : object response headers : status code : 0 | error response return type : Error response headers : GetArrayMetadata get metadata on an array @param namespace character @param array character @returnType ArrayInfo
status code : 200 | array metadata for an array return type : ArrayInfo response headers : status code : 0 | error response return type : Error response headers : GetArrayMetadataCapnp get metadata on an array @param namespace character @param array character @returnType ArrayMetadata
status code : 200 | array metadata for an array return type : ArrayMetadata response headers : status code : 0 | error response return type : Error response headers : GetArrayNonEmptyDomain get the non empty domain of an array @param namespace character @param array character @param content.type character @param x.payer character @returnType NonEmptyDomain
status code : 200 | get the non empty domain of an array return type : NonEmptyDomain response headers : status code : 0 | error response return type : Error response headers : GetArrayNonEmptyDomainJson get non-empty domain from the array in json format @param namespace character @param array character status code : 200 | get array non-empty domaim return type : object response headers : status code : 0 | error response return type : Error response headers : GetArraySampleData get an sample set of data from the array @param namespace character @param array character @param samples numeric @returnType ArraySample
status code : 200 | get array sample data return type : ArraySample response headers : status code : 0 | error response return type : Error response headers : GetArraySharingPolicies Get all sharing details of the array @param namespace character @param array character @returnType list( ArraySharing )
status code : 200 | List of all specific sharing policies return type : array[ArraySharing] response headers : status code : 404 | Array does not exist or user does not have permissions to view array-sharing policies response headers : status code : 0 | error response return type : Error response headers : GetArraysInNamespace get metadata on all arrays in a namespace @param namespace character @returnType list( ArrayInfo )
status code : 200 | array metadata for all arrays in a namespace return type : array[ArrayInfo] response headers : status code : 0 | error response return type : Error response headers : GetFragmentEndTimestamp Get fragment end_timestamp on an array, will search for the closest end_timestamp to the timestamp asked @param namespace character @param array character @param end.timestamp integer status code : 200 | fragment end_timestamp on an array return type : integer response headers : status code : 0 | error response return type : Error response headers : GetLastAccessedArrays @returnType list( LastAccessedArray )
status code : 200 | gets last accessed arrays return type : array[LastAccessedArray] response headers : status code : 0 | error response return type : Error response headers : RegisterArray register an array at a specified URI registered to the given namespace @param namespace character @param array character @param array.metadata ArrayInfoUpdate status code : 204 | schema registered successfully response headers : status code : 0 | error response return type : Error response headers : ShareArray Share an array with a user @param namespace character @param array character @param array.sharing ArraySharing status code : 204 | Array shared successfully response headers : status code : 404 | Array does not exist or user does not have permissions to share array response headers : status code : 0 | error response return type : Error response headers : UpdateArrayMetadata update metadata on an array @param namespace character @param array character @param array.metadata ArrayInfoUpdate status code : 204 | array metadata updated successfully response headers : status code : 0 | error response return type : Error response headers : UpdateArrayMetadataCapnp update metadata on an array @param namespace character @param array character @param array.metadata.entries ArrayMetadata status code : 200 | array metadata updated successfully response headers : status code : 0 | error response return type : Error response headers : VacuumArray vacuum an array at a specified URI @param namespace character @param array character @param tiledb.config TileDBConfig status code : 204 | array vacuumed successfully response headers : status code : 0 | error response return type : Error response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• ArrayApi$new()

• ArrayApi$ArrayActivityLog()

• ArrayApi$ArrayActivityLogWithHttpInfo()

• ArrayApi$ArraysBrowserOwnedGet()

• ArrayApi$ArraysBrowserOwnedGetWithHttpInfo()

• ArrayApi$ArraysBrowserOwnedSidebarGet()

• ArrayApi$ArraysBrowserOwnedSidebarGetWithHttpInfo()

• ArrayApi$ArraysBrowserPublicGet()

• ArrayApi$ArraysBrowserPublicGetWithHttpInfo()

• ArrayApi$ArraysBrowserPublicSidebarGet()

• ArrayApi$ArraysBrowserPublicSidebarGetWithHttpInfo()

• ArrayApi$ArraysBrowserSharedGet()

• ArrayApi$ArraysBrowserSharedGetWithHttpInfo()

• ArrayApi$ArraysBrowserSharedSidebarGet()

• ArrayApi$ArraysBrowserSharedSidebarGetWithHttpInfo()

• ArrayApi$ArraysNamespaceArrayEndTimestampsGet()

• ArrayApi$ArraysNamespaceArrayEndTimestampsGetWithHttpInfo()

• ArrayApi$ConsolidateArray()

• ArrayApi$ConsolidateArrayWithHttpInfo()

• ArrayApi$CreateArray()

• ArrayApi$CreateArrayWithHttpInfo()

• ArrayApi$DeleteArray()

• ArrayApi$DeleteArrayWithHttpInfo()

• ArrayApi$DeregisterArray()

• ArrayApi$DeregisterArrayWithHttpInfo()

• ArrayApi$GetActivityLogById()

• ArrayApi$GetActivityLogByIdWithHttpInfo()

• ArrayApi$GetAllArrayMetadata()

• ArrayApi$GetAllArrayMetadataWithHttpInfo()

• ArrayApi$GetArray()

• ArrayApi$GetArrayWithHttpInfo()

• ArrayApi$GetArrayMaxBufferSizes()

• ArrayApi$GetArrayMaxBufferSizesWithHttpInfo()

• ArrayApi$GetArrayMetaDataJson()

• ArrayApi$GetArrayMetaDataJsonWithHttpInfo()

• ArrayApi$GetArrayMetadata()

• ArrayApi$GetArrayMetadataWithHttpInfo()

• ArrayApi$GetArrayMetadataCapnp()

• ArrayApi$GetArrayMetadataCapnpWithHttpInfo()

• ArrayApi$GetArrayNonEmptyDomain()

• ArrayApi$GetArrayNonEmptyDomainWithHttpInfo()

• ArrayApi$GetArrayNonEmptyDomainJson()

• ArrayApi$GetArrayNonEmptyDomainJsonWithHttpInfo()

• ArrayApi$GetArraySampleData()

• ArrayApi$GetArraySampleDataWithHttpInfo()

• ArrayApi$GetArraySharingPolicies()

• ArrayApi$GetArraySharingPoliciesWithHttpInfo()

• ArrayApi$GetArraysInNamespace()

• ArrayApi$GetArraysInNamespaceWithHttpInfo()

• ArrayApi$GetFragmentEndTimestamp()

• ArrayApi$GetFragmentEndTimestampWithHttpInfo()

• ArrayApi$GetLastAccessedArrays()

• ArrayApi$GetLastAccessedArraysWithHttpInfo()

• ArrayApi$RegisterArray()

• ArrayApi$RegisterArrayWithHttpInfo()

• ArrayApi$ShareArray()

• ArrayApi$ShareArrayWithHttpInfo()

• ArrayApi$UpdateArrayMetadata()

• ArrayApi$UpdateArrayMetadataWithHttpInfo()

• ArrayApi$UpdateArrayMetadataCapnp()

• ArrayApi$UpdateArrayMetadataCapnpWithHttpInfo()

• ArrayApi$VacuumArray()

• ArrayApi$VacuumArrayWithHttpInfo()

• ArrayApi$clone()

---

Method new()

Usage

ArrayApi$new(apiClient)

---

Method ArrayActivityLog()

Usage

ArrayApi$ArrayActivityLog(
  namespace,
  array,
  start = NULL,
  end = NULL,
  event.types = NULL,
  task.id = NULL,
  has.task.id = NULL,
  ...
)

---

Method ArrayActivityLogWithHttpInfo()

Usage

ArrayApi$ArrayActivityLogWithHttpInfo(
  namespace,
  array,
  start = NULL,
  end = NULL,
  event.types = NULL,
  task.id = NULL,
  has.task.id = NULL,
  ...
)

---

Method ArraysBrowserOwnedGet()

Usage

ArrayApi$ArraysBrowserOwnedGet(
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  file.property = NULL,
  ...
)

---

Method ArraysBrowserOwnedGetWithHttpInfo()

Usage

ArrayApi$ArraysBrowserOwnedGetWithHttpInfo(
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  file.property = NULL,
  ...
)

---

Method ArraysBrowserOwnedSidebarGet()

Usage

ArrayApi$ArraysBrowserOwnedSidebarGet(...)

---

Method ArraysBrowserOwnedSidebarGetWithHttpInfo()

Usage

ArrayApi$ArraysBrowserOwnedSidebarGetWithHttpInfo(...)

---

Method ArraysBrowserPublicGet()

Usage

ArrayApi$ArraysBrowserPublicGet(
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  file.property = NULL,
  ...
)

---

Method ArraysBrowserPublicGetWithHttpInfo()

Usage

ArrayApi$ArraysBrowserPublicGetWithHttpInfo(
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  file.property = NULL,
  ...
)

---

Method ArraysBrowserPublicSidebarGet()

Usage

ArrayApi$ArraysBrowserPublicSidebarGet(...)

---

Method ArraysBrowserPublicSidebarGetWithHttpInfo()

Usage

ArrayApi$ArraysBrowserPublicSidebarGetWithHttpInfo(...)

---

Method ArraysBrowserSharedGet()

Usage

ArrayApi$ArraysBrowserSharedGet(
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  file.property = NULL,
  ...
)

---

Method ArraysBrowserSharedGetWithHttpInfo()

Usage

ArrayApi$ArraysBrowserSharedGetWithHttpInfo(
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  file.property = NULL,
  ...
)

---

Method ArraysBrowserSharedSidebarGet()

Usage

ArrayApi$ArraysBrowserSharedSidebarGet(...)

---

Method ArraysBrowserSharedSidebarGetWithHttpInfo()

Usage

ArrayApi$ArraysBrowserSharedSidebarGetWithHttpInfo(...)

---

Method ArraysNamespaceArrayEndTimestampsGet()

Usage

ArrayApi$ArraysNamespaceArrayEndTimestampsGet(
  namespace,
  array,
  page = NULL,
  per.page = NULL,
  ...
)

---

Method ArraysNamespaceArrayEndTimestampsGetWithHttpInfo()

Usage

ArrayApi$ArraysNamespaceArrayEndTimestampsGetWithHttpInfo(
  namespace,
  array,
  page = NULL,
  per.page = NULL,
  ...
)

---

Method ConsolidateArray()

Usage

ArrayApi$ConsolidateArray(namespace, array, tiledb.config, ...)

---

Method ConsolidateArrayWithHttpInfo()

Usage

ArrayApi$ConsolidateArrayWithHttpInfo(namespace, array, tiledb.config, ...)

---

Method CreateArray()

Usage

ArrayApi$CreateArray(
  namespace,
  array,
  content.type,
  array.schema,
  X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = NULL,
  ...
)

---

Method CreateArrayWithHttpInfo()

Usage

ArrayApi$CreateArrayWithHttpInfo(
  namespace,
  array,
  content.type,
  array.schema,
  X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = NULL,
  ...
)

---

Method DeleteArray()

Usage

ArrayApi$DeleteArray(namespace, array, content.type, ...)

---

Method DeleteArrayWithHttpInfo()

Usage

ArrayApi$DeleteArrayWithHttpInfo(namespace, array, content.type, ...)

---

Method DeregisterArray()

Usage

ArrayApi$DeregisterArray(namespace, array, ...)

---

Method DeregisterArrayWithHttpInfo()

Usage

ArrayApi$DeregisterArrayWithHttpInfo(namespace, array, ...)

---

Method GetActivityLogById()

Usage

ArrayApi$GetActivityLogById(namespace, array, id, ...)

---

Method GetActivityLogByIdWithHttpInfo()

Usage

ArrayApi$GetActivityLogByIdWithHttpInfo(namespace, array, id, ...)

---

Method GetAllArrayMetadata()

Usage

ArrayApi$GetAllArrayMetadata(public.share = NULL, ...)

---

Method GetAllArrayMetadataWithHttpInfo()

Usage

ArrayApi$GetAllArrayMetadataWithHttpInfo(public.share = NULL, ...)

---

Method GetArray()

Usage

ArrayApi$GetArray(namespace, array, content.type, ...)

---

Method GetArrayWithHttpInfo()

Usage

ArrayApi$GetArrayWithHttpInfo(namespace, array, content.type, ...)

---

Method GetArrayMaxBufferSizes()

Usage

ArrayApi$GetArrayMaxBufferSizes(
  namespace,
  array,
  subarray,
  content.type,
  x.payer = NULL,
  ...
)

---

Method GetArrayMaxBufferSizesWithHttpInfo()

Usage

ArrayApi$GetArrayMaxBufferSizesWithHttpInfo(
  namespace,
  array,
  subarray,
  content.type,
  x.payer = NULL,
  ...
)

---

Method GetArrayMetaDataJson()

Usage

ArrayApi$GetArrayMetaDataJson(
  namespace,
  array,
  length = NULL,
  end.timestamp = NULL,
  ...
)

---

Method GetArrayMetaDataJsonWithHttpInfo()

Usage

ArrayApi$GetArrayMetaDataJsonWithHttpInfo(
  namespace,
  array,
  length = NULL,
  end.timestamp = NULL,
  ...
)

---

Method GetArrayMetadata()

Usage

ArrayApi$GetArrayMetadata(namespace, array, ...)

---

Method GetArrayMetadataWithHttpInfo()

Usage

ArrayApi$GetArrayMetadataWithHttpInfo(namespace, array, ...)

---

Method GetArrayMetadataCapnp()

Usage

ArrayApi$GetArrayMetadataCapnp(namespace, array, ...)

---

Method GetArrayMetadataCapnpWithHttpInfo()

Usage

ArrayApi$GetArrayMetadataCapnpWithHttpInfo(namespace, array, ...)

---

Method GetArrayNonEmptyDomain()

Usage

ArrayApi$GetArrayNonEmptyDomain(
  namespace,
  array,
  content.type,
  x.payer = NULL,
  ...
)

---

Method GetArrayNonEmptyDomainWithHttpInfo()

Usage

ArrayApi$GetArrayNonEmptyDomainWithHttpInfo(
  namespace,
  array,
  content.type,
  x.payer = NULL,
  ...
)

---

Method GetArrayNonEmptyDomainJson()

Usage

ArrayApi$GetArrayNonEmptyDomainJson(namespace, array, ...)

---

Method GetArrayNonEmptyDomainJsonWithHttpInfo()

Usage

ArrayApi$GetArrayNonEmptyDomainJsonWithHttpInfo(namespace, array, ...)

---

Method GetArraySampleData()

Usage

ArrayApi$GetArraySampleData(namespace, array, samples = 5, ...)

---

Method GetArraySampleDataWithHttpInfo()

Usage

ArrayApi$GetArraySampleDataWithHttpInfo(namespace, array, samples = 5, ...)

---

Method GetArraySharingPolicies()

Usage

ArrayApi$GetArraySharingPolicies(namespace, array, ...)

---

Method GetArraySharingPoliciesWithHttpInfo()

Usage

ArrayApi$GetArraySharingPoliciesWithHttpInfo(namespace, array, ...)

---

Method GetArraysInNamespace()

Usage

ArrayApi$GetArraysInNamespace(namespace, ...)

---

Method GetArraysInNamespaceWithHttpInfo()

Usage

ArrayApi$GetArraysInNamespaceWithHttpInfo(namespace, ...)

---

Method GetFragmentEndTimestamp()

Usage

ArrayApi$GetFragmentEndTimestamp(namespace, array, end.timestamp = NULL, ...)

---

Method GetFragmentEndTimestampWithHttpInfo()

Usage

ArrayApi$GetFragmentEndTimestampWithHttpInfo(
  namespace,
  array,
  end.timestamp = NULL,
  ...
)

---

Method GetLastAccessedArrays()

Usage

ArrayApi$GetLastAccessedArrays(...)

---

Method GetLastAccessedArraysWithHttpInfo()

Usage

ArrayApi$GetLastAccessedArraysWithHttpInfo(...)

---

Method RegisterArray()

Usage

ArrayApi$RegisterArray(namespace, array, array.metadata, ...)

---

Method RegisterArrayWithHttpInfo()

Usage

ArrayApi$RegisterArrayWithHttpInfo(namespace, array, array.metadata, ...)

---

Method ShareArray()

Usage

ArrayApi$ShareArray(namespace, array, array.sharing, ...)

---

Method ShareArrayWithHttpInfo()

Usage

ArrayApi$ShareArrayWithHttpInfo(namespace, array, array.sharing, ...)

---

Method UpdateArrayMetadata()

Usage

ArrayApi$UpdateArrayMetadata(namespace, array, array.metadata, ...)

---

Method UpdateArrayMetadataWithHttpInfo()

Usage

ArrayApi$UpdateArrayMetadataWithHttpInfo(namespace, array, array.metadata, ...)

---

Method UpdateArrayMetadataCapnp()

Usage

ArrayApi$UpdateArrayMetadataCapnp(
  namespace,
  array,
  array.metadata.entries,
  ...
)

---

Method UpdateArrayMetadataCapnpWithHttpInfo()

Usage

ArrayApi$UpdateArrayMetadataCapnpWithHttpInfo(
  namespace,
  array,
  array.metadata.entries,
  ...
)

---

Method VacuumArray()

Usage

ArrayApi$VacuumArray(namespace, array, tiledb.config, ...)

---

Method VacuumArrayWithHttpInfo()

Usage

ArrayApi$VacuumArrayWithHttpInfo(namespace, array, tiledb.config, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ArrayApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples