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 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
use std::collections::HashMap;
pub struct QueryBuilder<'a> {
segments: Vec<QueryBuilderSegment<'a>>,
parameters: HashMap<&'a str, &'a str>,
storage: Vec<String>,
}
impl<'a> QueryBuilder<'a> {
pub fn new() -> Self {
QueryBuilder {
segments: Vec::new(),
parameters: HashMap::new(),
storage: Vec::new(),
}
}
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new().create("Person:ee").build();
///
/// assert_eq!(query, "CREATE Person:ee")
/// ```
pub fn create(mut self, node: &'a str) -> Self {
self.add_segment_p("CREATE", node);
self
}
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new().update("Person:ee").build();
///
/// assert_eq!(query, "UPDATE Person:ee")
/// ```
pub fn update(mut self, node: &'a str) -> Self {
self.add_segment_p("UPDATE", node);
self
}
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new().select("ee:Person").build();
///
/// assert_eq!(query, "SELECT ee:Person")
/// ```
pub fn select(mut self, node: &'a str) -> Self {
self.add_segment_p("SELECT", node);
self
}
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new().from("Person").build();
///
/// assert_eq!(query, "FROM Person")
pub fn from(mut self, node: &'a str) -> Self {
self.add_segment_p("FROM", node);
self
}
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new().select_many(&["ee:Person", "o:Order"]).build();
///
/// assert_eq!(query, "SELECT ee:Person , o:Order")
/// ```
pub fn select_many(mut self, nodes: &[&'a str]) -> Self {
self.add_segment("SELECT");
self.join_segments(",", "", nodes, "");
self
}
/// Adds the supplied query with a comma in front of it
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new().also(&"ee").build();
///
/// assert_eq!(query, ", ee")
/// ```
pub fn also(mut self, query: &'a str) -> Self {
self.add_segment_p(",", query);
self
}
/// Adds the given segments, separated by the given `separator` and with a `prefix`
/// and a `suffix` added to them too.
///
/// # Example
/// ```rs
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new()
/// .join_segments(",", "set", &["handle", "id"], "")
/// .build();
///
/// assert_eq!(query, "set handle , set id");
/// ```
#[allow(dead_code)]
fn join_segments<T: Into<QueryBuilderSegment<'a>>>(
&mut self, seperator: &'a str, prefix: &'a str, segments: &[T], suffix: &'a str,
) -> &mut Self
where
T: Copy,
{
let segments_count = segments.len();
if segments_count <= 1 {
for segment in segments {
self.add_segment_ps(prefix, *segment, suffix);
}
return self;
}
for i in 0..segments_count - 1 {
self.add_segment_ps(prefix, segments[i], suffix);
self.add_segment(seperator);
}
self.add_segment_ps(prefix, segments[segments_count - 1], suffix);
self
}
/// Starts a WHERE clause.
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new()
/// .filter("handle = ?1")
/// .build();
///
/// assert_eq!(query, "WHERE handle = ?1");
/// ```
pub fn filter(mut self, condition: &'a str) -> Self {
self.add_segment_p("WHERE", condition);
self
}
/// An alias for `QueryBuilder::filter`
pub fn and_where(self, condition: &'a str) -> Self {
self.filter(condition)
}
/// Starts a WHERE clause.
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new()
/// .and("handle = ?1")
/// .build();
///
/// assert_eq!(query, "AND handle = ?1");
/// ```
pub fn and(mut self, condition: &'a str) -> Self {
self.add_segment_p("AND", condition);
self
}
/// Starts a SET clause.
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new()
/// .set("handle = ?1")
/// .build();
///
/// assert_eq!(query, "SET handle = ?1");
/// ```
pub fn set(mut self, update: &'a str) -> Self {
self.add_segment_p("SET", update);
self
}
/// Starts a SET clause with many fields.
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new()
/// .set_many(&["handle = $1", "password = $2"])
/// .build();
///
/// assert_eq!(query, "SET handle = $1 , password = $2");
/// ```
pub fn set_many<T: Into<QueryBuilderSegment<'a>>>(mut self, updates: &[T]) -> Self
where
T: Copy,
{
self.add_segment("SET");
self.join_segments(",", "", updates, "");
self
}
/// Starts a FETCH clause,
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new()
/// .fetch("author")
/// .build();
///
/// assert_eq!(query, "FETCH author");
/// ```
pub fn fetch(mut self, field: &'a str) -> Self {
self.add_segment_p("FETCH", field);
self
}
/// Starts a FETCH clause with zero or more fields,
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new()
/// .fetch_many(&["author", "projects"])
/// .build();
///
/// assert_eq!(query, "FETCH author , projects");
/// ```
pub fn fetch_many<T: Into<QueryBuilderSegment<'a>>>(mut self, fields: &[T]) -> Self
where
T: Copy,
{
self.add_segment("FETCH");
self.join_segments(",", "", fields, "");
self
}
/// Queues a condition which allows the next statement to be ignored if
/// `condition` is `false`.
///
/// Conditions can be nested, the queue works as a LIFO queue.
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new()
/// .select_many(&["1", "2"])
/// .if_then(false, |query| query
/// .select_many(&["3", "4"])
/// // will not run:
/// .if_then(true, |query| query
/// .select_many(&["5", "6"])
/// )
/// )
/// .if_then(true, |query| query
/// .select_many(&["7", "8"])
/// )
/// .build();
///
/// assert_eq!(query, "SELECT 1 , 2 SELECT 7 , 8");
/// ```
pub fn if_then(self, condition: bool, action: fn(Self) -> Self) -> Self {
if !condition {
return self;
}
action(self)
}
/// Pushes raw text to the buffer
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new()
/// .raw("foo bar")
/// .build();
///
/// assert_eq!(query, "foo bar");
/// ```
pub fn raw(mut self, text: &'a str) -> Self {
self.add_segment(text);
self
}
/// Start a queue where all of the new pushed actions are separated by commas.
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new()
/// .commas(|query| query
/// .raw("foo")
/// .raw("bar")
/// ).build();
///
/// assert_eq!(query, "foo , bar");
/// ```
pub fn commas(mut self, action: fn(Self) -> Self) -> Self {
let other = action(QueryBuilder::new());
for (index, segment) in other.segments.into_iter().enumerate() {
if index <= 0 {
self.segments.push(segment);
} else {
self.add_segment(",");
self.segments.push(segment);
}
}
self
}
/// Start a LIMIT clause.
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
///
/// let page_size = 10.to_string();
/// let query = QueryBuilder::new()
/// .limit(&page_size)
/// .build();
///
/// assert_eq!(query, "LIMIT 10")
///
/// ```
pub fn limit(mut self, limit: &'a str) -> Self {
self.add_segment_p("LIMIT", limit);
self
}
/// Start a START AT clause.
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
///
/// let page_size = 10.to_string();
/// let query = QueryBuilder::new()
/// .start_at(&page_size)
/// .build();
///
/// assert_eq!(query, "START AT 10")
///
/// ```
pub fn start_at(mut self, offset: &'a str) -> Self {
self.add_segment_p("START AT", offset);
self
}
/// Add the given segment to the internal buffer. This is a rather internal
/// method that is set public for special cases, you should prefer using the `raw`
/// method instead.
pub fn add_segment<T: Into<QueryBuilderSegment<'a>>>(&mut self, segment: T) -> &mut Self {
let into = segment.into();
if let QueryBuilderSegment::Str(s) = into {
if s.is_empty() {
return self;
}
}
self.segments.push(into);
self
}
fn add_segment_p<T: Into<QueryBuilderSegment<'a>>>(
&mut self, prefix: &'a str, segment: T,
) -> &mut Self {
self.add_segment(prefix).add_segment(segment)
}
fn add_segment_ps<T: Into<QueryBuilderSegment<'a>>>(
&mut self, prefix: &'a str, segment: T, suffix: &'a str,
) -> &mut Self {
self.add_segment_p(prefix, segment).add_segment(suffix)
}
/// Add a parameter and its value to the query that will be used to replace all
/// occurences of `key` into `value` when the `build` method is called.
///
/// **IMPORTANT** Do not use this for user provided data, the input is not sanitized
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = QueryBuilder::new()
/// .select("{{field}}")
/// .from("Account")
/// .param("{{field}}", "id")
/// .build();
///
/// assert_eq!("SELECT id FROM Account", query);
/// ```
pub fn param(mut self, key: &'a str, value: &'a str) -> Self {
self.parameters.insert(key, value);
self
}
pub fn build(self) -> String {
let mut output = self
.segments
.iter()
.map(|s| match s {
QueryBuilderSegment::Str(s) => s,
QueryBuilderSegment::Ref(i) => &self.storage[*i][..],
})
.collect::<Vec<&str>>()
.join(" ");
for (key, value) in self.parameters {
let key_size = key.len();
while let Some(index) = output.find(key) {
output.replace_range(index..index + key_size, value);
}
}
output
}
/// Tell the current query builder to execute the [QueryBuilderSetObject] trait
/// for the given `T` generic type.
pub fn set_object<T: QueryBuilderSetObject>(self) -> Self
where
T: 'a,
{
T::set_querybuilder_object(self)
}
/// Tell the current querybuilder to hold the given string into its internal
/// buffer and to return a reference to the newly held value a `QueryBuilder`
/// can use.
///
/// This function is particularely useful if some of your code is inside a
/// short-lived scope such as a closure but you still need to add segments to
/// the querybuilder. However the fact the querybuilder initially holds series
/// of `&'a str` makes it impossible, this is where you can tell the builder
/// to _hold_ the given string for you.
pub fn hold(&mut self, string: String) -> QueryBuilderSegment<'a> {
let i = self.storage.len();
self.storage.push(string);
QueryBuilderSegment::Ref(i)
}
}
/// This trait allows you to easily and safely convert a type into a series of
/// statements. One such case being a series of `field = $field` statements.
///
/// # Example
/// ```rs
/// impl QueryBuilderSetObject for Account {
/// fn set_querybuilder_object<'a>(mut querybuilder: QueryBuilder<'a>) -> QueryBuilder {
/// let a = &[
/// querybuilder.hold(schema::handle.equals_parameterized()),
/// querybuilder.hold(schema::password.equals_parameterized()),
/// querybuilder.hold(schema::email.equals_parameterized()),
/// querybuilder.hold(schema::roles.equals_parameterized()),
/// ];
///
/// querybuilder.set_many(a)
/// }
/// }
/// ```
///
/// which can be used like so:
/// ```rs
/// let query = QueryBuilder::new()
/// .create("Account:John")
/// .set_object::<Account>()
/// .build();
///
/// assert_eq!(
/// "CREATE Account:John SET handle = $handle , password = $password , email = $email , roles = $roles",
/// query
/// );
/// ```
///
/// Refer to the `test.rs` file to a more complete example.
pub trait QueryBuilderSetObject {
fn set_querybuilder_object<'b>(querybuilder: QueryBuilder<'b>) -> QueryBuilder<'b>;
}
#[derive(Clone, Copy)]
pub enum QueryBuilderSegment<'a> {
Str(&'a str),
Ref(usize),
}
impl<'a> From<&'a str> for QueryBuilderSegment<'a> {
fn from(i: &'a str) -> Self {
QueryBuilderSegment::Str(i)
}
}
impl<'a> From<usize> for QueryBuilderSegment<'a> {
fn from(i: usize) -> Self {
QueryBuilderSegment::Ref(i)
}
}