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 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
use std::sync::Arc;
use std::future::Future;
use bytes::BytesMut;
use edgedb_protocol::model::Json;
use edgedb_protocol::common::CompilationOptions;
use edgedb_protocol::common::{IoFormat, Capabilities, Cardinality};
use edgedb_protocol::query_arg::{QueryArgs, Encoder};
use edgedb_protocol::QueryResult;
use tokio::time::sleep;
use crate::raw::{Pool, QueryCapabilities};
use crate::builder::Config;
use crate::errors::{Error, ErrorKind, SHOULD_RETRY};
use crate::errors::{ProtocolEncodingError, NoResultExpected, NoDataError};
use crate::transaction::{Transaction, transaction};
use crate::options::{TransactionOptions, RetryOptions};
use crate::raw::{Options, PoolState};
use crate::state::{AliasesDelta, GlobalsDelta, ConfigDelta};
use crate::state::{AliasesModifier, GlobalsModifier, ConfigModifier, Fn};
/// EdgeDB Client
///
/// Internally it contains a connection pool.
///
/// To create client, use [`create_client`](crate::create_client) function (it
/// gets database connection configuration from environment). You can also use
/// [`Builder`](crate::Builder) to [`build`](`crate::Builder::build`) custom
/// [`Config`] and [create a client](Client::new) using that config.
#[derive(Debug, Clone)]
pub struct Client {
options: Arc<Options>,
pool: Pool,
}
impl Client {
/// Create a new connection pool.
///
/// Note this does not create a connection immediately.
/// Use [`ensure_connected()`][Client::ensure_connected] to establish a
/// connection and verify that the connection is usable.
pub fn new(config: &Config) -> Client {
Client {
options: Default::default(),
pool: Pool::new(config),
}
}
/// Ensure that there is at least one working connection to the pool.
///
/// This can be used at application startup to ensure that you have a
/// working connection.
pub async fn ensure_connected(&self) -> Result<(), Error> {
self.pool.acquire().await?;
Ok(())
}
/// Execute a query and return a collection of results.
///
/// You will usually have to specify the return type for the query:
///
/// ```rust,ignore
/// let greeting = pool.query::<String, _>("SELECT 'hello'", &());
/// // or
/// let greeting: Vec<String> = pool.query("SELECT 'hello'", &());
///
/// let two_numbers: Vec<i32> = conn.query("select {<int32>$0, <int32>$1}", &(10, 20)).await?;
/// ```
///
/// This method can be used with both static arguments, like a tuple of
/// scalars, and with dynamic arguments [`edgedb_protocol::value::Value`].
/// Similarly, dynamically typed results are also supported.
pub async fn query<R, A>(&self, query: &str, arguments: &A)
-> Result<Vec<R>, Error>
where A: QueryArgs,
R: QueryResult,
{
let mut iteration = 0;
loop {
let mut conn = self.pool.acquire().await?;
let conn = conn.inner();
let state = &self.options.state;
let caps = Capabilities::MODIFICATIONS | Capabilities::DDL;
match conn.query(query, arguments, state, caps).await {
Ok(resp) => return Ok(resp.data),
Err(e) => {
let allow_retry = match e.get::<QueryCapabilities>() {
// Error from a weird source, or just a bug
// Let's keep on the safe side
None => false,
Some(QueryCapabilities::Unparsed) => true,
Some(QueryCapabilities::Parsed(c)) => c.is_empty(),
};
if allow_retry && e.has_tag(SHOULD_RETRY) {
let rule = self.options.retry.get_rule(&e);
iteration += 1;
if iteration < rule.attempts {
let duration = (rule.backoff)(iteration);
log::info!("Error: {:#}. Retrying in {:?}...",
e, duration);
sleep(duration).await;
continue;
}
}
return Err(e);
}
}
}
}
/// Execute a query and return a single result
///
/// You will usually have to specify the return type for the query:
///
/// ```rust,ignore
/// let greeting = pool.query_single::<String, _>("SELECT 'hello'", &());
/// // or
/// let greeting: Option<String> = pool.query_single(
/// "SELECT 'hello'",
/// &()
/// );
/// ```
///
/// This method can be used with both static arguments, like a tuple of
/// scalars, and with dynamic arguments [`edgedb_protocol::value::Value`].
/// Similarly, dynamically typed results are also supported.
pub async fn query_single<R, A>(&self, query: &str, arguments: &A)
-> Result<Option<R>, Error>
where A: QueryArgs,
R: QueryResult,
{
let mut iteration = 0;
loop {
let mut conn = self.pool.acquire().await?;
let conn = conn.inner();
let state = &self.options.state;
let caps = Capabilities::MODIFICATIONS | Capabilities::DDL;
match conn.query_single(query, arguments, state, caps).await {
Ok(resp) => return Ok(resp.data),
Err(e) => {
let allow_retry = match e.get::<QueryCapabilities>() {
// Error from a weird source, or just a bug
// Let's keep on the safe side
None => false,
Some(QueryCapabilities::Unparsed) => true,
Some(QueryCapabilities::Parsed(c)) => c.is_empty(),
};
if allow_retry && e.has_tag(SHOULD_RETRY) {
let rule = self.options.retry.get_rule(&e);
iteration += 1;
if iteration < rule.attempts {
let duration = (rule.backoff)(iteration);
log::info!("Error: {:#}. Retrying in {:?}...",
e, duration);
sleep(duration).await;
continue;
}
}
return Err(e);
}
}
}
}
/// Execute a query and return a single result
///
/// The query must return exactly one element. If the query returns more
/// than one element, a
/// [`ResultCardinalityMismatchError`][crate::errors::ResultCardinalityMismatchError]
/// is raised. If the query returns an empty set, a
/// [`NoDataError`][crate::errors::NoDataError] is raised.
///
/// You will usually have to specify the return type for the query:
///
/// ```rust,ignore
/// let greeting = pool.query_required_single::<String, _>(
/// "SELECT 'hello'",
/// &(),
/// );
/// // or
/// let greeting: String = pool.query_required_single(
/// "SELECT 'hello'",
/// &(),
/// );
/// ```
///
/// This method can be used with both static arguments, like a tuple of
/// scalars, and with dynamic arguments [`edgedb_protocol::value::Value`].
/// Similarly, dynamically typed results are also supported.
pub async fn query_required_single<R, A>(&self, query: &str, arguments: &A)
-> Result<R, Error>
where A: QueryArgs,
R: QueryResult,
{
self.query_single(query, arguments).await?
.ok_or_else(|| NoDataError::with_message(
"query row returned zero results"))
}
/// Execute a query and return the result as JSON.
pub async fn query_json(&self, query: &str, arguments: &impl QueryArgs)
-> Result<Json, Error>
{
let mut iteration = 0;
loop {
let mut conn = self.pool.acquire().await?;
let flags = CompilationOptions {
implicit_limit: None,
implicit_typenames: false,
implicit_typeids: false,
explicit_objectids: true,
allow_capabilities: Capabilities::MODIFICATIONS | Capabilities::DDL,
io_format: IoFormat::Json,
expected_cardinality: Cardinality::Many,
};
let desc;
match conn.parse(&flags, query, &self.options.state).await {
Ok(parsed) => desc = parsed,
Err(e) => {
if e.has_tag(SHOULD_RETRY) {
let rule = self.options.retry.get_rule(&e);
iteration += 1;
if iteration < rule.attempts {
let duration = (rule.backoff)(iteration);
log::info!("Error: {:#}. Retrying in {:?}...",
e, duration);
sleep(duration).await;
continue;
}
}
return Err(e);
}
};
let inp_desc = desc.input()
.map_err(ProtocolEncodingError::with_source)?;
let mut arg_buf = BytesMut::with_capacity(8);
arguments.encode(&mut Encoder::new(
&inp_desc.as_query_arg_context(),
&mut arg_buf,
))?;
let res = conn.execute(
&flags, query, &self.options.state, &desc, &arg_buf.freeze(),
).await;
let data = match res {
Ok(data) => data,
Err(e) => {
dbg!(&e, e.has_tag(SHOULD_RETRY));
if desc.capabilities == Capabilities::empty() &&
e.has_tag(SHOULD_RETRY)
{
let rule = self.options.retry.get_rule(&e);
iteration += 1;
if iteration < rule.attempts {
let duration = (rule.backoff)(iteration);
log::info!("Error: {:#}. Retrying in {:?}...",
e, duration);
sleep(duration).await;
continue;
}
}
return Err(e);
}
};
let out_desc = desc.output()
.map_err(ProtocolEncodingError::with_source)?;
match out_desc.root_pos() {
Some(root_pos) => {
let ctx = out_desc.as_queryable_context();
// JSON objects are returned as strings :(
let mut state = String::prepare(&ctx, root_pos)?;
let bytes = data.into_iter().next()
.and_then(|chunk| chunk.data.into_iter().next());
if let Some(bytes) = bytes {
// we trust database to produce valid json
let s = String::decode(&mut state, &bytes)?;
return Ok(unsafe { Json::new_unchecked(s) })
} else {
return Err(NoDataError::with_message(
"query row returned zero results"))
}
}
None => return Err(NoResultExpected::build()),
}
}
}
/// Execute a query and return a single result as JSON.
///
/// The query must return exactly one element. If the query returns more
/// than one element, a
/// [`ResultCardinalityMismatchError`][crate::errors::ResultCardinalityMismatchError]
/// is raised.
pub async fn query_single_json(&self,
query: &str, arguments: &impl QueryArgs)
-> Result<Option<Json>, Error>
{
let mut iteration = 0;
loop {
let mut conn = self.pool.acquire().await?;
let flags = CompilationOptions {
implicit_limit: None,
implicit_typenames: false,
implicit_typeids: false,
explicit_objectids: true,
allow_capabilities: Capabilities::MODIFICATIONS | Capabilities::DDL,
io_format: IoFormat::Json,
expected_cardinality: Cardinality::AtMostOne,
};
let desc;
match conn.parse(&flags, query, &self.options.state).await {
Ok(parsed) => desc = parsed,
Err(e) => {
if e.has_tag(SHOULD_RETRY) {
let rule = self.options.retry.get_rule(&e);
iteration += 1;
if iteration < rule.attempts {
let duration = (rule.backoff)(iteration);
log::info!("Error: {:#}. Retrying in {:?}...",
e, duration);
sleep(duration).await;
continue;
}
}
return Err(e);
}
};
let inp_desc = desc.input()
.map_err(ProtocolEncodingError::with_source)?;
let mut arg_buf = BytesMut::with_capacity(8);
arguments.encode(&mut Encoder::new(
&inp_desc.as_query_arg_context(),
&mut arg_buf,
))?;
let res = conn.execute(
&flags, query, &self.options.state, &desc, &arg_buf.freeze(),
).await;
let data = match res {
Ok(data) => data,
Err(e) => {
if desc.capabilities == Capabilities::empty() &&
e.has_tag(SHOULD_RETRY)
{
let rule = self.options.retry.get_rule(&e);
iteration += 1;
if iteration < rule.attempts {
let duration = (rule.backoff)(iteration);
log::info!("Error: {:#}. Retrying in {:?}...",
e, duration);
sleep(duration).await;
continue;
}
}
return Err(e);
}
};
let out_desc = desc.output()
.map_err(ProtocolEncodingError::with_source)?;
match out_desc.root_pos() {
Some(root_pos) => {
let ctx = out_desc.as_queryable_context();
// JSON objects are returned as strings :(
let mut state = String::prepare(&ctx, root_pos)?;
let bytes = data.into_iter().next()
.and_then(|chunk| chunk.data.into_iter().next());
if let Some(bytes) = bytes {
// we trust database to produce valid json
let s = String::decode(&mut state, &bytes)?;
return Ok(Some(unsafe { Json::new_unchecked(s) }))
} else {
return Ok(None)
}
}
None => return Err(NoResultExpected::build()),
}
}
}
/// Execute a query and return a single result as JSON.
///
/// The query must return exactly one element. If the query returns more
/// than one element, a
/// [`ResultCardinalityMismatchError`][crate::errors::ResultCardinalityMismatchError]
/// is raised. If the query returns an empty set, a
/// [`NoDataError`][crate::errors::NoDataError] is raised.
pub async fn query_required_single_json(&self,
query: &str, arguments: &impl QueryArgs)
-> Result<Json, Error>
{
self.query_single_json(query, arguments).await?
.ok_or_else(|| NoDataError::with_message(
"query row returned zero results"))
}
/// Execute a query and don't expect result
///
/// This method can be used with both static arguments, like a tuple of
/// scalars, and with dynamic arguments [`edgedb_protocol::value::Value`].
/// Similarly, dynamically typed results are also supported.
pub async fn execute<A>(&self, query: &str, arguments: &A)
-> Result<(), Error>
where A: QueryArgs,
{
let mut iteration = 0;
loop {
let mut conn = self.pool.acquire().await?;
let conn = conn.inner();
let state = &self.options.state;
let caps = Capabilities::MODIFICATIONS | Capabilities::DDL;
match conn.execute(query, arguments, state, caps).await {
Ok(resp) => return Ok(resp.data),
Err(e) => {
let allow_retry = match e.get::<QueryCapabilities>() {
// Error from a weird source, or just a bug
// Let's keep on the safe side
None => false,
Some(QueryCapabilities::Unparsed) => true,
Some(QueryCapabilities::Parsed(c)) => c.is_empty(),
};
if allow_retry && e.has_tag(SHOULD_RETRY) {
let rule = self.options.retry.get_rule(&e);
iteration += 1;
if iteration < rule.attempts {
let duration = (rule.backoff)(iteration);
log::info!("Error: {:#}. Retrying in {:?}...",
e, duration);
sleep(duration).await;
continue;
}
}
return Err(e);
}
}
}
}
/// Execute a transaction
///
/// Transaction body must be encompassed in the closure. The closure **may
/// be executed multiple times**. This includes not only database queries
/// but also executing the whole function, so the transaction code must be
/// prepared to be idempotent.
///
/// # Returning custom errors
///
/// See [this example](https://github.com/edgedb/edgedb-rust/blob/master/edgedb-tokio/examples/transaction_errors.rs)
/// and [the documentation of the `edgedb_errors` crate](https://docs.rs/edgedb-errors/latest/edgedb_errors/)
/// for how to return custom error types.
///
/// # Panics
///
/// Function panics when transaction object passed to the closure is not
/// dropped after closure exists. General rule: do not store transaction
/// anywhere and do not send to another coroutine. Pass to all further
/// function calls by reference.
///
/// # Example
///
/// ```rust,no_run
/// # async fn transaction() -> Result<(), edgedb_tokio::Error> {
/// let conn = edgedb_tokio::create_client().await?;
/// let val = conn.transaction(|mut tx| async move {
/// tx.query_required_single::<i64, _>("
/// WITH C := UPDATE Counter SET { value := .value + 1}
/// SELECT C.value LIMIT 1
/// ", &()
/// ).await
/// }).await?;
/// # Ok(())
/// # }
/// ```
pub async fn transaction<T, B, F>(&self, body: B) -> Result<T, Error>
where B: FnMut(Transaction) -> F,
F: Future<Output=Result<T, Error>>,
{
transaction(&self.pool, &self.options, body).await
}
/// Returns client with adjusted options for future transactions.
///
/// This method returns a "shallow copy" of the current client
/// with modified transaction options.
///
/// Both ``self`` and returned client can be used after, but when using
/// them transaction options applied will be different.
///
/// Transaction options are used by the ``transaction`` method.
pub fn with_transaction_options(&self, options: TransactionOptions)
-> Self
{
Client {
options: Arc::new(Options {
transaction: options,
retry: self.options.retry.clone(),
state: self.options.state.clone(),
}),
pool: self.pool.clone(),
}
}
/// Returns client with adjusted options for future retrying
/// transactions.
///
/// This method returns a "shallow copy" of the current client
/// with modified transaction options.
///
/// Both ``self`` and returned client can be used after, but when using
/// them transaction options applied will be different.
pub fn with_retry_options(&self, options: RetryOptions)
-> Self
{
Client {
options: Arc::new(Options {
transaction: self.options.transaction.clone(),
retry: options,
state: self.options.state.clone(),
}),
pool: self.pool.clone(),
}
}
fn with_state(&self, f: impl FnOnce(&PoolState) -> PoolState) -> Self {
Client {
options: Arc::new(Options {
transaction: self.options.transaction.clone(),
retry: self.options.retry.clone(),
state: Arc::new(f(&self.options.state)),
}),
pool: self.pool.clone(),
}
}
/// Returns the client with the specified global variables set
///
/// Most commonly used with `#[derive(GlobalsDelta)]`.
///
/// Note: this method is incremental, i.e. it adds (or removes) globals
/// instead of setting a definite set of variables. Use
/// `.with_globals(Unset(["name1", "name2"]))` to unset some variables.
///
/// This method returns a "shallow copy" of the current client
/// with modified global variables
///
/// Both ``self`` and returned client can be used after, but when using
/// them transaction options applied will be different.
pub fn with_globals(&self, globals: impl GlobalsDelta) -> Self {
self.with_state(|s| s.with_globals(globals))
}
/// Returns the client with the specified global variables set
///
/// This method returns a "shallow copy" of the current client
/// with modified global variables
///
/// Both ``self`` and returned client can be used after, but when using
/// them transaction options applied will be different.
///
/// This is equivalent to `.with_globals(Fn(f))` but more ergonomic as it
/// allows type inference for lambda.
pub fn with_globals_fn(&self, f: impl FnOnce(&mut GlobalsModifier))
-> Self
{
self.with_state(|s| s.with_globals(Fn(f)))
}
/// Returns the client with the specified aliases set
///
/// This method returns a "shallow copy" of the current client
/// with modified aliases.
///
/// Both ``self`` and returned client can be used after, but when using
/// them transaction options applied will be different.
pub fn with_aliases(&self, aliases: impl AliasesDelta) -> Self {
self.with_state(|s| s.with_aliases(aliases))
}
/// Returns the client with the specified aliases set
///
/// This method returns a "shallow copy" of the current client
/// with modified aliases.
///
/// Both ``self`` and returned client can be used after, but when using
/// them transaction options applied will be different.
///
/// This is equivalent to `.with_aliases(Fn(f))` but more ergonomic as it
/// allows type inference for lambda.
pub fn with_aliases_fn(&self, f: impl FnOnce(&mut AliasesModifier))
-> Self
{
self.with_state(|s| s.with_aliases(Fn(f)))
}
/// Returns the client with the default module set or unset
///
/// This method returns a "shallow copy" of the current client
/// with modified default module.
///
/// Both ``self`` and returned client can be used after, but when using
/// them transaction options applied will be different.
pub fn with_default_module(&self, module: Option<impl Into<String>>)
-> Self
{
self.with_state(|s| s.with_default_module(module.map(|m| m.into())))
}
/// Returns the client with the specified config
///
/// Note: this method is incremental, i.e. it adds (or removes) individual
/// settings instead of setting a definite configuration. Use
/// `.with_config(Unset(["name1", "name2"]))` to unset some settings.
///
/// This method returns a "shallow copy" of the current client
/// with modified global variables
///
/// Both ``self`` and returned client can be used after, but when using
/// them transaction options applied will be different.
pub fn with_config(&self, cfg: impl ConfigDelta) -> Self {
self.with_state(|s| s.with_config(cfg))
}
/// Returns the client with the specified config
///
/// Most commonly used with `#[derive(ConfigDelta)]`.
///
/// This method returns a "shallow copy" of the current client
/// with modified global variables
///
/// Both ``self`` and returned client can be used after, but when using
/// them transaction options applied will be different.
///
/// This is equivalent to `.with_config(Fn(f))` but more ergonomic as it
/// allows type inference for lambda.
pub fn with_config_fn(&self, f: impl FnOnce(&mut ConfigModifier))
-> Self
{
self.with_state(|s| s.with_config(Fn(f)))
}
}