Skip to main content

Crate uqa

Crate uqa 

Source
Expand description

Convenience facade for the embedded UQA engine.

This crate re-exports the complete uqa_engine API and the core Value type so applications can start with one dependency while lower-level crates remain independently usable.

Modules§

functions
Register execution-owned extension contracts in the engine.
migration
Migration support for legacy UQA SQLite catalog directories.
operator_tree_bridge
Public Engine retrieval entry points and statement-boundary composition.
sql
SQL result formatting, type metadata and bounded cursors. SQL result formatting, PostgreSQL type metadata and bounded columnar cursors.

Structs§

AutomaticStatisticsStatus
Process-local health of the database’s automatic statistics worker. A failed refresh retains its durable pending state and is retried.
ColumnVector
A column vector preserves its position in the declared output schema.
ColumnarBatch
Column-oriented transfer batch. Physical operators may remain row-oriented internally; API consumers can process one bounded batch without retaining the complete result set or rebuilding columns themselves.
DiskANNMaintenanceCensus
Exact counts for the most recently completed index capture; later commits may already have changed its live corpus.
DiskANNMaintenanceStatus
Census progress is read-only. Evaluated writes increment pruning/rebuild counters only after confirmed completion.
DiskANNRebuildPolicy
Soft triggers for one index’s current uncovered documents or logical raw vector bytes. Neither limit is a write quota or a physical-retention limit.
Engine
Unified query engine composed from explicit storage, durable-catalog, session, extension, epoch, and query-runtime ownership domains.
ExecutionOutcome
The original native return value or error together with its operation-scoped transaction facts.
FtsIndexStat
HybridSearchParams
Exact signed single-prior hybrid-search arguments. Keeps Engine::hybrid_search borrowing-friendly without an explosion of positional parameters.
NotificationSubscription
An idle listener independent of the query session that created it. Close every retained handle before replacing a database file.
NotificationSubscriptionError
A stable failure category with an original cause available only through explicit inspection.
NotificationSubscriptionOptions
Explicit limits for an owned listener. No deployment capacity is inferred from SQL work_mem.
NotificationSubscriptionPermit
One non-cloneable reservation against the original hub’s pending/live limit. Reserve before submitting registration to a runtime queue; dropping an unused permit releases capacity without provider I/O. A permit does not retain the Engine or register any channels.
PreparedStatement
A session-owned prepared definition’s identity. Removing and recreating its catalog name never rebinds this handle.
PreparedStatementDescription
Preparation-time parameter and positional result descriptors.
RobustHybridSearchParams
Explicit robust-ranking variant of HybridSearchParams. This contract applies positive-evidence gating and confidence scaling rather than exact single-prior Bayesian evidence fusion.
SQLBatchError
An atomic batch failure with its original SQL error and, when known, zero-based member. Transaction begin, commit and rollback failures are not attributed to a member.
SQLCursor
Iterator over schema-ordered column batches backed by a work-mem-bounded SharedSpill. Dropping the cursor releases its temporary file. Positional conversion preserves separately-valued duplicate labels in ColumnarBatch.
SQLCursorSummary
Metadata known before a cursor is consumed.
SQLFunctionContext
Host-owned invocation data belonging to the calling session. Registrations are shared across sessions; this data travels with execution, including worker and retained-portal execution, instead of with the registered code. Hosts should store weak session references here to avoid ownership cycles.
SQLFunctionOptions
Execution properties declared for a Rust-backed SQL callback.
SQLFunctionRegistration
An identity-specific lease on a shared registration, independent of the creating session. Dropping this handle releases the lease without removing its map entry. Call unregister to retire that entry explicitly.
SQLNotice
A notice that a statement reports without failing, as PostgreSQL’s ereport sends one below ERROR: its level, SQLSTATE and primary message, and the detail and hint that clients receive as fields of their own.
SQLNotification
One committed SQL notification waiting for this session.
SQLNotificationOptions
Opt-in bounds for the SQL session’s own LISTEN queue. Overflow is terminal and explicit. Queue bytes include string capacities, queue slots and transient prepared batches.
SQLResult
SQLRowStream
A fused row stream that closes its producer on EOF, failure or explicit early termination. A cleanup failure is a query error, never EOF. Dropping an abandoned stream is best-effort cleanup; execution must call close while it can still report an error to its consumer.
SQLTableFunctionResult
Result shape returned by a registered SQL table function.
SQLTableFunctionStream
Pull-based result returned by a registered SQL table function.
SQLiteCompressionOptions
ScoredEntry
SequenceState
Mutable state of a single SQL sequence.
TextSearchProfile
Observable work counters for one text top-k execution.

Enums§

DatabaseFileFormat
On-disk format of a database file, detected from its header bytes.
DiskANNMaintenancePhase
EngineError
ExecutionCompletion
Transaction facts for one admitted host operation. These facts never authorize replay: a message can contain explicit commits, and nontransactional sequence effects survive rollback.
NoticeLevel
The level of a notice, as PostgreSQL names its message levels below ERROR, in increasing order of severity.
NotificationReceive
One receive with adapter-owned storage admitted before dequeue. Rejected admission leaves both the queued notification and its delivery sequence unchanged.
NotificationWait
A bounded wait ending with one value, elapsed receive time, or explicit closure.
SQLFunctionRegistrationError
SQLFunctionVolatility
IMMUTABLE / STABLE / VOLATILE marker.
SQLParam
Value bound to a $N placeholder.
SQLiteError
ScoringMode
Scoring strategy for a text retrieval leaf.
SequenceBound
ALTER SEQUENCE bound action, distinguishing omission from NO MINVALUE or NO MAXVALUE.
SequenceDataType
SequenceRestart
Physical restart action carried by ALTER SEQUENCE.
TextSearchAlgorithm
Algorithm that actually produced a text-search result.
Value
Dynamic value type for document fields and posting payload extras.

Traits§

AsyncSQLEngine
Common asynchronous SQL interface implemented by embedded and HTTP engines.
SQLAggregateFactory
Fallible creation of an independent SQL aggregate state.
SQLAggregateFunction
Infallible factory retained for existing Rust aggregate implementations.
SQLAggregateState
Per-group state for a registered SQL aggregate function.
SQLRowSource
A row producer whose resources require fallible cleanup. A successful construction transfers its resources to SQLRowStream. close must release them even when it reports an error; it is invoked at most once.
SQLScalarFunction
Rust implementation of a scalar SQL function.
SQLTableFunction
Rust implementation of a SQL table function used in FROM.

Type Aliases§

EngineResult