Couchbase Python Client Library
4.1.1
Using the Couchbase Python SDK
Using the Python SDK
Synchronous API
Analytics
BinaryCollection
Core couchbase API
Datastructures
Diagnostics
Query (SQL++)
Management
Full Text Search
Transactions
Views
Global API
Authentication
Exceptions
Management Options
Options
Results
Subdocument
Asynchronous APIs
acouchbase
txcouchbase
Couchbase Python Client Library
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
ABORTED (couchbase.n1ql.QueryStatus attribute)
acouchbase.binary_collection
module
acouchbase.bucket
module
acouchbase.cluster
module
acouchbase.collection
module
acouchbase.scope
module
add() (couchbase.datastructures.CouchbaseMap method)
(couchbase.datastructures.CouchbaseSet method)
all_ok (couchbase.result.MultiCounterResult property)
(couchbase.result.MultiExistsResult property)
(couchbase.result.MultiGetResult property)
(couchbase.result.MultiMutationResult property)
AmbiguousTimeoutException (class in couchbase.exceptions)
analytics_indexes() (acouchbase.cluster.AsyncCluster method)
(couchbase.cluster.Cluster method)
analytics_query() (acouchbase.cluster.AsyncCluster method)
(acouchbase.scope.AsyncScope method)
(couchbase.cluster.Cluster method)
(couchbase.scope.Scope method)
AnalyticsMetaData (class in couchbase.analytics)
AnalyticsMetrics (class in couchbase.analytics)
AnalyticsResult (class in couchbase.result)
append() (acouchbase.binary_collection.BinaryCollection method)
(couchbase.binary_collection.BinaryCollection method)
(couchbase.datastructures.CouchbaseList method)
append_multi() (couchbase.binary_collection.BinaryCollection method)
AppendOptions (class in couchbase.options)
array_addunique() (in module couchbase.subdocument)
array_append() (in module couchbase.subdocument)
array_insert() (in module couchbase.subdocument)
array_prepend() (in module couchbase.subdocument)
as_json() (couchbase.result.DiagnosticsResult method)
(couchbase.result.PingResult method)
AsyncBucket (class in acouchbase.bucket)
AsyncCluster (class in acouchbase.cluster)
AsyncCollection (class in acouchbase.collection)
AsyncScope (class in acouchbase.scope)
AT_PLUS (couchbase.n1ql.QueryScanConsistency attribute)
(couchbase.search.SearchScanConsistency attribute)
AuthenticationException (class in couchbase.exceptions)
B
binary() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
BinaryCollection (class in acouchbase.binary_collection)
(class in couchbase.binary_collection)
Bucket (class in couchbase.bucket)
(in module acouchbase.bucket)
bucket() (acouchbase.cluster.AsyncCluster method)
(couchbase.cluster.Cluster method)
bucket_name (acouchbase.scope.AsyncScope property)
(couchbase.scope.Scope property)
BucketManager (class in couchbase.management.buckets)
BucketNotFoundException (class in couchbase.exceptions)
buckets() (acouchbase.cluster.AsyncCluster method)
(couchbase.cluster.Cluster method)
build_deferred_indexes() (couchbase.management.queries.QueryIndexManager method)
BuildDeferredQueryIndexOptions (class in couchbase.management.options)
C
cas (couchbase.result.CounterResult property)
(couchbase.result.GetResult property)
(couchbase.result.LookupInResult property)
(couchbase.result.MutateInResult property)
(couchbase.result.MutationResult property)
CertificateAuthenticator (class in couchbase.auth)
clear() (couchbase.datastructures.CouchbaseList method)
(couchbase.datastructures.CouchbaseMap method)
(couchbase.datastructures.CouchbaseQueue method)
(couchbase.datastructures.CouchbaseSet method)
client_context_id() (couchbase.n1ql.QueryMetaData method)
close() (acouchbase.cluster.AsyncCluster method)
(couchbase.cluster.Cluster method)
CLOSED (couchbase.n1ql.QueryStatus attribute)
Cluster (class in couchbase.cluster)
(in module acouchbase.cluster)
cluster_info() (acouchbase.cluster.AsyncCluster method)
(couchbase.cluster.Cluster method)
ClusterInfoResult (class in couchbase.result)
ClusterOptions (class in couchbase.options)
ClusterTimeoutOptions (class in couchbase.options)
ClusterTracingOptions (class in couchbase.options)
Collection (class in couchbase.collection)
(in module acouchbase.collection)
collection() (acouchbase.bucket.AsyncBucket method)
(couchbase.bucket.Bucket method)
CollectionManager (class in couchbase.management.collections)
collections (couchbase.management.collections.ScopeSpec property)
collections() (acouchbase.bucket.AsyncBucket method)
(couchbase.bucket.Bucket method)
CollectionSpec (class in couchbase.management.collections)
COMPLETED (couchbase.n1ql.QueryStatus attribute)
connect() (acouchbase.cluster.AsyncCluster static method)
(couchbase.cluster.Cluster static method)
connected (acouchbase.bucket.AsyncBucket property)
(acouchbase.cluster.AsyncCluster property)
(couchbase.bucket.Bucket property)
(couchbase.cluster.Cluster property)
contains() (couchbase.datastructures.CouchbaseSet method)
content (couchbase.result.CounterResult property)
content_as (couchbase.result.GetResult property)
(couchbase.result.LookupInResult property)
(couchbase.result.MutateInResult property)
couchbase.analytics
module
couchbase.auth
module
couchbase.binary_collection
module
couchbase.bucket
module
couchbase.cluster
module
couchbase.collection
module
couchbase.datastructures
module
couchbase.exceptions
module
couchbase.management.buckets
module
couchbase.management.collections
module
couchbase.management.options
module
couchbase.management.queries
module
couchbase.management.users
module
couchbase.n1ql
module
couchbase.options
module
couchbase.result
module
couchbase.scope
module
couchbase.search
module
couchbase.subdocument
module
couchbase.views
module
couchbase_list() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
couchbase_map() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
couchbase_queue() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
couchbase_set() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
CouchbaseException (class in couchbase.exceptions)
CouchbaseList (class in couchbase.datastructures)
CouchbaseMap (class in couchbase.datastructures)
CouchbaseQueue (class in couchbase.datastructures)
CouchbaseSet (class in couchbase.datastructures)
count() (in module couchbase.subdocument)
counter() (in module couchbase.subdocument)
CounterResult (class in couchbase.result)
create_bucket() (couchbase.management.buckets.BucketManager method)
create_collection() (couchbase.management.collections.CollectionManager method)
create_index() (couchbase.management.queries.QueryIndexManager method)
create_primary_index() (couchbase.management.queries.QueryIndexManager method)
create_scope() (couchbase.management.collections.CollectionManager method)
CreateBucketOptions (class in couchbase.management.options)
CreateCollectionOptions (class in couchbase.management.options)
CreatePrimaryQueryIndexOptions (class in couchbase.management.options)
CreateQueryIndexOptions (class in couchbase.management.options)
CreateScopeOptions (class in couchbase.management.options)
D
decrement() (acouchbase.binary_collection.BinaryCollection method)
(couchbase.binary_collection.BinaryCollection method)
(in module couchbase.subdocument)
decrement_multi() (couchbase.binary_collection.BinaryCollection method)
DecrementOptions (class in couchbase.options)
default_collection() (acouchbase.bucket.AsyncBucket method)
(couchbase.bucket.Bucket method)
diagnostics() (acouchbase.cluster.AsyncCluster method)
(couchbase.cluster.Cluster method)
DiagnosticsOptions (class in couchbase.options)
DiagnosticsResult (class in couchbase.result)
DocumentExistsException (class in couchbase.exceptions)
DocumentLockedException (class in couchbase.exceptions)
DocumentNotFoundException (class in couchbase.exceptions)
drop_bucket() (couchbase.management.buckets.BucketManager method)
drop_collection() (couchbase.management.collections.CollectionManager method)
drop_group() (couchbase.management.users.UserManager method)
drop_index() (couchbase.management.queries.QueryIndexManager method)
drop_primary_index() (couchbase.management.queries.QueryIndexManager method)
drop_scope() (couchbase.management.collections.CollectionManager method)
drop_user() (couchbase.management.users.UserManager method)
DropBucketOptions (class in couchbase.management.options)
DropCollectionOptions (class in couchbase.management.options)
DropGroupOptions (class in couchbase.management.options)
DropPrimaryQueryIndexOptions (class in couchbase.management.options)
DropQueryIndexOptions (class in couchbase.management.options)
DropScopeOptions (class in couchbase.management.options)
DropUserOptions (class in couchbase.management.options)
DurabilityImpossibleException (class in couchbase.exceptions)
DurabilityInvalidLevelException (class in couchbase.exceptions)
DurabilitySyncWriteAmbiguousException (class in couchbase.exceptions)
DurabilitySyncWriteInProgressException (class in couchbase.exceptions)
E
elapsed_time() (couchbase.n1ql.QueryMetrics method)
endpoints (couchbase.result.DiagnosticsResult property)
(couchbase.result.PingResult property)
error_count() (couchbase.n1ql.QueryMetrics method)
ERRORS (couchbase.n1ql.QueryStatus attribute)
errors() (couchbase.n1ql.QueryMetaData method)
eventing_functions() (acouchbase.cluster.AsyncCluster method)
(couchbase.cluster.Cluster method)
exceptions (couchbase.result.MultiCounterResult property)
(couchbase.result.MultiExistsResult property)
(couchbase.result.MultiGetResult property)
(couchbase.result.MultiMutationResult property)
execution_time() (couchbase.n1ql.QueryMetrics method)
exists (couchbase.result.ExistsResult property)
exists() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
(couchbase.datastructures.CouchbaseMap method)
(in module couchbase.subdocument)
exists_multi() (couchbase.collection.Collection method)
ExistsMultiOptions (class in couchbase.options)
ExistsOptions (class in couchbase.options)
ExistsResult (class in couchbase.result)
expiry_time (couchbase.result.GetResult property)
F
FATAL (couchbase.n1ql.QueryStatus attribute)
flush_bucket() (couchbase.management.buckets.BucketManager method)
FlushBucketOptions (class in couchbase.management.options)
G
get() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
(couchbase.datastructures.CouchbaseMap method)
(in module couchbase.subdocument)
get_all() (couchbase.datastructures.CouchbaseList method)
(couchbase.datastructures.CouchbaseMap method)
get_all_buckets() (couchbase.management.buckets.BucketManager method)
get_all_groups() (couchbase.management.users.UserManager method)
get_all_indexes() (couchbase.management.queries.QueryIndexManager method)
get_all_scopes() (couchbase.management.collections.CollectionManager method)
get_all_users() (couchbase.management.users.UserManager method)
get_and_lock() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
get_and_touch() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
get_at() (couchbase.datastructures.CouchbaseList method)
get_bucket() (couchbase.management.buckets.BucketManager method)
get_group() (couchbase.management.users.UserManager method)
get_multi() (couchbase.collection.Collection method)
get_roles() (couchbase.management.users.UserManager method)
get_user() (couchbase.management.users.UserManager method)
GetAllBucketOptions (class in couchbase.management.options)
GetAllGroupsOptions (class in couchbase.management.options)
GetAllQueryIndexOptions (class in couchbase.management.options)
GetAllScopesOptions (class in couchbase.management.options)
GetAllUsersOptions (class in couchbase.management.options)
GetAndLockOptions (class in couchbase.options)
GetAndTouchOptions (class in couchbase.options)
GetBucketOptions (class in couchbase.management.options)
GetGroupOptions (class in couchbase.management.options)
GetMultiOptions (class in couchbase.options)
GetOptions (class in couchbase.options)
GetResult (class in couchbase.result)
GetRolesOptions (class in couchbase.management.options)
GetUserOptions (class in couchbase.management.options)
I
id (couchbase.result.DiagnosticsResult property)
(couchbase.result.PingResult property)
increment() (acouchbase.binary_collection.BinaryCollection method)
(couchbase.binary_collection.BinaryCollection method)
(in module couchbase.subdocument)
increment_multi() (couchbase.binary_collection.BinaryCollection method)
IncrementOptions (class in couchbase.options)
index_of() (couchbase.datastructures.CouchbaseList method)
INSERT (couchbase.subdocument.StoreSemantics attribute)
insert() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
insert_multi() (couchbase.collection.Collection method)
InsertMultiOptions (class in couchbase.options)
InsertOptions (class in couchbase.options)
InternalServerFailureException (class in couchbase.exceptions)
InvalidArgumentException (class in couchbase.exceptions)
InvalidValueException (class in couchbase.exceptions)
is_community (couchbase.result.ClusterInfoResult property)
is_enterprise (couchbase.result.ClusterInfoResult property)
items() (couchbase.datastructures.CouchbaseMap method)
K
key (couchbase.result.CounterResult property)
(couchbase.result.GetResult property)
keys() (couchbase.datastructures.CouchbaseMap method)
L
list_append() (couchbase.collection.Collection method)
list_get() (couchbase.collection.Collection method)
list_prepend() (couchbase.collection.Collection method)
list_remove() (couchbase.collection.Collection method)
list_set() (couchbase.collection.Collection method)
list_size() (couchbase.collection.Collection method)
lock_multi() (couchbase.collection.Collection method)
LockMultiOptions (class in couchbase.options)
lookup_in() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
LookupInOptions (class in couchbase.options)
LookupInResult (class in couchbase.result)
M
map_add() (couchbase.collection.Collection method)
map_get() (couchbase.collection.Collection method)
map_remove() (couchbase.collection.Collection method)
map_size() (couchbase.collection.Collection method)
max_ttl (couchbase.management.collections.CollectionSpec property)
metadata() (couchbase.result.AnalyticsResult method)
(couchbase.result.QueryResult method)
(couchbase.result.SearchResult method)
(couchbase.result.ViewResult method)
metrics() (couchbase.n1ql.QueryMetaData method)
module
acouchbase.binary_collection
acouchbase.bucket
acouchbase.cluster
acouchbase.collection
acouchbase.scope
couchbase.analytics
couchbase.auth
couchbase.binary_collection
couchbase.bucket
couchbase.cluster
couchbase.collection
couchbase.datastructures
couchbase.exceptions
couchbase.management.buckets
couchbase.management.collections
couchbase.management.options
couchbase.management.queries
couchbase.management.users
couchbase.n1ql
couchbase.options
couchbase.result
couchbase.scope
couchbase.search
couchbase.subdocument
couchbase.views
MultiCounterResult (class in couchbase.result)
MultiExistsResult (class in couchbase.result)
MultiGetResult (class in couchbase.result)
MultiMutationResult (class in couchbase.result)
mutate_in() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
MutateInOptions (class in couchbase.options)
MutateInResult (class in couchbase.result)
mutation_count() (couchbase.n1ql.QueryMetrics method)
mutation_token() (couchbase.result.MutationResult method)
MutationResult (class in couchbase.result)
N
name (acouchbase.bucket.AsyncBucket property)
(acouchbase.collection.AsyncCollection property)
(acouchbase.scope.AsyncScope property)
(couchbase.bucket.Bucket property)
(couchbase.collection.Collection property)
(couchbase.management.collections.CollectionSpec property)
(couchbase.management.collections.ScopeSpec property)
(couchbase.scope.Scope property)
NOT_BOUNDED (couchbase.analytics.AnalyticsScanConsistency attribute)
(couchbase.n1ql.QueryScanConsistency attribute)
(couchbase.search.SearchScanConsistency attribute)
(couchbase.views.ViewScanConsistency attribute)
O
OFF (couchbase.n1ql.QueryProfile attribute)
on_connect() (acouchbase.cluster.AsyncCluster method)
P
PasswordAuthenticator (class in couchbase.auth)
PathExistsException (class in couchbase.exceptions)
PathMismatchException (class in couchbase.exceptions)
PathNotFoundException (class in couchbase.exceptions)
PHASES (couchbase.n1ql.QueryProfile attribute)
ping() (acouchbase.bucket.AsyncBucket method)
(acouchbase.cluster.AsyncCluster method)
(couchbase.bucket.Bucket method)
(couchbase.cluster.Cluster method)
PingOptions (class in couchbase.options)
PingResult (class in couchbase.result)
pop() (couchbase.datastructures.CouchbaseQueue method)
prepend() (acouchbase.binary_collection.BinaryCollection method)
(couchbase.binary_collection.BinaryCollection method)
(couchbase.datastructures.CouchbaseList method)
prepend_multi() (couchbase.binary_collection.BinaryCollection method)
PrependOptions (class in couchbase.options)
profile() (couchbase.n1ql.QueryMetaData method)
push() (couchbase.datastructures.CouchbaseQueue method)
Q
query() (acouchbase.cluster.AsyncCluster method)
(acouchbase.scope.AsyncScope method)
(couchbase.cluster.Cluster method)
(couchbase.scope.Scope method)
query_indexes() (acouchbase.cluster.AsyncCluster method)
(couchbase.cluster.Cluster method)
QueryIndexManager (class in couchbase.management.queries)
QueryMetaData (class in couchbase.n1ql)
QueryMetrics (class in couchbase.n1ql)
QueryOptions (class in couchbase.options)
QueryResult (class in couchbase.result)
queue_pop() (couchbase.collection.Collection method)
queue_push() (couchbase.collection.Collection method)
queue_size() (couchbase.collection.Collection method)
R
remove() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
(couchbase.datastructures.CouchbaseMap method)
(couchbase.datastructures.CouchbaseSet method)
(in module couchbase.subdocument)
remove_at() (couchbase.datastructures.CouchbaseList method)
remove_multi() (couchbase.collection.Collection method)
RemoveMultiOptions (class in couchbase.options)
RemoveOptions (class in couchbase.options)
REPLACE (couchbase.subdocument.StoreSemantics attribute)
replace() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
(in module couchbase.subdocument)
replace_multi() (couchbase.collection.Collection method)
ReplaceMultiOptions (class in couchbase.options)
ReplaceOptions (class in couchbase.options)
request_id() (couchbase.n1ql.QueryMetaData method)
REQUEST_PLUS (couchbase.analytics.AnalyticsScanConsistency attribute)
(couchbase.n1ql.QueryScanConsistency attribute)
(couchbase.search.SearchScanConsistency attribute)
(couchbase.views.ViewScanConsistency attribute)
result_count() (couchbase.n1ql.QueryMetrics method)
result_size() (couchbase.n1ql.QueryMetrics method)
results (couchbase.result.MultiCounterResult property)
(couchbase.result.MultiExistsResult property)
(couchbase.result.MultiGetResult property)
(couchbase.result.MultiMutationResult property)
rows() (couchbase.result.AnalyticsResult method)
(couchbase.result.QueryResult method)
(couchbase.result.SearchResult method)
(couchbase.result.ViewResult method)
RUNNING (couchbase.n1ql.QueryStatus attribute)
S
Scope (class in couchbase.scope)
(in module acouchbase.scope)
scope() (acouchbase.bucket.AsyncBucket method)
(couchbase.bucket.Bucket method)
scope_name (couchbase.management.collections.CollectionSpec property)
ScopeSpec (class in couchbase.management.collections)
sdk (couchbase.result.DiagnosticsResult property)
(couchbase.result.PingResult property)
search_indexes() (acouchbase.cluster.AsyncCluster method)
(couchbase.cluster.Cluster method)
search_query() (acouchbase.cluster.AsyncCluster method)
(acouchbase.scope.AsyncScope method)
(couchbase.cluster.Cluster method)
(couchbase.scope.Scope method)
SearchMetaData (class in couchbase.search)
SearchMetrics (class in couchbase.search)
SearchResult (class in couchbase.result)
server_version (couchbase.result.ClusterInfoResult property)
server_version_full (couchbase.result.ClusterInfoResult property)
server_version_short (couchbase.result.ClusterInfoResult property)
set_add() (couchbase.collection.Collection method)
set_at() (couchbase.datastructures.CouchbaseList method)
set_contains() (couchbase.collection.Collection method)
set_remove() (couchbase.collection.Collection method)
set_size() (couchbase.collection.Collection method)
signature() (couchbase.n1ql.QueryMetaData method)
size() (couchbase.datastructures.CouchbaseList method)
(couchbase.datastructures.CouchbaseMap method)
(couchbase.datastructures.CouchbaseQueue method)
(couchbase.datastructures.CouchbaseSet method)
sort_count() (couchbase.n1ql.QueryMetrics method)
state (couchbase.result.DiagnosticsResult property)
status() (couchbase.n1ql.QueryMetaData method)
STOPPED (couchbase.n1ql.QueryStatus attribute)
SubdocCantInsertValueException (in module couchbase.exceptions)
SubdocPathMismatchException (in module couchbase.exceptions)
SUCCESS (couchbase.n1ql.QueryStatus attribute)
T
TIMEOUT (couchbase.n1ql.QueryStatus attribute)
TIMINGS (couchbase.n1ql.QueryProfile attribute)
touch() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
touch_multi() (couchbase.collection.Collection method)
TouchMultiOptions (class in couchbase.options)
TouchOptions (class in couchbase.options)
transactions (acouchbase.cluster.AsyncCluster property)
(couchbase.cluster.Cluster property)
U
UnAmbiguousTimeoutException (class in couchbase.exceptions)
UNKNOWN (couchbase.n1ql.QueryStatus attribute)
unlock() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
unlock_multi() (couchbase.collection.Collection method)
UnlockMultiOptions (class in couchbase.options)
UnlockOptions (class in couchbase.options)
UPDATE_AFTER (couchbase.views.ViewScanConsistency attribute)
update_bucket() (couchbase.management.buckets.BucketManager method)
UpdateBucketOptions (class in couchbase.management.options)
UPSERT (couchbase.subdocument.StoreSemantics attribute)
upsert() (acouchbase.collection.AsyncCollection method)
(couchbase.collection.Collection method)
(in module couchbase.subdocument)
upsert_group() (couchbase.management.users.UserManager method)
upsert_multi() (couchbase.collection.Collection method)
upsert_user() (couchbase.management.users.UserManager method)
UpsertGroupOptions (class in couchbase.management.options)
UpsertMultiOptions (class in couchbase.options)
UpsertOptions (class in couchbase.options)
UpsertUserOptions (class in couchbase.management.options)
UserManager (class in couchbase.management.users)
users() (acouchbase.cluster.AsyncCluster method)
(couchbase.cluster.Cluster method)
V
values() (couchbase.datastructures.CouchbaseMap method)
(couchbase.datastructures.CouchbaseSet method)
version (couchbase.result.DiagnosticsResult property)
(couchbase.result.PingResult property)
view_indexes() (acouchbase.bucket.AsyncBucket method)
(couchbase.bucket.Bucket method)
view_query() (acouchbase.bucket.AsyncBucket method)
(couchbase.bucket.Bucket method)
ViewMetaData (class in couchbase.views)
ViewResult (class in couchbase.result)
W
wait_until_ready() (acouchbase.cluster.AsyncCluster method)
(couchbase.cluster.Cluster method)
WaitUntilReadyOptions (class in couchbase.options)
warning_count() (couchbase.n1ql.QueryMetrics method)
warnings() (couchbase.n1ql.QueryMetaData method)
watch_indexes() (couchbase.management.queries.QueryIndexManager method)
WatchQueryIndexOptions (class in couchbase.management.options)