Struct arangors::connection::GenericConnection

source ·

pub struct GenericConnection<C: ClientExt, S = Normal> { /* private fields */ }

Expand description

Connection is the top level API for this crate. It contains a http client, information about authentication, arangodb url.

Implementations§

source §

impl<S, C: ClientExt> GenericConnection<C, S>

source

pub async fn validate_server(arango_url: &str) -> Result<(), ClientError>

Validate the server at given arango url

Cast ClientError if

Invalid url
Connection failed
SERVER header in response header is not ArangoDB or empty

source

pub fn url(&self) -> &Url

Get url for remote arangoDB server.

source

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

Get HTTP session.

Users can use this method to get a authorized session to access arbitrary path on arangoDB Server.

TODO This method should only be public in this crate when all features are implemented.

source

pub async fn db(&self, name: &str) -> Result<Database<C>, ClientError>

Get database object with name.

Note

this function would make a request to arango server.

source

pub async fn accessible_databases( &self ) -> Result<HashMap<String, Permission>, ClientError>

Get a list of accessible database

This function uses the API that is used to retrieve a list of all databases the current user can access.

Note

this function would make a request to arango server.

source

pub async fn server_role(&self) -> Result<String, ClientError>

Possible return values for role are: SINGLE: the server is a standalone server without clustering COORDINATOR: the server is a Coordinator in a cluster PRIMARY: the server is a DB-Server in a cluster SECONDARY: this role is not used anymore AGENT: the server is an Agency node in a cluster UNDEFINED: in a cluster, UNDEFINED is returned if the server role cannot be determined.

Note

this function would make a request to arango server.

source §

impl<C: ClientExt> GenericConnection<C, Normal>

source

pub async fn establish_without_auth<T: Into<String>>( arango_url: T ) -> Result<GenericConnection<C, Normal>, ClientError>

Establish connection to ArangoDB sever without Authentication.

The target server MUST DISABLE authentication for all requests, which should only used for test purpose.

Disable authentication means all operations are performed by root user.

Example:

use arangors::Connection;

let conn = Connection::establish_without_auth("http://localhost:8529").await.unwrap();

source

pub async fn establish_basic_auth( arango_url: &str, username: &str, password: &str ) -> Result<GenericConnection<C, Normal>, ClientError>

Establish connection to ArangoDB sever with basic auth.

Example:

use arangors::Connection;

let conn = Connection::establish_basic_auth("http://localhost:8529", "username", "password")
    .await
    .unwrap();

source

pub async fn establish_jwt( arango_url: &str, username: &str, password: &str ) -> Result<GenericConnection<C, Normal>, ClientError>

Establish connection to ArangoDB sever with jwt authentication.

Prefered way to interact with arangoDB server.

JWT token expires after 1 month.

Example:

use arangors::Connection;

let conn = Connection::establish_jwt("http://localhost:8529", "username", "password")
    .await
    .unwrap();

source

pub async fn create_database( &self, name: &str ) -> Result<Database<C>, ClientError>

Create a database via HTTP request and add it into self.databases.

If creation fails, an Error is cast. Otherwise, a bool is returned to indicate whether the database is correctly created.

Example

use arangors::Connection;
let conn = Connection::establish_jwt("http://localhost:8529", "root", "KWNngteTps7XjrNv")
    .await
    .unwrap();
let result = conn.create_database("new_db").await.unwrap();
println!("{:?}", result);

let result = conn.drop_database("new_db").await.unwrap();
println!("{:?}", result);