Analytics

class acouchbase.management.analytics.AnalyticsIndexManager(impl: AsyncAnalyticsMgmtInterface)

Performs management operations on analytics dataverses, datasets, indexes and links.

Connects a link, so that its datasets start receiving data.

Parameters:
  • options (ConnectLinkOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

async create_dataset(dataset_name: str, bucket_name: str, options: CreateDatasetOptions | None = None, **kwargs: Unpack[CreateDatasetOptionsKwargs]) → None

Creates a new analytics dataset over a bucket.

Parameters:
  • dataset_name (str) – The name of the dataset to create.

  • bucket_name (str) – The name of the bucket the dataset reads from.

  • options (CreateDatasetOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async create_dataverse(dataverse_name: str, options: CreateDataverseOptions | None = None, **kwargs: Unpack[CreateDataverseOptionsKwargs]) → None

Creates a new analytics dataverse.

Parameters:
  • dataverse_name (str) – The name of the dataverse to create.

  • options (CreateDataverseOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async create_index(index_name: str, dataset_name: str, fields: dict[str, AnalyticsDataType], options: CreateAnalyticsIndexOptions | None = None, **kwargs: Unpack[CreateAnalyticsIndexOptionsKwargs]) → None

Creates a new analytics index on a dataset.

Parameters:
  • index_name (str) – The name of the index to create.

  • dataset_name (str) – The name of the dataset to index.

  • fields (dict[str, AnalyticsDataType]) – The fields the index covers, each mapped to its type.

  • options (CreateAnalyticsIndexOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:

InvalidArgumentException – If the index_name or dataset_name is not a str, or fields is not a dict of AnalyticsDataType values.

Creates a new analytics link.

Parameters:
Raises:

Disconnects a link, so that its datasets stop receiving data.

Parameters:
  • options (DisconnectLinkOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

async drop_dataset(dataset_name: str, options: DropDatasetOptions | None = None, **kwargs: Unpack[DropDatasetOptionsKwargs]) → None

Drops an existing analytics dataset.

Parameters:
  • dataset_name (str) – The name of the dataset to drop.

  • options (DropDatasetOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async drop_dataverse(dataverse_name: str, options: DropDataverseOptions | None = None, **kwargs: Unpack[DropDataverseOptionsKwargs]) → None

Drops an existing analytics dataverse.

Parameters:
  • dataverse_name (str) – The name of the dataverse to drop.

  • options (DropDataverseOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async drop_index(index_name: str, dataset_name: str, options: DropAnalyticsIndexOptions | None = None, **kwargs: Unpack[DropAnalyticsIndexOptionsKwargs]) → None

Drops an existing analytics index.

Parameters:
  • index_name (str) – The name of the index to drop.

  • dataset_name (str) – The name of the dataset the index is on.

  • options (DropAnalyticsIndexOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:

InvalidArgumentException – If the index_name or dataset_name is not a str.

Drops an existing analytics link.

Parameters:
  • link_name (str) – The name of the link to drop.

  • dataverse_name (str) – The name of the dataverse the link is in.

  • options (DropLinkAnalyticsOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async get_all_datasets(options: GetAllDatasetOptions | None = None, **kwargs: Unpack[GetAllDatasetOptionsKwargs]) → Iterable[AnalyticsDataset]

Returns every analytics dataset.

Parameters:
  • options (GetAllDatasetOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Returns:

The datasets.

Return type:

Awaitable[Iterable[AnalyticsDataset]]

async get_all_indexes(options: GetAllAnalyticsIndexesOptions | None = None, **kwargs: Unpack[GetAllAnalyticsIndexesOptionsKwargs]) → Iterable[AnalyticsIndex]

Returns every analytics index.

Parameters:
  • options (GetAllAnalyticsIndexesOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Returns:

The indexes.

Return type:

Awaitable[Iterable[AnalyticsIndex]]

Returns the analytics links, all of them unless the options narrow the search.

Parameters:
  • options (GetLinksAnalyticsOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Returns:

The links.

Return type:

Awaitable[Iterable[AnalyticsLink]]

Raises:

DataverseNotFoundException – If the dataverse named in the options does not exist.

async get_pending_mutations(options: GetPendingMutationsOptions | None = None, **kwargs: Unpack[GetPendingMutationsOptionsKwargs]) → dict[str, int]

Returns how many mutations each dataset has yet to process.

Parameters:
  • options (GetPendingMutationsOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Returns:

The number of pending mutations, keyed by dataverse and dataset name.

Return type:

Awaitable[dict[str, int]]

Replaces an existing analytics link.

Parameters:
Raises:

This module also publishes these, described where they are first documented: