diesel/sqlite/
mod.rs

1//! Provides types and functions related to working with SQLite
2//!
3//! Much of this module is re-exported from database agnostic locations.
4//! However, if you are writing code specifically to extend Diesel on
5//! SQLite, you may need to work with this module directly.
6
7mod auto_extension;
8pub(crate) mod backend;
9pub(crate) mod connection;
10pub mod expression;
11mod function_behavior;
12
13pub mod query_builder;
14
15mod types;
16
17pub use self::auto_extension::cancel_auto_extension;
18pub use self::auto_extension::register_auto_extension;
19pub use self::auto_extension::reset_auto_extension;
20pub use self::backend::{Sqlite, SqliteType};
21pub use self::connection::AutoVacuumMode;
22pub use self::connection::BusyDecision;
23pub use self::connection::CommitDecision;
24pub use self::connection::ProgressDecision;
25pub use self::connection::SerializedDatabase;
26pub use self::connection::SqliteBindValue;
27pub use self::connection::SqliteConnection;
28pub use self::connection::SqliteLimit;
29pub use self::connection::SqliteTraceEvent;
30pub use self::connection::SqliteTraceFlags;
31pub use self::connection::SqliteValue;
32pub use self::connection::WalCheckpointMode;
33pub use self::connection::WalCheckpointOutcome;
34pub use self::connection::authorizer;
35pub use self::connection::sqlite_blob::SqliteReadOnlyBlob;
36pub use self::connection::{AuthorizerContext, AuthorizerDecision};
37pub use self::connection::{CollationNeededContext, SqliteTextRep};
38#[cfg(feature = "i-implement-a-third-party-backend-and-opt-into-breaking-changes")]
39pub use self::connection::{
40    OwnedSqliteBindValue, SqliteBindCollector, SqliteBindCollectorData, SqliteBindValueRef,
41};
42pub use self::connection::{
43    SqliteChangeEvent, SqliteChangeOp, SqliteChangeOps, SqliteUpdateRouter,
44};
45#[cfg(feature = "__sqlite-shared")]
46pub use self::function_behavior::SqliteFunctionBehavior;
47pub use self::query_builder::SqliteQueryBuilder;
48
49/// Trait for the implementation of a SQLite aggregate function
50///
51/// This trait is to be used in conjunction with the `define_sql_function!`
52/// macro for defining a custom SQLite aggregate function. See
53/// the documentation [there](super::prelude::define_sql_function!) for details.
54pub trait SqliteAggregateFunction<Args>: Default {
55    /// The result type of the SQLite aggregate function
56    type Output;
57
58    /// The `step()` method is called once for every record of the query.
59    ///
60    /// This is called through a C FFI, as such panics do not propagate to the caller. Panics are
61    /// caught and cause a return with an error value. The implementation must still ensure that
62    /// state remains in a valid state (refer to [`std::panic::UnwindSafe`] for a bit more detail).
63    fn step(&mut self, args: Args);
64
65    /// After the last row has been processed, the `finalize()` method is
66    /// called to compute the result of the aggregate function. If no rows
67    /// were processed `aggregator` will be `None` and `finalize()` can be
68    /// used to specify a default result.
69    ///
70    /// This is called through a C FFI, as such panics do not propagate to the caller. Panics are
71    /// caught and cause a return with an error value.
72    fn finalize(aggregator: Option<Self>) -> Self::Output;
73}
74
75/// SQLite specific sql types
76pub mod sql_types {
77    #[doc(inline)]
78    pub use super::types::Timestamptz;
79
80    #[cfg(feature = "__sqlite-shared")]
81    #[doc(inline)]
82    pub use super::types::JsonValidFlags;
83}
84
85#[cfg(feature = "__sqlite-shared")]
86pub use self::types::JsonValidFlag;
diesel/sqlite/mod.rs

diesel/sqlite/
mod.rs
