Skip to main content

Crate featherdb_core

Crate featherdb_core 

Source
Expand description

Core types and traits for FeatherDB

This crate provides the fundamental types used throughout FeatherDB:

  • Value: The core data type for storing values
  • Error: Error types for all database operations
  • PageId, TransactionId: Type-safe identifiers
  • ToRow, FromRow: Traits for type-safe row conversion
  • WalSyncMode, WalGroupCommitConfig: WAL configuration for group commit
  • TransactionConfig: Transaction timeout configuration
  • Permissions: Table-level permission flags for authorization

Modules§

constants
Constants for the database file format

Structs§

ColumnDef
Column definition for schema generation
CompressionConfig
Compression configuration for the storage engine
Config
Database configuration options
Lsn
Log Sequence Number - identifies a position in the WAL
PageId
Page identifier - uniquely identifies a page in the database file
Permissions
Permission flags for table-level access control.
QueryContext
Query context for tracking position in SQL
QueryError
Rich query error with context and suggestions
StorageLimitsConfig
Configuration for database storage limits
TransactionConfig
Configuration for transaction behavior
TransactionId
Transaction identifier
WalGroupCommitConfig
WAL group commit configuration

Enums§

ColumnType
Column type definition
CompressionType
Compression algorithm type for page compression
ConfigError
Configuration error type
EncryptionConfig
Encryption configuration
Error
Main error type for FeatherDB operations
EvictionPolicyType
Buffer pool eviction policy type
Value
A database value
WalSyncMode
WAL synchronization mode

Traits§

FromRow
Trait for types that can be constructed from a database row
FromValue
Trait for types that can be created from a database Value
TableSchema
Trait for types that have a table schema
ToRow
Trait for types that represent a database row
ToValue
Trait for types that can be converted to a database Value

Functions§

find_best_match
Find the best match from a list of candidates
levenshtein_distance
Calculate Levenshtein distance between two strings
suggest_keyword
Common SQL keyword typos and their corrections

Type Aliases§

Result
Result type alias using FeatherDB’s Error