Struct SparkConnectServiceClient

pub struct SparkConnectServiceClient<T> { /* private fields */ }

Main interface for the SparkConnect service.

Implementations

impl SparkConnectServiceClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error>

where D: TryInto<Endpoint>, D::Error: Into<StdError>,

Attempt to create a new client by connecting to a given endpoint.

impl<T> SparkConnectServiceClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> SparkConnectServiceClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn execute_plan( &mut self, request: impl IntoRequest<ExecutePlanRequest>, ) -> Result<Response<Streaming<ExecutePlanResponse>>, Status>

Executes a request that contains the query and returns a stream of [[Response]].

It is guaranteed that there is at least one ARROW batch returned even if the result set is empty.

pub async fn analyze_plan( &mut self, request: impl IntoRequest<AnalyzePlanRequest>, ) -> Result<Response<AnalyzePlanResponse>, Status>

Analyzes a query and returns a [[AnalyzeResponse]] containing metadata about the query.

pub async fn config( &mut self, request: impl IntoRequest<ConfigRequest>, ) -> Result<Response<ConfigResponse>, Status>

Update or fetch the configurations and returns a [[ConfigResponse]] containing the result.

pub async fn add_artifacts( &mut self, request: impl IntoStreamingRequest<Message = AddArtifactsRequest>, ) -> Result<Response<AddArtifactsResponse>, Status>

Add artifacts to the session and returns a [[AddArtifactsResponse]] containing metadata about the added artifacts.

pub async fn artifact_status( &mut self, request: impl IntoRequest<ArtifactStatusesRequest>, ) -> Result<Response<ArtifactStatusesResponse>, Status>

Check statuses of artifacts in the session and returns them in a [[ArtifactStatusesResponse]]

pub async fn interrupt( &mut self, request: impl IntoRequest<InterruptRequest>, ) -> Result<Response<InterruptResponse>, Status>

Interrupts running executions

pub async fn reattach_execute( &mut self, request: impl IntoRequest<ReattachExecuteRequest>, ) -> Result<Response<Streaming<ExecutePlanResponse>>, Status>

Reattach to an existing reattachable execution. The ExecutePlan must have been started with ReattachOptions.reattachable=true. If the ExecutePlanResponse stream ends without a ResultComplete message, there is more to continue. If there is a ResultComplete, the client should use ReleaseExecute with

pub async fn release_execute( &mut self, request: impl IntoRequest<ReleaseExecuteRequest>, ) -> Result<Response<ReleaseExecuteResponse>, Status>

Release an reattachable execution, or parts thereof. The ExecutePlan must have been started with ReattachOptions.reattachable=true. Non reattachable executions are released automatically and immediately after the ExecutePlan RPC and ReleaseExecute may not be used.

Trait Implementations

impl<T: Clone> Clone for SparkConnectServiceClient<T>

fn clone(&self) -> SparkConnectServiceClient<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SparkConnectServiceClient<T>

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

Formats the value using the given formatter.