Skip to main content

Client

Struct Client 

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

Asynchronous client for a running DataPress server.

Cheap to clone (wraps an Arc internally via reqwest::Client); share one instance across tasks.

Implementations§

Source§

impl Client

Source

pub fn new(base_url: impl Into<String>) -> Result<Self>

Construct a client with defaults for base_url.

Source

pub fn builder(base_url: impl Into<String>) -> ClientBuilder

Start a ClientBuilder.

Source

pub async fn healthz(&self) -> Result<JsonValue>

Liveness probe — GET /healthz (always at the host root).

Source

pub async fn readyz(&self) -> Result<JsonValue>

Readiness probe — GET /readyz. Returns a 503 error while the server is still loading datasets.

Source

pub async fn datasets(&self) -> Result<Vec<String>>

List registered dataset names.

Source

pub async fn schema(&self, dataset: &str) -> Result<JsonValue>

Fetch the schema description for dataset.

Source

pub async fn count( &self, dataset: &str, predicates: &[Predicate], ) -> Result<u64>

Count matching rows. predicates is the same predicate shape used by QueryRequest; None/empty = unfiltered.

Source

pub async fn query_json( &self, dataset: &str, request: &QueryRequest, ) -> Result<QueryResponse>

Run a structured query and return the decoded JSON envelope.

Source

pub async fn sql( &self, sql: impl Into<String>, max_rows: Option<u64>, ) -> Result<SqlResponse>

Run a raw read-only SQL statement (POST /sql). The endpoint must be enabled server-side ([sql].enabled = true), else a 404 is returned.

Source

pub async fn reload(&self, dataset: &str) -> Result<JsonValue>

Trigger an in-place reload of dataset (requires admin_token or the configured reload scopes).

Source

pub async fn query_arrow_bytes( &self, dataset: &str, request: &QueryRequest, ) -> Result<Bytes>

Run a structured query against the Arrow IPC streaming endpoint (POST /datasets/{name}/query/stream), returning the raw IPC stream bytes. Use Client::query_arrow to decode them into record batches.

Source

pub async fn query_arrow( &self, dataset: &str, request: &QueryRequest, ) -> Result<Vec<RecordBatch>>

Run a structured query and decode the Arrow IPC response into a vector of arrow::record_batch::RecordBatch.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<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