Struct NodeDbError 

pub struct NodeDbError { /* private fields */ }

Public error type returned by all NodeDb trait methods.

Separates machine-readable data (ErrorCode + ErrorDetails) from the human-readable message. Optional cause preserves the error chain.

Implementations

impl NodeDbError

pub fn backup_tenant_mismatch(expected: u64, actual: u64) -> NodeDbError

RESTORE targeted expected but the envelope belongs to actual.

Names the exact mismatch and the two next actions: restore the tenant-expected backup instead, or target tenant actual.

pub fn backup_key_mismatch() -> NodeDbError

The envelope did not decrypt under this server’s configured backup KEK.

Never includes key material or a key fingerprint/hash — only that the keys disagree and where to look.

impl NodeDbError

pub fn from_wire(code: ErrorCode, message: impl Into<String>) -> NodeDbError

Rebuild a typed error from a wire-carried numeric code plus the message the originating side rendered.

The message is preserved verbatim rather than re-derived: it is the only place the structured context survives (the offending value, the index name, the gate). String fields on the reconstructed ErrorDetails are therefore left empty — the code identifies what kind of failure occurred, which is what the category predicates match on, while the human-readable specifics stay in message. Populating them by parsing the message back apart would invent structure the wire never carried.

Unrecognised codes fall through to ErrorDetails::Internal tagged "remote", which is also where a 0 code lands: a peer older than the numeric-code field sends nothing, and guessing from SQLSTATE would be worse than admitting the classification is unavailable.

pub fn from_wire_with_details( code: ErrorCode, message: impl Into<String>, details: Option<ErrorDetails>, ) -> NodeDbError

Rebuild a typed error from a wire frame that also carries the structured details the server held.

The carried details are used when they belong to code, so a client reads the collection, gate, or document the server named. Details of another category, or none, fall back to NodeDbError::from_wire.

impl NodeDbError

pub fn mirror_read_only(database: impl Into<String>) -> NodeDbError

Write was rejected because the target database is an un-promoted mirror.

The mirror is read-only until ALTER DATABASE <name> PROMOTE is issued.

pub fn stale_read_not_leader( database: impl Into<String>, source_cluster: impl Into<String>, ) -> NodeDbError

Strong-consistency read was requested on a mirror database.

Mirrors cannot serve strong reads; the client should redirect to source_cluster.

pub fn mirror_not_promoted(database: impl Into<String>) -> NodeDbError

Operation requires the database to already be a promoted mirror.

impl NodeDbError

pub fn move_tenant_drain_timeout( tenant: impl Into<String>, source_db: impl Into<String>, ) -> NodeDbError

Drain phase timed out; the tenant’s sessions on source could not be cleanly wound down within the bounded window. The source is left unmodified; no data was moved.

pub fn move_tenant_preflight_failed( tenant: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

Pre-flight schema-compatibility check failed. No state was mutated.

pub fn move_tenant_snapshot_failed( tenant: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

Snapshot phase failed; partial snapshot has been cleaned up. Source is unmodified.

pub fn move_tenant_cutover_failed( tenant: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

Cutover Raft proposal failed. The source database still holds the tenant’s data; no partial state was left.

pub fn move_tenant_already_at_target( tenant: impl Into<String>, target_db: impl Into<String>, ) -> NodeDbError

The tenant’s data is already in the target database; this is the idempotent response when a previously completed MOVE TENANT is re-issued.

impl NodeDbError

pub fn collection_not_found(collection: impl Into<String>) -> NodeDbError

pub fn collection_draining(collection: impl Into<String>) -> NodeDbError

Collection is mid-purge; new scans are refused until the purge ack. Distinct from collection_not_found so clients can differentiate “try again in a moment” from “does not exist”.

pub fn collection_deactivated( collection: impl Into<String>, retention_expires_at_ns: u64, ) -> NodeDbError

Collection is soft-deleted (retention window active). Distinct from collection_not_found so clients can surface the UNDROP COLLECTION <name> hint instead of “does not exist”.

pub fn document_not_found( collection: impl Into<String>, document_id: impl Into<String>, ) -> NodeDbError

pub fn plan_error(detail: impl Display) -> NodeDbError

pub fn plan_error_at( phase: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

pub fn sql_not_enabled() -> NodeDbError

pub fn undefined_function(name: impl Into<String>) -> NodeDbError

A function call in a query names no registered scalar, aggregate, or window function. Distinct from plan_error so clients can match on the specific code (SQLSTATE 42883, undefined_function) rather than parsing the message.

pub fn undefined_object(object: impl Into<String>) -> NodeDbError

A statement names a database object that does not exist. Distinct from undefined_function: the function exists, the object it names does not. Renders as SQLSTATE 42704 (undefined_object).

pub fn dependent_objects_exist( object: impl Into<String>, message: impl Into<String>, ) -> NodeDbError

A drop or revoke refused because other objects still depend on object. SQLSTATE 2BP01 (dependent_objects_still_exist). message is the full message and names the dependents.

pub fn object_not_ready( object: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

An object exists but a prerequisite step has not run, such as currval before this session called nextval. Renders as SQLSTATE 55000 (object_not_in_prerequisite_state).

pub fn undefined_column(column: impl Into<String>) -> NodeDbError

A column reference names no column of any relation in scope. Distinct from plan_error so clients match on the code rather than parsing the message.

pub fn ambiguous_column(column: impl Into<String>) -> NodeDbError

A bare column name resolves against more than one relation in scope. Distinct from plan_error so clients match on the code rather than parsing the message.

pub fn division_by_zero() -> NodeDbError

Expression evaluation divided or took a modulus by zero. Distinct from plan_error so clients can match on the specific code (SQLSTATE 22012, division_by_zero) rather than parsing the message.

pub fn data_exception(detail: impl Into<String>) -> NodeDbError

A function received a value it cannot compute on: a vector of the wrong dimension, an argument of the wrong shape, a malformed path. SQLSTATE 22000 (data_exception). detail is the full message.

pub fn numeric_value_out_of_range(detail: impl Into<String>) -> NodeDbError

A value does not fit its numeric type: an integer past a column’s declared width, or arithmetic that overflows. SQLSTATE 22003 (numeric_value_out_of_range). The error names no collection. detail is the full message.

pub fn program_limit_exceeded(detail: impl Into<String>) -> NodeDbError

A statement exceeded a server limit on its own size or depth: a recursion depth, a per-transaction staging budget. SQLSTATE 54000 (program_limit_exceeded). detail is the full message.

pub fn invalid_limit_value( clause: impl Into<String>, value: impl Into<String>, ) -> NodeDbError

A LIMIT/OFFSET/FETCH bound did not resolve to [0, usize::MAX]. Distinct from plan_error so clients match the code, SQLSTATE 2201W, instead of parsing the message.

pub fn authorization_denied(resource: impl Into<String>) -> NodeDbError

pub fn authentication_failed(detail: impl Display) -> NodeDbError

Credentials were rejected. detail must not say whether the user exists.

pub fn auth_expired(detail: impl Display) -> NodeDbError

pub fn tenant_vector_dim_exceeded(dim: u32, limit: u32) -> NodeDbError

Vector insert or index rejected: vector dim exceeds tenant’s max_vector_dim quota.

pub fn tenant_graph_depth_exceeded(depth: u32, limit: u32) -> NodeDbError

Graph traversal rejected: requested depth exceeds tenant’s max_graph_depth quota.

pub fn clone_depth_exceeded(depth: u32, limit: u32) -> NodeDbError

CLONE DATABASE rejected: the clone chain is already at depth levels, which equals or exceeds MAX_CLONE_DEPTH (8).

pub fn cannot_clone_mirror(database: impl Into<String>) -> NodeDbError

CLONE DATABASE rejected: the source database is a mirror and cannot be cloned until it is promoted to a writable primary.

pub fn clone_dependency( source: impl Into<String>, dependents: Vec<String>, ) -> NodeDbError

DROP DATABASE rejected: one or more databases are cloned from this source. dependents lists the dependent database names.

pub fn clone_predates_query_time( as_of_lsn: u64, created_at_lsn: u64, ) -> NodeDbError

Bitemporal AS OF query predates the clone’s creation LSN; the clone did not exist at that point in time.

pub fn clone_write_requires_materialize( collection: impl Into<String>, engine: impl Into<String>, database: impl Into<String>, reason: &str, ) -> NodeDbError

Write rejected: collection (engine engine) is a Shadowed or Materializing clone in database — merging target and source rows without a suppression record would silently duplicate them on read. reason names why no suppression record can be written: the engine has no copy-up/tombstone module at all, or this write’s shape is outside the module it does have.

impl NodeDbError

pub fn remote_typed(code: ErrorCode, message: impl Into<String>) -> NodeDbError

Preserve a numeric ErrorCode from a remote node verbatim, using wire_details’s pairing table to reconstruct typed details. code stays the wire code even for a secondary pairing (e.g. DATABASE_QUOTA_EXCEEDED), relaying the remote classification as-is.

impl NodeDbError

pub fn handshake_failed( code: HelloErrorCode, message: impl Display, ) -> NodeDbError

Build a HandshakeFailed error from a HelloErrorCode and the server’s diagnostic message.

pub fn sync_connection_failed(detail: impl Display) -> NodeDbError

pub fn sync_delta_rejected( reason: impl Display, compensation: Option<CompensationHint>, ) -> NodeDbError

pub fn shape_subscription_failed( shape_id: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn storage(detail: impl Display) -> NodeDbError

pub fn storage_op( component: impl Into<String>, op: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

pub fn segment_corrupted(detail: impl Display) -> NodeDbError

pub fn segment_corrupted_at( segment_id: u64, corruption: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

pub fn cold_storage(detail: impl Display) -> NodeDbError

pub fn cold_storage_op( backend: impl Into<String>, op: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

pub fn wal(detail: impl Display) -> NodeDbError

pub fn wal_at( stage: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

pub fn serialization( format: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn codec(detail: impl Display) -> NodeDbError

pub fn codec_at( codec: impl Into<String>, op: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

pub fn config(detail: impl Display) -> NodeDbError

pub fn bad_request(detail: impl Display) -> NodeDbError

pub fn no_leader(detail: impl Display) -> NodeDbError

pub fn not_leader(leader_addr: impl Into<String>) -> NodeDbError

pub fn migration_in_progress(detail: impl Display) -> NodeDbError

pub fn node_unreachable(detail: impl Display) -> NodeDbError

pub fn cluster(detail: impl Display) -> NodeDbError

pub fn memory_exhausted(engine: impl Into<String>) -> NodeDbError

pub fn encryption(detail: impl Display) -> NodeDbError

pub fn encryption_at( cipher: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

pub fn array(array: impl Into<String>, detail: impl Display) -> NodeDbError

pub fn quota_overcommit( field: impl Into<String>, detail: impl Display, ) -> NodeDbError

Sum of database or tenant quotas would exceed the configured ceiling.

pub fn quota_exceeded( scope: impl Into<String>, detail: impl Display, ) -> NodeDbError

Request rejected because a tenant or database quota is exhausted.

pub fn server_overload(detail: impl Display) -> NodeDbError

Global resource pressure; server cannot accept the request.

pub fn bridge(detail: impl Display) -> NodeDbError

pub fn bridge_op( plane: impl Into<String>, op: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

pub fn dispatch(detail: impl Display) -> NodeDbError

pub fn dispatch_at( stage: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

pub fn internal(detail: impl Display) -> NodeDbError

pub fn internal_at( component: impl Into<String>, detail: impl Into<String>, ) -> NodeDbError

impl NodeDbError

pub fn constraint_violation( collection: impl Into<String>, constraint: impl Into<String>, detail: impl Display, ) -> NodeDbError

constraint names the constraint kind ("not_null", "unique", …) so every hop — local or reconstructed from a remote node — can pick the right SQLSTATE instead of guessing unique_violation for everything.

pub fn write_conflict( collection: impl Into<String>, document_id: impl Into<String>, ) -> NodeDbError

pub fn deadline_exceeded() -> NodeDbError

pub fn prevalidation_rejected( constraint: impl Into<String>, reason: impl Display, ) -> NodeDbError

pub fn append_only_violation( collection: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn balance_violation( collection: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn period_locked( collection: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn period_lock_misconfigured( collection: impl Into<String>, ref_table: impl Into<String>, status_column: impl Into<String>, row_identity: impl Display, ) -> NodeDbError

A period-lock reference row exists but does not carry the configured status_column — a misconfigured column name, refused as a config error rather than admitted or treated as locked. row_identity names the reference row that is missing the column.

pub fn state_transition_violation( collection: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn transition_check_violation( collection: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn type_guard_violation( collection: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn retention_violation( collection: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn legal_hold_active( collection: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn type_mismatch( collection: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn overflow( collection: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn kv_counter_fault( collection: impl Into<String>, fault: impl Display, out_of_range: bool, ) -> NodeDbError

A KV counter atomic (INCR, INCRBYFLOAT) refused on collection.

fault is the client text, e.g. value is not an integer or out of range. The message is "{fault} on {collection}", the text the SQL surfaces send. out_of_range picks the class, and both classes are the data-exception class (22) the SQL surfaces send:

• OVERFLOW for a result out of range (SQLSTATE 22003).
• DATA_EXCEPTION for a stored value that does not parse (SQLSTATE 22P02). TYPE_MISMATCH is the class for a key that holds the wrong kind of value (SQLSTATE 42846), a different condition.

pub fn insufficient_balance( collection: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn rate_exceeded( gate: impl Into<String>, detail: impl Display, ) -> NodeDbError

pub fn transaction_rollback(detail: impl Into<String>) -> NodeDbError

A transaction rolled back for a reason other than a serialization conflict. SQLSTATE 40000 (transaction_rollback). The client retries it. detail is the full message.

pub fn active_sql_transaction(detail: impl Into<String>) -> NodeDbError

The statement cannot run inside an explicit transaction block. SQLSTATE 25001 (active_sql_transaction). detail is the full message.

impl NodeDbError

pub fn code(&self) -> ErrorCode

The stable numeric error code.

pub fn message(&self) -> &str

Human-readable error message.

pub fn details(&self) -> &ErrorDetails

Machine-matchable error details.

pub fn cause(&self) -> Option<&NodeDbError>

The chained cause, if any.

pub fn with_cause(self, cause: NodeDbError) -> NodeDbError

Attach a cause to this error.

pub fn is_retriable(&self) -> bool

Whether this error is retriable by the client.

pub fn is_client_error(&self) -> bool

Whether this error indicates the client sent invalid input.

impl NodeDbError

pub fn is_constraint_violation(&self) -> bool

pub fn is_not_found(&self) -> bool

pub fn is_auth_denied(&self) -> bool

pub fn is_storage(&self) -> bool

pub fn is_internal(&self) -> bool

pub fn is_type_mismatch(&self) -> bool

pub fn is_type_guard_violation(&self) -> bool

pub fn is_overflow(&self) -> bool

pub fn is_insufficient_balance(&self) -> bool

pub fn is_rate_exceeded(&self) -> bool

pub fn is_cluster(&self) -> bool

Trait Implementations

impl Clone for NodeDbError

fn clone(&self) -> NodeDbError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NodeDbError

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeDbError

fn deserialize<__D>( __deserializer: __D, ) -> Result<NodeDbError, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NodeDbError

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Error for NodeDbError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for NodeDbError

fn from(e: Error) -> NodeDbError

Converts to this type from the input type.

impl From<NdbDateTimeError> for NodeDbError

fn from(e: NdbDateTimeError) -> NodeDbError

Converts to this type from the input type.

impl Serialize for NodeDbError

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.