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

// Copyright (c) 2021 ruarango developers
//
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. All files in the project carrying such notice may not be copied,
// modified, or distributed except according to those terms.

//! `ruarango` database trait

use crate::{
    common::output::Response,
    db::{input::Create, output::Current},
    types::ArangoResult,
};
use async_trait::async_trait;

/// Database Operations
#[async_trait]
pub trait Database {
    /// Retrieves the properties of the current database
    async fn current(&self) -> ArangoResult<Response<Current>>;
    /// Retrieves the list of all databases the current user can access without specifying a different username or password.
    async fn user(&self) -> ArangoResult<Response<Vec<String>>>;
    /// Retrieves the list of all existing databases
    /// *Note*: retrieving the list of databases is only possible from within the _system database.
    /// *Note*: You should use the `GET user API` to fetch the list of the available databases now.
    async fn list(&self) -> ArangoResult<Response<Vec<String>>>;
    /// Creates a new database
    /// *Note*: creating a new database is only possible from within the _system database.
    async fn create(&self, db: &Create) -> ArangoResult<Response<bool>>;
    /// Drops the database along with all data stored in it.
    /// *Note*: dropping a database is only possible from within the _system database.
    /// The _system database itself cannot be dropped.
    async fn drop(&self, name: &str) -> ArangoResult<Response<bool>>;
}