tork-orm-core 0.1.0

Core runtime for the Tork ORM: dialect-agnostic query model, typed columns, and database drivers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! The [`Executor`] abstraction over things that can run a query.
//!
//! Query terminal and write methods are generic over `Executor` rather than a
//! concrete [`Database`], so the same call site works against a pooled connection
//! today and, in a later phase, against an open transaction with no change to a
//! single query signature. In this phase [`Database`] (and shared references to it)
//! are the only implementors.

use std::future::Future;
use std::sync::Arc;

use crate::database::Database;
use crate::dialect::Dialect;
use crate::driver::ExecuteResult;
use crate::row::Row;
use crate::value::Value;

/// Something that can run SQL with bound parameters.
///
/// The query layer takes `executor: impl Executor`, which lets a caller pass
/// `&db` (a [`Database`]) and, later, a transaction handle interchangeably.
pub trait Executor {
    /// Returns the dialect SQL should be rendered with before running.
    fn dialect(&self) -> &dyn Dialect;

    /// Runs a row-returning query.
    fn fetch_all(
        &self,
        sql: String,
        params: Vec<Value>,
    ) -> impl Future<Output = crate::Result<Vec<Row>>> + Send;

    /// Runs a statement that returns no rows.
    fn execute(
        &self,
        sql: String,
        params: Vec<Value>,
    ) -> impl Future<Output = crate::Result<ExecuteResult>> + Send;
}

impl Executor for Database {
    fn dialect(&self) -> &dyn Dialect {
        Database::dialect(self).as_ref()
    }

    fn fetch_all(
        &self,
        sql: String,
        params: Vec<Value>,
    ) -> impl Future<Output = crate::Result<Vec<Row>>> + Send {
        Database::fetch_all(self, sql, params)
    }

    fn execute(
        &self,
        sql: String,
        params: Vec<Value>,
    ) -> impl Future<Output = crate::Result<ExecuteResult>> + Send {
        Database::execute(self, sql, params)
    }
}

// `Database` is injected into handlers as `Arc<Database>`; implementing `Executor`
// for the `Arc` lets a query take `&db` directly, with no manual deref.
impl Executor for Arc<Database> {
    fn dialect(&self) -> &dyn Dialect {
        <Database as Executor>::dialect(self)
    }

    fn fetch_all(
        &self,
        sql: String,
        params: Vec<Value>,
    ) -> impl Future<Output = crate::Result<Vec<Row>>> + Send {
        <Database as Executor>::fetch_all(self, sql, params)
    }

    fn execute(
        &self,
        sql: String,
        params: Vec<Value>,
    ) -> impl Future<Output = crate::Result<ExecuteResult>> + Send {
        <Database as Executor>::execute(self, sql, params)
    }
}

impl<T> Executor for &T
where
    T: Executor + Sync + ?Sized,
{
    fn dialect(&self) -> &dyn Dialect {
        T::dialect(self)
    }

    fn fetch_all(
        &self,
        sql: String,
        params: Vec<Value>,
    ) -> impl Future<Output = crate::Result<Vec<Row>>> + Send {
        T::fetch_all(*self, sql, params)
    }

    fn execute(
        &self,
        sql: String,
        params: Vec<Value>,
    ) -> impl Future<Output = crate::Result<ExecuteResult>> + Send {
        T::execute(*self, sql, params)
    }
}