Skip to main content

TypeDBClient

Struct TypeDBClient 

Source
pub struct TypeDBClient { /* private fields */ }
Expand description

Wrapper around the TypeDB Rust driver providing a clean async API for query execution and schema retrieval.

Implementations§

Source§

impl TypeDBClient

Source

pub async fn connect(config: &TypeDBSection) -> Result<Self, PipelineError>

Connect to a TypeDB server using the provided configuration.

Source

pub async fn execute( &self, database: &str, typeql: &str, tx_type: &str, ) -> Result<Value, PipelineError>

Execute a TypeQL query and return results as JSON.

For read transactions, the transaction is used directly. For write and schema transactions, the transaction is committed after execution.

Source

pub async fn database_exists( &self, database: &str, ) -> Result<bool, PipelineError>

Return whether a TypeDB database exists on the connected server.

Source

pub async fn create_database(&self, database: &str) -> Result<(), PipelineError>

Create a TypeDB database.

Source

pub async fn delete_database(&self, database: &str) -> Result<(), PipelineError>

Delete a TypeDB database.

Source

pub async fn reset_database(&self, database: &str) -> Result<(), PipelineError>

Delete a TypeDB database if it exists, then create it.

Source

pub fn is_connected(&self) -> bool

Check if the driver connection is open.

Trait Implementations§

Source§

impl QueryExecutor for TypeDBClient

Source§

fn execute<'a>( &'a self, database: &'a str, typeql: &'a str, transaction_type: &'a str, ) -> Pin<Box<dyn Future<Output = Result<Value, PipelineError>> + Send + 'a>>

Execute a TypeQL string against the given database.
Source§

fn is_connected(&self) -> bool

Check if the backend connection is alive.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more