Struct ydb_unofficial::generated::ydb::table::v1::table_service_client::TableServiceClient

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

Implementations

impl TableServiceClient<Channel>

pub async fn connect<D>( dst: D ) -> impl Future<Output = Result<TableServiceClient<Channel>, Error>>where D: TryInto<Endpoint>, <D as TryInto<Endpoint>>::Error: Into<Box<dyn Error + Send + Sync, Global>>,

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

impl<T> TableServiceClient<T>where T: GrpcService<UnsyncBoxBody<Bytes, Status>>, <T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::Error: Into<Box<dyn Error + Send + Sync, Global>>, <T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::ResponseBody: Body<Data = Bytes> + Send + 'static, <<T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::ResponseBody as Body>::Error: Into<Box<dyn Error + Send + Sync, Global>> + Send,

pub fn new(inner: T) -> TableServiceClient<T>

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

pub fn with_interceptor<F>( inner: T, interceptor: F ) -> TableServiceClient<InterceptedService<T, F>>where F: Interceptor, <T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::ResponseBody: Default, T: Service<Request<UnsyncBoxBody<Bytes, Status>>, Response = Response<<T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::ResponseBody>>, <T as Service<Request<UnsyncBoxBody<Bytes, Status>>>>::Error: Into<Box<dyn Error + Send + Sync, Global>> + Send + Sync,

pub fn send_compressed( self, encoding: CompressionEncoding ) -> TableServiceClient<T>

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 ) -> TableServiceClient<T>

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> TableServiceClient<T>

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> TableServiceClient<T>

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn create_session( &mut self, request: impl IntoRequest<CreateSessionRequest> ) -> impl Future<Output = Result<Response<CreateSessionResponse>, Status>>

Create new session. Implicit session creation is forbidden, so user must create new session before execute any query, otherwise BAD_SESSION status will be returned. Simultaneous execution of requests are forbiden. Sessions are volatile, can be invalidated by server, for example in case of fatal errors. All requests with this session will fail with BAD_SESSION status. So, client must be able to handle BAD_SESSION status.

pub async fn delete_session( &mut self, request: impl IntoRequest<DeleteSessionRequest> ) -> impl Future<Output = Result<Response<DeleteSessionResponse>, Status>>

Ends a session, releasing server resources associated with it.

pub async fn keep_alive( &mut self, request: impl IntoRequest<KeepAliveRequest> ) -> impl Future<Output = Result<Response<KeepAliveResponse>, Status>>

Idle sessions can be kept alive by calling KeepAlive periodically.

pub async fn create_table( &mut self, request: impl IntoRequest<CreateTableRequest> ) -> impl Future<Output = Result<Response<CreateTableResponse>, Status>>

Creates new table.

pub async fn drop_table( &mut self, request: impl IntoRequest<DropTableRequest> ) -> impl Future<Output = Result<Response<DropTableResponse>, Status>>

Drop table.

pub async fn alter_table( &mut self, request: impl IntoRequest<AlterTableRequest> ) -> impl Future<Output = Result<Response<AlterTableResponse>, Status>>

Modifies schema of given table.

pub async fn copy_table( &mut self, request: impl IntoRequest<CopyTableRequest> ) -> impl Future<Output = Result<Response<CopyTableResponse>, Status>>

Creates copy of given table.

pub async fn copy_tables( &mut self, request: impl IntoRequest<CopyTablesRequest> ) -> impl Future<Output = Result<Response<CopyTablesResponse>, Status>>

Creates consistent copy of given tables.

pub async fn rename_tables( &mut self, request: impl IntoRequest<RenameTablesRequest> ) -> impl Future<Output = Result<Response<RenameTablesResponse>, Status>>

Creates consistent move of given tables.

pub async fn describe_table( &mut self, request: impl IntoRequest<DescribeTableRequest> ) -> impl Future<Output = Result<Response<DescribeTableResponse>, Status>>

Returns information about given table (metadata).

pub async fn explain_data_query( &mut self, request: impl IntoRequest<ExplainDataQueryRequest> ) -> impl Future<Output = Result<Response<ExplainDataQueryResponse>, Status>>

Explains data query. SessionId of previously created session must be provided.

pub async fn prepare_data_query( &mut self, request: impl IntoRequest<PrepareDataQueryRequest> ) -> impl Future<Output = Result<Response<PrepareDataQueryResponse>, Status>>

Prepares data query, returns query id. SessionId of previously created session must be provided.

pub async fn execute_data_query( &mut self, request: impl IntoRequest<ExecuteDataQueryRequest> ) -> impl Future<Output = Result<Response<ExecuteDataQueryResponse>, Status>>

Executes data query. SessionId of previously created session must be provided.

pub async fn execute_scheme_query( &mut self, request: impl IntoRequest<ExecuteSchemeQueryRequest> ) -> impl Future<Output = Result<Response<ExecuteSchemeQueryResponse>, Status>>

Executes scheme query. SessionId of previously created session must be provided.

pub async fn begin_transaction( &mut self, request: impl IntoRequest<BeginTransactionRequest> ) -> impl Future<Output = Result<Response<BeginTransactionResponse>, Status>>

Begins new transaction.

pub async fn commit_transaction( &mut self, request: impl IntoRequest<CommitTransactionRequest> ) -> impl Future<Output = Result<Response<CommitTransactionResponse>, Status>>

Commits specified active transaction.

pub async fn rollback_transaction( &mut self, request: impl IntoRequest<RollbackTransactionRequest> ) -> impl Future<Output = Result<Response<RollbackTransactionResponse>, Status>>

Performs a rollback of the specified active transaction.

pub async fn describe_table_options( &mut self, request: impl IntoRequest<DescribeTableOptionsRequest> ) -> impl Future<Output = Result<Response<DescribeTableOptionsResponse>, Status>>

Describe supported table options.

pub async fn stream_read_table( &mut self, request: impl IntoRequest<ReadTableRequest> ) -> impl Future<Output = Result<Response<Streaming<ReadTableResponse>>, Status>>

Streaming read table

pub async fn bulk_upsert( &mut self, request: impl IntoRequest<BulkUpsertRequest> ) -> impl Future<Output = Result<Response<BulkUpsertResponse>, Status>>

Upserts a batch of rows non-transactionally. Returns success only when all rows were successfully upserted. In case of an error some rows might be upserted and some might not.

pub async fn stream_execute_scan_query( &mut self, request: impl IntoRequest<ExecuteScanQueryRequest> ) -> impl Future<Output = Result<Response<Streaming<ExecuteScanQueryPartialResponse>>, Status>>

Executes scan query with streaming result.

Trait Implementations

impl<T> Clone for TableServiceClient<T>where T: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for TableServiceClient<T>where T: Debug,

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

Formats the value using the given formatter.