ReadSession(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Information about the ReadSession. .. attribute:: name
Output only. Unique identifier for the session, in the form
projects/{project_id}/locations/{location}/sessions/{session_id}
.
:type: str
Attributes
Name | Description |
expire_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors. The expire_time is automatically assigned and currently cannot be specified or updated. |
data_format |
google.cloud.bigquery_storage_v1.types.DataFormat
Immutable. Data format of the output data. |
avro_schema |
google.cloud.bigquery_storage_v1.types.AvroSchema
Output only. Avro schema. |
arrow_schema |
google.cloud.bigquery_storage_v1.types.ArrowSchema
Output only. Arrow schema. |
table |
str
Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}
|
table_modifiers |
google.cloud.bigquery_storage_v1.types.ReadSession.TableModifiers
Optional. Any modifiers which are applied when reading from the specified table. |
read_options |
google.cloud.bigquery_storage_v1.types.ReadSession.TableReadOptions
Optional. Read options for this session (e.g. column selection, filters). |
streams |
Sequence[google.cloud.bigquery_storage_v1.types.ReadStream]
Output only. A list of streams created with the session. At least one stream is created with the session. In the future, larger request_stream_count values *may* result in this list being unpopulated, in that case, the user will need to use a List method to get the streams instead, which is not yet available. |
Classes
TableModifiers
TableModifiers(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Additional attributes when reading a table. .. attribute:: snapshot_time
The snapshot time of the table. If not set, interpreted as now.
:type: google.protobuf.timestamp_pb2.Timestamp
TableReadOptions
TableReadOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Options dictating how we read a table. .. attribute:: selected_fields
Names of the fields in the table that should be read. If empty, all fields will be read. If the specified field is a nested field, all the sub-fields in the field will be selected. The output field order is unrelated to the order of fields in selected_fields.
:type: Sequence[str]