rusqlite/rusqlite
Rusqlite
Rusqlite is an embedded database interface and relational database driver that provides a client library for interacting with SQLite. It functions as an SQL query wrapper, enabling the management of local file-based or in-memory databases through a safe interface.
The library allows for the extension of native database capabilities by implementing custom scalar functions, collations, and virtual tables. It also supports the embedding of the database engine directly into the application binary to remove external library dependencies.
The project covers a broad range of capabilities including atomic transaction management, prepared statement caching, and the mapping of database values to native application types. It provides utilities for online backups, database serialization, and the streaming of binary large objects.
Operational control is provided through schema inspection, resource limit management, and activity monitoring via event hooks and error logging.
Features
- SQL Query Execution - Executes SQL queries to retrieve single records, specific rows, or complete result sets.
- SQLite Integration - Provides a comprehensive interface for integrating SQLite as an embedded database within Rust applications.
- Data Type Mappings - Provides a type-system bridge to automate conversion between native application types and database column formats.
- Database Connections - Manages the lifecycle of opening and initializing connections to file-based or in-memory databases.
- Database Type Mappings - Transforms language-specific types including dates and JSON into compatible database data formats.
- Row Mapping Logic - Transforms raw database rows into structured objects using custom mapping functions.
- Database Value Conversions - Transforms database values into native language types including dates, UUIDs, and JSON.
- Embedded Databases - Functions as a lightweight embedded database engine bundled directly into the application binary.
- Named Parameter Bindings - Maps variables to placeholders using macros to simplify the preparation and execution of SQL queries.
- Prepared Statements - Compiles queries into reusable statements with bound variables to improve execution performance.
- Query Execution Optimizations - Implements performance optimizations including prepared statements and lazy row streaming to minimize resource consumption.
- Relational Database Drivers - Acts as a relational database driver managing connections, transactions, and prepared statements for SQLite.
- Relational Database Persistence - Enables relational data persistence using SQL queries and atomic transactions to maintain data integrity.
- Row-Based Result Streaming - Streams database records sequentially using lazy iteration to minimize memory consumption for large datasets.
- SQL Execution Interfaces - Executes database commands with custom parameters to modify data and retrieve affected row counts.
- SQL Query Interfaces - Provides an ergonomic SQL query wrapper for executing statements and mapping result rows to native types.
- SQLite Drivers - Offers a safe and ergonomic set of Rust bindings for interacting with SQLite databases.
- Transaction Management - Implements RAII-based transaction management that automatically triggers rollbacks if a transaction is dropped.
- C-API Wrappers - Provides an ergonomic object-oriented wrapper layer around low-level C functions of the SQLite engine.
- Custom Database Type Bindings - Serializes and deserializes complex types such as UUIDs, JSON, and timestamps to and from database columns.
- Streaming I/O - Implements streaming I/O to read, write, and seek binary large objects without loading them entirely into memory.
- Database Backup and Restoration - Provides utilities for online backups and database serialization to ensure data persistence and security.
- Database Backups - Provides utilities to save the current database to a specified path with optional progress tracking.
- Prepared Statement Engines - Stores compiled SQL statements for reuse to eliminate the overhead of repeated query preparation.
- Database Event Hooks - Implements callbacks for commit, rollback, and data change notifications to monitor database activity.
- Table Metadata Inspection - Provides capabilities to inspect table schemas, verify column existence, and retrieve metadata constraints.
- Database Restoration Tools - Provides utilities to populate the current database from a source path with optional progress tracking.
- Database Serializations - Enables converting a database into a byte stream or restoring a database from a byte stream.
- Binary Object Storage - Handles large binary data blobs through streaming I/O traits to minimize memory usage.
- Custom SQL Functions - Extends SQLite functionality by implementing custom scalar functions, collations, and virtual tables using Rust logic.
- User-Defined Functions - Supports the creation of user-defined functions to implement custom logic within SQL queries.
- Virtual Tables - Implements virtual tables to map external data sources into the database schema as queryable tables.
- Engine Bundling - Embeds the database engine directly into the binary to remove external library dependencies.
- Function-Pointer Callbacks - Allows registering native application functions as callbacks that the database engine invokes during query execution.
- External Library Linking - Supports both bundling the database engine into the binary and linking to shared system libraries at runtime.
- Table-Level Locks - Configures busy timeouts and callbacks to handle responses when database tables are locked.
