Skip to main content

GpuResultHandle

Struct GpuResultHandle 

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

GPU-resident query result bound to an Arrow schema and runtime.

Cloning shares the underlying cuDF batch, runtime, and frozen resident leases. Same-device consumers may borrow the result as resident input; host materialization is explicit through to_host_record_batch.

Implementations§

Source§

impl GpuResultHandle

Source

pub fn new( context: &ExecutionContext, frame: GpuDataFrame, schema: SchemaRef, ) -> Result<Self>

Bind a GPU frame to a schema and the runtime from context.

The frame must already reside on the context’s device. Hidden DataFusion order columns may be stripped before schema binding.

Source

pub fn frame(&self) -> &DataFrame

Borrow the underlying GPU cuDF frame.

Source

pub fn read_on(&self, context: &ExecutionContext) -> Result<GpuDataFrame>

Borrows this result as a frame read on context’s stream. Once that frame and every frame derived from it have dropped, the resident owner’s final release also waits for the work the stream had enqueued by then.

Source

pub fn into_gpu_frame(self) -> GpuDataFrame

Consume the handle and return its GPU frame wrapper.

Source

pub fn schema(&self) -> &SchemaRef

Arrow schema bound to this result.

Source

pub fn runtime(&self) -> &Arc<Runtime> ⓘ

Shared cuDF runtime that created the handle.

Source

pub fn graph_residency(&self) -> Option<&GraphResidencyDescriptor>

Graph source provenance carried by this handle, when known.

Source

pub fn placement(&self) -> ExecutionPlacement

Current cuDF execution placement for the underlying batch.

Source

pub fn num_rows(&self) -> usize

Row count in the GPU result.

Source

pub fn num_columns(&self) -> usize

Column count in the GPU result.

Source

pub fn to_host_record_batch(&self) -> Result<RecordBatch>

Materialize this GPU result to host Arrow.

Source

pub fn into_host_batch_cursor( self, cancellation: ExecutionCancellation, config: HostBatchCursorConfig, ) -> Result<GpuHostBatchCursor>

Consume this result into a bounded incremental host materializer.

Source

pub fn into_host_batch_cursor_with_host_schema( self, output_schema: SchemaRef, cancellation: ExecutionCancellation, config: HostBatchCursorConfig, ) -> Result<GpuHostBatchCursor>

Consume this result into a bounded host materializer using an external schema whose field names, nullability, and metadata are bound by ordinal.

Trait Implementations§

Source§

impl Clone for GpuResultHandle

Source§

fn clone(&self) -> Self

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

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

Source§

type Output = T

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

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.
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