Analytics
- class couchbase.management.analytics.AnalyticsDataType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
The type of a field an analytics index covers.
- DOUBLE = 'double'
- INT64 = 'int64'
- STRING = 'string'
- class couchbase.management.analytics.AnalyticsDataset(dataset_name: str | None = None, dataverse_name: str | None = None, link_name: str | None = None, bucket_name: str | None = None)
An analytics dataset, as the analytics service describes it.
- class couchbase.management.analytics.AnalyticsEncryptionLevel(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
How a remote Couchbase analytics link encrypts its connection.
NONEsends everything in plain text,HALFencrypts only the credentials, andFULLencrypts the whole connection with TLS.- FULL = 'full'
- HALF = 'half'
- NONE = 'none'
- class couchbase.management.analytics.AnalyticsIndex(name: str | None = None, dataset_name: str | None = None, dataverse_name: str | None = None, is_primary: bool | None = None)
An analytics index, as the analytics service describes it.
- class couchbase.management.analytics.AnalyticsIndexManager(impl: AnalyticsMgmtInterface)
Performs management operations on analytics dataverses, datasets, indexes and links.
- connect_link(options: ConnectLinkOptions | None = None, **kwargs: Unpack[ConnectLinkOptionsKwargs]) 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]) 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]) 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]) 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]) 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]) 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]) 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]) 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]) 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]) 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]) 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:
Iterable[
AnalyticsDataset]
- 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:
Iterable[
AnalyticsIndex]
- get_links(options: GetLinksAnalyticsOptions | None = None, **kwargs: Unpack[GetLinksAnalyticsOptionsKwargs]) 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:
Iterable[
AnalyticsLink]- Raises:
DataverseNotFoundException – If the dataverse named in the options does not exist.
- 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:
- replace_link(link: AnalyticsLink, options: ReplaceLinkAnalyticsOptions | None = None, **kwargs: Unpack[ReplaceLinkAnalyticsOptionsKwargs]) 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.
- class couchbase.management.analytics.AnalyticsLink
A link from the analytics service to a source of data outside the local cluster.
A link is one of
CouchbaseRemoteAnalyticsLink,S3ExternalAnalyticsLinkorAzureBlobExternalAnalyticsLink. Links are available on Couchbase Server 7.0 and later.- abstract dataverse_name() str
Get the name of the dataverse the link is in.
- Returns:
The name of the dataverse the link is in.
- Return type:
- abstract link_type() AnalyticsLinkType
Get the kind of data source the link connects to.
- Returns:
The kind of data source the link connects to.
- Return type:
- abstract validate() None
Check that the link has every setting its kind requires.
- Raises:
InvalidArgumentException – If a required setting is missing.
- class couchbase.management.analytics.AnalyticsLinkType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
The kind of data source an analytics link connects to.
- AzureBlobExternal = 'azureblob'
- CouchbaseRemote = 'couchbase'
- S3External = 's3'
- class couchbase.management.analytics.AzureBlobExternalAnalyticsLink(dataverse: str, link_name: str, connection_string: str | None = None, account_name: str | None = None, account_key: str | None = None, shared_access_signature: str | None = None, blob_endpoint: str | None = None, endpoint_suffix: str | None = None)
A link to data in Azure Blob Storage.
The link authenticates with a connection string, or with an account name and either an account key or a shared access signature.
- Parameters:
dataverse (str) – The name of the dataverse the link is in.
link_name (str) – The name of the link.
connection_string (str, optional) – The Azure connection string.
account_name (str, optional) – The storage account name.
account_key (str, optional) – The storage account key.
shared_access_signature (str, optional) – A shared access signature for the account.
blob_endpoint (str, optional) – The blob service endpoint.
endpoint_suffix (str, optional) – The endpoint suffix.
- dataverse_name() str
Get the name of the dataverse the link is in.
- Returns:
The name of the dataverse the link is in.
- Return type:
- link_type() AnalyticsLinkType
Get the kind of data source the link connects to.
- Returns:
The kind of data source the link connects to.
- Return type:
- validate() None
Check that the link has every setting its kind requires.
- Raises:
InvalidArgumentException – If a required setting is missing.
- class couchbase.management.analytics.CouchbaseAnalyticsEncryptionSettings(encryption_level: AnalyticsEncryptionLevel | None = None, certificate: bytes | bytearray | None = None, client_certificate: bytes | bytearray | None = None, client_key: bytes | bytearray | None = None)
The encryption a remote Couchbase analytics link uses.
- Parameters:
encryption_level (
AnalyticsEncryptionLevel, optional) – How the link encrypts its connection. Defaults toNONE.certificate (bytes | bytearray, optional) – The remote cluster’s certificate, required for
FULL.client_certificate (bytes | bytearray, optional) – The client certificate, required for
FULL.client_key (bytes | bytearray, optional) – The client certificate’s key, required for
FULL.
- property encryption_level: AnalyticsEncryptionLevel
How the link encrypts its connection.
- class couchbase.management.analytics.CouchbaseRemoteAnalyticsLink(dataverse: str, link_name: str, hostname: str, encryption: CouchbaseAnalyticsEncryptionSettings, username: str | None = None, password: str | None = None)
A link to a bucket on another Couchbase cluster.
- Parameters:
dataverse (str) – The name of the dataverse the link is in.
link_name (str) – The name of the link.
hostname (str) – The hostname of the remote cluster.
encryption (
CouchbaseAnalyticsEncryptionSettings) – How the link encrypts its connection.username (str, optional) – The username to authenticate with, required unless the encryption level is
FULL.password (str, optional) – The password to authenticate with, required unless the encryption level is
FULL.
- dataverse_name() str
Get the name of the dataverse the link is in.
- Returns:
The name of the dataverse the link is in.
- Return type:
- link_type() AnalyticsLinkType
Get the kind of data source the link connects to.
- Returns:
The kind of data source the link connects to.
- Return type:
- validate() None
Check that the link has every setting its kind requires.
- Raises:
InvalidArgumentException – If a required setting is missing.
- class couchbase.management.analytics.S3ExternalAnalyticsLink(dataverse: str, link_name: str, access_key_id: str, region: str, secret_access_key: str | None = None, session_token: str | None = None, service_endpoint: str | None = None)
A link to data in Amazon S3.
- Parameters:
dataverse (str) – The name of the dataverse the link is in.
link_name (str) – The name of the link.
access_key_id (str) – The AWS access key ID.
region (str) – The AWS region the data is in.
secret_access_key (str, optional) – The AWS secret access key. The link is not valid without it.
session_token (str, optional) – The AWS session token, for temporary credentials.
service_endpoint (str, optional) – The S3 endpoint, in place of the region’s default.
- dataverse_name() str
Get the name of the dataverse the link is in.
- Returns:
The name of the dataverse the link is in.
- Return type:
- link_type() AnalyticsLinkType
Get the kind of data source the link connects to.
- Returns:
The kind of data source the link connects to.
- Return type:
- validate() None
Check that the link has every setting its kind requires.
- Raises:
InvalidArgumentException – If a required setting is missing.