Class AppendRowsRequest (2.24.0)

Version latest

• 2.24.0 (latest)
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.1
• 2.18.1
• 2.17.0
• 2.16.2
• 2.15.0
• 2.14.2
• 2.13.2
• 2.12.0
• 2.11.0
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.3
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.1.2
• 1.0.0
• 0.8.0
• 0.7.0
• 0.6.0

AppendRowsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for AppendRows.

Because AppendRows is a bidirectional streaming RPC, certain parts of the AppendRowsRequest need only be specified for the first request before switching table destinations. You can also switch table destinations within the same connection for the default stream.

The size of a single AppendRowsRequest must be less than 10 MB in size. Requests larger than this return an error, typically INVALID_ARGUMENT.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
write_stream	str Required. The write_stream identifies the append operation. It must be provided in the following scenarios: - In the first request to an AppendRows connection. - In all subsequent requests to an AppendRows connection, if you use the same connection to write to multiple tables or change the input schema for default streams. For explicitly created write streams, the format is: - projects/{project}/datasets/{dataset}/tables/{table}/streams/{id} For the special default stream, the format is: - projects/{project}/datasets/{dataset}/tables/{table}/streams/_default. An example of a possible sequence of requests with write_stream fields within a single connection: - r1: {write_stream: stream_name_1} - r2: {write_stream: /*omit*/} - r3: {write_stream: /*omit*/} - r4: {write_stream: stream_name_2} - r5: {write_stream: stream_name_2} The destination changed in request_4, so the write_stream field must be populated in all subsequent requests in this stream.
offset	google.protobuf.wrappers_pb2.Int64Value If present, the write is only performed if the next append offset is same as the provided value. If not present, the write is performed at the current end of stream. Specifying a value for this field is not allowed when calling AppendRows for the '_default' stream.
proto_rows	google.cloud.bigquery_storage_v1.types.AppendRowsRequest.ProtoData Rows in proto format. This field is a member of oneof_ rows.
trace_id	str Id set by client to annotate its identity. Only initial request setting is respected.
missing_value_interpretations	MutableMapping[str, google.cloud.bigquery_storage_v1.types.AppendRowsRequest.MissingValueInterpretation] A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field. For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema. If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL. This field only applies to the current request, it won't affect other requests on the connection. Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.
default_missing_value_interpretation	google.cloud.bigquery_storage_v1.types.AppendRowsRequest.MissingValueInterpretation Optional. Default missing value interpretation for all columns in the table. When a value is specified on an AppendRowsRequest, it is applied to all requests on the connection from that point forward, until a subsequent AppendRowsRequest sets it to a different value. missing_value_interpretation can override default_missing_value_interpretation. For example, if you want to write NULL instead of using default values for some columns, you can set default_missing_value_interpretation to DEFAULT_VALUE and at the same time, set missing_value_interpretations to NULL_VALUE on those columns.

Classes

MissingValueInterpretation

MissingValueInterpretation(value)

An enum to indicate how to interpret missing values of fields that are present in user schema but missing in rows. A missing value can represent a NULL or a column default value defined in BigQuery table schema.

Values: MISSING_VALUE_INTERPRETATION_UNSPECIFIED (0): Invalid missing value interpretation. Requests with this value will be rejected. NULL_VALUE (1): Missing value is interpreted as NULL. DEFAULT_VALUE (2): Missing value is interpreted as column default value if declared in the table schema, NULL otherwise.

MissingValueInterpretationsEntry

MissingValueInterpretationsEntry(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

ProtoData

ProtoData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

ProtoData contains the data rows and schema when constructing append requests.