ClickHouseConnection

Struct ClickHouseConnection 

Source
pub struct ClickHouseConnection<'a> { /* private fields */ }
Expand description

A wrapper around ArrowPoolConnection that provides additional functionality relevant for DataFusion.

The methods ClickHouseConnection::tables, ClickHouseConnection::get_schema, and ClickHouseConnection::query_arrow will all be run against the ClickHouse instance.

Implementations§

Source§

impl<'a> ClickHouseConnection<'a>

Source

pub fn new(conn: ArrowPoolConnection<'a>) -> Self

Source

pub fn new_static(conn: ArrowPoolConnection<'static>) -> Self

Source

pub async fn query_arrow_with_schema( &self, sql: &str, params: &[()], schema: SchemaRef, coerce_schema: bool, ) -> Result<RecordBatchStreamWrapper, DataFusionError>

Issues a query against ClickHouse and returns the result as an arrow SendableRecordBatchStream using the provided schema.

The argument coerce_schema will be passed to RecordBatchStream only if projected_schema is also provided. Otherwise coercion won’t be necessary as the streamed RecordBatches will determine the schema.

§Errors
  • Returns an error if the query fails.
Source

pub async fn query_arrow( &self, sql: &str, params: &[()], projected_schema: Option<SchemaRef>, ) -> Result<SendableRecordBatchStream, GenericError>

Issues a query against ClickHouse and returns the result as an arrow SendableRecordBatchStream using the provided schema.

This method allows interop with datafusion-table-providers if desired. Otherwise, the method Self::query_arrow_raw can be used to prevent additional wrapping, or Self::query_arrow_with_schema if schema coercion is desired.

§Errors
  • Returns an error if the query fails.
Source§

impl ClickHouseConnection<'_>

Source

pub async fn tables(&self, schema: &str) -> Result<Vec<String>>

Fetch the names of the tables in a schema (database).

§Errors
  • Returns an error if the tables cannot be fetched.
Source

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

Fetch the names of the schemas (databases).

§Errors
  • Returns an error if the schemas cannot be fetched.
Source

pub async fn get_schema( &self, table_reference: &TableReference, ) -> Result<SchemaRef>

Fetch the schema for a table

§Errors
  • Returns an error if the schema cannot be fetched.
Source

pub async fn query_arrow_raw( &self, sql: &str, _params: &[()], ) -> Result<ClickHouseResponse<RecordBatch>>

Issues a query against ClickHouse and returns the raw ClickHouseResponse<RecordBatch>

§Errors
  • Returns an error if the query fails
Source

pub async fn execute( &self, sql: &str, _params: &[()], ) -> Result<u64, GenericError>

Executes a statement against ClickHouse and returns the number of affected rows.

§Errors
  • Returns an error if the query fails.

Trait Implementations§

Source§

impl<'a> Debug for ClickHouseConnection<'a>

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> 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> 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<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
Source§

impl<T> ErasedDestructor for T
where T: 'static,