Skip to main content

Module engine

Module engine 

Source
Expand description

Safe storage-engine interface for downstream implementations

Structs§

CostEstimate
A cost estimate an engine reports to the optimizer, mirroring MySQL’s Cost_estimate.
ParallelScanInit
The two outputs of StorageEngine::parallel_scan_init: the engine-owned scan context that every later parallel_scan* call receives back, and the number of worker threads the engine will drive.
RangeKey
One endpoint of a range scan, mirroring the relevant fields of MySQL’s key_range. The shim resolves the original key_part_map to the leading key bytes before crossing the FFI boundary, so key is already length-resolved; the borrow may not be retained past the callback that supplied it.

Enums§

BulkAccess
Whether the engine batches the rows of a multi-row UPDATE or DELETE itself, or lets MySQL drive the statement one row at a time.
EngineError
Errors a storage engine can return; each maps to a MySQL HA_ERR_* code
RKeyFunction
Search semantics for an index lookup, mirroring MySQL’s ha_rkey_function.
ResetCachedState
Whether MySQL has just reset the data-dictionary entry and any cached engine-private metadata should be re-emitted from scratch
SamplingMethod
Sampling algorithm requested for StorageEngine::sample_init, mirroring MySQL’s enum_sampling_method.

Traits§

StorageEngine
The safe interface every storage engine implements.

Type Aliases§

EngineResult
Result alias used throughout the StorageEngine trait