.. Generated by tools/docgen from tools/docgen/config/layout.yaml and tools/public_api.yaml. Do not edit; run `python -m tools.docgen generate --write`. Management options ================== .. module:: couchbase.management.options Buckets ------- .. autosummary:: BucketDescribeOptions CreateBucketOptions DropBucketOptions FlushBucketOptions GetAllBucketOptions GetBucketOptions UpdateBucketOptions .. autoclass:: BucketDescribeOptions :members: .. autoclass:: CreateBucketOptions :members: .. autoclass:: DropBucketOptions :members: .. autoclass:: FlushBucketOptions :members: .. autoclass:: GetAllBucketOptions :members: .. autoclass:: GetBucketOptions :members: .. autoclass:: UpdateBucketOptions :members: Scopes and collections ---------------------- .. autosummary:: CreateCollectionOptions CreateScopeOptions DropCollectionOptions DropScopeOptions GetAllScopesOptions UpdateCollectionOptions .. autoclass:: CreateCollectionOptions :members: .. autoclass:: CreateScopeOptions :members: .. autoclass:: DropCollectionOptions :members: .. autoclass:: DropScopeOptions :members: .. autoclass:: GetAllScopesOptions :members: .. autoclass:: UpdateCollectionOptions :members: Query indexes ------------- .. autosummary:: BuildDeferredQueryIndexOptions CreatePrimaryQueryIndexOptions CreateQueryIndexOptions DropPrimaryQueryIndexOptions DropQueryIndexOptions GetAllQueryIndexOptions WatchQueryIndexOptions .. autoclass:: BuildDeferredQueryIndexOptions :members: .. autoclass:: CreatePrimaryQueryIndexOptions :members: .. autoclass:: CreateQueryIndexOptions :members: .. autoclass:: DropPrimaryQueryIndexOptions :members: .. autoclass:: DropQueryIndexOptions :members: .. autoclass:: GetAllQueryIndexOptions :members: .. autoclass:: WatchQueryIndexOptions :members: Search indexes -------------- .. autosummary:: AllowQueryingSearchIndexOptions AnalyzeDocumentSearchIndexOptions DisallowQueryingSearchIndexOptions DropSearchIndexOptions FreezePlanSearchIndexOptions GetAllSearchIndexStatsOptions GetAllSearchIndexesOptions GetSearchIndexOptions GetSearchIndexStatsOptions GetSearchIndexedDocumentsCountOptions PauseIngestSearchIndexOptions ResumeIngestSearchIndexOptions UnfreezePlanSearchIndexOptions UpsertSearchIndexOptions .. autoclass:: AllowQueryingSearchIndexOptions :members: .. autoclass:: AnalyzeDocumentSearchIndexOptions :members: .. autoclass:: DisallowQueryingSearchIndexOptions :members: .. autoclass:: DropSearchIndexOptions :members: .. autoclass:: FreezePlanSearchIndexOptions :members: .. autoclass:: GetAllSearchIndexStatsOptions :members: .. autoclass:: GetAllSearchIndexesOptions :members: .. autoclass:: GetSearchIndexOptions :members: .. autoclass:: GetSearchIndexStatsOptions :members: .. autoclass:: GetSearchIndexedDocumentsCountOptions :members: .. autoclass:: PauseIngestSearchIndexOptions :members: .. autoclass:: ResumeIngestSearchIndexOptions :members: .. autoclass:: UnfreezePlanSearchIndexOptions :members: .. autoclass:: UpsertSearchIndexOptions :members: Users and groups ---------------- .. autosummary:: ChangePasswordOptions DropGroupOptions DropUserOptions GetAllGroupsOptions GetAllUsersOptions GetGroupOptions GetRolesOptions GetUserOptions UpsertGroupOptions UpsertUserOptions .. autoclass:: ChangePasswordOptions :members: .. autoclass:: DropGroupOptions :members: .. autoclass:: DropUserOptions :members: .. autoclass:: GetAllGroupsOptions :members: .. autoclass:: GetAllUsersOptions :members: .. autoclass:: GetGroupOptions :members: .. autoclass:: GetRolesOptions :members: .. autoclass:: GetUserOptions :members: .. autoclass:: UpsertGroupOptions :members: .. autoclass:: UpsertUserOptions :members: Analytics --------- .. autosummary:: ConnectLinkOptions CreateAnalyticsIndexOptions CreateDatasetOptions CreateDataverseOptions CreateLinkAnalyticsOptions DisconnectLinkOptions DropAnalyticsIndexOptions DropDatasetOptions DropDataverseOptions DropLinkAnalyticsOptions GetAllAnalyticsIndexesOptions GetAllDatasetOptions GetLinksAnalyticsOptions GetPendingMutationsOptions ReplaceLinkAnalyticsOptions .. autoclass:: ConnectLinkOptions :members: .. autoclass:: CreateAnalyticsIndexOptions :members: .. autoclass:: CreateDatasetOptions :members: .. autoclass:: CreateDataverseOptions :members: .. autoclass:: CreateLinkAnalyticsOptions :members: .. autoclass:: DisconnectLinkOptions :members: .. autoclass:: DropAnalyticsIndexOptions :members: .. autoclass:: DropDatasetOptions :members: .. autoclass:: DropDataverseOptions :members: .. autoclass:: DropLinkAnalyticsOptions :members: .. autoclass:: GetAllAnalyticsIndexesOptions :members: .. autoclass:: GetAllDatasetOptions :members: .. autoclass:: GetLinksAnalyticsOptions :members: .. autoclass:: GetPendingMutationsOptions :members: .. autoclass:: ReplaceLinkAnalyticsOptions :members: Eventing functions ------------------ .. autosummary:: DeployFunctionOptions DropFunctionOptions EventingFunctionOptions FunctionsStatusOptions GetAllFunctionOptions GetFunctionOptions PauseFunctionOptions ResumeFunctionOptions UndeployFunctionOptions UpsertFunctionOptions .. autoclass:: DeployFunctionOptions :members: .. autoclass:: DropFunctionOptions :members: .. autoclass:: EventingFunctionOptions :members: .. autoclass:: FunctionsStatusOptions :members: .. autoclass:: GetAllFunctionOptions :members: .. autoclass:: GetFunctionOptions :members: .. autoclass:: PauseFunctionOptions :members: .. autoclass:: ResumeFunctionOptions :members: .. autoclass:: UndeployFunctionOptions :members: .. autoclass:: UpsertFunctionOptions :members: Views ----- .. autosummary:: DropDesignDocumentOptions GetAllDesignDocumentsOptions GetDesignDocumentOptions PublishDesignDocumentOptions UpsertDesignDocumentOptions .. autoclass:: DropDesignDocumentOptions :members: .. autoclass:: GetAllDesignDocumentsOptions :members: .. autoclass:: GetDesignDocumentOptions :members: .. autoclass:: PublishDesignDocumentOptions :members: .. autoclass:: UpsertDesignDocumentOptions :members: