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
use crate::ast::*;
use std::borrow::Cow;
/// A builder for an `INSERT` statement.
#[derive(Clone, Debug, PartialEq)]
pub struct Insert<'a> {
pub(crate) table: Option<Table<'a>>,
pub(crate) columns: Vec<Column<'a>>,
pub(crate) values: Expression<'a>,
pub(crate) on_conflict: Option<OnConflict<'a>>,
pub(crate) returning: Option<Vec<Column<'a>>>,
pub(crate) comment: Option<Cow<'a, str>>,
}
/// A builder for an `INSERT` statement for a single row.
#[derive(Clone, Debug, PartialEq)]
pub struct SingleRowInsert<'a> {
pub(crate) table: Option<Table<'a>>,
pub(crate) columns: Vec<Column<'a>>,
pub(crate) values: Row<'a>,
}
/// A builder for an `INSERT` statement for multiple rows.
#[derive(Clone, Debug, PartialEq)]
pub struct MultiRowInsert<'a> {
pub(crate) table: Option<Table<'a>>,
pub(crate) columns: Vec<Column<'a>>,
pub(crate) values: Vec<Row<'a>>,
}
/// `INSERT` conflict resolution strategies.
#[allow(clippy::large_enum_variant)]
#[derive(Clone, Debug, PartialEq)]
pub enum OnConflict<'a> {
/// When a row already exists, do nothing. Works with PostgreSQL, MySQL or
/// SQLite without schema information.
///
/// ```rust
/// # use sqlint::{ast::*, visitor::{Visitor, Sqlite}};
/// # fn main() -> Result<(), sqlint::error::Error> {
/// let query: Insert = Insert::single_into("users").into();
/// let (sql, _) = Sqlite::build(query.on_conflict(OnConflict::DoNothing))?;
/// assert_eq!("INSERT OR IGNORE INTO `users` DEFAULT VALUES", sql);
/// # Ok(())
/// # }
/// ```
///
/// With Microsoft SQL server not supporting `IGNORE` in the `INSERT`
/// statement, the `INSERT` is converted to a `MERGE` statement. For it to work
/// in a correct way, the table should know all unique indices of the actual table.
///
/// In this example our `users` table holds one unique index for the `id` column.
///
/// ```rust
/// # use sqlint::{ast::*, visitor::{Visitor, Mssql}};
/// # use indoc::indoc;
/// # fn main() -> Result<(), sqlint::error::Error> {
/// let id = Column::from("id").table("users");
/// let table = Table::from("users").add_unique_index(id.clone());
/// let query: Insert = Insert::single_into(table).value(id, 1).into();
/// let (sql, _) = Mssql::build(query.on_conflict(OnConflict::DoNothing))?;
///
/// let expected_sql = indoc!(
/// "
/// MERGE INTO [users]
/// USING (SELECT @P1 AS [id]) AS [dual] ([id])
/// ON [dual].[id] = [users].[id]
/// WHEN NOT MATCHED THEN
/// INSERT ([id]) VALUES ([dual].[id]);
/// "
/// );
///
/// assert_eq!(expected_sql.replace('\n', " ").trim(), sql);
/// # Ok(())
/// # }
/// ```
///
/// If the `INSERT` statement misses a value for a unique column that does
/// not have default value set, the visitor will raise a panic. For compound
/// unique indices, the `add_unique_index` takes a vector as a parameter.
///
/// If the [column has a default value], it should be added to the `Column`
/// definition to allow inserting missing unique values with the `Insert`
/// statement. If default is set to [`DefaultValue::Generated`], the value
/// is considered to be always unique and not added to the join.
///
/// [`DefaultValue::Generated`]: enum.DefaultValue.html#variant.Generated
/// [column has a default value]: struct.Column.html#method.default
DoNothing,
/// ON CONFLICT UPDATE is supported for Sqlite and Postgres
Update(Update<'a>, Vec<Column<'a>>),
}
impl<'a> From<Insert<'a>> for Query<'a> {
fn from(insert: Insert<'a>) -> Self {
Query::Insert(Box::new(insert))
}
}
impl<'a> From<SingleRowInsert<'a>> for Insert<'a> {
fn from(insert: SingleRowInsert<'a>) -> Self {
let values =
if insert.values.is_empty() { Expression::from(Row::new()) } else { Expression::from(insert.values) };
Insert {
table: insert.table,
columns: insert.columns,
values,
on_conflict: None,
returning: None,
comment: None,
}
}
}
impl<'a> From<MultiRowInsert<'a>> for Insert<'a> {
fn from(insert: MultiRowInsert<'a>) -> Self {
let values = Expression::from(Values::new(insert.values));
Insert {
table: insert.table,
columns: insert.columns,
values,
on_conflict: None,
returning: None,
comment: None,
}
}
}
impl<'a> From<SingleRowInsert<'a>> for Query<'a> {
fn from(insert: SingleRowInsert<'a>) -> Query<'a> {
Query::from(Insert::from(insert))
}
}
impl<'a> From<MultiRowInsert<'a>> for Query<'a> {
fn from(insert: MultiRowInsert<'a>) -> Query<'a> {
Query::from(Insert::from(insert))
}
}
impl<'a> Insert<'a> {
/// Creates a new single row `INSERT` statement for the given table.
///
/// ```rust
/// # use sqlint::{ast::*, visitor::{Visitor, Sqlite}};
/// # fn main() -> Result<(), sqlint::error::Error> {
/// let query = Insert::single_into("users");
/// let (sql, _) = Sqlite::build(query)?;
///
/// assert_eq!("INSERT INTO `users` DEFAULT VALUES", sql);
/// # Ok(())
/// # }
/// ```
pub fn single_into<T>(table: T) -> SingleRowInsert<'a>
where
T: Into<Table<'a>>,
{
SingleRowInsert { table: Some(table.into()), columns: Vec::new(), values: Row::new() }
}
pub fn single() -> SingleRowInsert<'a> {
SingleRowInsert { table: None, columns: Vec::new(), values: Row::new() }
}
/// Creates a new multi row `INSERT` statement for the given table.
pub fn multi_into<T, K, I>(table: T, columns: I) -> MultiRowInsert<'a>
where
T: Into<Table<'a>>,
K: Into<Column<'a>>,
I: IntoIterator<Item = K>,
{
MultiRowInsert {
table: Some(table.into()),
columns: columns.into_iter().map(|c| c.into()).collect(),
values: Vec::new(),
}
}
pub fn multi<K, I>(columns: I) -> MultiRowInsert<'a>
where
K: Into<Column<'a>>,
I: IntoIterator<Item = K>,
{
MultiRowInsert { table: None, columns: columns.into_iter().map(|c| c.into()).collect(), values: Vec::new() }
}
pub fn expression_into<T, I, K, E>(table: T, columns: I, expression: E) -> Self
where
T: Into<Table<'a>>,
I: IntoIterator<Item = K>,
K: Into<Column<'a>>,
E: Into<Expression<'a>>,
{
Insert {
table: Some(table.into()),
columns: columns.into_iter().map(|c| c.into()).collect(),
values: expression.into(),
on_conflict: None,
returning: None,
comment: None,
}
}
/// Sets the conflict resolution strategy.
pub fn on_conflict(mut self, on_conflict: OnConflict<'a>) -> Self {
self.on_conflict = Some(on_conflict);
self
}
/// Adds a comment to the insert.
///
/// ```rust
/// # use sqlint::{ast::*, visitor::{Visitor, Sqlite}};
/// # fn main() -> Result<(), sqlint::error::Error> {
/// let query = Insert::single_into("users");
/// let insert = Insert::from(query).comment("trace_id='5bd66ef5095369c7b0d1f8f4bd33716a', parent_id='c532cb4098ac3dd2'");
/// let (sql, _) = Sqlite::build(insert)?;
///
/// assert_eq!("INSERT INTO `users` DEFAULT VALUES; /* trace_id='5bd66ef5095369c7b0d1f8f4bd33716a', parent_id='c532cb4098ac3dd2' */", sql);
/// # Ok(())
/// # }
/// ```
pub fn comment<C: Into<Cow<'a, str>>>(mut self, comment: C) -> Self {
self.comment = Some(comment.into());
self
}
/// Sets the returned columns.
///
/// ```rust
/// # use sqlint::{ast::*, visitor::{Visitor, Postgres}};
/// # fn main() -> Result<(), sqlint::error::Error> {
/// let query = Insert::single_into("users");
/// let insert = Insert::from(query).returning(vec!["id"]);
/// let (sql, _) = Postgres::build(insert)?;
///
/// assert_eq!("INSERT INTO \"users\" DEFAULT VALUES RETURNING \"id\"", sql);
/// # Ok(())
/// # }
/// ```
#[cfg(any(feature = "postgresql", feature = "mssql", feature = "sqlite"))]
#[cfg_attr(feature = "docs", doc(cfg(any(feature = "postgresql", feature = "mssql", feature = "sqlite"))))]
pub fn returning<K, I>(mut self, columns: I) -> Self
where
K: Into<Column<'a>>,
I: IntoIterator<Item = K>,
{
self.returning = Some(columns.into_iter().map(|k| k.into()).collect());
self
}
}
impl<'a> SingleRowInsert<'a> {
/// Adds a new value to the `INSERT` statement
///
/// ```rust
/// # use sqlint::{ast::*, visitor::{Visitor, Sqlite}};
/// # fn main() -> Result<(), sqlint::error::Error> {
/// let query = Insert::single_into("users").value("foo", 10);
/// let (sql, params) = Sqlite::build(query)?;
///
/// assert_eq!("INSERT INTO `users` (`foo`) VALUES (?)", sql);
/// assert_eq!(vec![Value::from(10)], params);
/// # Ok(())
/// # }
/// ```
pub fn value<K, V>(mut self, key: K, val: V) -> SingleRowInsert<'a>
where
K: Into<Column<'a>>,
V: Into<Expression<'a>>,
{
self.columns.push(key.into());
self.values.push(val.into());
self
}
/// Convert into a common `Insert` statement.
pub fn build(self) -> Insert<'a> {
Insert::from(self)
}
}
impl<'a> MultiRowInsert<'a> {
/// Adds a new row to be inserted.
///
/// ```rust
/// # use sqlint::{ast::*, visitor::{Visitor, Sqlite}};
/// # fn main() -> Result<(), sqlint::error::Error> {
/// let query = Insert::multi_into("users", vec!["foo"])
/// .values(vec![1])
/// .values(vec![2]);
///
/// let (sql, params) = Sqlite::build(query)?;
///
/// assert_eq!("INSERT INTO `users` (`foo`) VALUES (?), (?)", sql);
///
/// assert_eq!(
/// vec![
/// Value::from(1),
/// Value::from(2),
/// ], params);
/// # Ok(())
/// # }
/// ```
pub fn values<V>(mut self, values: V) -> Self
where
V: Into<Row<'a>>,
{
self.values.push(values.into());
self
}
/// Convert into a common `Insert` statement.
pub fn build(self) -> Insert<'a> {
Insert::from(self)
}
}