package protocol.sdk

Get desktop application:
View/edit binary Protocol Buffers messages

If the command specifies a docLocation use the collection within it, otherwise fall back on CollectionLevelCommand.collection.

Used in: CollectionLevelCommand

• oneof command

  • kv.Append append = 1

  • kv.Prepend prepend = 2

  • kv.Increment increment = 3

  • kv.Decrement decrement = 4

Used in: Command

• string bucket_name = 1

• oneof command

  • cluster.wait_until_ready.WaitUntilReadyRequest wait_until_ready = 2

  • bucket.collection_manager.Command collection_manager = 3

Used in: performer.PerformerCapsFetchResponse

• SDK_PRESERVE_EXPIRY = 0

• SDK_KV_RANGE_SCAN = 1

  KV range scan support. See CBD-5161 for requirements.

• SDK_QUERY_INDEX_MANAGEMENT = 2

  Query index management support - All APIs available to the Cluster level QueryIndexManager: cluster.queryIndexes()

• SDK_COLLECTION_QUERY_INDEX_MANAGEMENT = 3

  All APIs available to the Collection level CollectionQueryIndexManager: collection.queryIndexes()

• SDK_SEARCH = 4

  Can execute cluster.search() with all SearchOptions. This is everything under sdk.search.proto, except VectorQuery.

• SDK_VECTOR_SEARCH = 22

  Supports sdk.search.VectorQuery. Support for SDK_SEARCH is a prerequisite.

• SDK_VECTOR_SEARCH_BASE64 = 23

  Support for SDK_VECTOR_SEARCH is a prerequisite.

• SDK_SCOPE_SEARCH = 6

  Can execute scope.search() with all SearchOptions. Support for SDK_SEARCH is a prerequisite.

• SDK_SEARCH_RFC_REVISION_11 = 24

  The SDK implements support for search SDK-RFC 52 revision 11. (Improved FeatureNotAvailable handling against older clusters for scoped and vector indexes)

• SDK_SEARCH_INDEX_MANAGEMENT = 5

  Can execute all APIs under cluster.searchIndexes(), with all options. This is everything under sdk.management.search.proto.

• SDK_SCOPE_SEARCH_INDEX_MANAGEMENT = 7

  Can execute all APIs under scope.searchIndexes(), with all options. This is everything under sdk.management.scope.search.proto.

• WAIT_UNTIL_READY = 8

  The performer supports WaitUntilReady with options, at cluster and bucket level

• PROTOSTELLAR = 9

  The SDK supports couchbase2:// connection strings

• SDK_BUCKET_MANAGEMENT = 10

  The performer supports the BucketManager API. This is everything under sdk.cluster.bucket_manager

• SDK_EVENTING_FUNCTION_MANAGER = 11

  The performer supports the EventingFunctionManager API. This is everything under sdk.cluster.eventing_function_manager

• SDK_QUERY = 12

  The performer supports ClusterLevelCommand.query, ScopeLevelCommand.query, and everything needed by sdk.query.Command it supports sending results back with sdk.query.QueryResult Does not include the use_replica Query option

• SDK_LOOKUP_IN = 13

  Implements base LookupIn functionality from sdk.collection.lookup_in.proto

• SDK_LOOKUP_IN_REPLICAS = 14

  Implements LookupInAllReplicas and LookupInAnyReplica messages from sdk.collection.lookup_in.proto

• SDK_QUERY_READ_FROM_REPLICA = 15

• SDK_KV = 17

  The performer implements everything under sdk.kv.commands and sdk.kv.mutate_in, and is able to support all forms of shared.Content for Get and MutateIn commands The performer cap KV_SUPPORT_1 is a prerequisite

• SDK_OBSERVABILITY_RFC_REV_24 = 16

  Supports Extended SDK Observability SDK-RFC 67 revision 24. E.g. the SDK is sending additional metric tags. Support for performer cap OBSERVABILITY_1 is a pre-requisite.

• SDK_MANAGEMENT_HISTORY_RETENTION = 18

  Implements history retention settings for bucket and collection management.

• SDK_COLLECTION_MANAGEMENT = 19

  The performer supports the CollectionManager API. This is everything under sdk.bucket.collection_manager

• SDK_DOCUMENT_NOT_LOCKED = 20

  SDK can report the SDK_DOCUMENT_NOT_LOCKED_EXCEPTION error. The SDK_KV cap is a pre-requisite.

• SDK_CIRCUIT_BREAKERS = 21

• SDK_INDEX_MANAGEMENT_RFC_REVISION_25 = 25

  The SDK implements support for index management SDK-RFC 54 revision 25. (Improved FeatureNotAvailable handling against older clusters for scoped and vector indexes)

• SDK_COUCHBASE2_OBSERVABILITY = 26

  The SDK implements support for observability with couchbase2, as specified in SDK-RFC 77.

• SDK_ZONE_AWARE_READ_FROM_REPLICA = 27

  The SDK implements support for Zone aware read from replica in Lookupin and Get operations The options requiring support are SELECTED_SERVER_GROUP Add SDK_ZONE_AWARE_READ_FROM_REPLICA_SELECTED_SERVER_GROUP_OR_ALL_AVAILABLE if your performer also supports the optional SELECTED_SERVER_GROUP_OR_ALL_AVAILABLE mode.

• SDK_ZONE_AWARE_READ_FROM_REPLICA_SELECTED_SERVER_GROUP_OR_ALL_AVAILABLE = 29

• SDK_OBSERVABILITY_CLUSTER_LABELS = 28

  The SDK will send cluster name and uuid labels in spans and metrics. OBSERVABILITY_1 is a prerequisite. (But not SDK_OBSERVABILITY_RFC_REV_24)

• SDK_APP_TELEMETRY = 30

  The SDK implements support for the Application Telemetry feature, as detailed in SDK-RFC 84.

• SDK_BUCKET_SETTINGS_NUM_VBUCKETS = 31

  The SDK implements the num_vbuckets attribute of BucketSettings

• SDK_PREFILTER_VECTOR_SEARCH = 32

  The SDK implements support for Vector Search prefiltering.

• SDK_QUERY_BOTH_POSITIONAL_AND_NAMED_PARAMETERS = 33

  The SDK supports setting both positional and named parameters for query and analytics_query. * SDK3 Query RFC Revision #9 * SDK3 Analytics RFC Revision #3

• SUPPORTS_AUTHENTICATOR = 34

  The SDK supports the Authenticator type.

• SDK_SET_AUTHENTICATOR = 35

  The SDK supports setting a new Authenticator.

• SDK_JWT = 36

  The SDK supports JwtAuthenticator.

• SDK_STABLE_OTEL_SEMANTIC_CONVENTIONS = 37

  The SDK supports the stable OpenTelemetry semantic conventions (ExtendedObservability RFC Rev 26)

• SDK_STABLE_OTEL_SEMANTIC_CONVENTIONS_EMITTED_BY_DEFAULT = 38

  The SDK emits the stable OpenTelemetry semantic conventions by default. SDK_STABLE_OTEL_SEMANTIC_CONVENTIONS is a pre-requisite. This should only be declared by SDKs that do not support the legacy semantic conventions (C++ & wrappers, Rust).

• SDK_GET_OR_NULL = 39

  The SDK supports the collection.getOrNull() API.

• SDK_EVENTING_RESUMING_FUNCTION_STATUS = 40

  The SDK supports the RESUMING status in the result of functions_status() of the eventing management API.

Used in: Command

• oneof command

  • cluster.query.index_manager.Command query_index_manager = 1

    QueryIndexManager: cluster.queryIndexes()

  • search.Search search = 2

    cluster.searchQuery() - original FTS API

  • search.SearchWrapper search_v2 = 8

    cluster.search() - updated FTS API

  • cluster.search.index_manager.Command search_index_manager = 3

    SearchIndexManager: cluster.searchIndexes()

  • cluster.wait_until_ready.WaitUntilReadyRequest wait_until_ready = 4

  • cluster.bucket_manager.Command bucket_manager = 5

  • cluster.eventing_function_manager.Command eventing_function_manager = 6

  • query.Command query = 7

  • shared.Authenticator authenticator = 9

    cluster.authenticator()

If the command specifies a docLocation use the collection within it, otherwise fall back on CollectionLevelCommand.collection.

Used in: Command

• optional shared.Collection collection = 1

  Should be passed in any collection level command that does not have a Location in the message for the command

• oneof command

  • collection.query.index_manager.Command query_index_manager = 16

    CollectionQueryIndexManager: collection.queryIndexes()

  • kv.lookup_in.LookupIn lookup_in = 17

  • kv.lookup_in.LookupInAllReplicas lookup_in_all_replicas = 18

  • kv.mutate_in.MutateIn mutate_in = 20

  • kv.GetAndLock get_and_lock = 21

  • kv.Unlock unlock = 25

  • kv.GetAndTouch get_and_touch = 22

  • kv.Exists exists = 23

  • kv.Touch touch = 24

  • kv.GetAnyReplica get_any_replica = 30

  • kv.GetAllReplicas get_all_replicas = 31

  • kv.lookup_in.LookupInAnyReplica lookup_in_any_replica = 19

  • BinaryCollectionLevelCommand binary = 32

Used in: Workload

• oneof command

  • kv.Insert insert = 1

    KV commands. These would be added to CollectionLevelCommand if added now.

  • kv.Get get = 2

  • kv.GetOrNull getOrNull = 9

  • kv.Remove remove = 3

  • kv.Replace replace = 4

  • kv.Upsert upsert = 5

  • kv.rangescan.Scan range_scan = 7

  • ClusterLevelCommand cluster_command = 17

    With Serverless making it increasingly common that we have similar APIs at Cluster, Scope and/or Collection levels, it's becoming more important to separate them. GRPC added from now on should go into one of these four.

  • BucketLevelCommand bucket_command = 18

  • ScopeLevelCommand scope_command = 19

  • CollectionLevelCommand collection_command = 20

• bool return_result = 6

  Whether the returned CommandResult should contain a full result or just `success`. Used for performance tests when the result doesn't matter so the small cost of creating it can be eliminated. It only affects successful results. Failure should report the full exception, as that continues to be useful in performance tests.

• shared.API api = 8

  The API to use to execute this command.

The result of executing a single sdk.Command.

Used in: run.Result

• oneof result

  • bool success = 1

    If the small overhead of creating a full *Result is not required (e.g. for performance testing), can return this generic success instead. Controlled by SdkCommand.returnResult.

  • shared.Exception exception = 2

    If the operation failed.

  • bool null_result = 21

    If the SDK return null/none/undefined. Nb the SDK should very rarely do this! It is reserved for cases like getOrNull.

  • kv.GetResult get_result = 3

    If the operation succeeded and sdk.Command.returnResult==true, return one of these.

  • kv.MutationResult mutation_result = 4

  • kv.rangescan.ScanResult range_scan_result = 5

  • kv.ExistsResult exists_result = 16

  • kv.CounterResult counter_result = 17

  • kv.GetReplicaResult get_replica_result = 18

  • kv.mutate_in.MutateInResult mutate_in_result = 19

  • query.index_manager.QueryIndexes query_indexes = 6

    List of indexes returned by a GetAllIndexes request

  • search.BlockingSearchResult search_blocking_result = 7

    Search results.

  • search.StreamingSearchResult search_streaming_result = 8

  • search.index_manager.Result search_index_manager_result = 9

  • cluster.bucket_manager.Result bucket_manager_result = 10

    Bucket manager results

  • cluster.eventing_function_manager.Result eventing_function_manager_result = 11

    Eventing function manager results

  • query.QueryResult query_result = 12

    Query results

  • kv.lookup_in.LookupInResult lookup_in_result = 13

    LookupIn results

  • kv.lookup_in.LookupInAllReplicasResult lookup_in_all_replicas_result = 14

  • kv.lookup_in.LookupInReplicaResult lookup_in_any_replica_result = 15

  • bucket.collection_manager.Result collection_manager_result = 20

    Collection manager results

Used in: Command

• optional shared.Scope scope = 1

• oneof command

  • search.SearchWrapper search_v2 = 5

    scope.search() - updated FTS API

  • scope.search.index_manager.Command search_index_manager = 3

    ScopeSearchIndexManager: scope.searchIndexes()

  • query.Command query = 4

  • search.Search search = 2

    scope.searchQuery() - original FTS API Now deprecated as revision 10 of the RFC removes this (it was only implemented by one SDK). The SDK should implement only scope.search(), not scope.searchQuery(). FIT will not use this field.

Used in: run.Workload

• repeated Command command = 1

  The commands to run. The performer should execute these in a loop until `bounds` is completed. If there are multiple commands, each should register as separate command for the purposes of bounding, and each should send back one CommandResult. For example, if the bounds specifies to run 10 commands total, and there are 3 Command specified here, the performer should execute the 3 commands 3 times, and then the first command once more. And 10 sdk.Results will be sent back. If the command fails, the performer should not propagate the failure (but should still send back an sdk.Result).

• optional shared.Bounds bounds = 2

  Controls how the commands should be run. If it's not present, just run the commands through once.