Struct arangors::database::Database

pub struct Database<'a, C: ClientExt> { /* fields omitted */ }

Implementations

impl<'a, C: ClientExt> Database<'a, C>

pub async fn accessible_collections<'_>(
    &'_ self
) -> Result<Vec<Info>, ClientError>

Retrieve all collections of this database.

Note

this function would make a request to arango server.

pub fn get_url(&self) -> &Url

pub fn get_session(&self) -> Arc<C>

pub async fn collection<'_, '_>(
    &'_ self,
    name: &'_ str
) -> Result<Collection<'a, C>, ClientError>

Get collection object with name.

Note

this function would make a request to arango server.

pub async fn create_edge_collection<'_, '_, '_>(
    &'_ self,
    _name: &'_ str
) -> Collection<'_, C>

pub async fn create_collection<'_, '_, '_>(
    &'_ mut self,
    name: &'_ str
) -> Result<Collection<'_, C>, ClientError>

Create a collection via HTTP request.

Return a collection object if success.

Note

this function would make a request to arango server.

pub async fn drop_collection<'_, '_>(
    &'_ mut self,
    name: &'_ str
) -> Result<String, ClientError>

Drops a collection

pub async fn arango_version<'_>(&'_ self) -> Result<Version, ClientError>

Get the version remote arango database server

Note

this function would make a request to arango server.

pub async fn info<'_>(&'_ self) -> Result<DatabaseDetails, ClientError>

Get information of current database.

Note

this function would make a request to arango server.

pub async fn aql_query_batch<R, '_, '_>(
    &'_ self,
    aql: AqlQuery<'_>
) -> Result<Cursor<R>, ClientError> where
    R: DeserializeOwned + Debug, 

Execute aql query, return a cursor if succeed. The major advantage of batch query is that cursors contain more information and stats about the AQL query, and users can fetch results in batch to save memory resources on clients.

Note

this function would make a request to arango server.

pub async fn aql_next_batch<R, '_, '_>(
    &'_ self,
    cursor_id: &'_ str
) -> Result<Cursor<R>, ClientError> where
    R: DeserializeOwned + Debug, 

Get next batch given the cursor id.

Note

this function would make a request to arango server.

pub async fn aql_query<R, '_, '_>(
    &'_ self,
    aql: AqlQuery<'_>
) -> Result<Vec<R>, ClientError> where
    R: DeserializeOwned + Debug, 

Execute AQL query fetch all results.

DO NOT do this when the count of results is too large that network or memory resources cannot afford.

DO NOT set a small batch size, otherwise clients will have to make many HTTP requests.

Note

this function would make a request to arango server.

pub async fn aql_str<R, '_, '_>(
    &'_ self,
    query: &'_ str
) -> Result<Vec<R>, ClientError> where
    R: DeserializeOwned + Debug, 

Similar to aql_query, except that this method only accept a string of AQL query.

Note

this function would make a request to arango server.

pub async fn aql_bind_vars<R, '_, '_, '_>(
    &'_ self,
    query: &'_ str,
    bind_vars: HashMap<&'_ str, Value>
) -> Result<Vec<R>, ClientError> where
    R: DeserializeOwned + Debug, 

Similar to aql_query, except that this method only accept a string of AQL query, with additional bind vars.

Note

this function would make a request to arango server.

Trait Implementations

impl<'a, C: Clone + ClientExt> Clone for Database<'a, C>

fn clone(&self) -> Database<'a, C>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, C: Debug + ClientExt> Debug for Database<'a, C>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.