genproto: google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1 Index | Files

package storage

import "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1"

Index

Package Files

arrow.pb.go avro.pb.go storage.pb.go stream.pb.go

Variables

var (
    DataFormat_name = map[int32]string{
        0:  "DATA_FORMAT_UNSPECIFIED",
        1:  "AVRO",
        2:  "ARROW",
    }
    DataFormat_value = map[string]int32{
        "DATA_FORMAT_UNSPECIFIED": 0,
        "AVRO":                    1,
        "ARROW":                   2,
    }
)

Enum value maps for DataFormat.

var File_google_cloud_bigquery_storage_v1_arrow_proto protoreflect.FileDescriptor
var File_google_cloud_bigquery_storage_v1_avro_proto protoreflect.FileDescriptor
var File_google_cloud_bigquery_storage_v1_storage_proto protoreflect.FileDescriptor
var File_google_cloud_bigquery_storage_v1_stream_proto protoreflect.FileDescriptor

func RegisterBigQueryReadServer Uses

func RegisterBigQueryReadServer(s *grpc.Server, srv BigQueryReadServer)

type ArrowRecordBatch Uses

type ArrowRecordBatch struct {

    // IPC-serialized Arrow RecordBatch.
    SerializedRecordBatch []byte `protobuf:"bytes,1,opt,name=serialized_record_batch,json=serializedRecordBatch,proto3" json:"serialized_record_batch,omitempty"`
    // The count of rows in `serialized_record_batch`.
    RowCount int64 `protobuf:"varint,2,opt,name=row_count,json=rowCount,proto3" json:"row_count,omitempty"`
    // contains filtered or unexported fields
}

Arrow RecordBatch.

func (*ArrowRecordBatch) Descriptor Uses

func (*ArrowRecordBatch) Descriptor() ([]byte, []int)

Deprecated: Use ArrowRecordBatch.ProtoReflect.Descriptor instead.

func (*ArrowRecordBatch) GetRowCount Uses

func (x *ArrowRecordBatch) GetRowCount() int64

func (*ArrowRecordBatch) GetSerializedRecordBatch Uses

func (x *ArrowRecordBatch) GetSerializedRecordBatch() []byte

func (*ArrowRecordBatch) ProtoMessage Uses

func (*ArrowRecordBatch) ProtoMessage()

func (*ArrowRecordBatch) ProtoReflect Uses

func (x *ArrowRecordBatch) ProtoReflect() protoreflect.Message

func (*ArrowRecordBatch) Reset Uses

func (x *ArrowRecordBatch) Reset()

func (*ArrowRecordBatch) String Uses

func (x *ArrowRecordBatch) String() string

type ArrowSchema Uses

type ArrowSchema struct {

    // IPC serialized Arrow schema.
    SerializedSchema []byte `protobuf:"bytes,1,opt,name=serialized_schema,json=serializedSchema,proto3" json:"serialized_schema,omitempty"`
    // contains filtered or unexported fields
}

Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc

See code samples on how this message can be deserialized.

func (*ArrowSchema) Descriptor Uses

func (*ArrowSchema) Descriptor() ([]byte, []int)

Deprecated: Use ArrowSchema.ProtoReflect.Descriptor instead.

func (*ArrowSchema) GetSerializedSchema Uses

func (x *ArrowSchema) GetSerializedSchema() []byte

func (*ArrowSchema) ProtoMessage Uses

func (*ArrowSchema) ProtoMessage()

func (*ArrowSchema) ProtoReflect Uses

func (x *ArrowSchema) ProtoReflect() protoreflect.Message

func (*ArrowSchema) Reset Uses

func (x *ArrowSchema) Reset()

func (*ArrowSchema) String Uses

func (x *ArrowSchema) String() string

type AvroRows Uses

type AvroRows struct {

    // Binary serialized rows in a block.
    SerializedBinaryRows []byte `protobuf:"bytes,1,opt,name=serialized_binary_rows,json=serializedBinaryRows,proto3" json:"serialized_binary_rows,omitempty"`
    // The count of rows in the returning block.
    RowCount int64 `protobuf:"varint,2,opt,name=row_count,json=rowCount,proto3" json:"row_count,omitempty"`
    // contains filtered or unexported fields
}

Avro rows.

func (*AvroRows) Descriptor Uses

func (*AvroRows) Descriptor() ([]byte, []int)

Deprecated: Use AvroRows.ProtoReflect.Descriptor instead.

func (*AvroRows) GetRowCount Uses

func (x *AvroRows) GetRowCount() int64

func (*AvroRows) GetSerializedBinaryRows Uses

func (x *AvroRows) GetSerializedBinaryRows() []byte

func (*AvroRows) ProtoMessage Uses

func (*AvroRows) ProtoMessage()

func (*AvroRows) ProtoReflect Uses

func (x *AvroRows) ProtoReflect() protoreflect.Message

func (*AvroRows) Reset Uses

func (x *AvroRows) Reset()

func (*AvroRows) String Uses

func (x *AvroRows) String() string

type AvroSchema Uses

type AvroSchema struct {

    // Json serialized schema, as described at
    // https://avro.apache.org/docs/1.8.1/spec.html.
    Schema string `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"`
    // contains filtered or unexported fields
}

Avro schema.

func (*AvroSchema) Descriptor Uses

func (*AvroSchema) Descriptor() ([]byte, []int)

Deprecated: Use AvroSchema.ProtoReflect.Descriptor instead.

func (*AvroSchema) GetSchema Uses

func (x *AvroSchema) GetSchema() string

func (*AvroSchema) ProtoMessage Uses

func (*AvroSchema) ProtoMessage()

func (*AvroSchema) ProtoReflect Uses

func (x *AvroSchema) ProtoReflect() protoreflect.Message

func (*AvroSchema) Reset Uses

func (x *AvroSchema) Reset()

func (*AvroSchema) String Uses

func (x *AvroSchema) String() string

type BigQueryReadClient Uses

type BigQueryReadClient interface {
    // Creates a new read session. A read session divides the contents of a
    // BigQuery table into one or more streams, which can then be used to read
    // data from the table. The read session also specifies properties of the
    // data to be read, such as a list of columns or a push-down filter describing
    // the rows to be returned.
    //
    // A particular row can be read by at most one stream. When the caller has
    // reached the end of each stream in the session, then all the data in the
    // table has been read.
    //
    // Data is assigned to each stream such that roughly the same number of
    // rows can be read from each stream. Because the server-side unit for
    // assigning data is collections of rows, the API does not guarantee that
    // each stream will return the same number or rows. Additionally, the
    // limits are enforced based on the number of pre-filtered rows, so some
    // filters can lead to lopsided assignments.
    //
    // Read sessions automatically expire 24 hours after they are created and do
    // not require manual clean-up by the caller.
    CreateReadSession(ctx context.Context, in *CreateReadSessionRequest, opts ...grpc.CallOption) (*ReadSession, error)
    // Reads rows from the stream in the format prescribed by the ReadSession.
    // Each response contains one or more table rows, up to a maximum of 100 MiB
    // per response; read requests which attempt to read individual rows larger
    // than 100 MiB will fail.
    //
    // Each request also returns a set of stream statistics reflecting the current
    // state of the stream.
    ReadRows(ctx context.Context, in *ReadRowsRequest, opts ...grpc.CallOption) (BigQueryRead_ReadRowsClient, error)
    // Splits a given `ReadStream` into two `ReadStream` objects. These
    // `ReadStream` objects are referred to as the primary and the residual
    // streams of the split. The original `ReadStream` can still be read from in
    // the same manner as before. Both of the returned `ReadStream` objects can
    // also be read from, and the rows returned by both child streams will be
    // the same as the rows read from the original stream.
    //
    // Moreover, the two child streams will be allocated back-to-back in the
    // original `ReadStream`. Concretely, it is guaranteed that for streams
    // original, primary, and residual, that original[0-j] = primary[0-j] and
    // original[j-n] = residual[0-m] once the streams have been read to
    // completion.
    SplitReadStream(ctx context.Context, in *SplitReadStreamRequest, opts ...grpc.CallOption) (*SplitReadStreamResponse, error)
}

BigQueryReadClient is the client API for BigQueryRead service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewBigQueryReadClient Uses

func NewBigQueryReadClient(cc grpc.ClientConnInterface) BigQueryReadClient

type BigQueryReadServer Uses

type BigQueryReadServer interface {
    // Creates a new read session. A read session divides the contents of a
    // BigQuery table into one or more streams, which can then be used to read
    // data from the table. The read session also specifies properties of the
    // data to be read, such as a list of columns or a push-down filter describing
    // the rows to be returned.
    //
    // A particular row can be read by at most one stream. When the caller has
    // reached the end of each stream in the session, then all the data in the
    // table has been read.
    //
    // Data is assigned to each stream such that roughly the same number of
    // rows can be read from each stream. Because the server-side unit for
    // assigning data is collections of rows, the API does not guarantee that
    // each stream will return the same number or rows. Additionally, the
    // limits are enforced based on the number of pre-filtered rows, so some
    // filters can lead to lopsided assignments.
    //
    // Read sessions automatically expire 24 hours after they are created and do
    // not require manual clean-up by the caller.
    CreateReadSession(context.Context, *CreateReadSessionRequest) (*ReadSession, error)
    // Reads rows from the stream in the format prescribed by the ReadSession.
    // Each response contains one or more table rows, up to a maximum of 100 MiB
    // per response; read requests which attempt to read individual rows larger
    // than 100 MiB will fail.
    //
    // Each request also returns a set of stream statistics reflecting the current
    // state of the stream.
    ReadRows(*ReadRowsRequest, BigQueryRead_ReadRowsServer) error
    // Splits a given `ReadStream` into two `ReadStream` objects. These
    // `ReadStream` objects are referred to as the primary and the residual
    // streams of the split. The original `ReadStream` can still be read from in
    // the same manner as before. Both of the returned `ReadStream` objects can
    // also be read from, and the rows returned by both child streams will be
    // the same as the rows read from the original stream.
    //
    // Moreover, the two child streams will be allocated back-to-back in the
    // original `ReadStream`. Concretely, it is guaranteed that for streams
    // original, primary, and residual, that original[0-j] = primary[0-j] and
    // original[j-n] = residual[0-m] once the streams have been read to
    // completion.
    SplitReadStream(context.Context, *SplitReadStreamRequest) (*SplitReadStreamResponse, error)
}

BigQueryReadServer is the server API for BigQueryRead service.

type BigQueryRead_ReadRowsClient Uses

type BigQueryRead_ReadRowsClient interface {
    Recv() (*ReadRowsResponse, error)
    grpc.ClientStream
}

type BigQueryRead_ReadRowsServer Uses

type BigQueryRead_ReadRowsServer interface {
    Send(*ReadRowsResponse) error
    grpc.ServerStream
}

type CreateReadSessionRequest Uses

type CreateReadSessionRequest struct {

    // Required. The request project that owns the session, in the form of
    // `projects/{project_id}`.
    Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
    // Required. Session to be created.
    ReadSession *ReadSession `protobuf:"bytes,2,opt,name=read_session,json=readSession,proto3" json:"read_session,omitempty"`
    // Max initial number of streams. If unset or zero, the server will
    // provide a value of streams so as to produce reasonable throughput. Must be
    // non-negative. The number of streams may be lower than the requested number,
    // depending on the amount parallelism that is reasonable for the table. Error
    // will be returned if the max count is greater than the current system
    // max limit of 1,000.
    //
    // Streams must be read starting from offset 0.
    MaxStreamCount int32 `protobuf:"varint,3,opt,name=max_stream_count,json=maxStreamCount,proto3" json:"max_stream_count,omitempty"`
    // contains filtered or unexported fields
}

Request message for `CreateReadSession`.

func (*CreateReadSessionRequest) Descriptor Uses

func (*CreateReadSessionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateReadSessionRequest.ProtoReflect.Descriptor instead.

func (*CreateReadSessionRequest) GetMaxStreamCount Uses

func (x *CreateReadSessionRequest) GetMaxStreamCount() int32

func (*CreateReadSessionRequest) GetParent Uses

func (x *CreateReadSessionRequest) GetParent() string

func (*CreateReadSessionRequest) GetReadSession Uses

func (x *CreateReadSessionRequest) GetReadSession() *ReadSession

func (*CreateReadSessionRequest) ProtoMessage Uses

func (*CreateReadSessionRequest) ProtoMessage()

func (*CreateReadSessionRequest) ProtoReflect Uses

func (x *CreateReadSessionRequest) ProtoReflect() protoreflect.Message

func (*CreateReadSessionRequest) Reset Uses

func (x *CreateReadSessionRequest) Reset()

func (*CreateReadSessionRequest) String Uses

func (x *CreateReadSessionRequest) String() string

type DataFormat Uses

type DataFormat int32

Data format for input or output data.

const (
    DataFormat_DATA_FORMAT_UNSPECIFIED DataFormat = 0
    // Avro is a standard open source row based file format.
    // See https://avro.apache.org/ for more details.
    DataFormat_AVRO DataFormat = 1
    // Arrow is a standard open source column-based message format.
    // See https://arrow.apache.org/ for more details.
    DataFormat_ARROW DataFormat = 2
)

func (DataFormat) Descriptor Uses

func (DataFormat) Descriptor() protoreflect.EnumDescriptor

func (DataFormat) Enum Uses

func (x DataFormat) Enum() *DataFormat

func (DataFormat) EnumDescriptor Uses

func (DataFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use DataFormat.Descriptor instead.

func (DataFormat) Number Uses

func (x DataFormat) Number() protoreflect.EnumNumber

func (DataFormat) String Uses

func (x DataFormat) String() string

func (DataFormat) Type Uses

func (DataFormat) Type() protoreflect.EnumType

type ReadRowsRequest Uses

type ReadRowsRequest struct {

    // Required. Stream to read rows from.
    ReadStream string `protobuf:"bytes,1,opt,name=read_stream,json=readStream,proto3" json:"read_stream,omitempty"`
    // The offset requested must be less than the last row read from Read.
    // Requesting a larger offset is undefined. If not specified, start reading
    // from offset zero.
    Offset int64 `protobuf:"varint,2,opt,name=offset,proto3" json:"offset,omitempty"`
    // contains filtered or unexported fields
}

Request message for `ReadRows`.

func (*ReadRowsRequest) Descriptor Uses

func (*ReadRowsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadRowsRequest.ProtoReflect.Descriptor instead.

func (*ReadRowsRequest) GetOffset Uses

func (x *ReadRowsRequest) GetOffset() int64

func (*ReadRowsRequest) GetReadStream Uses

func (x *ReadRowsRequest) GetReadStream() string

func (*ReadRowsRequest) ProtoMessage Uses

func (*ReadRowsRequest) ProtoMessage()

func (*ReadRowsRequest) ProtoReflect Uses

func (x *ReadRowsRequest) ProtoReflect() protoreflect.Message

func (*ReadRowsRequest) Reset Uses

func (x *ReadRowsRequest) Reset()

func (*ReadRowsRequest) String Uses

func (x *ReadRowsRequest) String() string

type ReadRowsResponse Uses

type ReadRowsResponse struct {

    // Row data is returned in format specified during session creation.
    //
    // Types that are assignable to Rows:
    //	*ReadRowsResponse_AvroRows
    //	*ReadRowsResponse_ArrowRecordBatch
    Rows isReadRowsResponse_Rows `protobuf_oneof:"rows"`
    // Number of serialized rows in the rows block.
    RowCount int64 `protobuf:"varint,6,opt,name=row_count,json=rowCount,proto3" json:"row_count,omitempty"`
    // Statistics for the stream.
    Stats *StreamStats `protobuf:"bytes,2,opt,name=stats,proto3" json:"stats,omitempty"`
    // Throttling state. If unset, the latest response still describes
    // the current throttling status.
    ThrottleState *ThrottleState `protobuf:"bytes,5,opt,name=throttle_state,json=throttleState,proto3" json:"throttle_state,omitempty"`
    // contains filtered or unexported fields
}

Response from calling `ReadRows` may include row data, progress and throttling information.

func (*ReadRowsResponse) Descriptor Uses

func (*ReadRowsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadRowsResponse.ProtoReflect.Descriptor instead.

func (*ReadRowsResponse) GetArrowRecordBatch Uses

func (x *ReadRowsResponse) GetArrowRecordBatch() *ArrowRecordBatch

func (*ReadRowsResponse) GetAvroRows Uses

func (x *ReadRowsResponse) GetAvroRows() *AvroRows

func (*ReadRowsResponse) GetRowCount Uses

func (x *ReadRowsResponse) GetRowCount() int64

func (*ReadRowsResponse) GetRows Uses

func (m *ReadRowsResponse) GetRows() isReadRowsResponse_Rows

func (*ReadRowsResponse) GetStats Uses

func (x *ReadRowsResponse) GetStats() *StreamStats

func (*ReadRowsResponse) GetThrottleState Uses

func (x *ReadRowsResponse) GetThrottleState() *ThrottleState

func (*ReadRowsResponse) ProtoMessage Uses

func (*ReadRowsResponse) ProtoMessage()

func (*ReadRowsResponse) ProtoReflect Uses

func (x *ReadRowsResponse) ProtoReflect() protoreflect.Message

func (*ReadRowsResponse) Reset Uses

func (x *ReadRowsResponse) Reset()

func (*ReadRowsResponse) String Uses

func (x *ReadRowsResponse) String() string

type ReadRowsResponse_ArrowRecordBatch Uses

type ReadRowsResponse_ArrowRecordBatch struct {
    // Serialized row data in Arrow RecordBatch format.
    ArrowRecordBatch *ArrowRecordBatch `protobuf:"bytes,4,opt,name=arrow_record_batch,json=arrowRecordBatch,proto3,oneof"`
}

type ReadRowsResponse_AvroRows Uses

type ReadRowsResponse_AvroRows struct {
    // Serialized row data in AVRO format.
    AvroRows *AvroRows `protobuf:"bytes,3,opt,name=avro_rows,json=avroRows,proto3,oneof"`
}

type ReadSession Uses

type ReadSession struct {

    // Output only. Unique identifier for the session, in the form
    // `projects/{project_id}/locations/{location}/sessions/{session_id}`.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // 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.
    ExpireTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
    // Immutable. Data format of the output data.
    DataFormat DataFormat `protobuf:"varint,3,opt,name=data_format,json=dataFormat,proto3,enum=google.cloud.bigquery.storage.v1.DataFormat" json:"data_format,omitempty"`
    // The schema for the read. If read_options.selected_fields is set, the
    // schema may be different from the table schema as it will only contain
    // the selected fields.
    //
    // Types that are assignable to Schema:
    //	*ReadSession_AvroSchema
    //	*ReadSession_ArrowSchema
    Schema isReadSession_Schema `protobuf_oneof:"schema"`
    // Immutable. Table that this ReadSession is reading from, in the form
    // `projects/{project_id}/datasets/{dataset_id}/tables/{table_id}`
    Table string `protobuf:"bytes,6,opt,name=table,proto3" json:"table,omitempty"`
    // Optional. Any modifiers which are applied when reading from the specified table.
    TableModifiers *ReadSession_TableModifiers `protobuf:"bytes,7,opt,name=table_modifiers,json=tableModifiers,proto3" json:"table_modifiers,omitempty"`
    // Optional. Read options for this session (e.g. column selection, filters).
    ReadOptions *ReadSession_TableReadOptions `protobuf:"bytes,8,opt,name=read_options,json=readOptions,proto3" json:"read_options,omitempty"`
    // 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.
    Streams []*ReadStream `protobuf:"bytes,10,rep,name=streams,proto3" json:"streams,omitempty"`
    // contains filtered or unexported fields
}

Information about the ReadSession.

func (*ReadSession) Descriptor Uses

func (*ReadSession) Descriptor() ([]byte, []int)

Deprecated: Use ReadSession.ProtoReflect.Descriptor instead.

func (*ReadSession) GetArrowSchema Uses

func (x *ReadSession) GetArrowSchema() *ArrowSchema

func (*ReadSession) GetAvroSchema Uses

func (x *ReadSession) GetAvroSchema() *AvroSchema

func (*ReadSession) GetDataFormat Uses

func (x *ReadSession) GetDataFormat() DataFormat

func (*ReadSession) GetExpireTime Uses

func (x *ReadSession) GetExpireTime() *timestamp.Timestamp

func (*ReadSession) GetName Uses

func (x *ReadSession) GetName() string

func (*ReadSession) GetReadOptions Uses

func (x *ReadSession) GetReadOptions() *ReadSession_TableReadOptions

func (*ReadSession) GetSchema Uses

func (m *ReadSession) GetSchema() isReadSession_Schema

func (*ReadSession) GetStreams Uses

func (x *ReadSession) GetStreams() []*ReadStream

func (*ReadSession) GetTable Uses

func (x *ReadSession) GetTable() string

func (*ReadSession) GetTableModifiers Uses

func (x *ReadSession) GetTableModifiers() *ReadSession_TableModifiers

func (*ReadSession) ProtoMessage Uses

func (*ReadSession) ProtoMessage()

func (*ReadSession) ProtoReflect Uses

func (x *ReadSession) ProtoReflect() protoreflect.Message

func (*ReadSession) Reset Uses

func (x *ReadSession) Reset()

func (*ReadSession) String Uses

func (x *ReadSession) String() string

type ReadSession_ArrowSchema Uses

type ReadSession_ArrowSchema struct {
    // Output only. Arrow schema.
    ArrowSchema *ArrowSchema `protobuf:"bytes,5,opt,name=arrow_schema,json=arrowSchema,proto3,oneof"`
}

type ReadSession_AvroSchema Uses

type ReadSession_AvroSchema struct {
    // Output only. Avro schema.
    AvroSchema *AvroSchema `protobuf:"bytes,4,opt,name=avro_schema,json=avroSchema,proto3,oneof"`
}

type ReadSession_TableModifiers Uses

type ReadSession_TableModifiers struct {

    // The snapshot time of the table. If not set, interpreted as now.
    SnapshotTime *timestamp.Timestamp `protobuf:"bytes,1,opt,name=snapshot_time,json=snapshotTime,proto3" json:"snapshot_time,omitempty"`
    // contains filtered or unexported fields
}

Additional attributes when reading a table.

func (*ReadSession_TableModifiers) Descriptor Uses

func (*ReadSession_TableModifiers) Descriptor() ([]byte, []int)

Deprecated: Use ReadSession_TableModifiers.ProtoReflect.Descriptor instead.

func (*ReadSession_TableModifiers) GetSnapshotTime Uses

func (x *ReadSession_TableModifiers) GetSnapshotTime() *timestamp.Timestamp

func (*ReadSession_TableModifiers) ProtoMessage Uses

func (*ReadSession_TableModifiers) ProtoMessage()

func (*ReadSession_TableModifiers) ProtoReflect Uses

func (x *ReadSession_TableModifiers) ProtoReflect() protoreflect.Message

func (*ReadSession_TableModifiers) Reset Uses

func (x *ReadSession_TableModifiers) Reset()

func (*ReadSession_TableModifiers) String Uses

func (x *ReadSession_TableModifiers) String() string

type ReadSession_TableReadOptions Uses

type ReadSession_TableReadOptions struct {

    // 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.
    SelectedFields []string `protobuf:"bytes,1,rep,name=selected_fields,json=selectedFields,proto3" json:"selected_fields,omitempty"`
    // SQL text filtering statement, similar to a WHERE clause in a query.
    // Aggregates are not supported.
    //
    // Examples: "int_field > 5"
    //           "date_field = CAST('2014-9-27' as DATE)"
    //           "nullable_field is not NULL"
    //           "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))"
    //           "numeric_field BETWEEN 1.0 AND 5.0"
    RowRestriction string `protobuf:"bytes,2,opt,name=row_restriction,json=rowRestriction,proto3" json:"row_restriction,omitempty"`
    // contains filtered or unexported fields
}

Options dictating how we read a table.

func (*ReadSession_TableReadOptions) Descriptor Uses

func (*ReadSession_TableReadOptions) Descriptor() ([]byte, []int)

Deprecated: Use ReadSession_TableReadOptions.ProtoReflect.Descriptor instead.

func (*ReadSession_TableReadOptions) GetRowRestriction Uses

func (x *ReadSession_TableReadOptions) GetRowRestriction() string

func (*ReadSession_TableReadOptions) GetSelectedFields Uses

func (x *ReadSession_TableReadOptions) GetSelectedFields() []string

func (*ReadSession_TableReadOptions) ProtoMessage Uses

func (*ReadSession_TableReadOptions) ProtoMessage()

func (*ReadSession_TableReadOptions) ProtoReflect Uses

func (x *ReadSession_TableReadOptions) ProtoReflect() protoreflect.Message

func (*ReadSession_TableReadOptions) Reset Uses

func (x *ReadSession_TableReadOptions) Reset()

func (*ReadSession_TableReadOptions) String Uses

func (x *ReadSession_TableReadOptions) String() string

type ReadStream Uses

type ReadStream struct {

    // Output only. Name of the stream, in the form
    // `projects/{project_id}/locations/{location}/sessions/{session_id}/streams/{stream_id}`.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // contains filtered or unexported fields
}

Information about a single stream that gets data out of the storage system. Most of the information about `ReadStream` instances is aggregated, making `ReadStream` lightweight.

func (*ReadStream) Descriptor Uses

func (*ReadStream) Descriptor() ([]byte, []int)

Deprecated: Use ReadStream.ProtoReflect.Descriptor instead.

func (*ReadStream) GetName Uses

func (x *ReadStream) GetName() string

func (*ReadStream) ProtoMessage Uses

func (*ReadStream) ProtoMessage()

func (*ReadStream) ProtoReflect Uses

func (x *ReadStream) ProtoReflect() protoreflect.Message

func (*ReadStream) Reset Uses

func (x *ReadStream) Reset()

func (*ReadStream) String Uses

func (x *ReadStream) String() string

type SplitReadStreamRequest Uses

type SplitReadStreamRequest struct {

    // Required. Name of the stream to split.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // A value in the range (0.0, 1.0) that specifies the fractional point at
    // which the original stream should be split. The actual split point is
    // evaluated on pre-filtered rows, so if a filter is provided, then there is
    // no guarantee that the division of the rows between the new child streams
    // will be proportional to this fractional value. Additionally, because the
    // server-side unit for assigning data is collections of rows, this fraction
    // will always map to a data storage boundary on the server side.
    Fraction float64 `protobuf:"fixed64,2,opt,name=fraction,proto3" json:"fraction,omitempty"`
    // contains filtered or unexported fields
}

Request message for `SplitReadStream`.

func (*SplitReadStreamRequest) Descriptor Uses

func (*SplitReadStreamRequest) Descriptor() ([]byte, []int)

Deprecated: Use SplitReadStreamRequest.ProtoReflect.Descriptor instead.

func (*SplitReadStreamRequest) GetFraction Uses

func (x *SplitReadStreamRequest) GetFraction() float64

func (*SplitReadStreamRequest) GetName Uses

func (x *SplitReadStreamRequest) GetName() string

func (*SplitReadStreamRequest) ProtoMessage Uses

func (*SplitReadStreamRequest) ProtoMessage()

func (*SplitReadStreamRequest) ProtoReflect Uses

func (x *SplitReadStreamRequest) ProtoReflect() protoreflect.Message

func (*SplitReadStreamRequest) Reset Uses

func (x *SplitReadStreamRequest) Reset()

func (*SplitReadStreamRequest) String Uses

func (x *SplitReadStreamRequest) String() string

type SplitReadStreamResponse Uses

type SplitReadStreamResponse struct {

    // Primary stream, which contains the beginning portion of
    // |original_stream|. An empty value indicates that the original stream can no
    // longer be split.
    PrimaryStream *ReadStream `protobuf:"bytes,1,opt,name=primary_stream,json=primaryStream,proto3" json:"primary_stream,omitempty"`
    // Remainder stream, which contains the tail of |original_stream|. An empty
    // value indicates that the original stream can no longer be split.
    RemainderStream *ReadStream `protobuf:"bytes,2,opt,name=remainder_stream,json=remainderStream,proto3" json:"remainder_stream,omitempty"`
    // contains filtered or unexported fields
}

Response message for `SplitReadStream`.

func (*SplitReadStreamResponse) Descriptor Uses

func (*SplitReadStreamResponse) Descriptor() ([]byte, []int)

Deprecated: Use SplitReadStreamResponse.ProtoReflect.Descriptor instead.

func (*SplitReadStreamResponse) GetPrimaryStream Uses

func (x *SplitReadStreamResponse) GetPrimaryStream() *ReadStream

func (*SplitReadStreamResponse) GetRemainderStream Uses

func (x *SplitReadStreamResponse) GetRemainderStream() *ReadStream

func (*SplitReadStreamResponse) ProtoMessage Uses

func (*SplitReadStreamResponse) ProtoMessage()

func (*SplitReadStreamResponse) ProtoReflect Uses

func (x *SplitReadStreamResponse) ProtoReflect() protoreflect.Message

func (*SplitReadStreamResponse) Reset Uses

func (x *SplitReadStreamResponse) Reset()

func (*SplitReadStreamResponse) String Uses

func (x *SplitReadStreamResponse) String() string

type StreamStats Uses

type StreamStats struct {

    // Represents the progress of the current stream.
    Progress *StreamStats_Progress `protobuf:"bytes,2,opt,name=progress,proto3" json:"progress,omitempty"`
    // contains filtered or unexported fields
}

Estimated stream statistics for a given Stream.

func (*StreamStats) Descriptor Uses

func (*StreamStats) Descriptor() ([]byte, []int)

Deprecated: Use StreamStats.ProtoReflect.Descriptor instead.

func (*StreamStats) GetProgress Uses

func (x *StreamStats) GetProgress() *StreamStats_Progress

func (*StreamStats) ProtoMessage Uses

func (*StreamStats) ProtoMessage()

func (*StreamStats) ProtoReflect Uses

func (x *StreamStats) ProtoReflect() protoreflect.Message

func (*StreamStats) Reset Uses

func (x *StreamStats) Reset()

func (*StreamStats) String Uses

func (x *StreamStats) String() string

type StreamStats_Progress Uses

type StreamStats_Progress struct {

    // The fraction of rows assigned to the stream that have been processed by
    // the server so far, not including the rows in the current response
    // message.
    //
    // This value, along with `at_response_end`, can be used to interpolate
    // the progress made as the rows in the message are being processed using
    // the following formula: `at_response_start + (at_response_end -
    // at_response_start) * rows_processed_from_response / rows_in_response`.
    //
    // Note that if a filter is provided, the `at_response_end` value of the
    // previous response may not necessarily be equal to the
    // `at_response_start` value of the current response.
    AtResponseStart float64 `protobuf:"fixed64,1,opt,name=at_response_start,json=atResponseStart,proto3" json:"at_response_start,omitempty"`
    // Similar to `at_response_start`, except that this value includes the
    // rows in the current response.
    AtResponseEnd float64 `protobuf:"fixed64,2,opt,name=at_response_end,json=atResponseEnd,proto3" json:"at_response_end,omitempty"`
    // contains filtered or unexported fields
}

func (*StreamStats_Progress) Descriptor Uses

func (*StreamStats_Progress) Descriptor() ([]byte, []int)

Deprecated: Use StreamStats_Progress.ProtoReflect.Descriptor instead.

func (*StreamStats_Progress) GetAtResponseEnd Uses

func (x *StreamStats_Progress) GetAtResponseEnd() float64

func (*StreamStats_Progress) GetAtResponseStart Uses

func (x *StreamStats_Progress) GetAtResponseStart() float64

func (*StreamStats_Progress) ProtoMessage Uses

func (*StreamStats_Progress) ProtoMessage()

func (*StreamStats_Progress) ProtoReflect Uses

func (x *StreamStats_Progress) ProtoReflect() protoreflect.Message

func (*StreamStats_Progress) Reset Uses

func (x *StreamStats_Progress) Reset()

func (*StreamStats_Progress) String Uses

func (x *StreamStats_Progress) String() string

type ThrottleState Uses

type ThrottleState struct {

    // How much this connection is being throttled. Zero means no throttling,
    // 100 means fully throttled.
    ThrottlePercent int32 `protobuf:"varint,1,opt,name=throttle_percent,json=throttlePercent,proto3" json:"throttle_percent,omitempty"`
    // contains filtered or unexported fields
}

Information on if the current connection is being throttled.

func (*ThrottleState) Descriptor Uses

func (*ThrottleState) Descriptor() ([]byte, []int)

Deprecated: Use ThrottleState.ProtoReflect.Descriptor instead.

func (*ThrottleState) GetThrottlePercent Uses

func (x *ThrottleState) GetThrottlePercent() int32

func (*ThrottleState) ProtoMessage Uses

func (*ThrottleState) ProtoMessage()

func (*ThrottleState) ProtoReflect Uses

func (x *ThrottleState) ProtoReflect() protoreflect.Message

func (*ThrottleState) Reset Uses

func (x *ThrottleState) Reset()

func (*ThrottleState) String Uses

func (x *ThrottleState) String() string

type UnimplementedBigQueryReadServer Uses

type UnimplementedBigQueryReadServer struct {
}

UnimplementedBigQueryReadServer can be embedded to have forward compatible implementations.

func (*UnimplementedBigQueryReadServer) CreateReadSession Uses

func (*UnimplementedBigQueryReadServer) CreateReadSession(context.Context, *CreateReadSessionRequest) (*ReadSession, error)

func (*UnimplementedBigQueryReadServer) ReadRows Uses

func (*UnimplementedBigQueryReadServer) ReadRows(*ReadRowsRequest, BigQueryRead_ReadRowsServer) error

func (*UnimplementedBigQueryReadServer) SplitReadStream Uses

func (*UnimplementedBigQueryReadServer) SplitReadStream(context.Context, *SplitReadStreamRequest) (*SplitReadStreamResponse, error)

Package storage imports 11 packages (graph) and is imported by 2 packages. Updated 2020-06-14. Refresh now. Tools for package owners.