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

diesel/sqlite/
mod.rs
