Google Bigtable v2 API - Class Bigtable.BigtableBase (3.25.0)

Version latest

• 3.25.0 (latest)
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0

[BindServiceMethod(typeof(Bigtable), "BindService")]
public abstract class Bigtable.BigtableBase

Reference documentation and code samples for the Google Bigtable v2 API class Bigtable.BigtableBase.

Base class for server-side implementations of Bigtable

Inheritance

object > Bigtable.BigtableBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Methods

CheckAndMutateRow(CheckAndMutateRowRequest, ServerCallContext)

public virtual Task<CheckAndMutateRowResponse> CheckAndMutateRow(CheckAndMutateRowRequest request, ServerCallContext context)

Mutates a row atomically based on the output of a predicate Reader filter.

Parameters
Name	Description
request	CheckAndMutateRowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCheckAndMutateRowResponse	The response to send back to the client (wrapped by a task).

ExecuteQuery(ExecuteQueryRequest, IServerStreamWriter<ExecuteQueryResponse>, ServerCallContext)

public virtual Task ExecuteQuery(ExecuteQueryRequest request, IServerStreamWriter<ExecuteQueryResponse> responseStream, ServerCallContext context)

Executes a SQL query against a particular Bigtable instance.

Parameters
Name	Description
request	ExecuteQueryRequest The request received from the client.
responseStream	IServerStreamWriterExecuteQueryResponse Used for sending responses back to the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task	A task indicating completion of the handler.

GenerateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest, IServerStreamWriter<GenerateInitialChangeStreamPartitionsResponse>, ServerCallContext)

public virtual Task GenerateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest request, IServerStreamWriter<GenerateInitialChangeStreamPartitionsResponse> responseStream, ServerCallContext context)

Returns the current list of partitions that make up the table's change stream. The union of partitions will cover the entire keyspace. Partitions can be read with ReadChangeStream. NOTE: This API is only intended to be used by Apache Beam BigtableIO.

Parameters
Name	Description
request	GenerateInitialChangeStreamPartitionsRequest The request received from the client.
responseStream	IServerStreamWriterGenerateInitialChangeStreamPartitionsResponse Used for sending responses back to the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task	A task indicating completion of the handler.

MutateRow(MutateRowRequest, ServerCallContext)

public virtual Task<MutateRowResponse> MutateRow(MutateRowRequest request, ServerCallContext context)

Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by mutation.

Parameters
Name	Description
request	MutateRowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskMutateRowResponse	The response to send back to the client (wrapped by a task).

MutateRows(MutateRowsRequest, IServerStreamWriter<MutateRowsResponse>, ServerCallContext)

public virtual Task MutateRows(MutateRowsRequest request, IServerStreamWriter<MutateRowsResponse> responseStream, ServerCallContext context)

Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.

Parameters
Name	Description
request	MutateRowsRequest The request received from the client.
responseStream	IServerStreamWriterMutateRowsResponse Used for sending responses back to the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task	A task indicating completion of the handler.

PingAndWarm(PingAndWarmRequest, ServerCallContext)

public virtual Task<PingAndWarmResponse> PingAndWarm(PingAndWarmRequest request, ServerCallContext context)

Warm up associated instance metadata for this connection. This call is not required but may be useful for connection keep-alive.

Parameters
Name	Description
request	PingAndWarmRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPingAndWarmResponse	The response to send back to the client (wrapped by a task).

PrepareQuery(PrepareQueryRequest, ServerCallContext)

public virtual Task<PrepareQueryResponse> PrepareQuery(PrepareQueryRequest request, ServerCallContext context)

Prepares a GoogleSQL query for execution on a particular Bigtable instance.

Parameters
Name	Description
request	PrepareQueryRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPrepareQueryResponse	The response to send back to the client (wrapped by a task).

ReadChangeStream(ReadChangeStreamRequest, IServerStreamWriter<ReadChangeStreamResponse>, ServerCallContext)

public virtual Task ReadChangeStream(ReadChangeStreamRequest request, IServerStreamWriter<ReadChangeStreamResponse> responseStream, ServerCallContext context)

Reads changes from a table's change stream. Changes will reflect both user-initiated mutations and mutations that are caused by garbage collection. NOTE: This API is only intended to be used by Apache Beam BigtableIO.

Parameters
Name	Description
request	ReadChangeStreamRequest The request received from the client.
responseStream	IServerStreamWriterReadChangeStreamResponse Used for sending responses back to the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task	A task indicating completion of the handler.

ReadModifyWriteRow(ReadModifyWriteRowRequest, ServerCallContext)

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRow(ReadModifyWriteRowRequest request, ServerCallContext context)

Modifies a row atomically on the server. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.

Parameters
Name	Description
request	ReadModifyWriteRowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskReadModifyWriteRowResponse	The response to send back to the client (wrapped by a task).

ReadRows(ReadRowsRequest, IServerStreamWriter<ReadRowsResponse>, ServerCallContext)

public virtual Task ReadRows(ReadRowsRequest request, IServerStreamWriter<ReadRowsResponse> responseStream, ServerCallContext context)

Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each. Depending on their size, rows and cells may be broken up across multiple responses, but atomicity of each row will still be preserved. See the ReadRowsResponse documentation for details.

Parameters
Name	Description
request	ReadRowsRequest The request received from the client.
responseStream	IServerStreamWriterReadRowsResponse Used for sending responses back to the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task	A task indicating completion of the handler.

SampleRowKeys(SampleRowKeysRequest, IServerStreamWriter<SampleRowKeysResponse>, ServerCallContext)

public virtual Task SampleRowKeys(SampleRowKeysRequest request, IServerStreamWriter<SampleRowKeysResponse> responseStream, ServerCallContext context)

Returns a sample of row keys in the table. The returned row keys will delimit contiguous sections of the table of approximately equal size, which can be used to break up the data for distributed tasks like mapreduces.

Parameters
Name	Description
request	SampleRowKeysRequest The request received from the client.
responseStream	IServerStreamWriterSampleRowKeysResponse Used for sending responses back to the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task	A task indicating completion of the handler.