Skip to main content

ArrowRegistration

Struct ArrowRegistration 

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

A scoped, owned Arrow source registered with chDB’s process-wide registry.

The reader and its C Stream stay alive until the registration is removed. Streaming queries borrow this handle mutably, so it cannot be closed or dropped while such a query is still being consumed. The raw registration methods remain available for callers managing C Data pointers themselves. Do not unregister its opaque name through another connection: core’s registry is process-wide and cannot guard against that external action.

Implementations§

Source§

impl<'a> ArrowRegistration<'a>

Source

pub fn sql_expr(&self) -> String

SQL table expression for this source, e.g. ArrowStream('...').

Source

pub fn query(&self, sql: &str, format: OutputFormat) -> Result<QueryResult>

Run a synchronous query while the source remains registered.

Source

pub fn query_arrow(&self, sql: &str) -> Result<ArrowReader>

Materialize an Arrow result while the source remains registered.

Source

pub fn query_stream_arrow(&mut self, sql: &str) -> Result<ArrowQueryStream<'_>>

Run a lazy Arrow query. The registration cannot be dropped until this stream is consumed, cancelled, or dropped.

Source

pub fn query_stream( &mut self, sql: &str, format: OutputFormat, ) -> Result<QueryStream<'_>>

Run a lazy text query under the same lifetime constraint.

Source

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

Unregister explicitly, returning an error if the engine refuses it. Dropping the handle also unregisters, but cannot report that error.

Trait Implementations§

Source§

impl Drop for ArrowRegistration<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'a> !Sync for ArrowRegistration<'a>

§

impl<'a> !UnwindSafe for ArrowRegistration<'a>

§

impl<'a> Forget for ArrowRegistration<'a>

§

impl<'a> Freeze for ArrowRegistration<'a>

§

impl<'a> Move for ArrowRegistration<'a>

§

impl<'a> RefUnwindSafe for ArrowRegistration<'a>

§

impl<'a> Send for ArrowRegistration<'a>

§

impl<'a> Unpin for ArrowRegistration<'a>

§

impl<'a> UnsafeUnpin for ArrowRegistration<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.