.. 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`. Options ======= .. module:: couchbase.options Cluster configuration --------------------- .. autosummary:: CONFIG_PROFILES ClusterMetricsOptions ClusterOptions ClusterOrphanReportingOptions ClusterTimeoutOptions ClusterTracingOptions Compression ConfigProfile ConfigProfiles IpProtocol KnownConfigProfiles LockMode OptionValidationMode TLSVerifyMode WanDevelopmentProfile .. autodata:: CONFIG_PROFILES .. autoclass:: ClusterMetricsOptions :members: .. autoclass:: ClusterOptions :members: .. autoclass:: ClusterOrphanReportingOptions :members: .. autoclass:: ClusterTimeoutOptions :members: .. autoclass:: ClusterTracingOptions :members: .. autoclass:: Compression :members: :undoc-members: .. autoclass:: ConfigProfile :members: .. autoclass:: ConfigProfiles :members: .. autoclass:: IpProtocol :members: :undoc-members: .. autoclass:: KnownConfigProfiles :members: :undoc-members: .. autoclass:: LockMode :members: :undoc-members: .. autoclass:: OptionValidationMode :members: :undoc-members: .. autoclass:: TLSVerifyMode :members: :undoc-members: .. autoclass:: WanDevelopmentProfile :members: Key-value --------- .. autosummary:: ExistsOptions GetAllReplicasOptions GetAndLockOptions GetAndTouchOptions GetAnyReplicaOptions GetOptions GetReplicaOptions InsertOptions MutationOptions RemoveOptions ReplaceOptions ScanOptions TouchOptions UnlockOptions UpsertOptions .. autoclass:: ExistsOptions :members: .. autoclass:: GetAllReplicasOptions :members: .. autoclass:: GetAndLockOptions :members: .. autoclass:: GetAndTouchOptions :members: .. autoclass:: GetAnyReplicaOptions :members: .. autoclass:: GetOptions :members: .. autoclass:: GetReplicaOptions :members: .. autoclass:: InsertOptions :members: .. autodata:: MutationOptions .. autoclass:: RemoveOptions :members: .. autoclass:: ReplaceOptions :members: .. autoclass:: ScanOptions :members: .. autoclass:: TouchOptions :members: .. autoclass:: UnlockOptions :members: .. autoclass:: UpsertOptions :members: Binary ------ .. autosummary:: AppendOptions DecrementOptions DeltaValue IncrementOptions PrependOptions .. autoclass:: AppendOptions :members: .. autoclass:: DecrementOptions :members: .. autoclass:: DeltaValue :members: .. autoclass:: IncrementOptions :members: .. autoclass:: PrependOptions :members: Multi-document key-value ------------------------ .. autosummary:: AppendMultiOptions DecrementMultiOptions ExistsMultiOptions GetAllReplicasMultiOptions GetAndLockMultiOptions GetAnyReplicaMultiOptions GetMultiOptions IncrementMultiOptions InsertMultiOptions LockMultiOptions MutationMultiOptions NoValueMultiOptions PrependMultiOptions RemoveMultiOptions ReplaceMultiOptions TouchMultiOptions UnlockMultiOptions UpsertMultiOptions .. autoclass:: AppendMultiOptions :members: .. autoclass:: DecrementMultiOptions :members: .. autoclass:: ExistsMultiOptions :members: .. autoclass:: GetAllReplicasMultiOptions :members: .. autoclass:: GetAndLockMultiOptions :members: .. autoclass:: GetAnyReplicaMultiOptions :members: .. autoclass:: GetMultiOptions :members: .. autoclass:: IncrementMultiOptions :members: .. autoclass:: InsertMultiOptions :members: .. autoclass:: LockMultiOptions :members: .. autodata:: MutationMultiOptions .. autodata:: NoValueMultiOptions .. autoclass:: PrependMultiOptions :members: .. autoclass:: RemoveMultiOptions :members: .. autoclass:: ReplaceMultiOptions :members: .. autoclass:: TouchMultiOptions :members: .. autoclass:: UnlockMultiOptions :members: .. autoclass:: UpsertMultiOptions :members: Sub-document ------------ .. autosummary:: LookupInAllReplicasOptions LookupInAnyReplicaOptions LookupInOptions MutateInOptions .. autoclass:: LookupInAllReplicasOptions :members: .. autoclass:: LookupInAnyReplicaOptions :members: .. autoclass:: LookupInOptions :members: .. autoclass:: MutateInOptions :members: Query, analytics, search and views ---------------------------------- .. autosummary:: AnalyticsOptions QueryOptions SearchOptions VectorSearchOptions ViewOptions .. autoclass:: AnalyticsOptions :members: .. autoclass:: QueryOptions :members: .. autoclass:: SearchOptions :members: .. autoclass:: VectorSearchOptions :members: .. autoclass:: ViewOptions :members: Transactions ------------ .. autosummary:: TransactionConfig TransactionGetMultiOptions TransactionGetMultiReplicasFromPreferredServerGroupOptions TransactionGetOptions TransactionGetReplicaFromPreferredServerGroupOptions TransactionInsertOptions TransactionOptions TransactionQueryOptions TransactionReplaceOptions .. autoclass:: TransactionConfig :members: .. autoclass:: TransactionGetMultiOptions :members: .. autoclass:: TransactionGetMultiReplicasFromPreferredServerGroupOptions :members: .. autoclass:: TransactionGetOptions :members: .. autoclass:: TransactionGetReplicaFromPreferredServerGroupOptions :members: .. autoclass:: TransactionInsertOptions :members: .. autoclass:: TransactionOptions :members: .. autoclass:: TransactionQueryOptions :members: .. autoclass:: TransactionReplaceOptions :members: Diagnostics ----------- .. autosummary:: DiagnosticsOptions PingOptions WaitUntilReadyOptions .. autoclass:: DiagnosticsOptions :members: .. autoclass:: PingOptions :members: .. autoclass:: WaitUntilReadyOptions :members: Value types ----------- .. autosummary:: AcceptableInts ConstrainedInt SignedInt64 UnsignedInt32 UnsignedInt64 .. autodata:: AcceptableInts .. autoclass:: ConstrainedInt :members: .. autoclass:: SignedInt64 :members: .. autoclass:: UnsignedInt32 :members: .. autoclass:: UnsignedInt64 :members: