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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
use futures_core::stream::BoxStream;
use futures_util::{StreamExt, TryStreamExt};
use sqlx_core::{
Either, Error,
arguments::IntoArguments,
database::{Database, HasStatementCache},
executor::{Execute, Executor},
from_row::FromRow,
query::{Map, Query, query, query_with},
query_as::{QueryAs, query_as, query_as_with},
};
/// Internal executor for SQL templates
pub struct SqlTemplateExecute<'q, DB: Database> {
/// Reference to SQL query string
pub(crate) sql: &'q str,
/// SQL parameters
pub(crate) arguments: Option<DB::Arguments<'q>>,
/// Persistent flag
pub(crate) persistent: bool,
}
impl<'q, DB: Database> Clone for SqlTemplateExecute<'q, DB>
where
DB::Arguments<'q>: Clone,
{
fn clone(&self) -> Self {
SqlTemplateExecute {
sql: self.sql,
arguments: self.arguments.clone(),
persistent: self.persistent,
}
}
}
impl<'q, DB: Database> SqlTemplateExecute<'q, DB> {
/// Creates a new SQL template executor
pub fn new(sql: &'q str, arguments: Option<DB::Arguments<'q>>) -> Self {
SqlTemplateExecute {
sql,
arguments,
persistent: true,
}
}
/// If `true`, the statement will get prepared once and cached to the
/// connection's statement cache.
///
/// If queried once with the flag set to `true`, all subsequent queries
/// matching the one with the flag will use the cached statement until the
/// cache is cleared.
///
/// If `false`, the prepared statement will be closed after execution.
///
/// Default: `true`.
pub fn set_persistent(mut self, persistent: bool) -> Self {
self.persistent = persistent;
self
}
}
impl<'q, DB> SqlTemplateExecute<'q, DB>
where
DB: Database + HasStatementCache,
DB::Arguments<'q>: IntoArguments<'q, DB>,
{
/// to sqlx_core::QueryAs
/// Converts the SQL template to a `QueryAs` object, which can be executed to fetch rows
#[inline]
pub fn to_query_as<O>(self) -> QueryAs<'q, DB, O, DB::Arguments<'q>>
where
O: Send + Unpin + for<'r> FromRow<'r, DB::Row>,
{
let q = match self.arguments {
Some(args) => query_as_with(self.sql, args),
None => query_as(self.sql),
};
q.persistent(self.persistent)
}
/// to sqlx_core::Query
/// Converts the SQL template to a `Query` object, which can be executed to fetch rows
#[inline]
pub fn to_query(self) -> Query<'q, DB, DB::Arguments<'q>> {
let q = match self.arguments {
Some(args) => {
// let wrap = ArgWrapper(args);
query_with(self.sql, args)
}
None => query(self.sql),
};
q.persistent(self.persistent)
}
/// like sqlx_core::Query::map
/// Map each row in the result to another type.
#[inline]
pub fn map<F, O>(
self,
f: F,
) -> Map<'q, DB, impl FnMut(DB::Row) -> Result<O, sqlx_core::Error> + Send, DB::Arguments<'q>>
where
F: FnMut(DB::Row) -> O + Send,
O: Unpin,
{
self.to_query().map(f)
}
/// like sqlx_core::Query::try_map
/// Map each row in the result to another type, returning an error if the mapping fails.
#[inline]
pub fn try_map<F, O>(self, f: F) -> Map<'q, DB, F, DB::Arguments<'q>>
where
F: FnMut(DB::Row) -> Result<O, sqlx_core::Error> + Send,
O: Unpin,
{
self.to_query().try_map(f)
}
}
impl<'q, DB> SqlTemplateExecute<'q, DB>
where
DB: Database,
{
/// like sqlx_core::Query::execute
/// Execute the query and return the number of rows affected.
#[inline]
pub async fn execute<'e, 'c: 'e, E>(self, executor: E) -> Result<DB::QueryResult, Error>
where
'q: 'e,
DB::Arguments<'q>: 'q,
E: Executor<'c, Database = DB>,
{
executor.execute(self).await
}
/// like sqlx_core::Query::execute_many
/// Execute multiple queries and return the rows affected from each query, in a stream.
#[inline]
pub fn execute_many<'e, 'c: 'e, E>(
self,
executor: E,
) -> BoxStream<'e, Result<DB::QueryResult, Error>>
where
'q: 'e,
DB::Arguments<'q>: 'q,
E: Executor<'c, Database = DB>,
{
#[allow(deprecated)]
executor.execute_many(self)
}
/// like sqlx_core::Query::fetch
/// Execute the query and return the generated results as a stream.
#[inline]
pub fn fetch<'e, 'c: 'e, E>(self, executor: E) -> BoxStream<'e, Result<DB::Row, Error>>
where
'q: 'e,
DB::Arguments<'q>: 'q,
E: Executor<'c, Database = DB>,
{
executor.fetch(self)
}
/// like sqlx_core::Query::fetch_many
/// Execute multiple queries and return the generated results as a stream.
///
/// For each query in the stream, any generated rows are returned first,
/// then the `QueryResult` with the number of rows affected.
#[inline]
#[allow(clippy::type_complexity)]
pub fn fetch_many<'e, 'c: 'e, E>(
self,
executor: E,
) -> BoxStream<'e, Result<Either<DB::QueryResult, DB::Row>, Error>>
where
'q: 'e,
DB::Arguments<'q>: 'q,
E: Executor<'c, Database = DB>,
{
#[allow(deprecated)]
executor.fetch_many(self)
}
/// like sqlx_core::Query::fetch_all
/// Execute the query and return all the resulting rows collected into a [`Vec`].
///
/// ### Note: beware result set size.
/// This will attempt to collect the full result set of the query into memory.
///
/// To avoid exhausting available memory, ensure the result set has a known upper bound,
/// e.g. using `LIMIT`.
#[inline]
pub async fn fetch_all<'e, 'c: 'e, E>(self, executor: E) -> Result<Vec<DB::Row>, Error>
where
'q: 'e,
DB::Arguments<'q>: 'q,
E: Executor<'c, Database = DB>,
{
executor.fetch_all(self).await
}
/// like sqlx_core::Query::fetch_one
/// Execute the query, returning the first row or [`Error::RowNotFound`] otherwise.
///
/// ### Note: for best performance, ensure the query returns at most one row.
/// Depending on the driver implementation, if your query can return more than one row,
/// it may lead to wasted CPU time and bandwidth on the database server.
///
/// Even when the driver implementation takes this into account, ensuring the query returns at most one row
/// can result in a more optimal query plan.
///
/// If your query has a `WHERE` clause filtering a unique column by a single value, you're good.
///
/// Otherwise, you might want to add `LIMIT 1` to your query.
#[inline]
pub async fn fetch_one<'e, 'c: 'e, E>(self, executor: E) -> Result<DB::Row, Error>
where
'q: 'e,
DB::Arguments<'q>: 'q,
E: Executor<'c, Database = DB>,
{
executor.fetch_one(self).await
}
/// like sqlx_core::Query::fetch_optional
/// Execute the query, returning the first row or `None` otherwise.
///
/// ### Note: for best performance, ensure the query returns at most one row.
/// Depending on the driver implementation, if your query can return more than one row,
/// it may lead to wasted CPU time and bandwidth on the database server.
///
/// Even when the driver implementation takes this into account, ensuring the query returns at most one row
/// can result in a more optimal query plan.
///
/// If your query has a `WHERE` clause filtering a unique column by a single value, you're good.
///
/// Otherwise, you might want to add `LIMIT 1` to your query.
#[inline]
pub async fn fetch_optional<'e, 'c: 'e, E>(self, executor: E) -> Result<Option<DB::Row>, Error>
where
'q: 'e,
DB::Arguments<'q>: 'q,
E: Executor<'c, Database = DB>,
{
executor.fetch_optional(self).await
}
// QueryAs functions wrapp
/// like sqlx_core::QueryAs::fetch
/// Execute the query and return the generated results as a stream.
pub fn fetch_as<'e, 'c: 'e, O, E>(self, executor: E) -> BoxStream<'e, Result<O, Error>>
where
'q: 'e,
DB::Arguments<'q>: 'q,
E: 'e + Executor<'c, Database = DB>,
DB: 'e,
O: Send + Unpin + for<'r> FromRow<'r, DB::Row> + 'e,
{
self.fetch_many_as(executor)
.try_filter_map(|step| async move { Ok(step.right()) })
.boxed()
}
/// like sqlx_core::QueryAs::fetch_many
/// Execute multiple queries and return the generated results as a stream
/// from each query, in a stream.
pub fn fetch_many_as<'e, 'c: 'e, O, E>(
self,
executor: E,
) -> BoxStream<'e, Result<Either<DB::QueryResult, O>, Error>>
where
'q: 'e,
DB::Arguments<'q>: 'q,
E: 'e + Executor<'c, Database = DB>,
DB: 'e,
O: Send + Unpin + for<'r> FromRow<'r, DB::Row> + 'e,
{
#[allow(deprecated)]
executor
.fetch_many(self)
.map(|v| match v {
Ok(Either::Right(row)) => O::from_row(&row).map(Either::Right),
Ok(Either::Left(v)) => Ok(Either::Left(v)),
Err(e) => Err(e),
})
.boxed()
}
/// like sqlx_core::QueryAs::fetch_all
/// Execute the query and return all the resulting rows collected into a [`Vec`].
///
/// ### Note: beware result set size.
/// This will attempt to collect the full result set of the query into memory.
///
/// To avoid exhausting available memory, ensure the result set has a known upper bound,
/// e.g. using `LIMIT`.
#[inline]
pub async fn fetch_all_as<'e, 'c: 'e, O, E>(self, executor: E) -> Result<Vec<O>, Error>
where
'q: 'e,
DB::Arguments<'q>: 'q,
E: 'e + Executor<'c, Database = DB>,
DB: 'e,
O: Send + Unpin + for<'r> FromRow<'r, DB::Row> + 'e,
{
self.fetch_as(executor).try_collect().await
}
/// like sqlx_core::QueryAs::fetch_one
/// Execute the query, returning the first row or [`Error::RowNotFound`] otherwise.
///
/// ### Note: for best performance, ensure the query returns at most one row.
/// Depending on the driver implementation, if your query can return more than one row,
/// it may lead to wasted CPU time and bandwidth on the database server.
///
/// Even when the driver implementation takes this into account, ensuring the query returns at most one row
/// can result in a more optimal query plan.
///
/// If your query has a `WHERE` clause filtering a unique column by a single value, you're good.
///
/// Otherwise, you might want to add `LIMIT 1` to your query.
pub async fn fetch_one_as<'e, 'c: 'e, O, E>(self, executor: E) -> Result<O, Error>
where
'q: 'e,
DB::Arguments<'q>: 'q,
E: 'e + Executor<'c, Database = DB>,
DB: 'e,
O: Send + Unpin + for<'r> FromRow<'r, DB::Row> + 'e,
{
self.fetch_optional_as(executor)
.await
.and_then(|row| row.ok_or(sqlx_core::Error::RowNotFound))
}
/// like sqlx_core::QueryAs::fetch_optional
/// Execute the query, returning the first row or `None` otherwise.
///
/// ### Note: for best performance, ensure the query returns at most one row.
/// Depending on the driver implementation, if your query can return more than one row,
/// it may lead to wasted CPU time and bandwidth on the database server.
///
/// Even when the driver implementation takes this into account, ensuring the query returns at most one row
/// can result in a more optimal query plan.
///
/// If your query has a `WHERE` clause filtering a unique column by a single value, you're good.
///
/// Otherwise, you might want to add `LIMIT 1` to your query.
pub async fn fetch_optional_as<'e, 'c: 'e, O, E>(self, executor: E) -> Result<Option<O>, Error>
where
'q: 'e,
DB::Arguments<'q>: 'q,
E: 'e + Executor<'c, Database = DB>,
DB: 'e,
O: Send + Unpin + for<'r> FromRow<'r, DB::Row> + 'e,
{
let row = executor.fetch_optional(self).await?;
if let Some(row) = row {
O::from_row(&row).map(Some)
} else {
Ok(None)
}
}
}
impl<'q, DB: Database> Execute<'q, DB> for SqlTemplateExecute<'q, DB> {
/// Returns the SQL query string
#[inline]
fn sql(&self) -> &'q str {
log::debug!("Executing SQL: {}", self.sql);
self.sql
}
/// Gets prepared statement (not supported in this implementation)
#[inline]
fn statement(&self) -> Option<&DB::Statement<'q>> {
None
}
/// Takes ownership of the bound arguments
#[inline]
fn take_arguments(
&mut self,
) -> Result<Option<DB::Arguments<'q>>, sqlx_core::error::BoxDynError> {
Ok(self.arguments.take())
}
/// Checks if query is persistent
#[inline]
fn persistent(&self) -> bool {
self.persistent
}
}