Struct FrontendServiceClient

pub struct FrontendServiceClient<T> {
    inner: Grpc<T>,
}

Redap’s public API.

Fields

inner: Grpc<T>

Implementations

impl<T> FrontendServiceClient<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, ) -> FrontendServiceClient<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 find_entries( &mut self, request: impl IntoRequest<FindEntriesRequest>, ) -> Result<Response<FindEntriesResponse>, Status>

pub async fn delete_entry( &mut self, request: impl IntoRequest<DeleteEntryRequest>, ) -> Result<Response<DeleteEntryResponse>, Status>

pub async fn create_dataset_entry( &mut self, request: impl IntoRequest<CreateDatasetEntryRequest>, ) -> Result<Response<CreateDatasetEntryResponse>, Status>

pub async fn read_dataset_entry( &mut self, request: impl IntoRequest<ReadDatasetEntryRequest>, ) -> Result<Response<ReadDatasetEntryResponse>, Status>

pub async fn read_table_entry( &mut self, request: impl IntoRequest<ReadTableEntryRequest>, ) -> Result<Response<ReadTableEntryResponse>, Status>

pub async fn register_with_dataset( &mut self, request: impl IntoRequest<RegisterWithDatasetRequest>, ) -> Result<Response<RegisterWithDatasetResponse>, Status>

Register new partitions with the Dataset

pub async fn write_chunks( &mut self, request: impl IntoStreamingRequest<Message = WriteChunksRequest>, ) -> Result<Response<Streaming<WriteChunksResponse>>, Status>

Unimplemented.

pub async fn get_partition_table_schema( &mut self, request: impl IntoRequest<GetPartitionTableSchemaRequest>, ) -> Result<Response<GetPartitionTableSchemaResponse>, Status>

Returns the schema of the partition table (i.e. the dataset manifest) itself, not the underlying dataset.

• To inspect the data of the partition table, use ScanPartitionTable.
• To retrieve the schema of the underlying dataset, use GetDatasetSchema instead.

pub async fn scan_partition_table( &mut self, request: impl IntoRequest<ScanPartitionTableRequest>, ) -> Result<Response<Streaming<ScanPartitionTableResponse>>, Status>

Inspect the contents of the partition table (i.e. the dataset manifest).

The returned data will follow the schema specified by GetPartitionTableSchema.

pub async fn get_dataset_schema( &mut self, request: impl IntoRequest<GetDatasetSchemaRequest>, ) -> Result<Response<GetDatasetSchemaResponse>, Status>

Returns the schema of the dataset.

This is the union of all the schemas from all the underlying partitions. It will contain all the indexes, entities and components present in the dataset.

pub async fn create_index( &mut self, request: impl IntoRequest<CreateIndexRequest>, ) -> Result<Response<CreateIndexResponse>, Status>

Creates a custom index for a specific column (vector search, full-text search, etc).

pub async fn re_index( &mut self, request: impl IntoRequest<ReIndexRequest>, ) -> Result<Response<ReIndexResponse>, Status>

Recreate an index with the same configuration but (potentially) new data.

pub async fn search_dataset( &mut self, request: impl IntoRequest<SearchDatasetRequest>, ) -> Result<Response<Streaming<SearchDatasetResponse>>, Status>

Search a previously created index.

pub async fn query_dataset( &mut self, request: impl IntoRequest<QueryDatasetRequest>, ) -> Result<Response<Streaming<QueryDatasetResponse>>, Status>

Perform Rerun-native queries on a dataset, returning the matching chunk IDs.

These Rerun-native queries include:

• Filtering by specific partition and chunk IDs.
• Latest-at, range and dataframe queries.
• Arbitrary Lance filters.

To fetch the actual chunks themselves, see GetChunks.

Passing chunk IDs to this method effectively acts as a IF_EXIST filter.

pub async fn get_chunks( &mut self, request: impl IntoRequest<GetChunksRequest>, ) -> Result<Response<Streaming<GetChunksResponse>>, Status>

Perform Rerun-native queries on a dataset, returning the underlying chunks.

These Rerun-native queries include:

• Filtering by specific partition and chunk IDs.
• Latest-at, range and dataframe queries.
• Arbitrary Lance filters.

To fetch only the actual chunk IDs rather than the chunks themselves, see QueryDataset.

pub async fn get_table_schema( &mut self, request: impl IntoRequest<GetTableSchemaRequest>, ) -> Result<Response<GetTableSchemaResponse>, Status>

pub async fn scan_table( &mut self, request: impl IntoRequest<ScanTableRequest>, ) -> Result<Response<Streaming<ScanTableResponse>>, Status>

pub async fn query_tasks( &mut self, request: impl IntoRequest<QueryTasksRequest>, ) -> Result<Response<QueryTasksResponse>, Status>

— Tasks service — Query the status of submitted tasks

pub async fn fetch_task_output( &mut self, request: impl IntoRequest<FetchTaskOutputRequest>, ) -> Result<Response<FetchTaskOutputResponse>, Status>

Fetch the output of a completed task

pub async fn query_tasks_on_completion( &mut self, request: impl IntoRequest<QueryTasksOnCompletionRequest>, ) -> Result<Response<Streaming<QueryTasksOnCompletionResponse>>, Status>

Query the status of submitted tasks as soon as they are no longer pending

Trait Implementations

impl<T: Clone> Clone for FrontendServiceClient<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for FrontendServiceClient<T>

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

Formats the value using the given formatter.