package protocol.shared

Get desktop application:
View/edit binary Protocol Buffers messages

When an implementation supports multiple APIs, this enum allows sending which is preferred to be used for a given test. This is an abstraction that allows us to test e.g. Java's blocking vs reactive APIs. Declaration in supportedApis: For implementations with just one API: Only declare DEFAULT. For implementations with separate blocking & async APIs: declare both. When the performer receives a preferred API: For implementations with just one API: ignore it. For implementations with separate blocking & async APIs: use the appropriate one.

Used in: performer.PerformerCapsFetchResponse, sdk.Command, transactions.CreateConnectionResponse, transactions.TransactionCreateRequest, transactions.TransactionSingleQueryRequest

• DEFAULT = 0

• ASYNC = 1

Used in: sdk.ClusterLevelCommand, ClusterConnectionCreateRequest

• oneof authenticator

  • Authenticator.PasswordAuthenticator password_auth = 1

  • Authenticator.CertificateAuthenticator certificate_auth = 2

  • Authenticator.JwtAuthenticator jwt_auth = 3

Used in: Authenticator

• string cert = 1

  An X509 certificate in PEM format, e.g. -----BEGIN CERTIFICATE----- MIIDKDCCAhCgAwIBAgIGAYfmPG2mMA0GCSqGSIb3DQEBCwUAMDYxNDAyBgNVBAMT K2FwcHMuY2xvdWQtbmF0aXZlLmZnMWIucDEub3BlbnNoaWZ0YXBwcy5jb20wHhcN ... I+VkRC5NwrqMsnR3149LAVcj6Jen8hMjLM0wR8Frqu2zV9HW5yHMQmOTOKE= -----END CERTIFICATE----- The SDK should apply it in whatever way makes sense for it. Some SDKs (e.g. the C++ wrappers) cannot pass in such a certificate directly to the SDK. In this case they should write it to a temporary file first.

• string key = 2

  An X509 key in PEM format, e.g. -----BEGIN RSA PRIVATE KEY----- MIIJKAIBAAKCAgEAwiYPcb0zL9B5ZCn5mo/sF2QwdNr/aKjdfvnO6hx9h80klu5m ... QZ57rjd7D6hDSzbSxNW54ktF0ZJrBZatfXJize2/WL1SzSAkm7rJovUWXKA= -----END RSA PRIVATE KEY----- The SDK should apply it in whatever way makes sense for it. Some SDKs (e.g. the C++ wrappers) cannot pass in such a certificate directly to the SDK. In this case they should write it to a temporary file first.

Used in: Authenticator

• string jwt = 1

Used in: Authenticator

• string username = 1

• string password = 2

Controls how a given workload is bounded. A simple bounding would be to just run X operations as fast as possible, and then stop. In future we will support more advanced bounds, such as the performer maintaining a target throughput of 100 ops/sec and seeing what the latency is, for 60 seconds.

Used in: meta.Workload, sdk.Workload, transactions.Workload

• oneof bounds

  • Counter counter = 1

    The performer decrements the counter and continues iff counter is now > 0

  • ForTime for_time = 2

  • Counter counter_eq = 3

    The performer should not change the counter, just continue iff its equal to the initial value

Clear all counters for a given performer.

Used as request type in: PerformerService.clearAllCounters

(message has no fields)

Empty but included anyway per GRPC best practices.

Used as response type in: PerformerService.clearAllCounters

(message has no fields)

Used in: ClusterConnectionCreateRequest

• optional TransactionsConfig transactions_config = 1

  Will only be sent to ExtSDKIntegration-enabled performers.

• bool use_custom_serializer = 2

  The performer should use a custom JsonSerializer when creating the Cluster. This custom JsonSerializer is required to have specific serialization and deserialization logic, which the driver will validate. See the Java performer for implementation details.

• bool use_tls = 3

  Used for TLS enabled clusters such as Capella clusters. Note that use_tls should only be used by SDKs that have such a field (e.g. Java). Many SDKs do not have a use_tls equivalent, and TLS is enabled via couchbases:// on the connection string. The driver will use the appropriate option.

• optional string cert_path = 4

  If specified, it's the path to an certificate in PEM format, that the SDK should apply in whatever way makes sense for it. If `cert_path` is specified, `cert` will not be. (They are not `oneof`, for backwards compatibility). Note that now FIT is mainly tested through Docker, `cert_path` is generally not usable since it's non-trivial to pass files between Docker containers. `cert` should generally be used instead.

• optional string cert = 26

  If specified, it's an X509 certificate in PEM format, e.g. -----BEGIN CERTIFICATE----- MIIDKDCCAhCgAwIBAgIGAYfmPG2mMA0GCSqGSIb3DQEBCwUAMDYxNDAyBgNVBAMT K2FwcHMuY2xvdWQtbmF0aXZlLmZnMWIucDEub3BlbnNoaWZ0YXBwcy5jb20wHhcN ... I+VkRC5NwrqMsnR3149LAVcj6Jen8hMjLM0wR8Frqu2zV9HW5yHMQmOTOKE= -----END CERTIFICATE----- The SDK should apply it in whatever way makes sense for it. Some SDKs (e.g. the C++ wrappers) cannot pass in such a certificate directly to the SDK. In this case they should write it to a temporary file first. If `cert_path` is specified, `cert` will not be. (They are not `oneof`, for backwards compatibility). `cert` can be used where it's not easy to pass `cert_path`, such as when the driver and performer are on separate nodes or Docker containers.

• optional bool insecure = 27

  The SDK should skip certificate validation. It's SDK dependent how to implement this. On JVM it may involve applying InsecureTrustManager, while on a C++ wrapper it may require manipulating the connstr to pass "?tls_verify=none". Not every SDK can support this option against every backend. See internal discussion: https://couchbase.slack.com/archives/G9682CWN7/p1698333449931709 Behind cap CLUSTER_CONFIG_INSECURE.

• optional int32 kv_connect_timeout_secs = 5

  Following taken from: https://github.com/couchbaselabs/sdk-rfcs/blob/master/rfc/0059-sdk3-foundation.md#configuration

• optional int32 kv_timeout_millis = 6

• optional int32 kv_durable_timeout_millis = 7

• optional int32 view_timeout_secs = 8

• optional int32 query_timeout_secs = 9

• optional int32 analytics_timeout_secs = 10

• optional int32 search_timeout_secs = 11

• optional int32 management_timeout_secs = 12

• optional Transcoder transcoder = 13

• optional bool enable_mutation_tokens = 14

• optional int32 tcp_keep_alive_time_millis = 15

• optional bool enable_tcp_keep_alives = 16

• optional bool force_i_p_v4 = 17

• optional int32 config_poll_interval_secs = 18

• optional int32 config_poll_floor_interval_secs = 19

• optional int32 config_idle_redial_timeout_secs = 20

• optional int32 num_kv_connections = 21

• optional int32 max_http_connections = 22

• optional int32 idle_http_connection_timeout_secs = 23

• optional observability.Config observability_config = 24

  Whether some sort of observability (e.g. OpenTelemetry) output should be configured. The performer should pass this in to the cluster config's `requestTracer` and/or `meter` settings (depending on whether tracing and/or metrics is enabled). These will generally create OpenTelemetry SDK objects, e.g. SdkTracerProvider and SdkMeterProvider. These must be closed at the same time as this cluster connection is closed. Otherwise the SdkMeterProvider will continue outputting metrics until the application ends.

• optional int32 kv_scan_timeout_secs = 25

• optional sdk.circuit_breaker.Config circuit_breaker_config = 28

• optional string preferred_server_group = 29

• optional string app_telemetry_endpoint = 30

  A Application telemetry endpoint WebSocket URI of the form "ws://<host>:<port>/<path>"

• optional int32 app_telemetry_backoff_secs = 31

• optional bool enable_app_telemetry = 32

• optional int32 app_telemetry_ping_interval_secs = 33

• optional int32 app_telemetry_ping_timeout_secs = 34

Used as request type in: PerformerService.clusterConnectionClose

• string cluster_connection_id = 1

Used as response type in: PerformerService.clusterConnectionClose

• int32 cluster_connection_count = 2

  The number of cluster connections the performer has, after closing this one.

Only sent to ExtSDKIntegration-supporting performers. Creates a cluster connection, with an optional cluster & transactions configuration.

Used as request type in: PerformerService.clusterConnectionCreate

• string cluster_connection_id = 1

  The id to use for this connection.

• string cluster_hostname = 2

  Details of the cluster connection. cluster_hostname is the connection string. As with all fields (see rule 1 in README.md), the performer should pass this directly to the SDK without manipulation. E.g. it should not prepend couchbase:// or similar.

• string cluster_username = 3

  Either these two fields will be set or authenticator will be set, but not both. These will always be set until the performer returns the SupportsAuthenticator capability.

• string cluster_password = 4

• optional ClusterConfig cluster_config = 5

• map<string, string> tunables = 6

  Can apply SDK tunables that can't be represented generically in GRPC. One example is for performance testing, where we may want to experiment with various approaches in say the Java SDK. So one run may send "com.couchbase.executorMaxThreadCount"="10", and the next set it to "20". Interpretation of the tunables, and how to apply them inside the SDK, is completely SDK-dependent. The intent is that the tunables be associated with the cluster connection, but this may not be possible in all implementations - e.g. Java uses global system properties instead. Generally performers can ignore this field unless they are explicitly planning on using it.

• optional Authenticator authenticator = 7

  Either this will be set or username/password will be set, but not both. These will never be set until the performer returns the SupportsAuthenticator capability.

Used as response type in: PerformerService.clusterConnectionCreate

• int32 cluster_connection_count = 1

  The number of cluster connections the performer has, after opening this one.

Used in: sdk.CollectionLevelCommand, sdk.kv.rangescan.Scan, DocLocationPool, DocLocationSpecific, DocLocationUuid, TransactionsCleanupConfig, TransactionsConfig, transactions.CleanupSet, transactions.TransactionOptions, transactions.TransactionsFactoryCreateRequest

• string bucket_name = 1

• string scope_name = 2

• string collection_name = 3

Used in: sdk.kv.Insert, sdk.kv.Replace, sdk.kv.Upsert, sdk.kv.mutate_in.ContentOrMacro, transactions.CommandInsert, transactions.CommandReplace, transactions.Insert, transactions.Replace

• oneof content

  • string passthrough_string = 1

    This should be passed directly into the SDK, as string type - no initial conversion into a JsonObject or similar. How this is treated by the SDK will depend on the transcoder set (if any), which is sent separately in the options. (Usually it will be sent with RawJsonTranscoder).

  • bytes convert_to_json = 2

    The contents of this are JSON. The performer should convert to a platform-dependent representation of JSON, and then pass into the SDK. For Java, that would be the SDK's JsonObject. For Node, the result of JSON.parse(). Whatever is the most appropriate way to take a JSON blob and send it to the SDK without having to provide a transcoder, is the intent here.

  • bytes byte_array = 3

    Treat this content as a byte array and pass it directly through the SDK.

  • bool null = 4

    If this is sent then the performer should pass null/nil/none (depending on language) as the content.

The user is doing someResult.contentAs[Something]() - this allows specifying the Something. The protocol generally then requires that content to be converted into bytes to be streamed back.

Used in: sdk.kv.Get, sdk.kv.GetAllReplicas, sdk.kv.GetAndLock, sdk.kv.GetAndTouch, sdk.kv.GetAnyReplica, sdk.kv.GetOrNull, sdk.kv.lookup_in.LookupInSpec, sdk.kv.mutate_in.MutateInSpec, sdk.kv.rangescan.Scan, sdk.query.Command, sdk.search.Search, sdk.search.SearchWrapper, ContentAsPerformerValidation, transactions.Get

• oneof as

  • bool as_string = 1

    Intended to get the result as a String, then convert it into bytes from UTF-8. Something like this: var result = someResult.contentAs[String]() var returnOverGRPC = result.getBytes(StandardCharsets.UTF_8)

  • bool as_byte_array = 2

    Intended to get the result as a byte array, then convert it into bytes. Something like this: var returnOverGRPC = someResult.contentAs[Array[Byte]]() var returnOverGRPC = someResult.contentAsBytes()

  • bool as_json_object = 3

    JSON handling is very platform-dependent. The intent is to get the result in your platform's most standard/natural representation of JSON Objects, and then convert it into bytes, again using the most standard way of doing that. E.g. this is intended to represent how most users will use the SDK. var result = someResult.contentAs[JsonObject] var returnOverGRPC = result.toBytes()

  • bool as_json_array = 4

    JSON handling is very platform-dependent. The intent is to get the result in your platform's most standard/natural representation of JSON Arrays, and then convert it into bytes, again using the most standard way of doing that. E.g. this is intended to represent how most users will use the SDK. var result = someResult.contentAs[JsonArray] var returnOverGRPC = result.toBytes()

  • bool as_boolean = 5

    This is a way to represent an SDK deserializing content as a Boolean. Results where this is used should include a boolean in the oneof selection for content

  • bool as_integer = 6

    The driver is requesting someResult.contentAs[Integer]. The performer is free to interpret `Integer` in a platform-specific way. Tests will only be expecting values well below the limits of a 32 bit signed integer, and the performer can safely use the platform-specific version of such a type to hold the value: for example, an `int` or `long` are both fine.

  • bool as_floating_point = 7

    The driver is requesting someResult.contentAs[Float]. The performer is free to interpret `Float` in a platform-specific way. Tests will only be expecting values well below the limits of a 32 bit signed floating point, and the performer can safely use the platform-specific version of such a type to hold the value: for example, a `float` or `double` are both fine.

For subsystems (such as transactions) that rely on performer-side validation. Many result types have a `SomeResult.contentAs[SomeType]()` call, and this message controls how the performer executes those, and what validation it performs.

Used in: transactions.CommandGet, transactions.CommandGetMulti.TransactionGetMultiSpec, transactions.CommandGetOptional, transactions.CommandGetReplicaFromPreferredServerGroup

• optional ContentAs content_as = 1

  How the performer should perform SomeResult.contentAs[SomeType]().

• bool expect_success = 2

  If true, the contentAs operation is expected to succeed and the performer needs to validate this, raising a GRPC FAILED_PRECONDITION error if not. If false, the contentAs operation is expected to fail and similarly the performer needs to validate this and raise a GRPC INVALID_ARGUMENT error if validation fails. Specifically the operation would be expected to fail with an SDK3 DecodingFailureException. However, it is known that some SDKs do not follow the model, and so it is not a required part of the validation. The performer can choose to optionally validate it is a DecodingFailureException, for an extra level of regression safety.

• optional bytes expected_content_bytes = 3

  If specified, the performer will check the results of contentAs operation against this. The results of the contentAs operation should be converted to a byte[] first. Iff the expected content does not equal the actual content, the performer should raise a GRPC FAILED_PRECONDITION error.

Used in: sdk.kv.lookup_in.LookupInSpecResult, sdk.kv.mutate_in.MutateInSpecResult

• oneof result

  • ContentTypes content = 1

  • Exception exception = 2

Used in: sdk.kv.GetReplicaResult, sdk.kv.GetResult, sdk.kv.rangescan.ScanResult, sdk.query.QueryResult, sdk.search.SearchRow, ContentOrError

• oneof content

  • bytes content_as_bytes = 1

    Used for content as bytes and JSON

  • string content_as_string = 2

  • int64 content_as_int64 = 3

  • double content_as_double = 4

  • bool content_as_bool = 5

  • ContentTypes.NullValue content_as_null = 6

    content returned by sdk is supposed to be null

Used in: ContentTypes

(message has no fields)

An exception derived from CouchbaseException "Ex" naming as transactions already has CouchbaseException in an enum.

Used in: Exception

• string name = 1

  The simple name e.g. "DocumentNotFoundException"

• CouchbaseExceptionType type = 2

• optional Exception cause = 3

• string serialized = 4

  Broadly this is the result of outputting the exception. E.g. for Java `ex.toString()`. Per the RFC it's expected to contain the serialized error context.

All errors derived from CouchbaseException. The performer should return the most specific error possible. E.g. not SDK_COUCHBASE_EXCEPTION, unless a raw CouchbaseException is what the SDK raised. From https://github.com/couchbaselabs/sdk-rfcs/blob/master/rfc/0058-error-handling.md Go specific notes: Go deviates from the error handling RFC in a few ways, and gets some special handling in the performer to map it into the RFC model so it can work with the FIT GRPC: 1. It doesn't really have `ErrorContext` in the same way. Instead it has `KeyValueError`, `QueryError` et al., which perform a similar purpose to `ErrorContext`. 2. It doesn't have a base `CouchbaseException` error. Errors don't derive from `CouchbaseException`, and generic errors that would be just a `CouchbaseException` in another SDK, become a `KeyValueError`, `QueryError` etc. (Assuming the error did originate from the SDK.) We accommodate (2)) in the FIT model by having the Go performer check for all specific exceptions first with e.g. `errors.Is(err, ErrTimeout)`. If these all fail, it then checks if the error is a `QueryError` etc. with `errors.As()`. If one of those succeeds, it's regarded as a generic CouchbaseException. If all those checks fail, the error is classified as `ExceptionOther`. (1) is accommodated by just converted `QueryError` et al. into a serialized `ErrorContext`-esque string, as they are serving very similar purposes.

Used in: CouchbaseExceptionEx

• SDK_COUCHBASE_EXCEPTION = 0

• SDK_TIMEOUT_EXCEPTION = 1

• SDK_REQUEST_CANCELLED_EXCEPTION = 2

• SDK_INVALID_ARGUMENT_EXCEPTION = 3

• SDK_SERVICE_NOT_AVAILABLE_EXCEPTION = 4

• SDK_INTERNAL_SERVER_FAILURE_EXCEPTION = 5

• SDK_AUTHENTICATION_FAILURE_EXCEPTION = 6

• SDK_TEMPORARY_FAILURE_EXCEPTION = 7

• SDK_PARSING_FAILURE_EXCEPTION = 8

• SDK_CAS_MISMATCH_EXCEPTION = 9

• SDK_BUCKET_NOT_FOUND_EXCEPTION = 10

• SDK_COLLECTION_NOT_FOUND_EXCEPTION = 11

• SDK_UNSUPPORTED_OPERATION_EXCEPTION = 12

• SDK_AMBIGUOUS_TIMEOUT_EXCEPTION = 13

• SDK_UNAMBIGUOUS_TIMEOUT_EXCEPTION = 14

• SDK_FEATURE_NOT_AVAILABLE_EXCEPTION = 15

• SDK_SCOPE_NOT_FOUND_EXCEPTION = 16

• SDK_INDEX_NOT_FOUND_EXCEPTION = 17

• SDK_INDEX_EXISTS_EXCEPTION = 18

• SDK_ENCODING_FAILURE_EXCEPTION = 19

• SDK_DECODING_FAILURE_EXCEPTION = 20

• SDK_RATE_LIMITED_EXCEPTION = 21

• SDK_QUOTA_LIMITED_EXCEPTION = 22

• SDK_DOCUMENT_NOT_FOUND_EXCEPTION = 101

  Key-value

• SDK_DOCUMENT_UNRETRIEVABLE_EXCEPTION = 102

• SDK_DOCUMENT_LOCKED_EXCEPTION = 103

• SDK_DOCUMENT_NOT_LOCKED_EXCEPTION = 131

• SDK_VALUE_TOO_LARGE_EXCEPTION = 104

• SDK_DOCUMENT_EXISTS_EXCEPTION = 105

• SDK_DURABILITY_LEVEL_NOT_AVAILABLE_EXCEPTION = 107

• SDK_DURABILITY_IMPOSSIBLE_EXCEPTION = 108

• SDK_DURABILITY_AMBIGUOUS_EXCEPTION = 109

• SDK_DURABLE_WRITE_IN_PROGRESS_EXCEPTION = 110

• SDK_DURABLE_WRITE_RECOMMIT_IN_PROGRESS_EXCEPTION = 111

• SDK_PATH_NOT_FOUND_EXCEPTION = 113

• SDK_PATH_MISMATCH_EXCEPTION = 114

• SDK_PATH_INVALID_EXCEPTION = 115

• SDK_PATH_TOO_BIG_EXCEPTION = 116

• SDK_PATH_TOO_DEEP_EXCEPTION = 117

• SDK_VALUE_TOO_DEEP_EXCEPTION = 118

• SDK_DOCUMENT_TOO_DEEP_EXCEPTION = 125

• SDK_VALUE_INVALID_EXCEPTION = 119

• SDK_DOCUMENT_NOT_JSON_EXCEPTION = 120

• SDK_NUMBER_TOO_BIG_EXCEPTION = 121

• SDK_DELTA_INVALID_EXCEPTION = 122

• SDK_PATH_EXISTS_EXCEPTION = 123

• SDK_XATTR_UNKNOWN_MACRO_EXCEPTION = 124

• SDK_XATTR_INVALID_KEY_COMBO_EXCEPTION = 126

• SDK_XATTR_UNKNOWN_VIRTUAL_ATTRIBUTE_EXCEPTION = 127

• SDK_XATTR_CANNOT_MODIFY_VIRTUAL_ATTRIBUTE_EXCEPTION = 128

• SDK_XATTR_NO_ACCESS_EXCEPTION = 130

• SDK_PLANNING_FAILURE_EXCEPTION = 201

  Query

• SDK_INDEX_FAILURE_EXCEPTION = 202

• SDK_PREPARED_STATEMENT_FAILURE_EXCEPTION = 203

• SDK_DML_FAILURE_EXCEPTION = 204

• SDK_COMPILATION_FAILURE_EXCEPTION = 301

  Analytics

• SDK_JOB_QUEUE_FULL_EXCEPTION = 302

• SDK_DATASET_NOT_FOUND_EXCEPTION = 303

• SDK_DATAVERSE_NOT_FOUND_EXCEPTION = 304

• SDK_DATASET_EXISTS_EXCEPTION = 305

• SDK_DATAVERSE_EXISTS_EXCEPTION = 306

• SDK_LINK_NOT_FOUND_EXCEPTION = 307

• SDK_VIEW_NOT_FOUND_EXCEPTION = 501

  View

• SDK_DESIGN_DOCUMENT_NOT_FOUND_EXCEPTION = 502

• SDK_COLLECTION_EXISTS_EXCEPTION = 601

  Management

• SDK_SCOPE_EXISTS_EXCEPTION = 602

• SDK_USER_NOT_FOUND_EXCEPTION = 603

• SDK_GROUP_NOT_FOUND_EXCEPTION = 604

• SDK_BUCKET_EXISTS_EXCEPTION = 605

• SDK_USER_EXISTS_EXCEPTION = 606

• SDK_BUCKET_NOT_FLUSHABLE_EXCEPTION = 607

Used as request type in: PerformerService.setCounter

Used as field type in: Bounds, PoolSelectionStrategyCounter

• string counter_id = 1

  Each counter gets a unique id (unique to the WorkloadRunRequest, not globally unique). The performer will create these on-demand. Each counter is bound to a WorkloadRunRequest. E.g. concurrent WorkloadRunRequests both referencing "counter1" should have separate isolated counters.

• oneof counter

  • CounterGlobal global = 2

We may need the flexibility to do various forms of counter, e.g.: 1. Aim to do 1m operations across all threads. 2. Each thread does 1m operations. (1) is the simplest and most useful, so is the only one supported for now. And `counterId` lets us do (2) with it anyway.

Used in: Counter

• int32 count = 1

  The performer should initialise the counter at this value, and will generally keep going until the counter reaches 0

Used as request type in: PerformerService.disconnectConnections

(message has no fields)

Used as response type in: PerformerService.disconnectConnections

(message has no fields)

Used in: sdk.kv.Append, sdk.kv.Decrement, sdk.kv.Exists, sdk.kv.Get, sdk.kv.GetAllReplicas, sdk.kv.GetAndLock, sdk.kv.GetAndTouch, sdk.kv.GetAnyReplica, sdk.kv.GetOrNull, sdk.kv.Increment, sdk.kv.Insert, sdk.kv.Prepend, sdk.kv.Remove, sdk.kv.Replace, sdk.kv.Touch, sdk.kv.Unlock, sdk.kv.Upsert, sdk.kv.lookup_in.LookupIn, sdk.kv.lookup_in.LookupInAllReplicas, sdk.kv.lookup_in.LookupInAnyReplica, sdk.kv.mutate_in.MutateIn, transactions.CommandGetMulti.TransactionGetMultiSpec, transactions.Get, transactions.Insert, transactions.Remove, transactions.Replace

• oneof location

  • DocLocationSpecific specific = 1

  • DocLocationUuid uuid = 2

  • DocLocationPool pool = 3

The performer will pick a document from a pool. The performer should generate an integer in [0-poolSize) following selectionStrategy. Then append that to `idPreface` e.g. "${idPreface}${selectedInt}" to get the document id.

Used in: DocLocation

• optional Collection collection = 1

• string id_preface = 2

  All documents in the pool start with this.

• int64 pool_size = 3

  How many documents are in the pool.

• oneof poolSelectionStrategy

  • PoolSelectionStategyRandom random = 4

  • PoolSelectionStrategyCounter counter = 5

The performer will access the document in this exact location

Used in: DocLocation

• optional Collection collection = 1

• string id = 2

The performer will generate a random UUID for the document id

Used in: DocLocation

• optional Collection collection = 1

Used in: sdk.cluster.bucket_manager.BucketSettings, sdk.query.SingleQueryTransactionOptions, DurabilityType, TransactionsConfig, transactions.TransactionOptions, transactions.TransactionsFactoryCreateRequest

• NONE = 0

• MAJORITY = 1

• MAJORITY_AND_PERSIST_TO_ACTIVE = 2

• PERSIST_TO_MAJORITY = 3

Awkward name as Durability already taken

Used in: sdk.kv.AppendOptions, sdk.kv.DecrementOptions, sdk.kv.IncrementOptions, sdk.kv.InsertOptions, sdk.kv.PrependOptions, sdk.kv.RemoveOptions, sdk.kv.ReplaceOptions, sdk.kv.UpsertOptions, sdk.kv.mutate_in.MutateInOptions

• oneof durability

  • Durability durabilityLevel = 1

  • ObserveBased observe = 2

Request that the performer Echo a string to the performer logs.

Used as request type in: fit.columnar.ColumnarService.Echo, PerformerService.echo

• string message = 1

• string testName = 2

Used as response type in: fit.columnar.ColumnarService.Echo, PerformerService.echo

(message has no fields)

Used in: sdk.Result, sdk.kv.lookup_in.BooleanOrError, ContentOrError, CouchbaseExceptionEx, streams.Error

• oneof exception

  • CouchbaseExceptionEx couchbase = 1

  • ExceptionOther other = 2

If the exception is not represented in SdkException, can return it in raw form here

Used in: Exception

• string name = 1

  The simple name e.g. "InvalidArgumentException"

• string serialized = 2

  Broadly this is the result of outputting the exception. E.g. for Java `ex.toString()`.

Used in: sdk.kv.DecrementOptions, sdk.kv.GetAndTouch, sdk.kv.IncrementOptions, sdk.kv.InsertOptions, sdk.kv.ReplaceOptions, sdk.kv.Touch, sdk.kv.UpsertOptions, sdk.kv.mutate_in.MutateInOptions, transactions.TransactionInsertOptions, transactions.TransactionReplaceOptions

• oneof expiryType

  • int64 relativeSecs = 1

    The document will expire after the given duration.

  • int64 absoluteEpochSecs = 2

    The document will expire at a specific time. Given in epoch time.

The performer will run the bounded item until this much time has elapsed.

Used in: Bounds

• int32 seconds = 1

* CustomSerializer defines different serialization strategies using a `oneof`. Currently, it includes a boolean option but is designed to be extended with other serialization methods in the future.

Used in: sdk.search.SearchOptions

• oneof serializer

  • bool default = 1

    Explicitly use the SDK's default JsonSerializer (See https://github.com/couchbaselabs/sdk-rfcs/blob/master/rfc/0055-serializers-transcoders.md#default-jsonserializer) If the SDK does not have this concept, then it can instead not provide any serializer for this operation - which is expected to have the same effect.

  • bool custom_serializer = 2

    * **Custom Serializer** Uses a custom `JsonSerializer` implementation with specific serialization and deserialization logic. **Serialization Logic:** ```java public byte[] serialize(Object input) { // Convert the input object to a JSON string String jsonString = convertObjectToJsonString(input); // Create a JSON object from the string JsonObject jsonObject = parseStringToJsonObject(jsonString); // Add the "Serialized": true field jsonObject.put("Serialized", true); // Convert the JSON object to a byte array and return return convertJsonObjectToByteArray(jsonObject); } ``` **Deserialization Logic:** ```java public <T> T deserialize(Class<T> target, byte[] input) { // Parse the byte array into a JSON object JsonObject jsonObject = parseByteArrayToJsonObject(input); // Upsert the "Serialized" field to false, "Serialized" key may or may not present while deserializing. jsonObject.put("Serialized", false); // Convert the JSON object back to the target type and return return convertJsonObjectToTargetType(jsonObject, target); } ``` **Implementation Details:** - **`convertObjectToJsonString(Object input)`**: - Converts the input object to its JSON string representation. - **`parseStringToJsonObject(String jsonString)`**: - Parses the JSON string into a `JsonObject`. - **`convertJsonObjectToByteArray(JsonObject jsonObject)`**: - Serializes the `JsonObject` into a byte array. - **`parseByteArrayToJsonObject(byte[] input)`**: - Deserializes the byte array back into a `JsonObject`. - **`convertJsonObjectToTargetType(JsonObject jsonObject, Class<T> target)`**: - Converts the `JsonObject` to the specified target type `T`. **Notes for Performers:** - Implementations in other languages should follow the same logical steps using equivalent constructs. - Ensure that the `"Serialized"` flag is appropriately set during serialization and deserialization to track the state. - Proper error handling should be included to manage serialization/deserialization exceptions.

Used in: Transcoder

(message has no fields)

Note these latches don't work like real CountdownLatches (or equivalent). Each concurrent transaction gets its own version of the latch, and they are synchronized by the driver. Latches are bound to the rpc they are created in. E.g. it should be possible to have two concurrent `transactionStream` rpcs going on, each using the same latch name, but referring to two separate underlying CountdownLatches (or equivalents).

Used in: transactions.TransactionCreateRequest

• int32 initial_count = 1

• string name = 2

Used in: Transcoder

(message has no fields)

Used in: sdk.kv.rangescan.ScanOptions, sdk.query.QueryOptions, sdk.search.SearchOptions

• repeated MutationToken tokens = 1

Used in: sdk.kv.CounterResult, sdk.kv.MutationResult, sdk.kv.mutate_in.MutateInResult, MutationState, transactions.TransactionResult

• int32 partition_id = 1

  This is a short really, but GRPC doesn't have int16

• int64 partition_uuid = 2

• int64 sequence_number = 3

• string bucket_name = 4

Used in: DurabilityType

• PersistTo persistTo = 1

• ReplicateTo replicateTo = 2

Used in: ObserveBased

• PERSIST_TO_NONE = 0

• PERSIST_TO_ACTIVE = 1

• PERSIST_TO_ONE = 2

• PERSIST_TO_TWO = 3

• PERSIST_TO_THREE = 4

• PERSIST_TO_FOUR = 5

Generate a random id in [0-poolSize).

Used in: DocLocationPool

• RandomDistribution distribution = 1

Use a counter to select the next document in the pool, starting at 0. The performer should increment the counter each time it uses it. The performer should modulo `poolSize`. E.g. `realCounterResult = currentCounterValue % poolSize`.

Used in: DocLocationPool

• optional Counter counter = 1

Used in: PoolSelectionStategyRandom

• RANDOM_DISTRIBUTION_UNIFORM = 0

Used in: Transcoder

(message has no fields)

Used in: Transcoder

(message has no fields)

Used in: Transcoder

(message has no fields)

Zone Aware Read from Replica options

Used in: sdk.kv.GetAllReplicasOptions, sdk.kv.GetAnyReplicaOptions, sdk.kv.lookup_in.LookupInAllReplicasOptions, sdk.kv.lookup_in.LookupInAnyReplicaOptions

• NO_PREFERENCE = 0

• SELECTED_SERVER_GROUP = 1

• SELECTED_SERVER_GROUP_OR_ALL_AVAILABLE = 2

Used in: ObserveBased

• REPLICATE_TO_NONE = 0

• REPLICATE_TO_ONE = 1

• REPLICATE_TO_TWO = 2

• REPLICATE_TO_THREE = 3

Used in: sdk.cluster.eventing_function_manager.EventingFunctionSettings, sdk.query.QueryOptions, TransactionsConfigQuery, transactions.CommandQueryParameters, transactions.TransactionQueryOptions

• REQUEST_PLUS = 0

• NOT_BOUNDED = 1

Used in: sdk.ScopeLevelCommand, transactions.CommandQuery

• string bucket_name = 1

• string scope_name = 2

Empty but included anyway per GRPC best practices.

Used as response type in: PerformerService.setCounter

(message has no fields)

Used in: TransactionsConfig

• optional bool cleanup_lost_attempts = 1

  Whether to run the lost cleanup thread(s).

• optional bool cleanup_client_attempts = 2

  Whether to run the cleanup thread cleaning up attempts from this client.

• optional int64 cleanup_window_millis = 3

  Length of the lost cleanup window, in millis.

• repeated Collection cleanup_collection = 4

  Additional collections to add to the cleanup set. Can be ignored if not ExtSDKIntegration.

Options that can be overridden at the individual transaction level. Note that pre-ExtSDKIntegration, this struct was empty. Not in the implementation, where PerTransactionConfig existed, but here at the FIT level. So, it will only be populated for ExtSDKIntegration performers.

Used in: ClusterConfig, transactions.TransactionsFactoryCreateRequest

• optional Durability durability = 1

  Durability to use for all mutating KV operations, both in cleanup and all transactions initiated.

• optional int64 timeout_millis = 2

  Timeout (nee expirationTime) for all transactions.

• repeated hooks.transactions.Hook hook = 3

• optional Collection metadata_collection = 4

• optional TransactionsCleanupConfig cleanup_config = 5

• optional TransactionsConfigQuery query_config = 6

Used in: TransactionsConfig

• optional ScanConsistency scan_consistency = 1

All the transcoders required by https://github.com/couchbaselabs/sdk-rfcs/blob/master/rfc/0055-serializers-transcoders.md

Used in: sdk.kv.GetAllReplicasOptions, sdk.kv.GetAndLockOptions, sdk.kv.GetAndTouchOptions, sdk.kv.GetAnyReplicaOptions, sdk.kv.GetOptions, sdk.kv.InsertOptions, sdk.kv.ReplaceOptions, sdk.kv.UpsertOptions, sdk.kv.rangescan.ScanOptions, ClusterConfig, transactions.CommandGetMulti.TransactionGetMultiSpec, transactions.TransactionGetOptions, transactions.TransactionInsertOptions, transactions.TransactionReplaceOptions

• oneof transcoder

  • LegacyTranscoder legacy = 1

  • JsonTranscoder json = 2

  • RawJsonTranscoder raw_json = 3

  • RawStringTranscoder raw_string = 4

  • RawBinaryTranscoder raw_binary = 5