Management options
Buckets
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
- class couchbase.management.options.BucketDescribeOptions(**kwargs: Unpack[BucketDescribeOptionsKwargs])
Available options for a
BucketManager’s bucket describe operation.- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
- class couchbase.management.options.CreateBucketOptions(**kwargs: Unpack[CreateBucketOptionsKwargs])
Available options for a
BucketManager’s create bucket operation.- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
- class couchbase.management.options.DropBucketOptions(**kwargs: Unpack[DropBucketOptionsKwargs])
Available options for a
BucketManager’s drop bucket operation.- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
- class couchbase.management.options.FlushBucketOptions(**kwargs: Unpack[FlushBucketOptionsKwargs])
Available options for a
BucketManager’s flush bucket operation.- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
- class couchbase.management.options.GetAllBucketOptions(**kwargs: Unpack[GetAllBucketOptionsKwargs])
Available options for a
BucketManager’s get all buckets operation.- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
- class couchbase.management.options.GetBucketOptions(**kwargs: Unpack[GetBucketOptionsKwargs])
Available options for a
BucketManager’s get bucket operation.- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
- class couchbase.management.options.UpdateBucketOptions(**kwargs: Unpack[UpdateBucketOptionsKwargs])
Available options for a
BucketManager’s update bucket operation.- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
Scopes and collections
|
Available options for |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for |
- class couchbase.management.options.CreateCollectionOptions(**kwargs: Unpack[CreateCollectionOptionsKwargs])
Available options for
create_collection().- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
- class couchbase.management.options.CreateScopeOptions(**kwargs: Unpack[CreateScopeOptionsKwargs])
Available options for a
CollectionManager’s create scope operation.- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
- class couchbase.management.options.DropCollectionOptions(**kwargs: Unpack[DropCollectionOptionsKwargs])
Available options for a
CollectionManager’s drop collection operation.- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
- class couchbase.management.options.DropScopeOptions(**kwargs: Unpack[DropScopeOptionsKwargs])
Available options for a
CollectionManager’s drop scope operation.- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
- class couchbase.management.options.GetAllScopesOptions(**kwargs: Unpack[GetAllScopesOptionsKwargs])
Available options for a
CollectionManager’s get all scopes operation.- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
- class couchbase.management.options.UpdateCollectionOptions(**kwargs: Unpack[UpdateCollectionOptionsKwargs])
Available options for
update_collection().- Parameters:
parent_span (
RequestSpan, optional) – The parent span for this operation.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.
Query indexes
|
Available options for |
|
Available options for |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
- class couchbase.management.options.BuildDeferredQueryIndexOptions(**kwargs: Unpack[BuildDeferredQueryIndexOptionsKwargs])
Available options for
build_deferred_indexes().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.scope_name (str, optional) –
Specifies the scope of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.collection_name (str, optional) –
Specifies the collection of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.CreatePrimaryQueryIndexOptions(**kwargs: Unpack[CreatePrimaryQueryIndexOptionsKwargs])
Available options for
create_primary_index().- Parameters:
index_name (str, optional) – Specifies the name of the primary index.
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.ignore_if_exists (bool, optional) – Whether or not the call should ignore the index already existing when determining whether the call was successful.
num_replicas (int, optional) – The number of replicas of this index that should be created.
deferred (bool, optional) – Specifies whether this index creation should be deferred until a later point in time when they can be explicitly built together.
condition (str, optional) – Specifies the ‘where’ condition for partial index creation.
scope_name (str, optional) –
Specifies the scope of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.collection_name (str, optional) –
Specifies the collection of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.CreateQueryIndexOptions(**kwargs: Unpack[CreateQueryIndexOptionsKwargs])
Available options for a
QueryIndexManager’s create index operation.- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.ignore_if_exists (bool, optional) – Whether or not the call should ignore the index already existing when determining whether the call was successful.
num_replicas (int, optional) – The number of replicas of this index that should be created.
deferred (bool, optional) – Specifies whether this index creation should be deferred until a later point in time when they can be explicitly built together.
condition (str, optional) – Specifies the ‘where’ condition for partial index creation.
scope_name (str, optional) –
Specifies the scope of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.collection_name (str, optional) –
Specifies the collection of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.DropPrimaryQueryIndexOptions(**kwargs: Unpack[DropPrimaryQueryIndexOptionsKwargs])
Available options for a
QueryIndexManager’s drop primary index operation.- Parameters:
index_name (str, optional) – Specifies the name of the primary index.
ignore_if_not_exists (bool, optional) – Whether or not the call should ignore the index not existing when determining whether the call was successful.
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.scope_name (str, optional) –
Specifies the scope of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.collection_name (str, optional) –
Specifies the collection of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.DropQueryIndexOptions(**kwargs: Unpack[DropQueryIndexOptionsKwargs])
Available options for a
QueryIndexManager’s drop index operation.- Parameters:
ignore_if_not_exists (bool, optional) – Whether or not the call should ignore the index not existing when determining whether the call was successful.
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.scope_name (str, optional) –
Specifies the scope of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.collection_name (str, optional) –
Specifies the collection of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetAllQueryIndexOptions(**kwargs: Unpack[GetAllQueryIndexOptionsKwargs])
Available options for a
QueryIndexManager’s get all indexes operation.- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.scope_name (str, optional) –
Specifies the scope of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.collection_name (str, optional) –
Specifies the collection of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.WatchQueryIndexOptions(**kwargs: Unpack[WatchQueryIndexOptionsKwargs])
Available options for a
QueryIndexManager’s watch indexes operation.- Parameters:
watch_primary (bool, optional) – Specifies whether the primary indexes should be watched as well.
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.scope_name (str, optional) –
Specifies the scope of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.collection_name (str, optional) –
Specifies the collection of the index.
Deprecated since version 4.1.4: Use
CollectionQueryIndexManagerinstead.parent_span (
RequestSpan, optional) – The parent span for this operation.
Search indexes
- class couchbase.management.options.AllowQueryingSearchIndexOptions(**kwargs: Unpack[AllowQueryingSearchIndexOptionsKwargs])
Available options for
allow_querying().The same options apply to
allow_querying().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.AnalyzeDocumentSearchIndexOptions(**kwargs: Unpack[AnalyzeDocumentSearchIndexOptionsKwargs])
Available options for
analyze_document().The same options apply to
analyze_document().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.DisallowQueryingSearchIndexOptions(**kwargs: Unpack[DisallowQueryingSearchIndexOptionsKwargs])
Available options for
disallow_querying().The same options apply to
disallow_querying().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.DropSearchIndexOptions(**kwargs: Unpack[DropSearchIndexOptionsKwargs])
Available options for
drop_index().The same options apply to
drop_index().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.FreezePlanSearchIndexOptions(**kwargs: Unpack[FreezePlanSearchIndexOptionsKwargs])
Available options for
freeze_plan().The same options apply to
freeze_plan().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetAllSearchIndexStatsOptions(**kwargs: Unpack[GetAllSearchIndexStatsOptionsKwargs])
Available options for
get_all_index_stats().The same options apply to
get_all_index_stats().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetAllSearchIndexesOptions(**kwargs: Unpack[GetAllSearchIndexesOptionsKwargs])
Available options for
get_all_indexes().The same options apply to
get_all_indexes().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetSearchIndexOptions(**kwargs: Unpack[GetSearchIndexOptionsKwargs])
Available options for
get_index().The same options apply to
get_index().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetSearchIndexStatsOptions(**kwargs: Unpack[GetSearchIndexStatsOptionsKwargs])
Available options for
get_index_stats().The same options apply to
get_index_stats().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetSearchIndexedDocumentsCountOptions(**kwargs: Unpack[GetSearchIndexedDocumentsCountOptionsKwargs])
Available options for
get_indexed_documents_count().The same options apply to
get_indexed_documents_count().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.PauseIngestSearchIndexOptions(**kwargs: Unpack[PauseIngestSearchIndexOptionsKwargs])
Available options for
pause_ingest().The same options apply to
pause_ingest().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.ResumeIngestSearchIndexOptions(**kwargs: Unpack[ResumeIngestSearchIndexOptionsKwargs])
Available options for
resume_ingest().The same options apply to
resume_ingest().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.UnfreezePlanSearchIndexOptions(**kwargs: Unpack[UnfreezePlanSearchIndexOptionsKwargs])
Available options for
unfreeze_plan().The same options apply to
unfreeze_plan().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.UpsertSearchIndexOptions(**kwargs: Unpack[UpsertSearchIndexOptionsKwargs])
Available options for
upsert_index().The same options apply to
upsert_index().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
Users and groups
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
|
Available options for a |
- class couchbase.management.options.ChangePasswordOptions(**kwargs: Unpack[ChangePasswordOptionsKwargs])
Available options for a
UserManager’s change password operation.- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.DropGroupOptions(**kwargs: Unpack[DropGroupOptionsKwargs])
Available options for a
UserManager’s drop group operation.- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.DropUserOptions(**kwargs: Unpack[DropUserOptionsKwargs])
Available options for a
UserManager’s drop user operation.- Parameters:
domain_name (str |
AuthDomain, optional) – The user’s domain name (eitherlocalorexternal). Defaults tolocal.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetAllGroupsOptions(**kwargs: Unpack[GetAllGroupsOptionsKwargs])
Available options for a
UserManager’s get all groups operation.- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetAllUsersOptions(**kwargs: Unpack[GetAllUsersOptionsKwargs])
Available options for a
UserManager’s get all users operation.- Parameters:
domain_name (str |
AuthDomain, optional) – The user’s domain name (eitherlocalorexternal). Defaults tolocal.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetGroupOptions(**kwargs: Unpack[GetGroupOptionsKwargs])
Available options for a
UserManager’s get group operation.- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetRolesOptions(**kwargs: Unpack[GetRolesOptionsKwargs])
Available options for a
UserManager’s get roles operation.- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetUserOptions(**kwargs: Unpack[GetUserOptionsKwargs])
Available options for a
UserManager’s get user operation.- Parameters:
domain_name (str |
AuthDomain, optional) – The user’s domain name (eitherlocalorexternal). Defaults tolocal.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.UpsertGroupOptions(**kwargs: Unpack[UpsertGroupOptionsKwargs])
Available options for a
UserManager’s upsert group operation.- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.UpsertUserOptions(**kwargs: Unpack[UpsertUserOptionsKwargs])
Available options for a
UserManager’s upsert user operation.- Parameters:
domain_name (str |
AuthDomain, optional) – The user’s domain name (eitherlocalorexternal). Defaults tolocal.timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
Analytics
- class couchbase.management.options.ConnectLinkOptions(**kwargs: Unpack[ConnectLinkOptionsKwargs])
Available options for
connect_link().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.dataverse_name (str, optional) – The name of the dataverse the operation applies to.
link_name (str, optional) – The name of the link.
force (bool, optional) – Whether to connect the link even if the bucket’s UUID has changed, as it does when a bucket is dropped and created again.
parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.CreateAnalyticsIndexOptions(**kwargs: Unpack[CreateAnalyticsIndexOptionsKwargs])
Available options for
create_index().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.ignore_if_exists (bool, optional) – Whether or not the call should ignore the index already existing when determining whether the call was successful.
dataverse_name (str, optional) – The name of the dataverse the operation applies to.
parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.CreateDatasetOptions(**kwargs: Unpack[CreateDatasetOptionsKwargs])
Available options for
create_dataset().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.ignore_if_exists (bool, optional) – Whether or not the call should ignore the index already existing when determining whether the call was successful.
condition (str, optional) – Specifies the ‘where’ condition for partial index creation.
dataverse_name (str, optional) – The name of the dataverse the operation applies to.
parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.CreateDataverseOptions(**kwargs: Unpack[CreateDataverseOptionsKwargs])
Available options for
create_dataverse().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.ignore_if_exists (bool, optional) – Whether or not the call should ignore the index already existing when determining whether the call was successful.
parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.CreateLinkAnalyticsOptions(**kwargs: Unpack[CreateLinkAnalyticsOptionsKwargs])
Available options for
create_link().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.DisconnectLinkOptions(**kwargs: Unpack[DisconnectLinkOptionsKwargs])
Available options for
disconnect_link().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.dataverse_name (str, optional) – The name of the dataverse the operation applies to.
link_name (str, optional) – The name of the link.
parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.DropAnalyticsIndexOptions(**kwargs: Unpack[DropAnalyticsIndexOptionsKwargs])
Available options for
drop_index().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.ignore_if_not_exists (bool, optional) – Whether or not the call should ignore the index not existing when determining whether the call was successful.
dataverse_name (str, optional) – The name of the dataverse the operation applies to.
parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.DropDatasetOptions(**kwargs: Unpack[DropDatasetOptionsKwargs])
Available options for
drop_dataset().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.ignore_if_not_exists (bool, optional) – Whether or not the call should ignore the index not existing when determining whether the call was successful.
dataverse_name (str, optional) – The name of the dataverse the operation applies to.
parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.DropDataverseOptions(**kwargs: Unpack[DropDataverseOptionsKwargs])
Available options for
drop_dataverse().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.ignore_if_not_exists (bool, optional) – Whether or not the call should ignore the index not existing when determining whether the call was successful.
parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.DropLinkAnalyticsOptions(**kwargs: Unpack[DropLinkAnalyticsOptionsKwargs])
Available options for
drop_link().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetAllAnalyticsIndexesOptions(**kwargs: Unpack[GetAllAnalyticsIndexesOptionsKwargs])
Available options for
get_all_indexes().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetAllDatasetOptions(**kwargs: Unpack[GetAllDatasetOptionsKwargs])
Available options for
get_all_datasets().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetLinksAnalyticsOptions(**kwargs: Unpack[GetLinksAnalyticsOptionsKwargs])
Available options for
get_links().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.dataverse_name (str, optional) – The name of the dataverse the operation applies to.
name (str, optional) – Only get the link with this name, which also needs
dataverse_name.link_type (
AnalyticsLinkType, optional) – Only get the links of this type.parent_span (
RequestSpan, optional) – The parent span for this operation.
- property dataverse_name: str
The value of the
dataverse_nameoption, or'Default'if it was not set.
- property link_type: AnalyticsLinkType | None
The value of the
link_typeoption, orNoneif it was not set.
- class couchbase.management.options.GetPendingMutationsOptions(**kwargs: Unpack[GetPendingMutationsOptionsKwargs])
Available options for
get_pending_mutations().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.ReplaceLinkAnalyticsOptions(**kwargs: Unpack[ReplaceLinkAnalyticsOptionsKwargs])
Available options for
replace_link().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
analytics_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
Eventing functions
|
Available options for |
|
Available options for |
|
Available options for a |
|
Available options for |
|
Available options for |
|
Available options for |
|
Available options for |
|
Available options for |
|
Available options for |
|
Available options for |
- class couchbase.management.options.DeployFunctionOptions(**kwargs: Unpack[DeployFunctionOptionsKwargs])
Available options for
deploy_function().The same options apply to
deploy_function().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.DropFunctionOptions(**kwargs: Unpack[DropFunctionOptionsKwargs])
Available options for
drop_function().The same options apply to
drop_function().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.EventingFunctionOptions(**kwargs: Unpack[EventingFunctionOptionsKwargs])
Available options for a
EventingFunctionManageroperation.- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.FunctionsStatusOptions(**kwargs: Unpack[FunctionsStatusOptionsKwargs])
Available options for
functions_status().The same options apply to
functions_status().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetAllFunctionOptions(**kwargs: Unpack[GetAllFunctionOptionsKwargs])
Available options for
get_all_functions().The same options apply to
get_all_functions().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetFunctionOptions(**kwargs: Unpack[GetFunctionOptionsKwargs])
Available options for
get_function().The same options apply to
get_function().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.PauseFunctionOptions(**kwargs: Unpack[PauseFunctionOptionsKwargs])
Available options for
pause_function().The same options apply to
pause_function().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.ResumeFunctionOptions(**kwargs: Unpack[ResumeFunctionOptionsKwargs])
Available options for
resume_function().The same options apply to
resume_function().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.UndeployFunctionOptions(**kwargs: Unpack[UndeployFunctionOptionsKwargs])
Available options for
undeploy_function().The same options apply to
undeploy_function().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.UpsertFunctionOptions(**kwargs: Unpack[UpsertFunctionOptionsKwargs])
Available options for
upsert_function().The same options apply to
upsert_function().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
Views
|
Available options for |
|
Available options for |
|
Available options for |
|
Available options for |
|
Available options for |
- class couchbase.management.options.DropDesignDocumentOptions(**kwargs: Unpack[DropDesignDocumentOptionsKwargs])
Available options for
drop_design_document().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
views_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetAllDesignDocumentsOptions(**kwargs: Unpack[GetAllDesignDocumentsOptionsKwargs])
Available options for
get_all_design_documents().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
management_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.GetDesignDocumentOptions(**kwargs: Unpack[GetDesignDocumentOptionsKwargs])
Available options for
get_design_document().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
views_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.PublishDesignDocumentOptions(**kwargs: Unpack[PublishDesignDocumentOptionsKwargs])
Available options for
publish_design_document().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
views_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.
- class couchbase.management.options.UpsertDesignDocumentOptions(**kwargs: Unpack[UpsertDesignDocumentOptionsKwargs])
Available options for
upsert_design_document().- Parameters:
timeout (timedelta, optional) – The timeout for this operation. Defaults to the cluster’s
views_timeout, fromClusterTimeoutOptions.parent_span (
RequestSpan, optional) – The parent span for this operation.