| Modifier and Type | Class and Description |
|---|---|
static class |
Core.ResponseMetricIdentifier |
class |
CoreKeyspace |
class |
CoreLimiter |
class |
CoreProtostellar |
class |
Timer
The
Timer acts as the main timing facility for various operations, for
example to track and time out requests if they run for too long or for rescheduling needs. |
| Modifier and Type | Method and Description |
|---|---|
CoreContext |
CoreContext.alternateAddress(Optional<String> alternateAddress)
Sets the alternate address on this context.
|
CoreBucketManagerOps |
Core.bucketManager() |
ClusterConfig |
Core.clusterConfig()
This API provides access to the current config that is published throughout the core.
|
CoreCollectionManager |
Core.collectionManager(String bucketName) |
ConfigurationProvider |
Core.configurationProvider()
Returns the attached configuration provider.
|
Stream<EndpointDiagnostics> |
Core.diagnostics() |
Mono<Void> |
Core.ensureServiceAt(NodeIdentifier identifier,
ServiceType serviceType,
int port,
Optional<String> bucket,
Optional<String> alternateAddress)
This method can be used by a caller to make sure a certain service is enabled at the given
target node.
|
CoreHttpClient |
Core.httpClient(RequestTarget target)
Returns a client for issuing HTTP requests to servers in the cluster.
|
void |
Core.initGlobalConfig()
Instructs the client to, if possible, load and initialize the global config.
|
Stream<InternalEndpointDiagnostics> |
Core.internalDiagnostics() |
CoreKvBinaryOps |
Core.kvBinaryOps(CoreKeyspace keyspace) |
CoreKvOps |
Core.kvOps(CoreKeyspace keyspace) |
void |
Core.openBucket(String name)
Attempts to open a bucket and fails the
Mono if there is a persistent error
as the reason. |
CoreQueryOps |
Core.queryOps() |
ValueRecorder |
CoreProtostellar.responseMetric(Core.ResponseMetricIdentifier rmi) |
ValueRecorder |
Core.responseMetric(Request<?> request,
Throwable err) |
CoreSearchOps |
Core.searchOps(CoreBucketAndScope scope) |
<R extends Response> |
Core.send(Request<R> request,
boolean registerForTimeout)
Sends a command into the core layer and allows to avoid timeout registration.
|
Optional<Flux<ServiceState>> |
Core.serviceState(NodeIdentifier nodeIdentifier,
ServiceType type,
Optional<String> bucket)
If present, returns a flux that allows to monitor the state changes of a specific service.
|
Mono<Void> |
Core.shutdown() |
Mono<Void> |
Core.shutdown(Duration timeout)
Shuts down this core and all associated, owned resources.
|
CoreTransactionsCleanup |
Core.transactionsCleanup() |
CoreTransactionsContext |
Core.transactionsContext() |
static <T> Mono<T> |
Reactor.wrap(CompletableFuture<T> response,
Runnable cancellationTask)
Converts the given future into a mono.
|
| Modifier and Type | Class and Description |
|---|---|
interface |
SinceCouchbase
Specifies the earliest version of Couchbase Server that supports the annotated feature.
|
interface |
UsedBy
Indicates the target element is not intended for public use,
but some other Couchbase project depends on it.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
CoreCouchbaseOps
Provides access to the various
Core*Ops instances. |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreAsyncResponse<T>
Associates a
CompletableFuture with a cancellation task. |
class |
CoreCounterResult |
class |
CoreDurability
Either a synchronous
DurabilityLevel, or "persist to and replicate to" for legacy durability. |
interface |
CoreEncodedContent |
class |
CoreExistsResult |
class |
CoreExpiry
A relative or absolute expiry.
|
class |
CoreGetResult |
interface |
CoreKvBinaryOps |
interface |
CoreKvOps |
class |
CoreKvParamValidators |
class |
CoreKvResponseMetadata |
class |
CoreKvResult |
class |
CoreLookupInMacro
Convenience macros to retrieve document metadata using a lookupIn Sub-Document call.
|
class |
CoreMutationResult |
class |
CoreStoreSemantics |
class |
CoreSubdocGetCommand |
class |
CoreSubdocGetResult |
class |
CoreSubdocMutateResult |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreBucketAndScope |
interface |
CoreBuildQueryIndexOptions
Allows customizing how deferred indexes are built.
|
interface |
CoreCreatePrimaryQueryIndexOptions
Allows customizing how a query primary index is created.
|
interface |
CoreCreateQueryIndexOptions
Allows customizing how a query index is created.
|
interface |
CoreCreateQueryIndexSharedOptions
Allows customizing how a query primary index is created.
|
interface |
CoreDropPrimaryQueryIndexOptions
Allows customizing how primary indexes are dropped.
|
interface |
CoreDropQueryIndexOptions
Allows customizing how query indexes are dropped.
|
interface |
CoreGetAllQueryIndexesOptions
Allows customizing how query indexes are loaded.
|
class |
CoreQueryIndex
Contains the properties of a Query Index.
|
class |
CoreScopeAndCollection |
interface |
CoreWatchQueryIndexesOptions
Allows customizing how the query indexes are watched.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ClassicCoreBaseSearchIndexManager |
class |
ClassicCoreClusterSearchIndexManager |
class |
ClassicCoreScopeSearchIndexManager |
class |
CoreSearchIndex |
interface |
CoreSearchIndexManager
The same interface is used for ScopeSearchIndexManager and SearchIndexManager, as there is
no API difference between them at this level.
|
| Constructor and Description |
|---|
ClassicCoreBaseSearchIndexManager(Core core) |
ClassicCoreClusterSearchIndexManager(Core core) |
ClassicCoreScopeSearchIndexManager(Core core,
CoreBucketAndScope scope) |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreQueryContext |
class |
CoreQueryMetaData |
interface |
CoreQueryOps |
interface |
CoreQueryOptions |
class |
CoreQueryOptionsTransactions
Transactions does some rather complex things with CoreQueryOptions.
|
class |
CoreQueryProfile
Query profiling information received from the server query engine.
|
class |
CoreQueryResult
The result of a N1QL query, including rows and associated metadata.
|
class |
CoreQueryScanConsistency
The possible values for scan consistency in a N1QL request.
|
class |
CoreQueryStatus |
class |
CoreQueryWarning
Represents a single warning returned from the query engine.
|
class |
CoreReactiveQueryResult |
| Modifier and Type | Class and Description |
|---|---|
class |
ClassicCoreSearchOps |
class |
CoreHighlightStyle |
class |
CoreSearchKeyset |
class |
CoreSearchMetaData |
interface |
CoreSearchOps |
interface |
CoreSearchOptions |
class |
CoreSearchQuery |
class |
CoreSearchScanConsistency |
| Modifier and Type | Method and Description |
|---|---|
static void |
ClassicCoreSearchOps.injectOptions(String indexName,
com.couchbase.client.core.deps.com.fasterxml.jackson.databind.node.ObjectNode queryJson,
Duration timeout,
CoreSearchOptions opts,
boolean disableShowRequest) |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreDateRange |
class |
CoreDateRangeFacet |
class |
CoreNumericRange |
class |
CoreNumericRangeFacet |
class |
CoreSearchFacet |
class |
CoreTermFacet |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreAbstractCompoundQuery |
class |
CoreBooleanFieldQuery |
class |
CoreBooleanQuery |
class |
CoreConjunctionQuery |
class |
CoreCustomQuery |
class |
CoreDateRangeQuery |
class |
CoreDisjunctionQuery |
class |
CoreDocIdQuery |
class |
CoreGeoBoundingBoxQuery |
class |
CoreGeoCoordinates
To create a new instance:
|
class |
CoreGeoDistanceQuery |
class |
CoreGeohash |
interface |
CoreGeoPoint |
class |
CoreGeoPolygonQuery |
class |
CoreMatchAllQuery |
class |
CoreMatchNoneQuery |
class |
CoreMatchOperator |
class |
CoreMatchPhraseQuery |
class |
CoreMatchQuery |
class |
CoreNumericRangeQuery |
class |
CorePhraseQuery |
class |
CorePrefixQuery |
class |
CoreQueryStringQuery |
class |
CoreRegexpQuery |
class |
CoreSearchRequest |
class |
CoreTermQuery |
class |
CoreTermRangeQuery |
class |
CoreWildcardQuery |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreAbstractSearchFacetResult |
class |
CoreDateRangeSearchFacetResult |
class |
CoreNumericRangeSearchFacetResult |
class |
CoreReactiveSearchResult |
class |
CoreSearchDateRange
A range (or bucket) for a
CoreDateRangeSearchFacetResult. |
interface |
CoreSearchFacetResult |
class |
CoreSearchMetrics |
class |
CoreSearchNumericRange |
class |
CoreSearchResult |
class |
CoreSearchRowLocation |
class |
CoreSearchRowLocations |
class |
CoreSearchStatus |
class |
CoreSearchTermRange |
class |
CoreTermSearchFacetResult |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreSearchFieldMissing |
class |
CoreSearchFieldMode |
class |
CoreSearchFieldType |
class |
CoreSearchGeoDistanceUnits |
class |
CoreSearchSort |
class |
CoreSearchSortField |
class |
CoreSearchSortGeoDistance |
class |
CoreSearchSortId |
class |
CoreSearchSortScore |
class |
CoreSearchSortString
A sort tier specified as a string.
|
| Modifier and Type | Class and Description |
|---|---|
class |
SearchCapabilityCheck |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreVectorQuery |
class |
CoreVectorQueryCombination |
class |
CoreVectorSearch |
class |
CoreVectorSearchOptions |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreMutationState |
| Modifier and Type | Interface and Description |
|---|---|
interface |
BeforeSendRequestCallback
This callback is executed once an operation reaches the core and gets sent to a node.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ClassicExpiryHelper |
class |
ClassicHelper |
| Modifier and Type | Class and Description |
|---|---|
class |
BinaryAccessor |
class |
ClassicCoreKvBinaryOps |
class |
ClassicCoreKvOps |
| Modifier and Type | Class and Description |
|---|---|
class |
ClassicCoreBucketManager |
class |
ClassicCoreCollectionManagerOps |
| Constructor and Description |
|---|
CoreBucketSettingsJson(String name,
Map<String,String> controllers,
Map<String,Long> quota,
int numReplicas,
boolean replicaIndex,
int maxTTL,
CoreCompressionMode compressionMode,
BucketType bucketType,
CoreConflictResolutionType conflictResolutionType,
CoreEvictionPolicyType evictionPolicy,
String durabilityMinLevel,
CoreStorageBackend storageBackend,
Boolean historyRetentionCollectionDefault,
Long historyRetentionBytes,
Long historyRetentionDurationSeconds) |
| Modifier and Type | Class and Description |
|---|---|
class |
ClassicCoreQueryMetaData |
class |
ClassicCoreQueryMetrics |
class |
ClassicCoreQueryOps |
class |
ClassicCoreQueryResult |
class |
ClassicCoreReactiveQueryResult |
class |
EnhancedPreparedStatementStrategy
Server remembers query plan; client sends just the prepared statement name.
|
class |
LegacyPreparedStatementStrategy
Client remembers query plan and sends it on every request.
|
class |
PreparedStatementStrategy |
| Modifier and Type | Method and Description |
|---|---|
static com.couchbase.client.core.deps.com.fasterxml.jackson.databind.node.ObjectNode |
ClassicCoreQueryOps.convertOptions(CoreQueryOptions opts) |
static ClassicCoreQueryMetaData |
ClassicCoreQueryMetaData.from(QueryChunkHeader header,
QueryChunkTrailer trailer) |
| Constructor and Description |
|---|
ClassicCoreQueryMetaData(QueryChunkHeader header,
QueryChunkTrailer trailer) |
ClassicCoreReactiveQueryResult(QueryResponse response,
NodeIdentifier lastDispatchedTo) |
| Modifier and Type | Class and Description |
|---|---|
class |
CbTracing |
class |
OrphanReporter |
class |
SimpleEventBus
This super simple event bus should be used in testing only to assert certain
events got pushed through.
|
class |
TracingIdentifiers
Holds static tracing and metrics identifiers throughout the SDK.
|
| Modifier and Type | Method and Description |
|---|---|
default void |
RequestSpan.lowCardinalityAttribute(String key,
boolean value)
Sets a low-cardinality attribute on the span, which is translated to the corresponding implementation specific tag.
|
default void |
RequestSpan.lowCardinalityAttribute(String key,
long value)
Sets a low-cardinality attribute on the span, which is translated to the corresponding implementation specific tag.
|
default void |
RequestSpan.lowCardinalityAttribute(String key,
String value)
Sets a low-cardinality attribute on the span, which is translated to the corresponding implementation specific tag.
|
void |
RequestSpan.requestContext(RequestContext requestContext)
Allows to set a request context to the request span.
|
| Constructor and Description |
|---|
OrphanReporter(EventBus eventBus,
OrphanReporterConfig config)
Creates a new
OrphanReporter. |
| Modifier and Type | Class and Description |
|---|---|
class |
EndpointDisconnectDelayedEvent
This event is generated when an endpoint disconnect was delayed because it is still in use
|
class |
EndpointDisconnectResumedEvent
This event is generated when an endpoint disconnect was delayed, but is now about to be disconnected
|
| Modifier and Type | Class and Description |
|---|---|
class |
UnknownServerPushRequestReceivedEvent |
| Constructor and Description |
|---|
TransactionLogEvent(long timestamp,
long threadId,
String threadName,
String transactionId,
String secondaryId,
String fmt,
Object[] values,
Event.Severity level) |
| Modifier and Type | Class and Description |
|---|---|
class |
NameAndTags
Helper class which consolidates names and tags for caching purposes.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ConfigRefreshFailure |
interface |
ConfigurationProvider
The
ConfigurationProvider is responsible for grabbing, converting and managing
bucket and cluster configurations. |
class |
ConfigVersion |
class |
KetamaRing<E>
A
Ketama ring
(or "continuum", if you prefer) with Couchbase-specific parameters defined by
Couchbase SDK RFC 26 (Ketama Hashing)
|
| Modifier and Type | Method and Description |
|---|---|
void |
ClusterConfig.deleteBucketConfig(String bucketName) |
void |
ClusterConfig.deleteGlobalConfig() |
void |
ClusterConfig.setBucketConfig(BucketConfig config) |
void |
ClusterConfig.setGlobalConfig(GlobalConfig config) |
| Modifier and Type | Class and Description |
|---|---|
class |
KeyValueBucketRefresher
The
KeyValueBucketRefresher keeps configs up-to-date through the KV service. |
| Modifier and Type | Class and Description |
|---|---|
class |
HealthPinger
The
HealthPinger allows to "ping" individual services with real operations for their health. |
class |
InternalEndpointDiagnostics |
class |
WaitUntilReadyHelper
Helper class to perform the "wait until ready" logic.
|
static interface |
WaitUntilReadyHelper.WaitUntilReadyLogger |
static class |
WaitUntilReadyHelper.WaitUntilReadyState
Encapsulates the state of where a wait until ready flow is in.
|
| Modifier and Type | Method and Description |
|---|---|
static Mono<PingResult> |
HealthPinger.ping(Core core,
Optional<Duration> timeout,
RetryStrategy retryStrategy,
Set<ServiceType> serviceTypes,
Optional<String> reportId,
Optional<String> bucketName) |
static Mono<PingResult> |
HealthPinger.ping(Core core,
Optional<Duration> timeout,
RetryStrategy retryStrategy,
Set<ServiceType> serviceTypes,
Optional<String> reportId,
Optional<String> bucketName,
WaitUntilReadyHelper.WaitUntilReadyLogger log)
Performs a service ping against all or (if given) the services provided.
|
| Constructor and Description |
|---|
DiagnosticsResult(Map<ServiceType,List<EndpointDiagnostics>> endpoints,
String sdk,
String id)
Creates the new diagnostics report.
|
EndpointDiagnostics(ServiceType type,
EndpointState state,
CircuitBreaker.State circuitBreakerState,
String local,
String remote,
Optional<String> namespace,
Optional<Long> lastActivityUs,
Optional<String> id,
Optional<Throwable> lastConnectAttemptFailure) |
EndpointPingReport(ServiceType type,
String id,
String local,
String remote,
PingState state,
Optional<String> namespace,
Duration latency,
Optional<String> error) |
PingResult(Map<ServiceType,List<EndpointPingReport>> endpoints,
String sdk,
String id)
Creates the new ping report.
|
| Modifier and Type | Class and Description |
|---|---|
class |
MultiAddressNameResolverFactory |
class |
ProtostellarPool
Maintains a pool of ProtostellarEndpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AuthenticationStatus |
EndpointContext.authenticationStatus() |
void |
EndpointContext.authenticationStatus(AuthenticationStatus authenticationStatus) |
void |
BaseEndpoint.decrementOutstandingRequests()
Helper method to decrement outstanding requests, even if they haven't finished yet.
|
InternalEndpointDiagnostics |
Endpoint.internalDiagnostics() |
long |
BaseEndpoint.lastConnectedAt() |
void |
QueryEndpoint.markRequestCompletion() |
void |
BaseEndpoint.markRequestCompletion()
Called from the event loop handlers to mark a request as being completed.
|
void |
BaseEndpoint.notifyChannelInactive()
This method is called from inside the channel to tell the endpoint hat it got inactive.
|
CompletableFuture<Void> |
ProtostellarEndpoint.waitUntilReady(Deadline deadline,
boolean waitingForReady)
Waits until the ManagedChannel is in READY state.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
CoreCommonOptions |
class |
CoreHttpClient |
class |
CoreHttpPath
The "path" component of a URI, with support for path parameters
whose replacement values are automatically url-encoded.
|
class |
CoreHttpRequest |
static class |
CoreHttpRequest.Builder
Builder for dynamic HTTP requests
|
class |
CoreHttpResponse |
| Modifier and Type | Class and Description |
|---|---|
class |
CouchbaseForkPoolThreadFactory |
class |
CouchbaseThreadFactory |
static class |
LoggerConfig.Defaults |
static class |
LoggingMeterConfig.Defaults |
static class |
OrphanReporterConfig.Defaults |
class |
OwnedSupplier<T>
A special supplier which allows the SDK to distinguish passed in suppliers vs.
|
interface |
RequestCallback
Marker interface for different callbacks in the request lifecycle.
|
static class |
SecurityConfig.Defaults |
static class |
SecurityConfig.InternalMethods |
static class |
ThresholdLoggingTracerConfig.Defaults |
static class |
ThresholdRequestTracerConfig.Defaults
Deprecated.
|
| Modifier and Type | Field and Description |
|---|---|
static int |
IoEnvironment.DEFAULT_EVENT_LOOP_THREAD_COUNT |
| Modifier and Type | Method and Description |
|---|---|
SELF |
CoreEnvironment.Builder.addRequestCallback(RequestCallback requestCallback)
Allows to configure callbacks across the lifetime of a request.
|
default void |
Authenticator.applyTlsProperties(com.couchbase.client.core.deps.io.netty.handler.ssl.SslContextBuilder sslContextBuilder)
The authenticator gets the chance to attach the client certificate to the ssl context if needed.
|
default void |
Authenticator.authHttpRequest(ServiceType serviceType,
com.couchbase.client.core.deps.io.netty.handler.codec.http.HttpRequest request)
Allows to add authentication credentials to the http request for the given service.
|
default void |
Authenticator.authKeyValueConnection(EndpointContext endpointContext,
com.couchbase.client.core.deps.io.netty.channel.ChannelPipeline pipeline)
Allows the authenticator to add KV handlers during connection bootstrap to perform
authentication.
|
IoEnvironment |
IoEnvironment.Builder.build() |
Executor |
CoreEnvironment.executor()
Returns the executor used to schedule non-reactive async tasks across the SDK.
|
Map<String,Object> |
TimerConfig.exportAsMap() |
static ThresholdRequestTracerConfig.Builder |
ThresholdRequestTracerConfig.Builder.fromNewBuilder(ThresholdLoggingTracerConfig.Builder newBuilder)
Deprecated.
|
com.couchbase.client.core.deps.io.grpc.CallCredentials |
Authenticator.protostellarCallCredentials() |
com.couchbase.client.core.deps.io.grpc.CallCredentials |
CertificateAuthenticator.protostellarCallCredentials() |
List<RequestCallback> |
CoreEnvironment.requestCallbacks() |
default boolean |
Authenticator.supportsNonTls()
If this authenticator supports non-encrypted connections.
|
default boolean |
Authenticator.supportsTls()
If this authenticator supports encrypted connections.
|
ThresholdLoggingTracerConfig.Builder |
ThresholdRequestTracerConfig.Builder.toNewBuillder()
Deprecated.
Converts this deprecated builder into its non-deprecated version.
|
SELF |
CoreEnvironment.Builder.transactionsConfig(CoreTransactionsConfig transactionsConfig)
Allows configuring the transactions config.
|
| Constructor and Description |
|---|
OwnedSupplier(T value) |
| Modifier and Type | Class and Description |
|---|---|
class |
BucketNotFoundDuringLoadException
Exception raised if during config load the bucket is not found (think: http 404).
|
class |
BucketNotReadyDuringLoadException
Exception raised if during config load the bucket is found, but not deemed ready yet.
|
class |
DefaultErrorUtil |
class |
HttpStatusCodeException |
class |
IndexesNotReadyException |
class |
NoAccessDuringConfigLoadException |
class |
RangeScanPartitionFailedException
This is an internal exception used to signal exceptional states in the range scan orchestrator.
|
class |
StacklessCompletionException
Internal optimisation to avoid the cost of completableFuture.completeExceptionally() creating a CompletionException
(including expensive stack creation).
|
class |
UnsupportedConfigMechanismException |
| Modifier and Type | Method and Description |
|---|---|
byte[] |
AnalyticsException.content() |
static List<ErrorCodeAndMessage> |
ErrorCodeAndMessage.from(byte[] content) |
static List<ErrorCodeAndMessage> |
ErrorCodeAndMessage.fromJsonArray(byte[] jsonArray) |
boolean |
PreparedStatementFailureException.retryable() |
| Constructor and Description |
|---|
BucketExistsException(String bucketName,
ErrorContext context) |
CollectionExistsException(String collectionName,
ErrorContext context) |
CouchbaseException(String message,
Throwable cause,
boolean enableSuppression,
boolean writableStacktrace,
ErrorContext ctx) |
InternalServerFailureException(Throwable cause,
ErrorContext ctx) |
RequestCanceledException(String message,
CancellationReason reason,
Throwable cause,
CancellationErrorContext ctx) |
ScopeExistsException(String scopeName,
ErrorContext context) |
ScopeNotFoundException(String scopeName,
ErrorContext context) |
| Modifier and Type | Method and Description |
|---|---|
void |
GenericErrorContext.put(String key,
Object value) |
| Modifier and Type | Class and Description |
|---|---|
class |
DocumentAlreadyAliveException
Sub-Document exception thrown when ReviveDocument has been used with a document that already exists
|
| Modifier and Type | Class and Description |
|---|---|
class |
RetryTransactionException
Indicates that this transaction should be retried.
|
class |
TransactionOperationFailedException
This operation (such as a replace, get or insert) either failed or ambiguously succeeded.
|
static class |
TransactionOperationFailedException.FinalErrorToRaise |
| Modifier and Type | Method and Description |
|---|---|
boolean |
TransactionOperationFailedException.autoRollbackAttempt() |
boolean |
TransactionOperationFailedException.retryTransaction() |
TransactionOperationFailedException.FinalErrorToRaise |
TransactionOperationFailedException.toRaise() |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreTransactionCommitAmbiguousException
The transaction expired at the point of trying to commit it.
|
class |
CoreTransactionExpiredException
The transaction could not be fully completed in the configured timeout.
|
class |
CoreTransactionFailedException
The transaction failed to reach the Committed point.
|
class |
ForwardCompatibilityRequiresRetryException |
class |
RetryAtrCommitException
Indicates that committing the ATR entry should be retried.
|
class |
RetryOperationException
Indicates that this operation should be retried.
|
class |
TestFailAmbiguousException
Used only in testing: injects an error that will be handled as FAIL_AMBIGUOUS.
|
class |
TestFailHardException
Used only in testing: injects an error that will be handled as FAIL_HARD.
|
class |
TestFailOtherException
Used only in testing: injects an error that will be handled as FAIL_OTHER.
|
class |
TestFailTransientException
Used only in testing: injects a FAIL_TRANSIENT error.
|
class |
ThreadStopRequestedException |
interface |
WrappedTransactionOperationFailedException
TransactionOperationFailedException is raised as an opaque signal that something went wrong with a transaction
operation.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CollectionIdentifier
The
CollectionIdentifier uniquely identifies the position of a collection. |
| Modifier and Type | Class and Description |
|---|---|
class |
SslHandlerFactory
This factory creates
SslHandler based on a given configuration. |
class |
TracingUtils
Contains various utils to set attributes for tracing spans.
|
| Modifier and Type | Method and Description |
|---|---|
static List<String> |
SslHandlerFactory.defaultCiphers(boolean nativeTlsEnabled)
Lists the default ciphers used for this platform.
|
static boolean |
SslHandlerFactory.opensslAvailable()
True if the native ssl transport is available, false otherwise.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ErrorMapLoadingHandler
This handler tries to load the KV Error Map in a best effort manner.
|
class |
FeatureNegotiatingHandler
The
FeatureNegotiatingHandler is responsible for sending the KV "hello" command
and to handshake enabled features on both sides. |
class |
SaslListMechanismsHandler
The
SaslListMechanismsHandler asks the server KV engine which SASL mechanism it supports. |
class |
SelectBucketHandler
The
SelectBucketHandler is responsible for, selecting the right
bucket on this KV connection. |
class |
ServerFeature
Describes all the different negotiation modes
between the server and the SDK.
|
| Modifier and Type | Method and Description |
|---|---|
Set<SaslMechanism> |
SaslAuthenticationHandler.allowedMechanisms()
Returns the allowed mechanisms for this handler, useful for testing assertions.
|
| Constructor and Description |
|---|
KeyValueChannelContext(CompressionConfig compression,
Optional<String> bucket,
CollectionMap collectionMap,
com.couchbase.client.core.deps.io.netty.channel.ChannelId channelId,
Set<ServerFeature> features) |
| Modifier and Type | Class and Description |
|---|---|
class |
Mapper
Provides utilities for encoding and decoding JSON data.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
CoreRangeScan
Performs a KV range scan to scan between two
CoreScanTerms. |
interface |
CoreSamplingScan
Performs a KV range scan using random sampling.
|
interface |
CoreScanOptions
Allows to customize the various range and sampling scan options.
|
class |
CoreScanTerm
A single
CoreScanTerm identifying either the point to scan from or to scan to. |
interface |
CoreScanType
Either RangeScan or SampleScan
|
class |
RangeScanOrchestrator
Main entry point from higher level languages to perform KV range scans.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CoreAnalyticsLinkManager |
class |
CoreBucketManager
Deprecated.
|
interface |
CoreBucketManagerOps |
interface |
CoreCollectionManager |
class |
CoreCollectionQueryIndexManager |
class |
CoreEventingFunctionManager
Encapsulates common functionality around the eventing management APIs.
|
class |
CoreQueryIndexManager |
class |
CoreQueryType |
class |
CoreViewIndexManager |
| Modifier and Type | Interface and Description |
|---|---|
interface |
CoreBucketSettings |
class |
CoreCompressionMode |
class |
CoreConflictResolutionType |
interface |
CoreCreateBucketSettings |
class |
CoreEvictionPolicyType |
class |
CoreStorageBackend |
| Modifier and Type | Method and Description |
|---|---|
String |
CoreStorageBackend.alias() |
String |
CoreCompressionMode.alias() |
String |
CoreEvictionPolicyType.alias() |
static CoreStorageBackend |
CoreStorageBackend.of(String alias) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
CoreCreateOrUpdateCollectionSettings |
| Modifier and Type | Class and Description |
|---|---|
class |
RequestTarget |
| Modifier and Type | Method and Description |
|---|---|
RequestContext |
RequestContext.clientContext(Map<String,Object> clientContext)
Allows to set a custom payload for this request.
|
RequestContext |
RequestContext.dispatchLatency(long dispatchLatency)
Allows to set the dispatch duration of the request.
|
RequestContext |
RequestContext.encodeLatency(long encodeLatency) |
RequestContext |
RequestContext.incrementRetryAttempts(Duration lastRetryDuration,
RetryReason reason) |
RequestContext |
RequestContext.lastChannelId(String lastChannelId) |
RequestContext |
RequestContext.lastDispatchedFrom(HostAndPort lastDispatchedFrom) |
RequestContext |
RequestContext.lastDispatchedTo(HostAndPort lastDispatchedTo) |
NodeIdentifier |
RequestContext.lastDispatchedToNode() |
RequestContext |
RequestContext.lastDispatchedToNode(NodeIdentifier lastDispatchedToNode) |
RequestContext |
RequestContext.logicallyComplete() |
RequestContext |
RequestContext.logicallyComplete(Throwable err)
Signals that this request is completed fully, including streaming sections or logical sub-requests also being
completed (i.e.
|
RequestContext |
RequestContext.serverLatency(long serverLatency) |
| Constructor and Description |
|---|
RequestContext(CoreContext ctx,
Request<? extends Response> request) |
RequestContext(Core core,
long contextId,
CoreEnvironment environment,
Authenticator authenticator,
Request<? extends Response> request) |
| Modifier and Type | Class and Description |
|---|---|
class |
GetResponse
Represents the response of a
GetRequest. |
class |
MutationTokenAggregator
Helper class that language-specific clients may use to implement
MutationState. |
class |
RangeScanCancelRequest |
class |
RangeScanCancelResponse |
class |
SubDocumentField |
| Modifier and Type | Method and Description |
|---|---|
byte |
DurabilityLevel.code() |
static DurabilityLevel |
DurabilityLevel.decodeFromManagementApi(String input)
Decodes the string representation of the durability level from the management API into an enum.
|
String |
DurabilityLevel.encodeForManagementApi()
Encodes the
DurabilityLevel so that the management API understands it. |
| Modifier and Type | Method and Description |
|---|---|
void |
BucketConfigStreamingResponse.completeStream() |
void |
BucketConfigStreamingResponse.failStream(Throwable e) |
void |
BucketConfigStreamingResponse.pushConfig(String config) |
| Modifier and Type | Class and Description |
|---|---|
class |
PreparedStatement
Prepared statement cache entry.
|
| Modifier and Type | Method and Description |
|---|---|
QueryRequest |
QueryRequest.toExecuteRequest(String preparedStatementName,
String encodedPlan,
RequestTracer requestTracer)
Returns a copy of this request tailored to execute a prepared statement.
|
QueryRequest |
QueryRequest.toPrepareRequest(boolean autoExecute,
RequestTracer requestTracer)
Returns a new request that creates a prepared statement using this request as a template.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
MemcachedHashingStrategy
This interface defines different hashing strategies used for ketama hashing in memcached buckets.
|
| Modifier and Type | Method and Description |
|---|---|
Stream<InternalEndpointDiagnostics> |
Node.internalDiagnostics() |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreProtostellarErrorHandlingUtil |
class |
CoreProtostellarUtil |
interface |
GrpcAwareRequestTracer |
class |
ProtostellarCollectionManagerRequest<TGrpcRequest> |
class |
ProtostellarContext |
class |
ProtostellarKeyValueRequest<TGrpcRequest> |
class |
ProtostellarRequest<TGrpcRequest>
Holds onto a GRPC request, along with pertaining mutable and immutable state bound to the request's lifetime.
|
class |
ProtostellarStatsCollector |
| Constructor and Description |
|---|
ProtostellarBaseRequest(CoreProtostellar core,
ProtostellarRequest<?> request) |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreProtostellarKeyValueRequests
For creating Protostellar GRPC KV requests.
|
class |
CoreProtostellarKeyValueResponses
For converting Protostellar GRPC KV responses.
|
class |
CoreProtoStellarKvBinaryRequests |
class |
CoreProtostellarKvBinaryResponses
For converting Protostellar GRPC KV responses.
|
class |
ProtostellarCoreEncodedContent |
class |
ProtostellarCoreKvBinaryOps |
class |
ProtostellarCoreKvOps |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreProtostellarCollectionManagerRequests
For creating Protostellar GRPC requests.
|
class |
CoreProtostellarCollectionManagerResponses
For converting Protostellar GRPC responses.
|
class |
ProtostellarCoreBucketManager |
class |
ProtostellarCoreBucketManagerRequests |
class |
ProtostellarCoreCollectionManagerOps |
| Modifier and Type | Class and Description |
|---|---|
class |
ProtostellarCoreQueryMetaData |
class |
ProtostellarCoreQueryMetrics |
class |
ProtostellarCoreQueryOps |
class |
ProtostellarCoreReactiveQueryResult |
| Modifier and Type | Class and Description |
|---|---|
class |
ProtostellarCoreSearchOps |
| Modifier and Type | Class and Description |
|---|---|
class |
AuthErrorDecider |
class |
FailFastRetryStrategy
An internal strategy to fail fast any request that goes through it.
|
class |
ProtostellarRequestBehaviour
Determines what to do with a request.
|
class |
RetryOrchestrator
The
RetryOrchestrator is responsible for checking if a request is eligible for retry
and if so dispatch it properly and update state. |
class |
RetryOrchestratorProtostellar |
| Modifier and Type | Method and Description |
|---|---|
static Duration |
RetryOrchestratorProtostellar.capDuration(Duration uncappedDuration,
ProtostellarRequest<?> request) |
static Duration |
RetryOrchestrator.capDuration(Duration uncappedDuration,
Request<? extends Response> request)
Calculates the potentially capped retry duration so we do not schedule a longer retry than the actual
total timeout.
|
static Duration |
RetryOrchestrator.controlledBackoff(int retryAttempt)
Helper method for a simple, bounded controlled backoff for the "always retry" handler so that it doesn't spam
quickly all the time.
|
| Modifier and Type | Method and Description |
|---|---|
Stream<InternalEndpointDiagnostics> |
Service.internalDiagnostics() |
| Modifier and Type | Class and Description |
|---|---|
class |
ReplicaHelper |
| Modifier and Type | Class and Description |
|---|---|
class |
AccessorUtil |
class |
CoreTransactionAttemptContext
Provides methods to allow an application's transaction logic to read, mutate, insert and delete documents, as well
as commit or rollback the transaction.
|
class |
CoreTransactionContext
Stores some context related to a transaction.
|
class |
CoreTransactionGetResult
Represents a value fetched from Couchbase, along with additional transactional metadata.
|
class |
CoreTransactionResult |
class |
CoreTransactionsReactive |
| Modifier and Type | Method and Description |
|---|---|
static CoreTransactionGetResult |
CoreTransactionGetResult.createFrom(CollectionIdentifier collection,
String documentId,
SubdocGetResponse doc) |
static CoreTransactionGetResult |
CoreTransactionGetResult.createFrom(CoreTransactionGetResult doc,
byte[] content) |
| Constructor and Description |
|---|
CoreTransactionGetResult(String id,
byte[] content,
int userFlags,
long cas,
CollectionIdentifier collection,
TransactionLinks links,
Optional<DocumentMetadata> documentMetadata,
Optional<com.couchbase.client.core.deps.com.fasterxml.jackson.databind.JsonNode> txnMeta,
Optional<String> crc32OfGet)
Note that it's intentionally obfuscated here as to whether both content and userFlags come from the document's current body, or staged in the transactional metadata.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ActiveTransactionRecordIds |
| Modifier and Type | Class and Description |
|---|---|
class |
ActiveTransactionRecordStats
Simple data class, so all fields are public.
|
class |
CleanerFactory
Used for testing/mocking.
|
class |
CleanerHooks |
class |
CleanerMockFactory
Used for testing/mocking.
|
class |
CleanupRequest |
class |
ClientRecord
Represents the ClientRecord doc, a single document that contains an entry for every client (app) current
participating
in the cleanup of 'lost' transactions.
|
class |
ClientRecordDetails
Utility class to store the result of a client checking/updating the Client Record doc.
|
class |
ClientRecordFactory
Used for testing/mocking.
|
class |
ClientRecordFactoryMock
Used for testing/mocking.
|
class |
CoreTransactionsCleanup
Owns cleanup threads.
|
class |
LostCleanupDistributed
Runs the algorithm to find 'lost' transactions, distributing the work between clients.
|
class |
TransactionsCleaner
Handles cleaning up expired/lost transactions.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ActiveTransactionRecord |
static class |
ActiveTransactionRecord.ParsedHLC |
class |
ActiveTransactionRecordEntry |
class |
ActiveTransactionRecords |
class |
ActiveTransactionRecordUtil |
class |
CasMode
Metadata related to the CAS.
|
class |
DocRecord |
class |
DocumentGetter
Responsible for doing transaction-aware get()s.
|
class |
DocumentMetadata
Stores some $document metadata from when the document is fetched
|
class |
DurabilityLevelUtil |
class |
OperationTypes |
class |
TransactionLinks
Stores the transaction links stored on each document in a transaction
|
| Modifier and Type | Method and Description |
|---|---|
Optional<byte[]> |
TransactionLinks.stagedContentBinary() |
Optional<byte[]> |
TransactionLinks.stagedContentJson() |
Optional<byte[]> |
TransactionLinks.stagedContentJsonOrBinary() |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreMergedTransactionConfig
Merges
CoreTransactionOptions and CoreTransactionsConfig. |
class |
CoreSingleQueryTransactionOptions |
class |
CoreTransactionOptions
Tunables for an individual transaction.
|
class |
CoreTransactionsCleanupConfig |
class |
CoreTransactionsConfig |
| Modifier and Type | Method and Description |
|---|---|
static CoreTransactionsCleanupConfig |
CoreTransactionsCleanupConfig.createDefault() |
static CoreTransactionsConfig |
CoreTransactionsConfig.createDefault() |
| Modifier and Type | Class and Description |
|---|---|
class |
CoreTransactionsContext
Holds transactions state that has the same lifetime as a Core.
|
class |
CoreTransactionsCounters |
| Modifier and Type | Class and Description |
|---|---|
class |
ErrorClass |
| Modifier and Type | Class and Description |
|---|---|
class |
Extension
All protocol extensions known about by this implementation.
|
class |
ForwardCompatibility
A mechanism to help ensure that older clients can be prevented from interacting with transactions created by future
clients that they do not know how to process.
|
class |
ForwardCompatibilityStage
Points in the protocol where forward compatibility can be checked.
|
class |
Supported
Defines what is support by this implementation (extensions and protocol version).
|
| Modifier and Type | Class and Description |
|---|---|
class |
CoreTransactionLogger
A logger optimized for logging transactions-specific info.
|
class |
SimpleEventBusLogger
Simple wrapper around logging to the Couchbase event bus.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AttemptState
The possible states for a transaction attempt.
|
class |
OptionsUtil |
class |
SpanWrapper
Wraps a RequestSpan, with the value-add that it automatically records how long the operation took for
transaction logging.
|
class |
SpanWrapperUtil |
class |
StagedMutation |
class |
StagedMutationType |
class |
TransactionAttemptContextFactory |
class |
TransactionFields |
| Modifier and Type | Class and Description |
|---|---|
class |
TransactionMarker
Used to indicate that we are inside a transaction, and placed in ThreadLocalStorage (or reactive context).
|
class |
TransactionMarkerOwner
Used to manage ThreadLocalStorage (or reactive context) of TransactionMarker.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CoreTransactionAttemptContextHooks
Can be used for testing transactions, but is for internal use only.
|
class |
CoreTransactionsSchedulers
Mainly to aid debugging, transactions use their own pool of schedulers.
|
class |
DebugUtil |
class |
LockTokens |
class |
LogDeferDocId |
class |
LogDeferThrowable |
class |
MeteringUnits
Tracks read and write units used.
|
static class |
MeteringUnits.MeteringUnitsBuilder |
class |
MonoBridge<T>
Protects against concurrent op cancellation.
|
class |
QueryUtil |
class |
ReactiveLock
A mutex pessimistic lock, compatible with reactive.
|
class |
ReactiveWaitGroup
Provides locking functionality in line with Go's WaitGroups, in a reactive compatible way.
|
class |
TestTransactionAttemptContextFactory
Can be used for testing transactions, but is for internal use only.
|
class |
TransactionKVHandler
Transactions does a lot of KV work from core-io.
|
interface |
TriFunction<T,U,V,R> |
| Modifier and Type | Class and Description |
|---|---|
class |
BucketConfigUtil
Defines helpful routines for working with bucket configs.
|
class |
CbAnnotations |
class |
CbCollections |
class |
CbObjects |
class |
CbPreconditions |
class |
CbStrings |
class |
CbThrowables |
class |
ClusterCapabilitiesUtil
Defines helpful routines for working with cluster capabilities.
|
class |
ClusterCleanupTask |
static class |
ConnectionString.PortType |
class |
ConnectionStringUtil
Contains various helper methods when dealing with the connection string.
|
class |
ConsistencyUtil
Helper routines for tests to wait for all nodes to have a consistent view of a resource.
|
class |
CoreAsyncUtils |
class |
CoreIdGenerator |
class |
CouchbaseBlockHoundIntegration
Integrates the Couchbase infrastructure with
BlockHound. |
class |
Deadline |
class |
DnsSrv
The default implementation for performing DNS SRV lookups.
|
class |
DnsSrvResolver |
class |
EnumLookupTable<E extends Enum<E>>
Provides efficient lookup for enums whose values are associated with small integers.
|
interface |
IntMap<E>
A read-only map where the keys are non-negative integers.
|
class |
Jdk8Cleaner
Approximates Java 9's
java.lang.ref.Cleaner
|
class |
LatestStateSubscription<T>
Useful when only the latest value of a Flux is interesting,
and processing values is relatively expensive.
|
class |
NanoTimestamp |
class |
NetworkAddress
A convenient wrapper class around network primitives in Java.
|
interface |
PreventsGarbageCollection
Indicates that at least one purpose of the annotated field
is to prevent the value from being garbage collected.
|
class |
ProtostellarUtil |
class |
UrlQueryStringBuilder |
| Modifier and Type | Method and Description |
|---|---|
static NetworkAddress |
NetworkAddress.create(String input)
Creates a new
NetworkAddress from either a hostname or ip address literal. |
static List<String> |
ConnectionStringUtil.fromDnsSrvOrThrowIfTlsRequired(String serviceName,
boolean secure) |
String |
NetworkAddress.hostname()
Returns the hostname for this network address.
|
ConnectionString |
ConnectionString.withParams(Map<String,String> params) |
ConnectionString |
ConnectionString.withScheme(ConnectionString.Scheme scheme) |
Copyright © 2024 Couchbase, Inc.. All rights reserved.