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 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
#[cfg(feature = "sqlite")]
use crate::structure::InsertVars;
use crate::{
behavior::{push_unique, Concat, TransactionQuery, WithQuery},
fmt,
structure::{Insert, InsertClause, Select},
};
impl WithQuery for Insert {}
impl TransactionQuery for Insert {}
impl Insert {
/// Gets the current state of the [Insert] and returns it as string
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let query = sql::Insert::new()
/// .insert_into("users (login)")
/// .values("('foo')")
/// .as_string();
///
/// # let expected = "INSERT INTO users (login) VALUES ('foo')";
/// # assert_eq!(query, expected);
/// ```
///
/// Output
///
/// ```sql
/// INSERT INTO users (login) VALUES ('foo')
/// ```
pub fn as_string(&self) -> String {
let fmts = fmt::one_line();
self.concat(&fmts)
}
/// Prints the current state of the [Insert] to the standard output in a more ease to read version.
/// This method is useful to debug complex queries or just print the generated SQL while you type
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let insert_query = sql::Insert::new()
/// .insert_into("users (login, name)")
/// .values("('foo', 'Foo')")
/// .debug()
/// .values("('bar', 'Bar')")
/// .as_string();
/// ```
///
/// Prints to the standard output
///
/// ```sql
/// -- ------------------------------------------------------------------------------
/// INSERT INTO users (login, name)
/// VALUES ('foo', 'Foo')
/// -- ------------------------------------------------------------------------------
/// ```
pub fn debug(self) -> Self {
let fmts = fmt::multiline();
println!("{}", fmt::format(self.concat(&fmts), &fmts));
self
}
/// The `default values` clause
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let insert_query = sql::Insert::new()
/// .insert_into("users")
/// .default_values()
/// .to_string();
///
/// # let expected = "INSERT INTO users DEFAULT VALUES";
/// # assert_eq!(insert_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// INSERT INTO users DEFAULT VALUES
/// ```
pub fn default_values(mut self) -> Self {
self._default_values = true;
self
}
/// The `insert into` clause. This method overrides the previous value
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let insert = sql::Insert::new()
/// .insert_into("users (login, name)");
/// #
/// # let expected = "INSERT INTO users (login, name)";
/// # assert_eq!(insert.to_string(), expected);
///
/// let insert = sql::Insert::new()
/// .insert_into("addresses (state, country)")
/// .insert_into("users (login, name)");
///
/// # let expected = "INSERT INTO users (login, name)";
/// # assert_eq!(insert.to_string(), expected);
/// ```
#[cfg(not(feature = "sqlite"))]
pub fn insert_into(mut self, table_name: &str) -> Self {
self._insert_into = table_name.trim().to_string();
self
}
/// Creates instance of the Insert command
pub fn new() -> Self {
Self::default()
}
/// The `on conflict` clause. This method overrides the previous value
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let query = sql::Insert::new()
/// .insert_into("users (login)")
/// .on_conflict("do nothing")
/// .as_string();
///
/// # let expected = "INSERT INTO users (login) ON CONFLICT do nothing";
/// # assert_eq!(query, expected);
/// ```
///
/// Output
///
/// ```sql
/// INSERT INTO users (login) ON CONFLICT do nothing
/// ```
pub fn on_conflict(mut self, conflict: &str) -> Self {
self._on_conflict = conflict.trim().to_string();
self
}
/// The `overriding` clause. This method overrides the previous value
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let query = sql::Insert::new()
/// .insert_into("users (login)")
/// .overriding("user value")
/// .as_string();
///
/// # let expected = "INSERT INTO users (login) OVERRIDING user value";
/// # assert_eq!(query, expected);
/// ```
///
/// Output
///
/// ```sql
/// INSERT INTO users (login) OVERRIDING user value
/// ```
#[cfg(not(feature = "sqlite"))]
pub fn overriding(mut self, option: &str) -> Self {
self._overriding = option.trim().to_string();
self
}
/// Prints the current state of the [Insert] to the standard output similar to debug method,
/// the difference is that this method prints in one line.
pub fn print(self) -> Self {
let fmts = fmt::one_line();
println!("{}", fmt::format(self.concat(&fmts), &fmts));
self
}
/// The `select` clause. This method overrides the previous value
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let insert_query = sql::Insert::new()
/// .insert_into("users (login, name)")
/// .select(
/// sql::Select::new()
/// .select("login, name")
/// .from("users_bk")
/// .where_clause("active = true"),
/// )
/// .as_string();
///
/// # let expected = "\
/// # INSERT INTO users (login, name) \
/// # SELECT login, name \
/// # FROM users_bk \
/// # WHERE active = true\
/// # ";
/// # assert_eq!(insert_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// INSERT INTO users (login, name)
/// SELECT login, name
/// FROM users_bk
/// WHERE active = true
/// ```
pub fn select(mut self, select: Select) -> Self {
self._select = Some(select);
self
}
/// Adds at the beginning a raw SQL query.
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let raw_query = "insert into users (login, name)";
/// let insert_query = sql::Insert::new()
/// .raw(raw_query)
/// .values("('foo', 'Foo')")
/// .as_string();
///
/// # let expected = "insert into users (login, name) VALUES ('foo', 'Foo')";
/// # assert_eq!(insert_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// insert into users (login, name) VALUES ('foo', 'Foo')
/// ```
pub fn raw(mut self, raw_sql: &str) -> Self {
push_unique(&mut self._raw, raw_sql.trim().to_string());
self
}
/// Adds a raw SQL query after a specified clause.
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let raw = "values ('foo', 'Foo')";
/// let insert_query = sql::Insert::new()
/// .insert_into("users (login, name)")
/// .raw_after(sql::InsertClause::InsertInto, raw)
/// .as_string();
///
/// # let expected = "INSERT INTO users (login, name) values ('foo', 'Foo')";
/// # assert_eq!(insert_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// INSERT INTO users (login, name) values ('foo', 'Foo')
/// ```
pub fn raw_after(mut self, clause: InsertClause, raw_sql: &str) -> Self {
self._raw_after.push((clause, raw_sql.trim().to_string()));
self
}
/// Adds a raw SQL query before a specified clause.
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let raw = "insert into users (login, name)";
/// let insert_query = sql::Insert::new()
/// .raw_before(sql::InsertClause::Values, raw)
/// .values("('bar', 'Bar')")
/// .as_string();
///
/// # let expected = "insert into users (login, name) VALUES ('bar', 'Bar')";
/// # assert_eq!(insert_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// insert into users (login, name) VALUES ('bar', 'Bar')
/// ```
pub fn raw_before(mut self, clause: InsertClause, raw_sql: &str) -> Self {
self._raw_before.push((clause, raw_sql.trim().to_string()));
self
}
/// The `values` clause
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let query = sql::Insert::new()
/// .insert_into("users (login, name)")
/// .values("('foo', 'Foo')")
/// .values("('bar', 'Bar')")
/// .as_string();
///
/// # let expected = "INSERT INTO users (login, name) VALUES ('foo', 'Foo'), ('bar', 'Bar')";
/// # assert_eq!(query, expected);
/// ```
///
/// Output
///
/// ```sql
/// INSERT INTO users (login, name) VALUES ('foo', 'Foo'), ('bar', 'Bar')
/// ```
pub fn values(mut self, value: &str) -> Self {
push_unique(&mut self._values, value.trim().to_string());
self
}
}
#[cfg(any(doc, feature = "postgresql", feature = "sqlite"))]
impl Insert {
/// The `returning` clause, this method can be used enabling a feature flag
///
/// # Example
///
/// ```
/// # #[cfg(any(feature = "postgresql", feature = "sqlite"))]
/// # {
/// # use sql_query_builder as sql;
/// let insert_query = sql::Insert::new()
/// .insert_into("users")
/// .returning("id")
/// .returning("login")
/// .to_string();
///
/// # let expected = "INSERT INTO users RETURNING id, login";
/// # assert_eq!(insert_query, expected);
/// # }
/// ```
///
/// Output
///
/// ```sql
/// INSERT INTO users RETURNING id, login
/// ```
pub fn returning(mut self, output_name: &str) -> Self {
push_unique(&mut self._returning, output_name.trim().to_string());
self
}
/// The `with` clause, this method can be used enabling a feature flag
///
/// # Example
///
/// ```
/// # #[cfg(any(feature = "postgresql", feature = "sqlite"))]
/// # {
/// # use sql_query_builder as sql;
/// let active_users = sql::Select::new()
/// .select("*")
/// .from("users_bk")
/// .where_clause("ative = true");
///
/// let insert_query = sql::Insert::new()
/// .with("active_users", active_users)
/// .insert_into("users")
/// .select(sql::Select::new().select("*").from("active_users"))
/// .to_string();
///
/// # let expected = "\
/// # WITH active_users AS (\
/// # SELECT * \
/// # FROM users_bk \
/// # WHERE ative = true\
/// # ) \
/// # INSERT INTO users \
/// # SELECT * \
/// # FROM active_users\
/// # ";
/// # assert_eq!(insert_query, expected);
/// # }
/// ```
///
/// Output
///
/// ```sql
/// WITH active_users AS (
/// SELECT *
/// FROM users_bk
/// WHERE ative = true
/// )
/// INSERT INTO users
/// SELECT *
/// FROM active_users
/// ```
pub fn with(mut self, name: &str, query: impl WithQuery + 'static) -> Self {
self._with.push((name.trim().to_string(), std::sync::Arc::new(query)));
self
}
}
#[cfg(any(doc, feature = "sqlite"))]
impl Insert {
/// The `insert into` clause, this method overrides the previous value and can be used enabling the feature flag `sqlite`
#[cfg(not(doc))]
pub fn insert_into(mut self, expression: &str) -> Self {
self._insert = (InsertVars::InsertInto, expression.trim().to_string());
self
}
/// The `insert or <keyword> into` clause, this method can be used enabling the feature flag `sqlite`
///
/// # Example
///
/// ```
/// # #[cfg(feature = "sqlite")]
/// # {
/// # use sql_query_builder as sql;
/// let insert = sql::Insert::new()
/// .insert_or("abort into users (login, name)");
/// #
/// # let expected = "INSERT OR abort into users (login, name)";
/// # assert_eq!(insert.to_string(), expected);
///
/// let insert = sql::Insert::new()
/// .insert_or("fail into addresses (state, country)")
/// .insert_or("abort into users (login, name)");
///
/// # let expected = "INSERT OR abort into users (login, name)";
/// # assert_eq!(insert.to_string(), expected);
/// # }
/// ```
///
/// Output
///
/// ```sql
/// INSERT OR abort into users (login, name)
/// ```
pub fn insert_or(mut self, expression: &str) -> Self {
self._insert = (InsertVars::InsertOr, expression.trim().to_string());
self
}
/// The `replace into` clause, this method overrides the previous value and can be used enabling the feature flag `sqlite`
///
/// # Example
///
/// ```
/// # #[cfg(feature = "sqlite")]
/// # {
/// # use sql_query_builder as sql;
/// let insert = sql::Insert::new()
/// .replace_into("users (login, name)");
/// #
/// # let expected = "REPLACE INTO users (login, name)";
/// # assert_eq!(insert.to_string(), expected);
/// # }
/// ```
///
/// Output
///
/// ```sql
/// REPLACE INTO users (login, name)
/// ```
pub fn replace_into(mut self, expression: &str) -> Self {
self._insert = (InsertVars::ReplaceInto, expression.trim().to_string());
self
}
}
impl std::fmt::Display for Insert {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{}", self.as_string())
}
}
impl std::fmt::Debug for Insert {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
let fmts = fmt::multiline();
write!(f, "{}", fmt::format(self.concat(&fmts), &fmts))
}
}