Management Options

Note

Further updates to the management options docs will come with future 4.0.x releases.

Bucket Management 

CreateBucketOptions 

class couchbase.management.options.CreateBucketOptions(parent_span: RequestSpan | None = None, timeout: timedelta | None = None)

Available options for a BucketManager’s create bucket operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestTracer, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

DropBucketOptions 

class couchbase.management.options.DropBucketOptions(parent_span: RequestSpan | None = None, timeout: timedelta | None = None)

Available options to for a BucketManager’s update bucket operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestTracer, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

FlushBucketOptions 

class couchbase.management.options.FlushBucketOptions(parent_span: RequestSpan | None = None, timeout: timedelta | None = None)

Available options to for a BucketManager’s flush bucket operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestTracer, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetAllBucketOptions 

class couchbase.management.options.GetAllBucketOptions(parent_span: RequestSpan | None = None, timeout: timedelta | None = None)

Available options for a BucketManager’s get all buckets operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestTracer, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetBucketOptions 

class couchbase.management.options.GetBucketOptions(parent_span: RequestSpan | None = None, timeout: timedelta | None = None)

Available options to for a BucketManager’s get bucket operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestTracer, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

UpdateBucketOptions 

class couchbase.management.options.UpdateBucketOptions(parent_span: RequestSpan | None = None, timeout: timedelta | None = None)

Available options to for a BucketManager’s update bucket operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestTracer, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

Collection Management 

CreateCollectionOptions 

class couchbase.management.options.CreateCollectionOptions(parent_span: RequestSpan | None = None, timeout: timedelta | None = None)

Available options for a CollectionManager’s create collection operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestTracer, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

CreateScopeOptions 

class couchbase.management.options.CreateScopeOptions(parent_span: RequestSpan | None = None, timeout: timedelta | None = None)

Available options for a CollectionManager’s create scope operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestTracer, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

UpdateCollectionOptions 

class couchbase.management.options.UpdateCollectionOptions(parent_span: RequestSpan | None = None, timeout: timedelta | None = None)

Available options for a CollectionManager’s update collection operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestTracer, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

DropCollectionOptions 

class couchbase.management.options.DropCollectionOptions(parent_span: RequestSpan | None = None, timeout: timedelta | None = None)

Available options for a CollectionManager’s drop collection operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestTracer, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

DropScopeOptions 

class couchbase.management.options.DropScopeOptions(parent_span: RequestSpan | None = None, timeout: timedelta | None = None)

Available options for a CollectionManager’s drop scope operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestTracer, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetAllScopesOptions 

class couchbase.management.options.GetAllScopesOptions(parent_span: RequestSpan | None = None, timeout: timedelta | None = None)

Available options for a CollectionManager’s get all scopes operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestTracer, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

class couchbase.management.options.BuildDeferredQueryIndexOptions(timeout: timedelta | None = None, scope_name: str | None = None, collection_name: str | None = None, parent_span: RequestSpan | None = None)

Available options to for a QueryIndexManager’s build deferred indexes operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

collection_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the collection of the index.
scope_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the scope of the index.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.
parent_span (RequestSpan, optional) – The parent span for this operation.

CreatePrimaryQueryIndexOptions 

Available options to for a QueryIndexManager’s create primary index operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

collection_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the collection of the index.
condition (str, optional) – Specifies the ‘where’ condition for partial index creation.
deferred (bool, optional) – Specifies whether this index creation should be deferred until a later point in time when they can be explicitly built together.
ignore_if_exists (bool, optional) – Whether or not the call should ignore the index already existing when determining whether the call was successful.
index_name (str, optional) – Specifies the name of the primary index.
num_replicas (int, optional) – The number of replicas of this index that should be created.
scope_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the scope of the index.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.
parent_span (RequestTracer, optional) – The parent span for this operation.

CreateQueryIndexOptions 

Available options to for a QueryIndexManager’s create index operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

collection_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the collection of the index.
condition (str, optional) – Specifies the ‘where’ condition for partial index creation.
deferred (bool, optional) – Specifies whether this index creation should be deferred until a later point in time when they can be explicitly built together.
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.
scope_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the scope of the index.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.
parent_span (RequestTracer, optional) – The parent span for this operation.

DropPrimaryQueryIndexOptions 

Available options to for a QueryIndexManager’s drop primary index operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

collection_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the collection of the 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.
index_name (str, optional) – Specifies the name of the primary index.
scope_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the scope of the index.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.
parent_span (RequestTracer, optional) – The parent span for this operation.

DropQueryIndexOptions 

Available options to for a QueryIndexManager’s drop index operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

collection_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the collection of the 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.
scope_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the scope of the index.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.
parent_span (RequestTracer, optional) – The parent span for this operation.

GetAllQueryIndexOptions 

class couchbase.management.options.GetAllQueryIndexOptions(timeout: timedelta | None = None, scope_name: str | None = None, collection_name: str | None = None, parent_span: RequestSpan | None = None)

Available options to for a QueryIndexManager’s get all indexes operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

collection_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the collection of the indexes.
scope_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the scope of the indexes.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.
parent_span (RequestTracer, optional) – The parent span for this operation.

WatchQueryIndexOptions 

Available options to for a QueryIndexManager’s watch indexes operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

collection_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the collection of the index.
scope_name (str, optional) – DEPRECATED - use CollectionQueryIndexManager. Specifies the scope of the index.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.
watch_primary (bool, optional) – Specifies whether the primary indexes should be watched as well.
parent_span (RequestTracer, optional) – The parent span for this operation.

User Management 

DropGroupOptions 

class couchbase.management.options.DropGroupOptions(timeout=None, parent_span=None)

Available options to for a UserManager’s drop group operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

DropUserOptions 

class couchbase.management.options.DropUserOptions(domain_name='local', timeout=None, parent_span=None)

Available options to for a UserManager’s drop user operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

domain_name (str, optional) – The user’s domain name (either local or external). Defaults to local.
parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetAllGroupsOptions 

class couchbase.management.options.GetAllGroupsOptions(timeout=None, parent_span=None)

Available options to for a UserManager’s get all groups operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetAllUsersOptions 

class couchbase.management.options.GetAllUsersOptions(domain_name='local', timeout=None, parent_span=None)

Available options to for a UserManager’s get all users operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

domain_name (str, optional) – The user’s domain name (either local or external). Defaults to local.
parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetGroupOptions 

class couchbase.management.options.GetGroupOptions(timeout=None, parent_span=None)

Available options to for a UserManager’s get group operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetRolesOptions 

class couchbase.management.options.GetRolesOptions(timeout=None, parent_span=None)

Available options to for a UserManager’s get roles operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetUserOptions 

class couchbase.management.options.GetUserOptions(**kwargs)

Available options to for a UserManager’s get user operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

domain_name (str, optional) – The user’s domain name (either local or external). Defaults to local.
parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

UpsertGroupOptions 

class couchbase.management.options.UpsertGroupOptions(timeout=None, parent_span=None)

Available options to for a UserManager’s upsert group operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

UpsertUserOptions 

class couchbase.management.options.UpsertUserOptions(domain_name='local', timeout=None, parent_span=None)

Available options to for a UserManager’s upsert user operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

domain_name (str, optional) – The user’s domain name (either local or external). Defaults to local.
parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

Search Index Management 

UpsertSearchIndexOptions 

class couchbase.management.options.UpsertSearchIndexOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.upsert_index() or a SearchIndexManager.upsert_index() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

DropSearchIndexOptions 

class couchbase.management.options.DropSearchIndexOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.drop_index() or a SearchIndexManager.drop_index() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetSearchIndexOptions 

class couchbase.management.options.GetSearchIndexOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.get_index() or a SearchIndexManager.get_index() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetAllSearchIndexesOptions 

class couchbase.management.options.GetAllSearchIndexesOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.get_all_indexes() or a SearchIndexManager.get_all_indexes() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetSearchIndexedDocumentsCountOptions 

class couchbase.management.options.GetSearchIndexedDocumentsCountOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.get_indexed_documents_count() or a SearchIndexManager.get_indexed_documents_count() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

PauseIngestSearchIndexOptions 

class couchbase.management.options.PauseIngestSearchIndexOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.pause_ingest() or a SearchIndexManager.pause_ingest() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

ResumeIngestSearchIndexOptions 

class couchbase.management.options.ResumeIngestSearchIndexOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.resume_ingest() or a SearchIndexManager.resume_ingest() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

AllowQueryingSearchIndexOptions 

class couchbase.management.options.AllowQueryingSearchIndexOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.allow_querying() or a SearchIndexManager.allow_querying() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

DisallowQueryingSearchIndexOptions 

class couchbase.management.options.DisallowQueryingSearchIndexOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.disallow_querying() or a SearchIndexManager.disallow_querying() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

FreezePlanSearchIndexOptions 

class couchbase.management.options.FreezePlanSearchIndexOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.freeze_plan() or a SearchIndexManager.freeze_plan() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

UnfreezePlanSearchIndexOptions 

class couchbase.management.options.UnfreezePlanSearchIndexOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.unfreeze_plan() or a SearchIndexManager.unfreeze_plan() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

AnalyzeDocumentSearchIndexOptions 

class couchbase.management.options.AnalyzeDocumentSearchIndexOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.analyze_document() or a SearchIndexManager.analyze_document() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetSearchIndexStatsOptions 

class couchbase.management.options.GetSearchIndexStatsOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.get_index_stats() or a SearchIndexManager.get_index_stats() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.

GetAllSearchIndexStatsOptions 

class couchbase.management.options.GetAllSearchIndexStatsOptions(timeout=None, parent_span=None)

Available options for a ScopeSearchIndexManager.get_all_index_stats() or a SearchIndexManager.get_all_index_stats() operation.

Note

All management options should be imported from couchbase.management.options.

Parameters:

parent_span (RequestSpan, optional) – The parent span for this operation.
timeout (timedelta, optional) – The timeout for this operation. Defaults to global management operation timeout.