Docs.rs
  • sqlx-core-0.8.5
    • sqlx-core 0.8.5
    • Docs.rs crate page
    • MIT OR Apache-2.0
    • Links
    • Repository
    • crates.io
    • Source
    • Owners
    • mehcode
    • abonander
    • Dependencies
      • async-io ^1.9.0 normal optional
      • async-std ^1.12 normal optional
      • base64 ^0.22.0 normal
      • bigdecimal ^0.4.0 normal optional
      • bit-vec ^0.6.3 normal optional
      • bstr ^1.0 normal optional
      • bytes ^1.1.0 normal
      • chrono ^0.4.34 normal optional
      • crc ^3 normal optional
      • crossbeam-queue ^0.3.2 normal
      • either ^1.6.1 normal
      • event-listener ^5.2.0 normal
      • futures-core ^0.3.19 normal
      • futures-intrusive ^0.5.0 normal
      • futures-io ^0.3.24 normal
      • futures-util ^0.3.19 normal
      • hashbrown ^0.15.0 normal
      • hashlink ^0.10.0 normal
      • indexmap ^2.0 normal
      • ipnet ^2.3.0 normal optional
      • ipnetwork ^0.20.0 normal optional
      • log ^0.4.18 normal
      • mac_address ^1.1.5 normal optional
      • memchr ^2.4.1 normal
      • native-tls ^0.2.10 normal optional
      • once_cell ^1.9.0 normal
      • percent-encoding ^2.1.0 normal
      • regex ^1.5.5 normal optional
      • rust_decimal ^1.26.1 normal optional
      • rustls ^0.23.15 normal optional
      • rustls-native-certs ^0.8.0 normal optional
      • serde ^1.0.132 normal optional
      • serde_json ^1.0.73 normal optional
      • sha2 ^0.10.0 normal optional
      • smallvec ^1.7.0 normal
      • thiserror ^2.0.0 normal
      • time ^0.3.36 normal optional
      • tokio ^1 normal optional
      • tokio-stream ^0.1.8 normal optional
      • tracing ^0.1.37 normal
      • url ^2.2.2 normal
      • uuid ^1.1.2 normal optional
      • webpki-roots ^0.26 normal optional
      • sqlx =0.8.5 dev
      • tokio ^1 dev
    • Versions
    • 61.52% of the crate is documented
  • Go to latest version
  • Platform
    • i686-pc-windows-msvc
    • i686-unknown-linux-gnu
    • x86_64-apple-darwin
    • x86_64-pc-windows-msvc
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate sqlx_core

sqlx_core0.8.5

  • All Items

Sections

  • Note: Semver Exempt API

Crate Items

  • Re-exports
  • Modules
  • Macros
  • Structs
  • Enums

Crates

  • sqlx_core

Crate sqlx_core

Source
Expand description

Core of SQLx, the rust SQL toolkit.

§Note: Semver Exempt API

The API of this crate is not meant for general use and does not follow Semantic Versioning. The only crate that follows Semantic Versioning in the project is the sqlx crate itself. If you are building a custom SQLx driver, you should pin an exact version for sqlx-core to avoid breakages:

sqlx-core = { version = "=0.6.2" }

And then make releases in lockstep with sqlx-core. We recommend all driver crates, in-tree or otherwise, use the same version numbers as sqlx-core to avoid confusion.

Re-exports§

pub use error::Error;
pub use error::Result;
pub use percent_encoding;
pub use url;
pub use bytes;

Modules§

acquire
arguments
Types and traits for passing arguments to SQL queries.
column
common
connection
database
Traits to represent a database driver.
decode
Provides Decode for decoding values from the database.
describe
driver_prelude
Helper module to get drivers compiling again that used to be in this crate, to avoid having to replace tons of use crate::<...> imports.
encode
Provides Encode for encoding values for the database.
error
Types for working with errors produced by SQLx.
executor
ext
from_row
fs
hash_map
A hash map implemented with quadratic probing and SIMD lookup.
io
logger
net
pool
Provides the connection pool for asynchronous SQLx connections.
query
query_as
query_builder
Runtime query-builder API.
query_scalar
raw_sql
row
rt
statement
sync
transaction
type_checking
type_info
types
Conversions between Rust and SQL types.
value

Macros§

err_protocol
Format an error message as a Protocol error
impl_acquire
impl_column_index_for_row
impl_column_index_for_statement
impl_encode_for_option
impl_into_arguments_for_arguments
impl_statement_query
impl_type_checking
try_stream

Structs§

HashMap
A hash map implemented with quadratic probing and SIMD lookup.
IndexMap
A hash table where the iteration order of the key-value pairs is independent of the hash values of the keys.
SmallVec
A Vec-like container that can store a small number of elements inline.
Url
A parsed URL record.

Enums§

Either
The enum Either with variants Left and Right is a general purpose sum type with two cases.

Results

Settings
Help
    trait
    sqlx_core::executor::Executor
    A type that contains or can provide a database connection …
    module
    sqlx_core::executor
    trait
    sqlx_core::executor::Execute
    A type that may be executed against a database connection.
    method
    sqlx_core::executor::Executor::execute
    Execute the query and return the total number of rows …
    method
    sqlx_core::query::Query::execute
    Execute the query and return the total number of rows …
    method
    sqlx_core::raw_sql::RawSql::execute
    Execute the SQL string and return the total number of rows …
    method
    sqlx_core::raw_sql::RawSql::execute
    RawSql, E -> Result
    where
    E: Executor
    Execute the SQL string and return the total number of rows …
    method
    sqlx_core::raw_sql::RawSql::fetch_one
    RawSql, E -> Result
    where
    E: Executor
    Execute the SQL string, returning the first row or …
    method
    sqlx_core::raw_sql::RawSql::fetch_optional
    RawSql, E -> Result
    where
    E: Executor
    Execute the SQL string, returning the first row or None …
    method
    sqlx_core::raw_sql::RawSql::fetch_all
    RawSql, E -> Result<Vec>
    where
    E: Executor
    Execute the SQL string and return all the resulting rows …
    method
    sqlx_core::raw_sql::RawSql::execute_many
    RawSql, E -> BoxStream<Result>
    where
    E: Executor
    Execute the SQL string. Returns a stream which gives the …
    method
    sqlx_core::raw_sql::RawSql::fetch
    RawSql, E -> BoxStream<Result<Error>>
    where
    E: Executor
    Execute the SQL string and return the generated results as …
    method
    sqlx_core::raw_sql::RawSql::fetch_many
    RawSql, E -> BoxStream<Result<Either, Error>>
    where
    E: Executor
    Execute the SQL string and return the generated results as …
    method
    sqlx_core::executor::Executor::prepare
    Executor, &str -> BoxFuture<Result<Error>>
    Prepare the SQL query to inspect the type information of …
    method
    sqlx_core::executor::Executor::fetch
    Executor, E -> BoxStream<Result<Error>>
    Execute the query and return the generated results as a …
    method
    sqlx_core::executor::Executor::execute
    Executor, E -> BoxFuture<Result<Error>>
    Execute the query and return the total number of rows …
    method
    sqlx_core::executor::Executor::fetch_one
    Executor, E -> BoxFuture<Result<Error>>
    Execute the query and returns exactly one row.
    method
    sqlx_core::executor::Executor::execute_many
    Executor, E -> BoxStream<Result<Error>>
    Execute multiple queries and return the rows affected from …
    method
    sqlx_core::executor::Executor::fetch_all
    Executor, E -> BoxFuture<Result<Vec, Error>>
    Execute the query and return all the generated results, …
    trait method
    sqlx_core::executor::Executor::fetch_many
    Executor, E -> BoxStream<Result<Either, Error>>
    Execute multiple queries and return the generated results …
    trait method
    sqlx_core::executor::Executor::prepare_with
    Executor, &str, &[] -> BoxFuture<Result<Error>>
    Prepare the SQL query, with parameter type information, to …
    trait method
    sqlx_core::executor::Executor::fetch_optional
    Executor, E -> BoxFuture<Result<Option, Error>>
    Execute the query and returns at most one row.
    method
    sqlx_core::query::Query::execute
    Query<DB, A>, E -> Result<Error>
    where
    E: Executor<Database=DB>
    Execute the query and return the total number of rows …
    method
    sqlx_core::query::Query::fetch_one
    Query<DB, A>, E -> Result<Error>
    where
    E: Executor<Database=DB>
    Execute the query, returning the first row or …
    method
    sqlx_core::query::Query::fetch
    Query<DB, A>, E -> BoxStream<Result<Error>>
    where
    E: Executor<Database=DB>
    Execute the query and return the generated results as a …
    method
    sqlx_core::query::Query::fetch_all
    Query<DB, A>, E -> Result<Vec, Error>
    where
    E: Executor<Database=DB>
    Execute the query and return all the resulting rows …
    method
    sqlx_core::query::Query::fetch_optional
    Query<DB, A>, E -> Result<Option, Error>
    where
    E: Executor<Database=DB>
    Execute the query, returning the first row or None …
    method
    sqlx_core::query::Query::execute_many
    Query<DB, A>, E -> BoxStream<Result<Error>>
    where
    E: Executor<Database=DB>
    Execute multiple queries and return the rows affected from …
    method
    sqlx_core::query::Query::fetch_many
    Query<DB, A>, E -> BoxStream<Result<Either, Error>>
    where
    E: Executor<Database=DB>
    Execute multiple queries and return the generated results …
    method
    sqlx_core::query_scalar::QueryScalar::fetch_one
    QueryScalar<DB, O, A>, E -> Result<O, Error>
    where
    E: Executor<Database=DB>
    Execute the query, returning the first row or …
    method
    sqlx_core::query_scalar::QueryScalar::fetch
    QueryScalar<DB, O, A>, E -> BoxStream<Result<O, Error>>
    where
    E: Executor<Database=DB>
    Execute the query and return the generated results as a …
    method
    sqlx_core::query_scalar::QueryScalar::fetch_all
    QueryScalar<DB, O, A>, E -> Result<Vec<O>, Error>
    where
    E: Executor<Database=DB>
    Execute the query and return all the resulting rows …
    method
    sqlx_core::query_as::QueryAs::fetch_one
    QueryAs<DB, O, A>, E -> Result<O, Error>
    where
    E: Executor<Database=DB>
    Execute the query, returning the first row or …
    method
    sqlx_core::query_scalar::QueryScalar::fetch_optional
    QueryScalar<DB, O, A>, E -> Result<Option<O>, Error>
    where
    E: Executor<Database=DB>
    Execute the query, returning the first row or None …
    method
    sqlx_core::query_as::QueryAs::fetch
    QueryAs<DB, O, A>, E -> BoxStream<Result<O, Error>>
    where
    E: Executor<Database=DB>
    Execute the query and return the generated results as a …
    method
    sqlx_core::query_as::QueryAs::fetch_all
    QueryAs<DB, O, A>, E -> Result<Vec<O>, Error>
    where
    E: Executor<Database=DB>
    Execute the query and return all the resulting rows …
    method
    sqlx_core::query_as::QueryAs::fetch_optional
    QueryAs<DB, O, A>, E -> Result<Option<O>, Error>
    where
    E: Executor<Database=DB>
    Execute the query, returning the first row or None …
    method
    sqlx_core::query_scalar::QueryScalar::fetch_many
    QueryScalar<DB, O, A>, E -> BoxStream<Result<Either<O>, Error>>
    where
    E: Executor<Database=DB>
    Execute multiple queries and return the generated results …
    method
    sqlx_core::query_as::QueryAs::fetch_many
    QueryAs<DB, O, A>, E -> BoxStream<Result<Either<O>, Error>>
    where
    E: Executor<Database=DB>
    Execute multiple queries and return the generated results …
    method
    sqlx_core::query::Map::fetch_one
    Map<DB, F, A>, E -> Result<O, Error>
    where
    E: Executor<Database=DB>
    Execute the query, returning the first row or …
    method
    sqlx_core::query::Map::fetch
    Map<DB, F, A>, E -> BoxStream<Result<O, Error>>
    where
    E: Executor<Database=DB>
    Execute the query and return the generated results as a …
    method
    sqlx_core::query::Map::fetch_all
    Map<DB, F, A>, E -> Result<Vec<O>, Error>
    where
    E: Executor<Database=DB>
    Execute the query and return all the resulting rows …
    method
    sqlx_core::query::Map::fetch_optional
    Map<DB, F, A>, E -> Result<Option<O>, Error>
    where
    E: Executor<Database=DB>
    Execute the query, returning the first row or None …
    method
    sqlx_core::query::Map::fetch_many
    Map<DB, F, A>, E -> BoxStream<Result<Either<O>, Error>>
    where
    E: Executor<Database=DB>
    Execute multiple queries and return the generated results …
No results :(
Try on DuckDuckGo?

Or try looking in one of these:
  • The Rust Reference for technical details about the language.
  • Rust By Example for expository code examples.
  • The Rust Book for introductions to language features and the language itself.
  • Docs.rs for documentation of crates released on crates.io.