Crate sfo_sql

Source

Modules§

__rt
any
SEE DOCUMENTATION BEFORE USE. Runtime-generic database driver.
database
Traits to represent a database driver.
decode
Provides Decode for decoding values from the database.
encode
Provides Encode for encoding values for the database.
error
Types for working with errors produced by SQLx.
errors
migrate
mysql
pool
Provides the connection pool for asynchronous SQLx connections.
prelude
Convenience re-export of common traits.
query
Types and traits for the query family of functions and macros.
query_builder
Runtime query-builder API.
sqlx_macros
testing
types
Conversions between Rust and SQL types.

Macros§

migrate
Embeds migrations into the binary by expanding to a static instance of Migrator.
query
Statically checked SQL query with println!() style syntax.
query_as
A variant of query! which takes a path to an explicitly defined struct as the output type.
query_as_unchecked
A variant of query_as! which does not check the input or output types. This still does parse the query to ensure it’s syntactically and semantically valid for the current database.
query_file
A variant of query! where the SQL query is stored in a separate file.
query_file_as
Combines the syntaxes of query_as! and query_file!.
query_file_as_unchecked
A variant of query_file_as! which does not check the input or output types. This still does parse the query to ensure it’s syntactically and semantically valid for the current database.
query_file_scalar
A variant of query_scalar! which takes a file path like query_file!.
query_file_scalar_unchecked
A variant of query_file_scalar! which does not typecheck bind parameters and leaves the output type to inference. The query itself is still checked that it is syntactically and semantically valid for the database, that it only produces one column and that the number of bind parameters is correct.
query_file_unchecked
A variant of query_file! which does not check the input or output types. This still does parse the query to ensure it’s syntactically and semantically valid for the current database.
query_scalar
A variant of query! which expects a single column from the query and evaluates to an instance of QueryScalar.
query_scalar_unchecked
A variant of query_scalar! which does not typecheck bind parameters and leaves the output type to inference. The query itself is still checked that it is syntactically and semantically valid for the database, that it only produces one column and that the number of bind parameters is correct.
query_unchecked
A variant of query! which does not check the input or output types. This still does parse the query to ensure it’s syntactically and semantically valid for the current database.
sql_query

Structs§

Any
Opaque database driver. Capable of being used in place of any SQLx database driver. The actual driver used will be selected at runtime, from the connection url.
AnyConnection
A connection to any SQLx database.
MySql
MySQL database driver.
MySqlConnection
A connection to a MySQL database.
Pool
An asynchronous pool of SQLx database connections.
QueryBuilder
A builder type for constructing queries at runtime.
RawSql
One or more raw SQL statements, separated by semicolons (;).
Transaction
An in-progress database transaction or savepoint.

Enums§

Either
The enum Either with variants Left and Right is a general purpose sum type with two cases.
Error
Represents all the ways a method can fail within SQLx.

Traits§

Acquire
Acquire connections or transactions from a database in a generic way.
AnyExecutor
An alias for Executor<'_, Database = Any>.
Arguments
A tuple of arguments to be sent to the database.
Column
ColumnIndex
A type that can be used to index into a Row or Statement.
ConnectOptions
Connection
Represents a single database connection.
Database
A database driver.
Decode
A type that can be decoded from the database.
Encode
Encode a single value to be sent to the database.
Execute
A type that may be executed against a database connection.
Executor
A type that contains or can provide a database connection to use for executing queries against the database.
FromRow
A record that can be built from a row returned by the database.
IntoArguments
MySqlExecutor
An alias for Executor<'_, Database = MySql>.
Row
Represents a single row from the database.
Statement
An explicitly prepared statement.
Type
Indicates that a SQL type is supported for a database.
TypeInfo
Provides information about a SQL type for the database driver.
Value
An owned value from the database.
ValueRef
A reference to a single value from the database.

Functions§

__query_scalar_with_result
Same as query_scalar_with but takes arguments as Result
__query_with_result
Same as query_with but is initialized with a Result of arguments instead
query
Execute a single SQL query as a prepared statement (transparently cached).
query_as
Execute a single SQL query as a prepared statement (transparently cached). Maps rows to Rust types using FromRow.
query_as_with
Execute a single SQL query, with the given arguments as a prepared statement (transparently cached). Maps rows to Rust types using FromRow.
query_scalar
Execute a single SQL query as a prepared statement (transparently cached) and extract the first column of each row.
query_scalar_with
Execute a SQL query as a prepared statement (transparently cached), with the given arguments, and extract the first column of each row.
query_with
Execute a SQL query as a prepared statement (transparently cached), with the given arguments.
raw_sql
Execute one or more statements as raw SQL, separated by semicolons (;).
test_block_on

Type Aliases§

AnyPool
MySqlPool
An alias for Pool, specialized for MySQL.
MySqlTransaction
An alias for Transaction, specialized for MySQL.
Result
A specialized Result type for SQLx.

Attribute Macros§

test

Derive Macros§

Decode
Encode
FromRow
Type