quaint
quaint copied to clipboard
SQL Query AST and Visitor for Rust
Quaint
Quaint is an abstraction over certain SQL databases. It provides:
- An AST for building dynamic SQL queries.
- Visitors for different databases to generate SQL strings.
- Connectors to abstract over results and querying.
- Pooling with mobc
- Async/await and Futures 0.3
Documentation
Feature flags
mysql: Support for MySQL databases.postgresql: Support for PostgreSQL databases.sqlite: Support for SQLite databases.mssql: Support for Microsoft SQL Server databases.pooled: A connection pool inpooled::Quaint.json: JSON type support withserde_jsoncrate.uuid: UUID type support withuuidcrate.chrono: DateTime type support withchronocrate.serde-support: Deserialize support from result set withserdecrate.bigdecimal: Numeric values can be read asBigDecimal.vendored-openssl: Statically links against a vendored OpenSSL library on non-Windows or non-Apple platforms.fmt-sql: Enables logging SQL queries formatted. TheFMT_SQLenv var must be present for the formatting to be enabled.
Goals:
- Query generation when the database and conditions are not known beforehand.
- Parameterized queries and SQL injection protection.
- A modular design, a separate AST and separate visitors and connectors.
Non-goals:
- Database-level type-safety in query building or being an ORM.
For type-safe database abstraction, Diesel is an excellent choice.
Testing:
- See
.envrcfor connection params. Override variables if different. MySQL, PostgreSQL and SQL Server needs to be running for tests to succeed.
Then:
> cargo test
Query debug
The queries can be logged by setting the LOG_QUERIES environment variable to any
value. They'll be logged at the INFO level and are visible when having a
logger in scope.
The FMT_SQL environment variable can be used to log formatted SQL queries. Beware, the fmt-sql feature must be enabled too.
Security
If you have a security issue to report, please contact us at [email protected]