public static interface BigQueryWriteGrpc.AsyncServiceBigQuery Write API. The Write API can be used to write data to BigQuery. The google.cloud.bigquery.storage.v1 API should be used instead of the v1beta2 API for BigQueryWrite operations.
Methods
appendRows(StreamObserver<AppendRowsResponse> responseObserver)
public default StreamObserver<AppendRowsRequest> appendRows(StreamObserver<AppendRowsResponse> responseObserver) Appends data to the given stream.
If offset is specified, the offset is checked against the end of
stream. The server returns OUT_OF_RANGE in AppendRowsResponse if an
attempt is made to append to an offset beyond the current end of the stream
or ALREADY_EXISTS if user provids an offset that has already been
written to. User can retry with adjusted offset within the same RPC
stream. If offset is not specified, append happens at the end of the
stream.
The response contains the offset at which the append happened. Responses
are received in the same order in which requests are sent. There will be
one response for each successful request. If the offset is not set in
response, it means append didn't happen due to some errors. If one request
fails, all the subsequent requests will also fail until a success request
is made again.
If the stream is of PENDING type, data will only be available for read
operations after the stream is committed.
| Parameter | |
|---|---|
| Name | Description |
responseObserver | io.grpc.stub.StreamObserver<AppendRowsResponse> |
| Returns | |
|---|---|
| Type | Description |
io.grpc.stub.StreamObserver<AppendRowsRequest> | |
batchCommitWriteStreams(BatchCommitWriteStreamsRequest request, StreamObserver<BatchCommitWriteStreamsResponse> responseObserver)
public default void batchCommitWriteStreams(BatchCommitWriteStreamsRequest request, StreamObserver<BatchCommitWriteStreamsResponse> responseObserver) Atomically commits a group of PENDING streams that belong to the same
parent table.
Streams must be finalized before commit and cannot be committed multiple
times. Once a stream is committed, data in the stream becomes available
for read operations.
| Parameters | |
|---|---|
| Name | Description |
request | BatchCommitWriteStreamsRequest |
responseObserver | io.grpc.stub.StreamObserver<BatchCommitWriteStreamsResponse> |
createWriteStream(CreateWriteStreamRequest request, StreamObserver<WriteStream> responseObserver)
public default void createWriteStream(CreateWriteStreamRequest request, StreamObserver<WriteStream> responseObserver)Creates a write stream to the given table. Additionally, every table has a special COMMITTED stream named '_default' to which data can be written. This stream doesn't need to be created using CreateWriteStream. It is a stream that can be used simultaneously by any number of clients. Data written to this stream is considered committed as soon as an acknowledgement is received.
| Parameters | |
|---|---|
| Name | Description |
request | CreateWriteStreamRequest |
responseObserver | io.grpc.stub.StreamObserver<WriteStream> |
finalizeWriteStream(FinalizeWriteStreamRequest request, StreamObserver<FinalizeWriteStreamResponse> responseObserver)
public default void finalizeWriteStream(FinalizeWriteStreamRequest request, StreamObserver<FinalizeWriteStreamResponse> responseObserver)Finalize a write stream so that no new data can be appended to the stream. Finalize is not supported on the '_default' stream.
| Parameters | |
|---|---|
| Name | Description |
request | FinalizeWriteStreamRequest |
responseObserver | io.grpc.stub.StreamObserver<FinalizeWriteStreamResponse> |
flushRows(FlushRowsRequest request, StreamObserver<FlushRowsResponse> responseObserver)
public default void flushRows(FlushRowsRequest request, StreamObserver<FlushRowsResponse> responseObserver)Flushes rows to a BUFFERED stream. If users are appending rows to BUFFERED stream, flush operation is required in order for the rows to become available for reading. A Flush operation flushes up to any previously flushed offset in a BUFFERED stream, to the offset specified in the request. Flush is not supported on the _default stream, since it is not BUFFERED.
| Parameters | |
|---|---|
| Name | Description |
request | FlushRowsRequest |
responseObserver | io.grpc.stub.StreamObserver<FlushRowsResponse> |
getWriteStream(GetWriteStreamRequest request, StreamObserver<WriteStream> responseObserver)
public default void getWriteStream(GetWriteStreamRequest request, StreamObserver<WriteStream> responseObserver)Gets a write stream.
| Parameters | |
|---|---|
| Name | Description |
request | GetWriteStreamRequest |
responseObserver | io.grpc.stub.StreamObserver<WriteStream> |