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
use crate::{
backend::QueryBuilder, error::*, prepare::*, types::*, value::*, Query, QueryStatementBuilder,
SelectExpr, SelectStatement,
};
#[cfg(feature = "with-json")]
use serde_json::Value as JsonValue;
/// Insert any new rows into an existing table
///
/// # Examples
///
/// ```
/// use sea_query::{*, tests_cfg::*};
///
/// let query = Query::insert()
/// .into_table(Glyph::Table)
/// .columns(vec![
/// Glyph::Aspect,
/// Glyph::Image,
/// ])
/// .values_panic(vec![
/// 5.15.into(),
/// "12A".into(),
/// ])
/// .values_panic(vec![
/// 4.21.into(),
/// "123".into(),
/// ])
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// r#"INSERT INTO `glyph` (`aspect`, `image`) VALUES (5.15, '12A'), (4.21, '123')"#
/// );
/// assert_eq!(
/// query.to_string(PostgresQueryBuilder),
/// r#"INSERT INTO "glyph" ("aspect", "image") VALUES (5.15, '12A'), (4.21, '123')"#
/// );
/// assert_eq!(
/// query.to_string(SqliteQueryBuilder),
/// r#"INSERT INTO `glyph` (`aspect`, `image`) VALUES (5.15, '12A'), (4.21, '123')"#
/// );
/// ```
#[derive(Debug, Default, Clone)]
pub struct InsertStatement {
pub(crate) table: Option<Box<TableRef>>,
pub(crate) columns: Vec<DynIden>,
pub(crate) values: Vec<Vec<Value>>,
pub(crate) returning: Vec<SelectExpr>,
}
impl InsertStatement {
/// Construct a new [`InsertStatement`]
pub fn new() -> Self {
Self::default()
}
/// Specify which table to insert into.
///
/// # Examples
///
/// See [`InsertStatement::values`]
#[allow(clippy::wrong_self_convention)]
pub fn into_table<T>(&mut self, tbl_ref: T) -> &mut Self
where
T: IntoTableRef,
{
self.table = Some(Box::new(tbl_ref.into_table_ref()));
self
}
/// Specify what columns to insert.
///
/// # Examples
///
/// See [`InsertStatement::values`]
pub fn columns<C, I>(&mut self, columns: I) -> &mut Self
where
C: IntoIden,
I: IntoIterator<Item = C>,
{
self.columns = columns.into_iter().map(|c| c.into_iden()).collect();
self
}
/// Specify a row of values to be inserted.
///
/// # Examples
///
/// ```
/// use sea_query::{*, tests_cfg::*};
///
/// let query = Query::insert()
/// .into_table(Glyph::Table)
/// .columns(vec![
/// Glyph::Aspect,
/// Glyph::Image,
/// ])
/// .values(vec![
/// 2.1345.into(),
/// "24B".into(),
/// ])
/// .unwrap()
/// .values_panic(vec![
/// 5.15.into(),
/// "12A".into(),
/// ])
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// r#"INSERT INTO `glyph` (`aspect`, `image`) VALUES (2.1345, '24B'), (5.15, '12A')"#
/// );
/// assert_eq!(
/// query.to_string(PostgresQueryBuilder),
/// r#"INSERT INTO "glyph" ("aspect", "image") VALUES (2.1345, '24B'), (5.15, '12A')"#
/// );
/// assert_eq!(
/// query.to_string(SqliteQueryBuilder),
/// r#"INSERT INTO `glyph` (`aspect`, `image`) VALUES (2.1345, '24B'), (5.15, '12A')"#
/// );
/// ```
pub fn values<I>(&mut self, values: I) -> Result<&mut Self>
where
I: IntoIterator<Item = Value>,
{
let values = values.into_iter().collect::<Vec<_>>();
if self.columns.len() != values.len() {
return Err(Error::ColValNumMismatch {
col_len: self.columns.len(),
val_len: values.len(),
});
}
self.values.push(values);
Ok(self)
}
/// Specify a row of values to be inserted, variation of [`InsertStatement::values`].
pub fn values_panic<I>(&mut self, values: I) -> &mut Self
where
I: IntoIterator<Item = Value>,
{
self.values(values).unwrap()
}
/// RETURNING expressions. Postgres only.
///
/// ```
/// use sea_query::{*, tests_cfg::*};
///
/// let query = Query::insert()
/// .into_table(Glyph::Table)
/// .columns(vec![
/// Glyph::Image,
/// ])
/// .values_panic(vec![
/// "12A".into(),
/// ])
/// .returning(Query::select().column(Glyph::Id).take())
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// "INSERT INTO `glyph` (`image`) VALUES ('12A')"
/// );
/// assert_eq!(
/// query.to_string(PostgresQueryBuilder),
/// r#"INSERT INTO "glyph" ("image") VALUES ('12A') RETURNING "id""#
/// );
/// assert_eq!(
/// query.to_string(SqliteQueryBuilder),
/// "INSERT INTO `glyph` (`image`) VALUES ('12A')"
/// );
/// ```
pub fn returning(&mut self, select: SelectStatement) -> &mut Self {
self.returning = select.selects;
self
}
/// RETURNING a column after insertion. Postgres only. This is equivalent to MySQL's LAST_INSERT_ID.
/// Wrapper over [`InsertStatement::returning()`].
///
/// ```
/// use sea_query::{*, tests_cfg::*};
///
/// let query = Query::insert()
/// .into_table(Glyph::Table)
/// .columns(vec![
/// Glyph::Image,
/// ])
/// .values_panic(vec![
/// "12A".into(),
/// ])
/// .returning_col(Glyph::Id)
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// "INSERT INTO `glyph` (`image`) VALUES ('12A')"
/// );
/// assert_eq!(
/// query.to_string(PostgresQueryBuilder),
/// r#"INSERT INTO "glyph" ("image") VALUES ('12A') RETURNING "id""#
/// );
/// assert_eq!(
/// query.to_string(SqliteQueryBuilder),
/// "INSERT INTO `glyph` (`image`) VALUES ('12A')"
/// );
/// ```
pub fn returning_col<C>(&mut self, col: C) -> &mut Self
where
C: IntoIden,
{
self.returning(Query::select().column(col.into_iden()).take())
}
/// Specify a row of values to be inserted, taking a JSON Object as input.
/// Will panic if `object` is not serde_json::Value::Object.
///
/// # Example
///
/// ```
/// use sea_query::{*, tests_cfg::*};
///
/// let query = Query::insert()
/// .into_table(Glyph::Table)
/// .columns(vec![
/// Glyph::Aspect,
/// Glyph::Image,
/// ])
/// .json(json!({
/// "aspect": 2.1345,
/// "image": "24B",
/// }))
/// .json(json!({
/// "aspect": 4.21,
/// "image": "123",
/// }))
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// r#"INSERT INTO `glyph` (`aspect`, `image`) VALUES (2.1345, '24B'), (4.21, '123')"#
/// );
/// assert_eq!(
/// query.to_string(PostgresQueryBuilder),
/// r#"INSERT INTO "glyph" ("aspect", "image") VALUES (2.1345, '24B'), (4.21, '123')"#
/// );
/// assert_eq!(
/// query.to_string(SqliteQueryBuilder),
/// r#"INSERT INTO `glyph` (`aspect`, `image`) VALUES (2.1345, '24B'), (4.21, '123')"#
/// );
/// ```
#[cfg(feature = "with-json")]
#[cfg_attr(docsrs, doc(cfg(feature = "with-json")))]
pub fn json(&mut self, object: JsonValue) -> &mut Self {
match object {
JsonValue::Object(_) => (),
_ => panic!("must be JsonValue::Object"),
}
let mut values = Vec::new();
if self.columns.is_empty() {
let map = object.as_object().unwrap();
let mut keys: Vec<String> = map.keys().cloned().collect();
keys.sort();
for k in keys.iter() {
self.columns.push(SeaRc::new(Alias::new(k)));
}
}
for col in self.columns.iter() {
values.push(match object.get(col.to_string()) {
Some(value) => json_value_to_sea_value(value),
None => Value::Null,
});
}
self.values.push(values);
self
}
}
impl QueryStatementBuilder for InsertStatement {
/// Build corresponding SQL statement for certain database backend and collect query parameters
///
/// # Examples
///
/// ```
/// use sea_query::{*, tests_cfg::*};
///
/// let query = Query::insert()
/// .into_table(Glyph::Table)
/// .columns(vec![
/// Glyph::Aspect,
/// Glyph::Image,
/// ])
/// .values_panic(vec![
/// 3.1415.into(),
/// "041080".into(),
/// ])
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// r#"INSERT INTO `glyph` (`aspect`, `image`) VALUES (3.1415, '041080')"#
/// );
///
/// let mut params = Vec::new();
/// let mut collector = |v| params.push(v);
///
/// assert_eq!(
/// query.build_collect(MysqlQueryBuilder, &mut collector),
/// r#"INSERT INTO `glyph` (`aspect`, `image`) VALUES (?, ?)"#
/// );
/// assert_eq!(
/// params,
/// vec![
/// Value::Double(3.1415),
/// Value::String(Box::new(String::from("041080"))),
/// ]
/// );
/// ```
fn build_collect<T: QueryBuilder>(
&self,
query_builder: T,
collector: &mut dyn FnMut(Value),
) -> String {
let mut sql = SqlWriter::new();
query_builder.prepare_insert_statement(self, &mut sql, collector);
sql.result()
}
fn build_collect_any(
&self,
query_builder: &dyn QueryBuilder,
collector: &mut dyn FnMut(Value),
) -> String {
let mut sql = SqlWriter::new();
query_builder.prepare_insert_statement(self, &mut sql, collector);
sql.result()
}
}