Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AdaptiveBackoff - Class in com.cockroachlabs.crdb.retry
-
Computes backoff delays that adapt to observed contention.
- AdaptiveBackoff(RetryPolicy) - Constructor for class com.cockroachlabs.crdb.retry.AdaptiveBackoff
-
Uses
ThreadLocalRandomfor jitter. - AdaptiveBackoff(RetryPolicy, DoubleSupplier) - Constructor for class com.cockroachlabs.crdb.retry.AdaptiveBackoff
- addListener(CrdbEventListener) - Static method in class com.cockroachlabs.crdb.observe.CrdbEvents
- aegis(AegisConfig) - Static method in class com.cockroachlabs.crdb.Crdb
-
Cockroach Aegis client (autonomous-ops findings/recommendations + exhaust).
- AegisClient - Interface in com.cockroachlabs.crdb.spi
-
Cockroach Aegis client: read-first access to autonomous-ops findings and recommendations, plus an
AegisClient.emit(AppEvent)channel for app telemetry. - AegisConfig - Record Class in com.cockroachlabs.crdb.spi
-
Configuration for the Cockroach Aegis client.
- AegisConfig(boolean, String, String) - Constructor for record class com.cockroachlabs.crdb.spi.AegisConfig
-
Creates an instance of a
AegisConfigrecord class. - AegisFactory - Interface in com.cockroachlabs.crdb.spi
-
SPI for creating
AegisClientinstances. - agent() - Static method in class com.cockroachlabs.crdb.Crdb
-
Agent / MCP surface.
- AgentTool - Annotation Interface in com.cockroachlabs.crdb.annotations
-
Marks the annotated method as an agent-callable tool.
- anomaly() - Method in exception class com.cockroachlabs.crdb.anomaly.CrdbException
-
The typed anomaly this exception carries.
- AnomalyClassifier - Class in com.cockroachlabs.crdb.anomaly
-
Maps raw
SQLExceptions onto the typedCrdbAnomalyhierarchy and decides retryability, based on SQLSTATE. - AppEvent - Record Class in com.cockroachlabs.crdb.spi
-
An application-level operational signal emitted to Cockroach Aegis (the "exhaust").
- AppEvent(String, String, Map, long) - Constructor for record class com.cockroachlabs.crdb.spi.AppEvent
-
Creates an instance of a
AppEventrecord class. - attempts() - Method in record class com.cockroachlabs.crdb.anomaly.RetryExhausted
-
Returns the value of the
attemptsrecord component. - attrs() - Method in record class com.cockroachlabs.crdb.spi.AppEvent
-
Returns the value of the
attrsrecord component.
B
- baseDelayMillis() - Element in annotation interface com.cockroachlabs.crdb.annotations.CrdbRetry
-
Base delay between attempts, in milliseconds.
- baseDelayMillis() - Method in record class com.cockroachlabs.crdb.retry.RetryPolicy
-
Returns the value of the
baseDelayMillisrecord component. - bytes() - Method in record class com.cockroachlabs.crdb.spi.TableStorage
-
Returns the value of the
bytesrecord component.
C
- call() - Method in interface com.cockroachlabs.crdb.proxy.OriginalCall
- call(Callable) - Method in class com.cockroachlabs.crdb.vcluster.VirtualClusterScope
-
Run
bodywith this vCluster context bound. - cause() - Method in record class com.cockroachlabs.crdb.anomaly.ConnectionAnomaly
-
Returns the value of the
causerecord component. - cause() - Method in record class com.cockroachlabs.crdb.anomaly.SerializationConflict
-
Returns the value of the
causerecord component. - cause() - Method in record class com.cockroachlabs.crdb.anomaly.UnknownAnomaly
-
Returns the value of the
causerecord component. - CircuitBreaker - Class in com.cockroachlabs.crdb.circuit
-
A thread-safe circuit breaker.
- CircuitBreaker - Annotation Interface in com.cockroachlabs.crdb.annotations
-
Wraps the annotated method in a circuit breaker.
- CircuitBreaker(int, long) - Constructor for class com.cockroachlabs.crdb.circuit.CircuitBreaker
- CircuitBreaker(int, long, LongSupplier) - Constructor for class com.cockroachlabs.crdb.circuit.CircuitBreaker
- circuitFailureThreshold() - Method in record class com.cockroachlabs.crdb.config.CrdbConfig
-
Returns the value of the
circuitFailureThresholdrecord component. - CircuitOpen - Record Class in com.cockroachlabs.crdb.anomaly
-
Signals that a circuit breaker is OPEN and the call was rejected without being attempted.
- CircuitOpen(int) - Constructor for record class com.cockroachlabs.crdb.anomaly.CircuitOpen
-
Creates an instance of a
CircuitOpenrecord class. - circuitOpens() - Method in record class com.cockroachlabs.crdb.observe.CrdbStats
-
Returns the value of the
circuitOpensrecord component. - circuitResetMillis() - Method in record class com.cockroachlabs.crdb.config.CrdbConfig
-
Returns the value of the
circuitResetMillisrecord component. - classify(SQLException) - Static method in class com.cockroachlabs.crdb.anomaly.AnomalyClassifier
-
Classify a
SQLExceptioninto a typedCrdbAnomaly. - clearListeners() - Static method in class com.cockroachlabs.crdb.observe.CrdbEvents
-
Remove all listeners (does not reset counters).
- CLOSED - Enum constant in enum class com.cockroachlabs.crdb.circuit.State
-
Calls flow normally; failures are counted.
- com.cockroachlabs.crdb - package com.cockroachlabs.crdb
-
CockroachDB pure-Java library — a framework-free, annotation-driven toolkit that makes CockroachDB anomaly handling (serialization-conflict retries, circuit breaking) disappear behind runtime dynamic proxies.
- com.cockroachlabs.crdb.annotations - package com.cockroachlabs.crdb.annotations
-
Runtime annotations that drive CockroachDB-aware behavior through the
dynamic-proxy engine. - com.cockroachlabs.crdb.anomaly - package com.cockroachlabs.crdb.anomaly
-
Typed, exhaustive modelling of CockroachDB failure modes.
- com.cockroachlabs.crdb.circuit - package com.cockroachlabs.crdb.circuit
-
A thread-safe circuit breaker that fast-fails calls after repeated failures.
- com.cockroachlabs.crdb.config - package com.cockroachlabs.crdb.config
-
Library-wide configuration records.
- com.cockroachlabs.crdb.context - package com.cockroachlabs.crdb.context
-
Virtual-thread-safe call context (region, vCluster, workload, follower-read staleness) carried via Java's
ScopedValue— notThreadLocal— so it propagates correctly across structured concurrency and virtual threads. - com.cockroachlabs.crdb.observe - package com.cockroachlabs.crdb.observe
-
Lightweight observability hooks.
- com.cockroachlabs.crdb.proxy - package com.cockroachlabs.crdb.proxy
-
The dynamic-proxy engine: the headline feature that makes CockroachDB anomaly
try/catchdisappear. - com.cockroachlabs.crdb.retry - package com.cockroachlabs.crdb.retry
-
Adaptive, contention-aware retry for CockroachDB serialization anomalies.
- com.cockroachlabs.crdb.spi - package com.cockroachlabs.crdb.spi
-
Service-provider interfaces and value types for the Cockroach Continuum surfaces exposed through
Crdb. - com.cockroachlabs.crdb.tx - package com.cockroachlabs.crdb.tx
-
Programmatic transaction execution with adaptive retry and follower-read support — the always-available functional core of the library.
- com.cockroachlabs.crdb.vcluster - package com.cockroachlabs.crdb.vcluster
-
The Cockroach vCluster entry point returned by
Crdb.vcluster(String). - ConnectionAnomaly - Record Class in com.cockroachlabs.crdb.anomaly
-
A connection-level failure (SQLSTATE class
08), e.g. - ConnectionAnomaly(String, String, Throwable) - Constructor for record class com.cockroachlabs.crdb.anomaly.ConnectionAnomaly
-
Creates an instance of a
ConnectionAnomalyrecord class. - ConnectionCallback<T> - Interface in com.cockroachlabs.crdb.tx
-
A unit of work executed against an open, in-transaction
Connection. - contentionRatio() - Method in class com.cockroachlabs.crdb.retry.AdaptiveBackoff
-
Contention estimate in [0, 1]: recent average retries relative to the policy's
maxRetries. - Crdb - Class in com.cockroachlabs.crdb
-
The one-stop entry point for the CockroachDB pure-Java library.
- CrdbAnomaly - Interface in com.cockroachlabs.crdb.anomaly
-
A typed CockroachDB failure.
- CrdbConfig - Record Class in com.cockroachlabs.crdb.config
-
Immutable library configuration.
- CrdbConfig(RetryPolicy, int, long, Isolation) - Constructor for record class com.cockroachlabs.crdb.config.CrdbConfig
-
Creates an instance of a
CrdbConfigrecord class. - CrdbContext - Class in com.cockroachlabs.crdb.context
-
Access point for the current
CrdbContextValues, bound viaScopedValueso it is safe under virtual threads and structured concurrency. - CrdbContextValues - Record Class in com.cockroachlabs.crdb.context
-
Immutable bundle of CockroachDB call context.
- CrdbContextValues(String, String, Workload.Priority, String) - Constructor for record class com.cockroachlabs.crdb.context.CrdbContextValues
-
Creates an instance of a
CrdbContextValuesrecord class. - CrdbEventListener - Interface in com.cockroachlabs.crdb.observe
-
Receives operational events emitted by the library's retry and circuit-breaker machinery.
- CrdbEvents - Class in com.cockroachlabs.crdb.observe
-
Process-wide event bus and counters for CockroachDB operational signals.
- CrdbException - Exception Class in com.cockroachlabs.crdb.anomaly
-
Unchecked, typed failure that wraps a
CrdbAnomaly. - CrdbException(CrdbAnomaly) - Constructor for exception class com.cockroachlabs.crdb.anomaly.CrdbException
- CrdbProxyFactory - Class in com.cockroachlabs.crdb.proxy
-
Produces enhanced instances of annotated targets.
- CrdbProxyFactory() - Constructor for class com.cockroachlabs.crdb.proxy.CrdbProxyFactory
- CrdbProxyFactory(CrdbConfig) - Constructor for class com.cockroachlabs.crdb.proxy.CrdbProxyFactory
- CrdbProxyFactory.Interceptor - Class in com.cockroachlabs.crdb.proxy
-
ByteBuddy interception target.
- CrdbRetry - Annotation Interface in com.cockroachlabs.crdb.annotations
-
Retries the annotated method on CockroachDB serialization anomalies (SQLSTATE
40001/40P01) using adaptive exponential backoff. - CrdbStats - Record Class in com.cockroachlabs.crdb.observe
-
A snapshot of process-wide operational counters.
- CrdbStats(long, long, long) - Constructor for record class com.cockroachlabs.crdb.observe.CrdbStats
-
Creates an instance of a
CrdbStatsrecord class. - create(AegisConfig) - Method in interface com.cockroachlabs.crdb.spi.AegisFactory
-
Create an Aegis client for the given configuration.
- create(DataSource) - Method in interface com.cockroachlabs.crdb.spi.StorageInsightsFactory
-
Create a storage-insights view over
dataSource. - current() - Static method in class com.cockroachlabs.crdb.context.CrdbContext
-
The full context bound to the current scope, if any.
D
- defaultIsolation() - Method in record class com.cockroachlabs.crdb.config.CrdbConfig
-
Returns the value of the
defaultIsolationrecord component. - defaults() - Static method in record class com.cockroachlabs.crdb.config.CrdbConfig
-
Sensible defaults for all settings.
- defaults() - Static method in record class com.cockroachlabs.crdb.retry.RetryPolicy
-
Sensible defaults: 5 retries, 100ms base, 5s cap, x2 backoff, 20% jitter.
- defaults() - Static method in record class com.cockroachlabs.crdb.spi.AegisConfig
-
Disabled by default: selects the simulated backend, emits nothing remote.
- describe(CrdbAnomaly) - Static method in exception class com.cockroachlabs.crdb.anomaly.CrdbException
-
Formats an anomaly for logging/telemetry using an exhaustive pattern-matching
switchover the sealed hierarchy — the compiler guarantees every kind is handled. - destructive() - Element in annotation interface com.cockroachlabs.crdb.annotations.AgentTool
-
Whether this tool performs a destructive/mutating action.
- detail() - Method in record class com.cockroachlabs.crdb.spi.Finding
-
Returns the value of the
detailrecord component. - detail() - Method in record class com.cockroachlabs.crdb.spi.Recommendation
-
Returns the value of the
detailrecord component.
E
- emit(AppEvent) - Method in interface com.cockroachlabs.crdb.spi.AegisClient
-
Emit an application operational signal to Aegis.
- empty() - Static method in record class com.cockroachlabs.crdb.context.CrdbContextValues
-
The empty context (all fields unset).
- enabled() - Method in record class com.cockroachlabs.crdb.spi.AegisConfig
-
Returns the value of the
enabledrecord component. - endpoint() - Method in record class com.cockroachlabs.crdb.spi.AegisConfig
-
Returns the value of the
endpointrecord component. - enhance(T) - Static method in class com.cockroachlabs.crdb.Crdb
-
Return an enhanced view of
targetwhose annotated methods gain retry / circuit-breaking / context behavior. - enhance(T) - Method in class com.cockroachlabs.crdb.proxy.CrdbProxyFactory
-
Enhance
target, choosing the proxy strategy automatically. - enhance(T, CrdbConfig) - Static method in class com.cockroachlabs.crdb.Crdb
-
As
Crdb.enhance(Object), using a specificCrdbConfig. - epochMillis() - Method in record class com.cockroachlabs.crdb.spi.AppEvent
-
Returns the value of the
epochMillisrecord component. - equals(Object) - Method in record class com.cockroachlabs.crdb.anomaly.CircuitOpen
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.anomaly.ConnectionAnomaly
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.anomaly.RetryExhausted
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.anomaly.SerializationConflict
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.anomaly.UnknownAnomaly
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.config.CrdbConfig
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.context.CrdbContextValues
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.observe.CrdbStats
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.retry.RetryPolicy
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.spi.AegisConfig
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.spi.AppEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.spi.Finding
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.spi.Recommendation
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cockroachlabs.crdb.spi.TableStorage
-
Indicates whether some other object is "equal to" this one.
- execute(Isolation, boolean, ConnectionCallback) - Method in class com.cockroachlabs.crdb.tx.TransactionTemplate
-
Execute
workin a transaction. - execute(Callable) - Method in class com.cockroachlabs.crdb.circuit.CircuitBreaker
-
Execute
workthrough the breaker.
F
- failureThreshold() - Element in annotation interface com.cockroachlabs.crdb.annotations.CircuitBreaker
-
Consecutive failures that trip the breaker into the OPEN state.
- Finding - Record Class in com.cockroachlabs.crdb.spi
-
A Cockroach Aegis finding: something the autonomous-ops agents observed about a cluster.
- Finding(String, String, String, String) - Constructor for record class com.cockroachlabs.crdb.spi.Finding
-
Creates an instance of a
Findingrecord class. - findings() - Method in interface com.cockroachlabs.crdb.spi.AegisClient
-
Current findings for the cluster.
- fireCircuitOpen(String, int) - Static method in class com.cockroachlabs.crdb.observe.CrdbEvents
- fireRetryAttempt(String, int, String) - Static method in class com.cockroachlabs.crdb.observe.CrdbEvents
- fireRetryExhausted(String, int, String) - Static method in class com.cockroachlabs.crdb.observe.CrdbEvents
- FollowerRead - Annotation Interface in com.cockroachlabs.crdb.annotations
-
Marks the annotated method as a follower-read call.
- followerReadStaleness() - Static method in class com.cockroachlabs.crdb.context.CrdbContext
-
The follower-read staleness expression bound to the current scope, if any.
- followerReadStaleness() - Method in record class com.cockroachlabs.crdb.context.CrdbContextValues
-
Returns the value of the
followerReadStalenessrecord component.
H
- HALF_OPEN - Enum constant in enum class com.cockroachlabs.crdb.circuit.State
-
A single trial call is allowed to probe recovery.
- hashCode() - Method in record class com.cockroachlabs.crdb.anomaly.CircuitOpen
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.anomaly.ConnectionAnomaly
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.anomaly.RetryExhausted
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.anomaly.SerializationConflict
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.anomaly.UnknownAnomaly
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.config.CrdbConfig
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.context.CrdbContextValues
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.observe.CrdbStats
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.retry.RetryPolicy
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.spi.AegisConfig
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.spi.AppEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.spi.Finding
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.spi.Recommendation
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cockroachlabs.crdb.spi.TableStorage
-
Returns a hash code value for this object.
- HIGH - Enum constant in enum class com.cockroachlabs.crdb.annotations.Workload.Priority
-
Maps to QoS
critical.
I
- id() - Method in record class com.cockroachlabs.crdb.spi.Finding
-
Returns the value of the
idrecord component. - id() - Method in record class com.cockroachlabs.crdb.spi.Recommendation
-
Returns the value of the
idrecord component. - intercept(Method, Callable, Object[]) - Method in class com.cockroachlabs.crdb.proxy.CrdbProxyFactory.Interceptor
- isolation() - Element in annotation interface com.cockroachlabs.crdb.annotations.Transactional
-
Transaction isolation level.
- Isolation - Enum Class in com.cockroachlabs.crdb.tx
-
Transaction isolation levels supported by CockroachDB.
- isRetryable(SQLException) - Static method in class com.cockroachlabs.crdb.anomaly.AnomalyClassifier
-
Whether a
SQLExceptionrepresents a retryable anomaly.
J
- jdbcLevel() - Method in enum class com.cockroachlabs.crdb.tx.Isolation
-
The corresponding
Connectionisolation constant. - jitter() - Method in record class com.cockroachlabs.crdb.retry.RetryPolicy
-
Returns the value of the
jitterrecord component.
K
- kind() - Method in record class com.cockroachlabs.crdb.spi.AppEvent
-
Returns the value of the
kindrecord component.
L
- last() - Method in record class com.cockroachlabs.crdb.anomaly.RetryExhausted
-
Returns the value of the
lastrecord component. - LOW - Enum constant in enum class com.cockroachlabs.crdb.annotations.Workload.Priority
-
Maps to QoS
background.
M
- maxDelayMillis() - Element in annotation interface com.cockroachlabs.crdb.annotations.CrdbRetry
-
Upper bound on any single backoff delay, in milliseconds.
- maxDelayMillis() - Method in record class com.cockroachlabs.crdb.retry.RetryPolicy
-
Returns the value of the
maxDelayMillisrecord component. - maxRetries() - Element in annotation interface com.cockroachlabs.crdb.annotations.CrdbRetry
-
Maximum number of retry attempts before giving up.
- maxRetries() - Method in record class com.cockroachlabs.crdb.retry.RetryPolicy
-
Returns the value of the
maxRetriesrecord component. - merge(CrdbContextValues) - Method in record class com.cockroachlabs.crdb.context.CrdbContextValues
-
Overlay
otheronto this one: any non-null field ofotherwins, otherwise this value is retained. - message() - Method in record class com.cockroachlabs.crdb.anomaly.CircuitOpen
- message() - Method in record class com.cockroachlabs.crdb.anomaly.ConnectionAnomaly
-
Returns the value of the
messagerecord component. - message() - Method in interface com.cockroachlabs.crdb.anomaly.CrdbAnomaly
-
A human-readable description of the anomaly.
- message() - Method in record class com.cockroachlabs.crdb.anomaly.RetryExhausted
- message() - Method in record class com.cockroachlabs.crdb.anomaly.SerializationConflict
-
Returns the value of the
messagerecord component. - message() - Method in record class com.cockroachlabs.crdb.anomaly.UnknownAnomaly
-
Returns the value of the
messagerecord component. - multiplier() - Method in record class com.cockroachlabs.crdb.retry.RetryPolicy
-
Returns the value of the
multiplierrecord component.
N
- name() - Method in class com.cockroachlabs.crdb.vcluster.VirtualClusterScope
-
The vCluster name.
- nextDelayMillis(int) - Method in class com.cockroachlabs.crdb.retry.AdaptiveBackoff
-
The delay to wait before the given zero-based
attempt. - NORMAL - Enum constant in enum class com.cockroachlabs.crdb.annotations.Workload.Priority
-
Maps to QoS
regular(CockroachDB default).
O
- of(String, String, Map, long) - Static method in record class com.cockroachlabs.crdb.spi.AppEvent
-
Convenience factory that defensively copies
attrs. - onCircuitOpen(String, int) - Method in interface com.cockroachlabs.crdb.observe.CrdbEventListener
-
A circuit breaker transitioned to OPEN.
- onRetryAttempt(String, int, String) - Method in interface com.cockroachlabs.crdb.observe.CrdbEventListener
-
A retryable anomaly occurred and a retry is being attempted.
- onRetryExhausted(String, int, String) - Method in interface com.cockroachlabs.crdb.observe.CrdbEventListener
-
Retries were exhausted for an operation.
- OPEN - Enum constant in enum class com.cockroachlabs.crdb.circuit.State
-
Calls are rejected immediately until the reset timeout elapses.
- openedFailures() - Method in record class com.cockroachlabs.crdb.anomaly.CircuitOpen
-
Returns the value of the
openedFailuresrecord component. - OriginalCall - Interface in com.cockroachlabs.crdb.proxy
-
A call to the original (un-enhanced) method body.
P
- priority() - Method in class com.cockroachlabs.crdb.vcluster.VirtualClusterScope
-
The workload priority, if set.
Q
- qos() - Method in enum class com.cockroachlabs.crdb.annotations.Workload.Priority
-
The CockroachDB
default_transaction_quality_of_servicevalue for this priority: one ofcritical,regular,background.
R
- READ_COMMITTED - Enum constant in enum class com.cockroachlabs.crdb.tx.Isolation
-
Weaker isolation with fewer retries; available on modern CockroachDB.
- Recommendation - Record Class in com.cockroachlabs.crdb.spi
-
A Cockroach Aegis recommendation: a suggested action derived from findings.
- Recommendation(String, String, String, String) - Constructor for record class com.cockroachlabs.crdb.spi.Recommendation
-
Creates an instance of a
Recommendationrecord class. - recommendations() - Method in interface com.cockroachlabs.crdb.spi.AegisClient
-
Current recommendations for the cluster.
- record(int) - Method in class com.cockroachlabs.crdb.retry.AdaptiveBackoff
-
Feed the observed number of retries an operation needed.
- region() - Static method in class com.cockroachlabs.crdb.context.CrdbContext
-
The region bound to the current scope, if any.
- region() - Method in record class com.cockroachlabs.crdb.context.CrdbContextValues
-
Returns the value of the
regionrecord component. - Region - Annotation Interface in com.cockroachlabs.crdb.annotations
-
Pins the annotated method's execution to a CockroachDB region.
- removeListener(CrdbEventListener) - Static method in class com.cockroachlabs.crdb.observe.CrdbEvents
- resetStats() - Static method in class com.cockroachlabs.crdb.observe.CrdbEvents
-
Reset all counters to zero.
- resetTimeoutMillis() - Element in annotation interface com.cockroachlabs.crdb.annotations.CircuitBreaker
-
Time the breaker stays OPEN before allowing a HALF_OPEN trial, in millis.
- retriesExhausted() - Method in record class com.cockroachlabs.crdb.observe.CrdbStats
-
Returns the value of the
retriesExhaustedrecord component. - retry() - Element in annotation interface com.cockroachlabs.crdb.annotations.Transactional
-
Retry the transaction on serialization conflicts.
- retry() - Method in record class com.cockroachlabs.crdb.config.CrdbConfig
-
Returns the value of the
retryrecord component. - retryAttempts() - Method in record class com.cockroachlabs.crdb.observe.CrdbStats
-
Returns the value of the
retryAttemptsrecord component. - RetryEngine - Class in com.cockroachlabs.crdb.retry
-
Executes a unit of work, retrying on retryable CockroachDB anomalies with
AdaptiveBackoff. - RetryEngine() - Constructor for class com.cockroachlabs.crdb.retry.RetryEngine
- RetryEngine(DoubleSupplier, RetryEngine.Sleeper) - Constructor for class com.cockroachlabs.crdb.retry.RetryEngine
- RetryEngine.Sleeper - Interface in com.cockroachlabs.crdb.retry
-
Abstracts sleeping so tests can run without real delays.
- RetryExhausted - Record Class in com.cockroachlabs.crdb.anomaly
-
Signals that the retry engine gave up after exhausting all attempts.
- RetryExhausted(int, CrdbAnomaly) - Constructor for record class com.cockroachlabs.crdb.anomaly.RetryExhausted
-
Creates an instance of a
RetryExhaustedrecord class. - RetryPolicy - Record Class in com.cockroachlabs.crdb.retry
-
Immutable retry configuration.
- RetryPolicy(int, long, long, double, double) - Constructor for record class com.cockroachlabs.crdb.retry.RetryPolicy
-
Creates an instance of a
RetryPolicyrecord class. - rows() - Method in record class com.cockroachlabs.crdb.spi.TableStorage
-
Returns the value of the
rowsrecord component. - run(RetryPolicy, Callable) - Method in class com.cockroachlabs.crdb.retry.RetryEngine
-
Run
work, retrying on retryable anomalies perpolicy. - run(Runnable) - Method in class com.cockroachlabs.crdb.vcluster.VirtualClusterScope
-
Run
bodywith this vCluster context bound. - run(Connection) - Method in interface com.cockroachlabs.crdb.tx.ConnectionCallback
-
Do work on the connection and return a result.
S
- schema() - Method in record class com.cockroachlabs.crdb.spi.TableStorage
-
Returns the value of the
schemarecord component. - SERIALIZABLE - Enum constant in enum class com.cockroachlabs.crdb.tx.Isolation
-
Strongest isolation; CockroachDB's default.
- SerializationConflict - Record Class in com.cockroachlabs.crdb.anomaly
-
A serialization conflict (SQLSTATE
40001, or the deadlock variant40P01). - SerializationConflict(String, String, Throwable) - Constructor for record class com.cockroachlabs.crdb.anomaly.SerializationConflict
-
Creates an instance of a
SerializationConflictrecord class. - severity() - Method in record class com.cockroachlabs.crdb.spi.Finding
-
Returns the value of the
severityrecord component. - sleep(long) - Method in interface com.cockroachlabs.crdb.retry.RetryEngine.Sleeper
- source() - Method in record class com.cockroachlabs.crdb.spi.AppEvent
-
Returns the value of the
sourcerecord component. - sqlState() - Method in record class com.cockroachlabs.crdb.anomaly.CircuitOpen
- sqlState() - Method in record class com.cockroachlabs.crdb.anomaly.ConnectionAnomaly
-
Returns the value of the
sqlStaterecord component. - sqlState() - Method in interface com.cockroachlabs.crdb.anomaly.CrdbAnomaly
-
The SQLSTATE associated with this anomaly, or
nullif not applicable. - sqlState() - Method in record class com.cockroachlabs.crdb.anomaly.RetryExhausted
- sqlState() - Method in record class com.cockroachlabs.crdb.anomaly.SerializationConflict
-
Returns the value of the
sqlStaterecord component. - sqlState() - Method in record class com.cockroachlabs.crdb.anomaly.UnknownAnomaly
-
Returns the value of the
sqlStaterecord component. - SQLSTATE_DEADLOCK - Static variable in class com.cockroachlabs.crdb.anomaly.AnomalyClassifier
-
Deadlock detected (also treated as a serialization conflict on CockroachDB).
- SQLSTATE_SERIALIZATION_FAILURE - Static variable in class com.cockroachlabs.crdb.anomaly.AnomalyClassifier
-
Serialization failure.
- staleness() - Element in annotation interface com.cockroachlabs.crdb.annotations.FollowerRead
-
Staleness expression.
- state() - Method in class com.cockroachlabs.crdb.circuit.CircuitBreaker
-
Current breaker state (snapshot).
- State - Enum Class in com.cockroachlabs.crdb.circuit
-
Circuit breaker states.
- stats() - Static method in class com.cockroachlabs.crdb.observe.CrdbEvents
-
A snapshot of the current counters.
- storage(DataSource) - Static method in class com.cockroachlabs.crdb.Crdb
-
Cockroach Plenum storage insights (read-only usage signals).
- StorageInsights - Interface in com.cockroachlabs.crdb.spi
-
Read-only Cockroach Plenum storage insights.
- StorageInsightsFactory - Interface in com.cockroachlabs.crdb.spi
-
SPI for creating
StorageInsightsinstances. - suggestedAction() - Method in record class com.cockroachlabs.crdb.spi.Recommendation
-
Returns the value of the
suggestedActionrecord component. - summary() - Method in interface com.cockroachlabs.crdb.spi.StorageInsights
-
Storage summary for every user table in the connection's current database.
- summary(String) - Method in interface com.cockroachlabs.crdb.spi.StorageInsights
-
Storage summary for every user table in the named database.
T
- table() - Method in record class com.cockroachlabs.crdb.spi.TableStorage
-
Returns the value of the
tablerecord component. - TableStorage - Record Class in com.cockroachlabs.crdb.spi
-
Storage usage for a single table (Cockroach Plenum insight).
- TableStorage(String, String, OptionalLong, OptionalLong) - Constructor for record class com.cockroachlabs.crdb.spi.TableStorage
-
Creates an instance of a
TableStoragerecord class. - template(DataSource) - Static method in class com.cockroachlabs.crdb.Crdb
-
A reusable
TransactionTemplatebound tods. - title() - Method in record class com.cockroachlabs.crdb.spi.Finding
-
Returns the value of the
titlerecord component. - title() - Method in record class com.cockroachlabs.crdb.spi.Recommendation
-
Returns the value of the
titlerecord component. - token() - Method in record class com.cockroachlabs.crdb.spi.AegisConfig
-
Returns the value of the
tokenrecord component. - toString() - Method in record class com.cockroachlabs.crdb.anomaly.CircuitOpen
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.anomaly.ConnectionAnomaly
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.anomaly.RetryExhausted
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.anomaly.SerializationConflict
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.anomaly.UnknownAnomaly
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.config.CrdbConfig
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.context.CrdbContextValues
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.observe.CrdbStats
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.retry.RetryPolicy
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.spi.AegisConfig
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.spi.AppEvent
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.spi.Finding
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.spi.Recommendation
-
Returns a string representation of this record class.
- toString() - Method in record class com.cockroachlabs.crdb.spi.TableStorage
-
Returns a string representation of this record class.
- Transactional - Annotation Interface in com.cockroachlabs.crdb.annotations
-
Runs the annotated method inside a JDBC transaction (SERIALIZABLE by default).
- TransactionTemplate - Class in com.cockroachlabs.crdb.tx
-
Runs
ConnectionCallbacks inside a managed JDBC transaction. - TransactionTemplate(DataSource) - Constructor for class com.cockroachlabs.crdb.tx.TransactionTemplate
- TransactionTemplate(DataSource, RetryPolicy, RetryEngine) - Constructor for class com.cockroachlabs.crdb.tx.TransactionTemplate
- tx(DataSource, ConnectionCallback) - Static method in class com.cockroachlabs.crdb.Crdb
-
Run
workin a SERIALIZABLE transaction with automatic retry on serialization conflicts. - tx(DataSource, ConnectionCallback) - Method in class com.cockroachlabs.crdb.vcluster.VirtualClusterScope
-
Run a SERIALIZABLE, auto-retrying transaction with this vCluster context bound; the transaction is tagged with
application_nameand the mapped workload QoS at start.
U
- UnknownAnomaly - Record Class in com.cockroachlabs.crdb.anomaly
-
Any failure that does not map to a more specific
CrdbAnomaly. - UnknownAnomaly(String, String, Throwable) - Constructor for record class com.cockroachlabs.crdb.anomaly.UnknownAnomaly
-
Creates an instance of a
UnknownAnomalyrecord class. - useSimulated() - Method in record class com.cockroachlabs.crdb.spi.AegisConfig
-
Whether the simulated backend should be used (disabled or no endpoint).
V
- value() - Element in annotation interface com.cockroachlabs.crdb.annotations.AgentTool
-
The tool name exposed to agents (e.g.
- value() - Element in annotation interface com.cockroachlabs.crdb.annotations.Region
-
The region name (e.g.
- value() - Element in annotation interface com.cockroachlabs.crdb.annotations.VirtualCluster
-
The virtual cluster name (e.g.
- value() - Element in annotation interface com.cockroachlabs.crdb.annotations.Workload
-
Workload priority class.
- valueOf(String) - Static method in enum class com.cockroachlabs.crdb.annotations.Workload.Priority
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.cockroachlabs.crdb.circuit.State
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.cockroachlabs.crdb.tx.Isolation
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.cockroachlabs.crdb.annotations.Workload.Priority
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.cockroachlabs.crdb.circuit.State
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.cockroachlabs.crdb.tx.Isolation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- vcluster(String) - Static method in class com.cockroachlabs.crdb.Crdb
-
Cockroach vCluster handle: a context-scoped executor that tags work with a vCluster name and (optionally) a workload priority/QoS.
- virtualCluster() - Static method in class com.cockroachlabs.crdb.context.CrdbContext
-
The virtual cluster bound to the current scope, if any.
- virtualCluster() - Method in record class com.cockroachlabs.crdb.context.CrdbContextValues
-
Returns the value of the
virtualClusterrecord component. - VirtualCluster - Annotation Interface in com.cockroachlabs.crdb.annotations
-
Routes the annotated method to a Cockroach vCluster (virtual cluster) for workload isolation on shared capacity.
- VirtualClusterScope - Class in com.cockroachlabs.crdb.vcluster
-
A context-scoped executor for a Cockroach vCluster.
- VirtualClusterScope(String) - Constructor for class com.cockroachlabs.crdb.vcluster.VirtualClusterScope
W
- with(CrdbContextValues, Callable) - Static method in class com.cockroachlabs.crdb.context.CrdbContext
-
Run
bodywithvaluesmerged onto any currently-bound context. - withFollowerReadStaleness(String) - Method in record class com.cockroachlabs.crdb.context.CrdbContextValues
- withRegion(String) - Method in record class com.cockroachlabs.crdb.context.CrdbContextValues
- withVirtualCluster(String) - Method in record class com.cockroachlabs.crdb.context.CrdbContextValues
- withWorkload(Workload.Priority) - Method in record class com.cockroachlabs.crdb.context.CrdbContextValues
- workload() - Static method in class com.cockroachlabs.crdb.context.CrdbContext
-
The workload priority bound to the current scope, if any.
- workload() - Method in record class com.cockroachlabs.crdb.context.CrdbContextValues
-
Returns the value of the
workloadrecord component. - workload(Workload.Priority) - Method in class com.cockroachlabs.crdb.vcluster.VirtualClusterScope
-
Return a scope that also tags the workload priority/QoS.
- Workload - Annotation Interface in com.cockroachlabs.crdb.annotations
-
Tags the annotated method's workload priority/class for a Cockroach vCluster.
- Workload.Priority - Enum Class in com.cockroachlabs.crdb.annotations
-
Relative importance of a workload sharing a virtual cluster.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form