Skip to main content

GrpcConnectionAsync

Struct GrpcConnectionAsync 

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

Async gRPC connection to a Hyper database (query-only).

This is the async version of GrpcConnection, designed for use with tokio-based async applications.

§Example

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut conn = GrpcConnectionAsync::connect(
        "http://localhost:7484",
        "my_database.hyper"
    ).await?;

    let arrow_data = conn.execute_query_to_arrow("SELECT * FROM users").await?;
    Ok(())
}

Implementations§

Source§

impl GrpcConnectionAsync

Source

pub async fn connect(endpoint: &str, database_path: &str) -> Result<Self>

Connects to a Hyper server via gRPC (async).

§Arguments
  • endpoint - The gRPC endpoint URL (e.g., “http://localhost:7484”)
  • database_path - Path to the database to query
§Errors

Returns crate::Error::Client if the HTTP/2 channel cannot be established (endpoint unreachable, TLS handshake failure).

Source

pub async fn connect_with_config(config: GrpcConfig) -> Result<Self>

Connects to a Hyper server via gRPC with custom configuration (async).

§Errors

Returns crate::Error::Client if the HTTP/2 channel cannot be established with the supplied configuration.

Source

pub async fn execute_query_to_arrow(&mut self, sql: &str) -> Result<Bytes>

Executes a SQL query and returns raw Arrow IPC bytes (async).

§Errors

Returns crate::Error::Client if the server rejects the query or the HTTP/2 channel fails mid-stream.

Source

pub async fn execute_query(&mut self, sql: &str) -> Result<GrpcQueryResult>

Executes a SQL query and returns a structured result (async).

§Errors

Returns crate::Error::Client if the server rejects the query or the HTTP/2 channel fails.

Source

pub async fn cancel_query(&mut self, query_id: &str) -> Result<()>

Cancels an in-flight gRPC query by its query_id (async).

See GrpcConnection::cancel_query for full semantics, including the “Fallible by design” discussion of why this returns Result<()> and why it is not an implementation of the Cancellable trait. The async variant avoids blocking the current thread; both variants route the cancel over the same channel used for queries, carrying this connection’s database routing and custom headers.

§Example
conn.cancel_query(query_id).await?;
§Errors

See GrpcConnection::cancel_query.

Source

pub fn database(&self) -> Option<&str>

Returns the database path, if one is attached.

Source

pub fn config(&self) -> &GrpcConfig

Returns the gRPC configuration.

Source

pub async fn close(self) -> Result<()>

Closes the connection (async).

§Errors

Returns crate::Error::Client if the underlying HTTP/2 channel cannot be shut down cleanly.

Trait Implementations§

Source§

impl Debug for GrpcConnectionAsync

Source§

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

Formats the value using the given formatter. Read more

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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

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

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<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