Couchbase Go SDK Release Notes

GOCBC-1125: Deprecated Cas on Binary Append and Prepend as the server does not support this. Usage of Cas on these operations will now return an error.

GOCBC-1203: Added CompressionOptions to ClusterOptions, defaulting to compression being enabled.

GOCBC-1255: Deprecated AggregatingMeterOptions and NewAggregatingMeter.

GOCBC-1265: Bundle Capella CA certificate with the SDK.

TXNG-1253: Removed ServerDurationDisabled from ThresholdLoggingOptions.

GOCBC-1267: Fixed issue where GetAllIndexes could incorrectly omit the default collection.

GOCBC-1221: Added support for handling any retry:true field in a query error result by retrying it.

GOCBC-1228: Updated the query used within BuildDeferredIndexes in QueryIndexManager.

GOCBC-1244: Updated SDK dependencies.

GOCBC-1254: Added NewLoggingMeter and LoggingMeterOptions for creating the LoggingMeter. AggregatingMeterOptions and NewAggregatingMeter will be deprecated in the next dot minor release.

GOCBC-1248: Fixed issue where a hard close of a memdclient during a graceful close could trigger a panic.

GOCBC-1251: Fixed issue where SearchOptions ConsistentWith was using an incorrect key within the JSON payload.

GOCBC-1256: Fixed issue where config polling could fallback to using the http poller, when no http addresses are registered for use.

GOCBC-1258: Fixed issue where log redaction tags were not closed correctly.

GOCBC-1172: Added uncommitted API stability support for Query option PreserveExpiry.

GOCBC-1176: Added uncommitted API stability support for collections to query index manager.

GOCBC-1239: Added DurabilityLevelUnknown as default durability level.

TXNG-127: Integrated transactions into the SDK.

GOCBC-1240: Fixed issue where MutateIn was not setting durability level.

GOCBC-1152: Added uncommitted API stability support for custom conflict resolution to BucketSettings.

GOCBC-1156; Added volatile API stability support for includeLocations to SearchOptions and Operator to search MatchQuery.

GOCBC-1175: Added uncommitted API stability support for storageBackend to BucketSettings.

GOCBC-1196: Added the ErrorText of the response body field to AnalyticsError, SearchError, ManagementError, and ViewError, to allow easier debugging and error handling. Renamed the ResponseBody of the QueryError to be ErrorText and contain only the error text. Added the StatusCode of the response to AnalyticsError, QueryError, ManagementError, and ViewError.

GOCBC-1200: Renamed ErrRateLimiting and ErrQuotaLimiting to ErrRateLimited and ErrQuotaLimited. Note: this is a breaking change, it not expected to impact any users.

GOCBC-1202:

GOCBC-1211: Fixed issues relating to rate limit error message parsing.

GOCBC-1210: Fixed issue where a quota limit error was returned rather than rate limit error for key value response status code 0x32.

GOCBC-1179: Added support to attempt graceful closing of connections.

GOCBC-1154; GOCBC-1184: Added RateLimitFailure and QuotaLimitFailure support for Couchbase Capella.

GOCBC-1193: Added the ResponseBody field to QueryError, to allow easier debugging and error handling.

GOCBC-1185: Fixed an issue with Queue and Set retrying during pop and remove operations.

GOCBC-1186: Fixed issue where logging meter could cause a deadlock on closing the cluster object.

GOCBC-1187: Fixed issue where logging meter could log a service/operation pair which has no operations.

GOCBC-1194: Changed ordering of route config bootstrapping, to check all seed nodes for the default network type first. This fixed an issue with stuck deployments using the Eventing service, after upgrade to server 7.0.2.

GOCBC-1178: We no longer remove poller controller watcher from cluster config updates.

GOCBC-1177: Fixed issue where a connection being closed by the server during bootstrap could cause the SDK to loop reconnect without backoff.

GOCBC-1183: Fixed issue where SSL certificates were be not verified when no root CAs were provided.

GOCBC-1009: Add support for Eventing function management.

GOCBC-1166: Check error codes and fallback to parsing messages in query index management.

GOCBC-1168: Fixed issue where cluster level HTTP operations could hang indefinitely.

GOCBC-1170: Fixed issue where Search ScanConsistency was sending an incorrect value for NotBounded.

GOCBC-1140: Fixed issue where ViewOptions would return an error when using group_level.

GOCBC-1144: Added missing min function to Disjunction search query.

GOCBC-1147: Fixed issue where an error occuring whilst fetching the error map during bootstrap could cause an indefinite hang.

GOCBC-1149: Fixed issue where GetAllScopes would panic on HTTP request send failure.

GOCBC-1147: Fixed issue where an error occuring whilst fetching the error map during bootstrap could cause an indefinite hang.

GOCBC-1149: Fixed issue where GetAllScopes would panic on HTTP request send failure.

GOCBC-935: Added support for Analytics remote and external link management.

GOCBC-936: Added support for compound dataverse names to Analytics management.

GOCBC-940:

GOCBC-1096: Updated the tracing interface, and made it API stability level committed.

GOCBC-1037: Added support for PreserveExpiry option to key value operations.

GOCBC-1044: Added support for meter interface, and default LoggingMeter implementation.

GOCBC-1063: Added uncommitted support for context.Context to options blocks.

GOCBC-1077: Updated errors returned on Query error code return of 12009.

GOCBC-1130: Updated Query error handling to return an authentication error on error code 13104.

GOCBC-1095: Fixed issue where View error contents were being parsed incorrectly.

GOCBC-1100: Fixed issue where the Search metrics took field was being parsed incorrectly.

GOCBC-1106: Fixed issue where a Search response containing a hits field but the field being null would lead to an error.

GOCBC-1111: Fixed issue where any errors returned from the Search service were not being propagated through the SDK.

GOCBC-1127: Fixed issue where Query errors were sometimes not being parsed correctly.

GOCBC-1132: Fixed issue where benchmarks would not compile.

GOCBC-1095: Fixed issue where errors returned from views was parsed incorrectly.

GOCBC-1102: Fixed issue where WaitUntilReady would never recover if one of the HTTP based services returned an error.

GOCBC-1106: Fixed issue where hits being null in a search response would leave to an internal error.

GOCBC-1111; GOCBC-1112: Fixed issue where parsing search errors was using the incorrect field.

GOCBC-1100: Fixed issue where the took field in search metrics was parsed incorrectly.

GOCBC-1071: Updated SDK to use new protocol level changes for get collection id.

GOCBC-1068: Dropped log level to warn for when applying a cluster config object is preempted.

GOCBC-1079: During bootstrap don’t retry authentication if the error is request cancelled.

GOCBC-1081: During CCCP polling don’t retry request if the error is request cancelled.

GOCBC-1074: Fixed issue where threshold log tracer was missing fields in log output.

GOCBC-1080: Fixed issue where SDK would always rebuild connections on first cluster config fetched against server 7.0.

GOCBC-1082: Fixed issue where bootstrapping a node during an SDK wide reconnect would cause a delay in connecting to that node.

GOCBC-1088: Fixed issue where the poller controller could deadlock if a node reported a bucket not found at the same time as CCCP successfully fetched a cluster config for the first time.

GOCBC-1010: Added uncommitted support for collections to SearchOptions.

GOCBC-1024: Added partition information to QueryIndex.

GOCBC-1056: Various performance enhancements to improve CPU usage.

GOCBC-1068: Dropped log level to warn for when applying a cluster config object is preempted.

GOCBC-1070: Fixed issue where BucketManager FlushBucket didn’t return ErrBucketNotFound when the bucket doesn’t exist.

GOCBC-1066: Fixed issue where shutting down cluster config polling could lead to a panic.

GOCBC-1017: Updated server endpoints for collections manager.

GOCBC-1040: Updated json serialization of errors to include the underlying cause.

GOCBC-1054: Updated MutateIn to allow a blank path with RemoveSpec.

GOCBC-1047: Fixed issue where GetAllScopes was not setting the max expiry value for any collections.

GOCBC-1052: Fixed issue where GetAllDesignDocuments was ignoring the provided namespace.

GOCBC-1061: Fixed issue where an extra, empty, origin was added to user roles on fetching the user.

GOCBC-1017: Updated server endpoints for collections manager.

GOCBC-1040: Updated json serialization of errors to include the underlying cause.

GOCBC-1054: Updated MutateIn to allow a blank path with RemoveSpec.

GOCBC-1047: Fixed issue where GetAllScopes was not setting the max expiry value for any collections.

GOCBC-1052: Fixed issue where GetAllDesignDocuments was ignoring the provided namespace.

GOCBC-1061: Fixed issue where an extra, empty, origin was added to user roles on fetching the user.

GOCBC-869: BucketSettings MaxTTL field deprecated in favour of MaxExpiry.

GOCBC-934: Added support for bucket level durability settings in BucketManager.

GOCBC-948: Changed document expiry durations so that expiry lengths of > 30 days sent as unix timestamps (now + expiry).

GOCBC-934: Added support for bucket level durability settings in BucketManager.

GOCBC-963: GetResult Expiry function deprecated in favour of ExpiryTime.

GOCBC-972: Added support for Score to SearchOptions.

GOCBC-1014: Updated search GeoPolygon support to API stability committed.

GOCBC-1015: Updated QueryOptions FlexIndex support to API stability committed.

GOCBC-1026: Updated BucketSettings ephemeral eviction policies support to API stability committed.

GOCBC-1022: Fixed issue where having multiple buckets open could cause view requests to be sent to an incorrect bucket.

GOCBC-1021: Fixed issue where having multiple buckets open could cause view manager requests to be sent to an incorrect bucket.

GOCBC-1028: Fixed issue where bootstrapping against a non-kv node could never successfully fully connect.

GOCBC-937: Added uncommitted support for GeoPolygon search queries.

GOCBC-1005: Added document id to key value errors.

GOCBC-1006: Changed the log level for retry strategy retries from info to debug.

GOCBC-1007: Fixed issue some operations were being incorrectly sent to the retry orchestrator on errors.

GOCBC-938: Added uncommitted support for FlexIndex to QueryOptions.

GOCBC-942: Added uncommitted support for Scope level queries.

GOCBC-944: Added uncommitted support for Scope level analytics queries.

GOCBC-944: Added uncommitted support for User collections level RBAC.

GOCBC-994: Fixed issue where nil values used in subdoc MutateIn operations would be rejected by the server. These values are now coerced into JSON null values before sending.

GOCBC-1001: Added missing Terms, DateRanges, and NumericRanges fields to SearchFacetResult.

GOCBC-977: Fixed issue where analytics GetPendingMutations was looking for the incorrect data structure in the HTTP response body.

GOCBC-990: Fixed issue where enhanced durability timeout adaptive algorithm was incorrect.

GOCBC-991: Fixed issue where authentication mechanisms were not correctly iterated on bootstrap.

GOCBC-996: Fixed issue where the Map datastructure was using invalid paths for At and Exists.

GOCBC-979: Add ExpiryTime to GetResult, providing the point in time at which a document will expire.

GOCBC-969: Fixed issue where the SDK would attempt to parse query metrics even if they weren’t present.

GOCBC-976: Fixed issue where custom transcoders were not supported for performing a get request with expiry.

GOCBC-978: Fixed issue where it was possible for more than one request to trigger switching from unknown to pending state for a given collection.

GOCBC-981: Fixed issue where setting the network connection string property to default would be discarded.

GOCBC-926: Added a new Cluster level option to set which authentication mechanisms to use.

GOCBC-962: Exposed the ThresholdLogTracer and corresponding options so that threshold logging can be configured. The threshold logger can then be set on the Cluster level options as Tracer. Note: The threshold logger is the default tracer used by the SDK.

GOCBC-718: Fixed issue where errors would be silently swallwed when performing JSON unmarshalling of search and view queries. Unmarshalling errors will now be surfaced by the result.Err() function after iterating results.

GOCBC-950: Fixed issue where the SDK was not performing HELLO with the JSON feature enabled, leading to some KV error message context being lost.

GOCBC-968: Fixed issue where n1ql indexes were being created using prepared statements.

GOCBC-889: Added support for remaining service types to WaitUntilReadyOptions.

GOCBC-932: Added support for ephemeral bucket eviction types in the BucketManager.

GOCBC-951: Adjusted the default max idle http connection timeout to be 4.5s from unlimited.

GOCBC-925: Fixed issue where errors could not be accessed for queries responding with a HTTP 200 status code but containing errors. Any errors that are included in the query response when the status code is 200 will now be surfaced through the result Err call.

GOCBC-928: Fixed issue where enhanced durability could be incorrectly flagged as unsupported.

GOCBC-931: Fixed issue where enhanced durability timeouts were being sent as seconds rather than milliseconds.

GOCBC-945: Fixed issue where ephemeral buckets could not be created using the BucketManager.

GOCBC-946: Fixed issue where MaxTTL was being sent as nanoseconds rather than seconds when creating buckets using the BucketManager.

GOCBC-955: Fixed issue where xattrs were being reordered when being moved to the front of the list in subdoc operations.

GOCBC-941: Fixed issue where WaitUntilReady at the Cluster level would always timeout.

GOCBC-907: Enhance search query errors to include the index name and error text from the server.

GOCBC-913: Ensure that only available services are used for Ping if no services specified.

GOCBC-923: Updated const declarations to add types to improve API reference.

GOCBC-879, GOCBC-890: Fixed issue causing Cluster level operations to return errors when performed before underlying cluster or bucket connections are ready. These operations (query, search, analytics, views, management APIs) will now behave like key value operations - waiting for connections to be ready before they are sent. The WaitUntilReady call can still be used for verifying that connections are ready.

GOCBC-891: Fixed issue where the Name property of a Role was being sent as the incorrect json field name.

GOCBC-897: Fixed issue where operations with incredible short timeouts (timing out before operation sent) could cause a data race.

GOCBC-900: Fixed issue where IgnoreIfExists option was being ignored for query index management.

GOCBC-906: Fixed issue where enhanced durability could be incorrectly set as unsupported on early operations.

GOCBC-914: Fixed issue where operations using named collections could be sent with an incorrect collection ID in queued before the collection is known.

GOCBC-778: Updated legacy durability polling to use a backoff rather than a fixed interval.

GOCBC-824: Enhanced timeout errors to contain more information and match up with the Response Time Observability RFC.

GOCBC-828: Added MaxExpiry to the CollectionSpec.

GOCBC-870: Updated GetAllIndexes to only fetch GSI indexes.

GOCBC-884: Improved logging to always log the cluster config when fetched.

GOCBC-888: Re-enabled HTTP dispatch traces.

GOCBC-691: Fixed issue where operations on unknown collections (when using 6.5 developer preview) are not automatically retried.

GOCBC-757: Fixed issue where an array of arrays could cause a failure when using Get with Projections.

GOCBC-882: Fixed issue where an invalid cluster config would trigger a shutdown of the underlying core SDK causing operations to fail.

GOCBC-884: Fixed issue where UpsertUser sent an invalid request if a role was specified with no bucket.

GOCBC-879, GOCBC-890: Performing Cluster level operations (query, search, management APIs) before underlying cluster or bucket connections are ready causes errors to be returned. To mitigate this the err := WaitUntilReady(time.Duration, WaitUntilReadyOptions) operation can be used on either Cluster or Bucket which will either:

GOCBC-843: Updated to the new version of gocbcore. This change includes a key behavioral change of no longer reporting non-configuration related connect time errors.

GOCBC-845: Add support for the WaitForReady operation, support waiting for the KeyValue service to be ready.

GOCBC-844: Updated to the latest version of gocbconnstr.

GOCBC-838: Fixed issue where HTTP endpoints were being used when SSL is enabled.

GOCBC-851: Fixed issue where ServerName was not being set on the tls.Config when SSL was use.

GOCBC-853: Fixed issue where using PasswordAuthenticator with a root CA and SSL would cause a panic.

GOCBC-831: Fixed issue where search consistency options were not being set in the request payload.

GOCBC-662: The server requires that any subdoc xattr ops are at the beginning of the ops list. If the user provides an ops list containing subdoc xattr ops out of order, the SDK will now reorder it for them and then reorder it back again when it gets the result. This ensures that ContentAt works as expected.

GOCBC-700: Made improvements to errors returned from management operations. They now provide more contextual information.

GOCBC-716: SDK now returns a FlushNotEnabled error if bucket flush not enabled.

GOCBC-719: SDK now consistently creates tracing spans for all HTTP requests.

GOCBC-728: Added cluster level Ping operation.

GOCBC-807: Updated best effort retry strategy to use an exponential backoff calculator.

GOCBC-820: Removed context.Context from search index manager operations. Note that whilst this is a breaking change it was deemed best to break it and make sure any users who are using it know that they are using unused functionality.

GOCBC-814: Fixed issue where search was looking for incorrect field in the JSON response.

GOCBC-817: Fixed issue where opening a bucket with the same name twice led to incorrect behaviour on both buckets.

GOCBC-805: Updated timeout behavior across the SDK to be consistent. If an operation level timeout is provided then it is used, otherwise the respective global timeout is used.

GOCBC-804: Fixed issue with timeouts not being respected for HTTP requests, leading to them never timing out.

GOCBC-775: Improve error message for when performing cluster level operations with no connections available.

GOCBC-776: Added support for KVDurableTimeout.

GOCBC-786: Improve error messages for the UserManager GetUser function.

GOCBC-701: Fixed issue with enhanced prepared statements not being used.

GOCBC-702: Fixed issue with CA root certificates not being able to be provided.

GOCBC-759: Fixed issue with streaming results for HTTP based services timing out unexpectedly.

GOCBC-772: Fixed issue with many of the management API functions timing out immediately.

GOCBC-773: Fixed issue with queries that do not return rows (e.g. mutations) causing errors.

GOCBC-777: Fixed issue with failing operations causing nil pointers.

GOCBC-783: Fixed issue with Exists returning incorrectly if the document was recently deleted.

GOCBC-784: Fixed issue with Unlock returning a doc not found error instead of cas mismatch.

GOCBC-787: Fixed issue with some (xattr related) subdoc operations sending invalid packets.

GOCBC-789: Fixed issue with search index manager FreezePlan function using an invalid HTTP method.

GOCBC-790: Fixed issue with user manager sometimes parsing user role origins incorrectly.

GOCBC-796: Fixed issue with cccp poller hanging if the get cluster config op timed out.

GOCBC-510: Dropped support for connecting using the http scheme.

GOCBC-534: Added support for retry handling.

GOCBC-652: Added support for circuit breakers.

GOCBC-655: Added support for enhanced timeout errors providing more information about operations which timeout.

GOCBC-656: Added support for threshold logging tracer.

GOCBC-680: Updated how we expose and handle errors.

GOCBC-694: A large number of updates including: How query and analytics results are iterated. Minor renaming of various types. Moving search facets, sorting, and queries to a search subpackage. Removing serializers.

GOCBC-740: Updated expiry options to be time.Duration.

GOCBC-760: Moved authenticator to ClusterOptions.