Analytics
- class txcouchbase.management.analytics.AnalyticsIndexManager(impl: TxAnalyticsMgmtInterface)
Performs management operations on analytics dataverses, datasets, indexes and links.
- connect_link(options: ConnectLinkOptions | None = None, **kwargs: Unpack[ConnectLinkOptionsKwargs]) Deferred[None]
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.
- create_dataset(dataset_name: str, bucket_name: str, options: CreateDatasetOptions | None = None, **kwargs: Unpack[CreateDatasetOptionsKwargs]) Deferred[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:
InvalidArgumentException – If the dataset_name or bucket_name is not a str.
DatasetAlreadyExistsException – If the dataset already exists and ignore_if_exists is not set.
- create_dataverse(dataverse_name: str, options: CreateDataverseOptions | None = None, **kwargs: Unpack[CreateDataverseOptionsKwargs]) Deferred[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:
InvalidArgumentException – If the dataverse_name is not a str.
DataverseAlreadyExistsException – If the dataverse already exists and ignore_if_exists is not set.
- create_index(index_name: str, dataset_name: str, fields: dict[str, AnalyticsDataType], options: CreateAnalyticsIndexOptions | None = None, **kwargs: Unpack[CreateAnalyticsIndexOptionsKwargs]) Deferred[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
AnalyticsDataTypevalues.
- create_link(link: AnalyticsLink, options: CreateLinkAnalyticsOptions | None = None, **kwargs: Unpack[CreateLinkAnalyticsOptionsKwargs]) Deferred[None]
Creates a new analytics link.
- Parameters:
link (
AnalyticsLink) – The link to create: aCouchbaseRemoteAnalyticsLink,S3ExternalAnalyticsLinkorAzureBlobExternalAnalyticsLink.options (
CreateLinkAnalyticsOptions) – Optional parameters for this operation.**kwargs – keyword arguments that can be used as optional parameters for this operation.
- Raises:
InvalidArgumentException – If the link is not an
AnalyticsLink, or is not valid.AnalyticsLinkExistsException – If the link already exists.
DataverseNotFoundException – If the link’s dataverse does not exist.
- disconnect_link(options: DisconnectLinkOptions | None = None, **kwargs: Unpack[DisconnectLinkOptionsKwargs]) Deferred[None]
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.
- drop_dataset(dataset_name: str, options: DropDatasetOptions | None = None, **kwargs: Unpack[DropDatasetOptionsKwargs]) Deferred[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:
InvalidArgumentException – If the dataset_name is not a str.
DatasetNotFoundException – If the dataset does not exist and ignore_if_not_exists is not set.
- drop_dataverse(dataverse_name: str, options: DropDataverseOptions | None = None, **kwargs: Unpack[DropDataverseOptionsKwargs]) Deferred[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:
InvalidArgumentException – If the dataverse_name is not a str.
DataverseNotFoundException – If the dataverse does not exist and ignore_if_not_exists is not set.
- drop_index(index_name: str, dataset_name: str, options: DropAnalyticsIndexOptions | None = None, **kwargs: Unpack[DropAnalyticsIndexOptionsKwargs]) Deferred[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.
- drop_link(link_name: str, dataverse_name: str, options: DropLinkAnalyticsOptions | None = None, **kwargs: Unpack[DropLinkAnalyticsOptionsKwargs]) Deferred[None]
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:
InvalidArgumentException – If the link_name or dataverse_name is not a str.
AnalyticsLinkNotFoundException – If the link does not exist.
DataverseNotFoundException – If the dataverse does not exist.
- get_all_datasets(options: GetAllDatasetOptions | None = None, **kwargs: Unpack[GetAllDatasetOptionsKwargs]) Deferred[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:
Deferred[Iterable[
AnalyticsDataset]]
- get_all_indexes(options: GetAllAnalyticsIndexesOptions | None = None, **kwargs: Unpack[GetAllAnalyticsIndexesOptionsKwargs]) Deferred[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:
Deferred[Iterable[
AnalyticsIndex]]
- get_links(options: GetLinksAnalyticsOptions | None = None, **kwargs: Unpack[GetLinksAnalyticsOptionsKwargs]) Deferred[Iterable[AnalyticsLink]]
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:
Deferred[Iterable[
AnalyticsLink]]- Raises:
DataverseNotFoundException – If the dataverse named in the options does not exist.
- get_pending_mutations(options: GetPendingMutationsOptions | None = None, **kwargs: Unpack[GetPendingMutationsOptionsKwargs]) Deferred[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:
- replace_link(link: AnalyticsLink, options: ReplaceLinkAnalyticsOptions | None = None, **kwargs: Unpack[ReplaceLinkAnalyticsOptionsKwargs]) Deferred[None]
Replaces an existing analytics link.
- Parameters:
link (
AnalyticsLink) – The link to replace: aCouchbaseRemoteAnalyticsLink,S3ExternalAnalyticsLinkorAzureBlobExternalAnalyticsLink.options (
ReplaceLinkAnalyticsOptions) – Optional parameters for this operation.**kwargs – keyword arguments that can be used as optional parameters for this operation.
- Raises:
InvalidArgumentException – If the link is not an
AnalyticsLink, or is not valid.AnalyticsLinkNotFoundException – If the link does not exist.
DataverseNotFoundException – If the link’s dataverse does not exist.
This module also publishes these, described where they are first documented: