Package @google-cloud/bigquery-storage (4.8.0)

Classes

managedwriter.JSONWriter

A StreamWriter that can write JSON data to BigQuery tables. The JSONWriter is built on top of a Writer, and it simply converts all JSON data to protobuf messages then calls Writer's appendRows() method to write to BigQuery tables. It maintains all Writer functions, but also provides an additional feature: schema update support, where if the BigQuery table schema is updated, users will be able to ingest data on the new schema after some time (in order of minutes).

managedwriter.Writer managedwriter

managedwriter.Writer

A BigQuery Storage API Writer that can be used to write data into BigQuery Table using the Storage API.

managedwriter

managedwriter.WriterClient

BigQuery Write API Client. The Write API can be used to write data to BigQuery.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

For supplementary information about the Write API, see: https://cloud.google.com/bigquery/docs/write-api

managedwriter

protos.google.api.ClientLibrarySettings

Represents a ClientLibrarySettings.

protos.google.api.CommonLanguageSettings

Represents a CommonLanguageSettings.

protos.google.api.CppSettings

Represents a CppSettings.

protos.google.api.CustomHttpPattern

Represents a CustomHttpPattern.

protos.google.api.DotnetSettings

Represents a DotnetSettings.

protos.google.api.GoSettings

Represents a GoSettings.

protos.google.api.Http

Represents a Http.

protos.google.api.HttpRule

Represents a HttpRule.

protos.google.api.JavaSettings

Represents a JavaSettings.

protos.google.api.MethodSettings

Represents a MethodSettings.

protos.google.api.MethodSettings.LongRunning

Represents a LongRunning.

protos.google.api.NodeSettings

Represents a NodeSettings.

protos.google.api.PhpSettings

Represents a PhpSettings.

protos.google.api.Publishing

Represents a Publishing.

protos.google.api.PythonSettings

Represents a PythonSettings.

protos.google.api.ResourceDescriptor

Represents a ResourceDescriptor.

protos.google.api.ResourceReference

Represents a ResourceReference.

protos.google.api.RubySettings

Represents a RubySettings.

protos.google.cloud.bigquery.storage.v1.AppendRowsRequest

Represents an AppendRowsRequest.

protos.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData

Represents a ProtoData.

protos.google.cloud.bigquery.storage.v1.AppendRowsResponse

Represents an AppendRowsResponse.

protos.google.cloud.bigquery.storage.v1.AppendRowsResponse.AppendResult

Represents an AppendResult.

protos.google.cloud.bigquery.storage.v1.ArrowRecordBatch

Represents an ArrowRecordBatch.

protos.google.cloud.bigquery.storage.v1.ArrowSchema

Represents an ArrowSchema.

protos.google.cloud.bigquery.storage.v1.ArrowSerializationOptions

Represents an ArrowSerializationOptions.

protos.google.cloud.bigquery.storage.v1.AvroRows

Represents an AvroRows.

protos.google.cloud.bigquery.storage.v1.AvroSchema

Represents an AvroSchema.

protos.google.cloud.bigquery.storage.v1.AvroSerializationOptions

Represents an AvroSerializationOptions.

protos.google.cloud.bigquery.storage.v1.BatchCommitWriteStreamsRequest

Represents a BatchCommitWriteStreamsRequest.

protos.google.cloud.bigquery.storage.v1.BatchCommitWriteStreamsResponse

Represents a BatchCommitWriteStreamsResponse.

protos.google.cloud.bigquery.storage.v1.BigQueryRead

Represents a BigQueryRead

protos.google.cloud.bigquery.storage.v1.BigQueryWrite

Represents a BigQueryWrite

protos.google.cloud.bigquery.storage.v1.CreateReadSessionRequest

Represents a CreateReadSessionRequest.

protos.google.cloud.bigquery.storage.v1.CreateWriteStreamRequest

Represents a CreateWriteStreamRequest.

protos.google.cloud.bigquery.storage.v1.FinalizeWriteStreamRequest

Represents a FinalizeWriteStreamRequest.

protos.google.cloud.bigquery.storage.v1.FinalizeWriteStreamResponse

Represents a FinalizeWriteStreamResponse.

protos.google.cloud.bigquery.storage.v1.FlushRowsRequest

Represents a FlushRowsRequest.

protos.google.cloud.bigquery.storage.v1.FlushRowsResponse

Represents a FlushRowsResponse.

protos.google.cloud.bigquery.storage.v1.GetWriteStreamRequest

Represents a GetWriteStreamRequest.

protos.google.cloud.bigquery.storage.v1.ProtoRows

Represents a ProtoRows.

protos.google.cloud.bigquery.storage.v1.ProtoSchema

Represents a ProtoSchema.

protos.google.cloud.bigquery.storage.v1.ReadRowsRequest

Represents a ReadRowsRequest.

protos.google.cloud.bigquery.storage.v1.ReadRowsResponse

Represents a ReadRowsResponse.

protos.google.cloud.bigquery.storage.v1.ReadSession

Represents a ReadSession.

protos.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers

Represents a TableModifiers.

protos.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions

Represents a TableReadOptions.

protos.google.cloud.bigquery.storage.v1.ReadStream

Represents a ReadStream.

protos.google.cloud.bigquery.storage.v1.RowError

Represents a RowError.

protos.google.cloud.bigquery.storage.v1.SplitReadStreamRequest

Represents a SplitReadStreamRequest.

protos.google.cloud.bigquery.storage.v1.SplitReadStreamResponse

Represents a SplitReadStreamResponse.

protos.google.cloud.bigquery.storage.v1.StorageError

Represents a StorageError.

protos.google.cloud.bigquery.storage.v1.StreamStats

Represents a StreamStats.

protos.google.cloud.bigquery.storage.v1.StreamStats.Progress

Represents a Progress.

protos.google.cloud.bigquery.storage.v1.TableFieldSchema

Represents a TableFieldSchema.

protos.google.cloud.bigquery.storage.v1.TableFieldSchema.FieldElementType

Represents a FieldElementType.

protos.google.cloud.bigquery.storage.v1.TableSchema

Represents a TableSchema.

protos.google.cloud.bigquery.storage.v1.ThrottleState

Represents a ThrottleState.

protos.google.cloud.bigquery.storage.v1.WriteStream

Represents a WriteStream.

protos.google.cloud.bigquery.storage.v1beta1.ArrowRecordBatch

Represents an ArrowRecordBatch.

protos.google.cloud.bigquery.storage.v1beta1.ArrowSchema

Represents an ArrowSchema.

protos.google.cloud.bigquery.storage.v1beta1.AvroRows

Represents an AvroRows.

protos.google.cloud.bigquery.storage.v1beta1.AvroSchema

Represents an AvroSchema.

protos.google.cloud.bigquery.storage.v1beta1.BatchCreateReadSessionStreamsRequest

Represents a BatchCreateReadSessionStreamsRequest.

protos.google.cloud.bigquery.storage.v1beta1.BatchCreateReadSessionStreamsResponse

Represents a BatchCreateReadSessionStreamsResponse.

protos.google.cloud.bigquery.storage.v1beta1.BigQueryStorage

Represents a BigQueryStorage

protos.google.cloud.bigquery.storage.v1beta1.CreateReadSessionRequest

Represents a CreateReadSessionRequest.

protos.google.cloud.bigquery.storage.v1beta1.FinalizeStreamRequest

Represents a FinalizeStreamRequest.

protos.google.cloud.bigquery.storage.v1beta1.Progress

Represents a Progress.

protos.google.cloud.bigquery.storage.v1beta1.ReadRowsRequest

Represents a ReadRowsRequest.

protos.google.cloud.bigquery.storage.v1beta1.ReadRowsResponse

Represents a ReadRowsResponse.

protos.google.cloud.bigquery.storage.v1beta1.ReadSession

Represents a ReadSession.

protos.google.cloud.bigquery.storage.v1beta1.SplitReadStreamRequest

Represents a SplitReadStreamRequest.

protos.google.cloud.bigquery.storage.v1beta1.SplitReadStreamResponse

Represents a SplitReadStreamResponse.

protos.google.cloud.bigquery.storage.v1beta1.Stream

Represents a Stream.

protos.google.cloud.bigquery.storage.v1beta1.StreamPosition

Represents a StreamPosition.

protos.google.cloud.bigquery.storage.v1beta1.StreamStatus

Represents a StreamStatus.

protos.google.cloud.bigquery.storage.v1beta1.TableModifiers

Represents a TableModifiers.

protos.google.cloud.bigquery.storage.v1beta1.TableReadOptions

Represents a TableReadOptions.

protos.google.cloud.bigquery.storage.v1beta1.TableReference

Represents a TableReference.

protos.google.cloud.bigquery.storage.v1beta1.ThrottleStatus

Represents a ThrottleStatus.

protos.google.protobuf.Any

Represents an Any.

protos.google.protobuf.BoolValue

Represents a BoolValue.

protos.google.protobuf.BytesValue

Represents a BytesValue.

protos.google.protobuf.DescriptorProto

Represents a DescriptorProto.

protos.google.protobuf.DescriptorProto.ExtensionRange

Represents an ExtensionRange.

protos.google.protobuf.DescriptorProto.ReservedRange

Represents a ReservedRange.

protos.google.protobuf.DoubleValue

Represents a DoubleValue.

protos.google.protobuf.Duration

Represents a Duration.

protos.google.protobuf.Empty

Represents an Empty.

protos.google.protobuf.EnumDescriptorProto

Represents an EnumDescriptorProto.

protos.google.protobuf.EnumDescriptorProto.EnumReservedRange

Represents an EnumReservedRange.

protos.google.protobuf.EnumOptions

Represents an EnumOptions.

protos.google.protobuf.EnumValueDescriptorProto

Represents an EnumValueDescriptorProto.

protos.google.protobuf.EnumValueOptions

Represents an EnumValueOptions.

protos.google.protobuf.ExtensionRangeOptions

Represents an ExtensionRangeOptions.

protos.google.protobuf.ExtensionRangeOptions.Declaration

Represents a Declaration.

protos.google.protobuf.FeatureSet

Represents a FeatureSet.

protos.google.protobuf.FeatureSetDefaults

Represents a FeatureSetDefaults.

protos.google.protobuf.FeatureSetDefaults.FeatureSetEditionDefault

Represents a FeatureSetEditionDefault.

protos.google.protobuf.FieldDescriptorProto

Represents a FieldDescriptorProto.

protos.google.protobuf.FieldOptions

Represents a FieldOptions.

protos.google.protobuf.FieldOptions.EditionDefault

Represents an EditionDefault.

protos.google.protobuf.FileDescriptorProto

Represents a FileDescriptorProto.

protos.google.protobuf.FileDescriptorSet

Represents a FileDescriptorSet.

protos.google.protobuf.FileOptions

Represents a FileOptions.

protos.google.protobuf.FloatValue

Represents a FloatValue.

protos.google.protobuf.GeneratedCodeInfo

Represents a GeneratedCodeInfo.

protos.google.protobuf.GeneratedCodeInfo.Annotation

Represents an Annotation.

protos.google.protobuf.Int32Value

Represents an Int32Value.

protos.google.protobuf.Int64Value

Represents an Int64Value.

protos.google.protobuf.MessageOptions

Represents a MessageOptions.

protos.google.protobuf.MethodDescriptorProto

Represents a MethodDescriptorProto.

protos.google.protobuf.MethodOptions

Represents a MethodOptions.

protos.google.protobuf.OneofDescriptorProto

Represents an OneofDescriptorProto.

protos.google.protobuf.OneofOptions

Represents an OneofOptions.

protos.google.protobuf.ServiceDescriptorProto

Represents a ServiceDescriptorProto.

protos.google.protobuf.ServiceOptions

Represents a ServiceOptions.

protos.google.protobuf.SourceCodeInfo

Represents a SourceCodeInfo.

protos.google.protobuf.SourceCodeInfo.Location

Represents a Location.

protos.google.protobuf.StringValue

Represents a StringValue.

protos.google.protobuf.Timestamp

Represents a Timestamp.

protos.google.protobuf.UInt32Value

Represents a UInt32Value.

protos.google.protobuf.UInt64Value

Represents a UInt64Value.

protos.google.protobuf.UninterpretedOption

Represents an UninterpretedOption.

protos.google.protobuf.UninterpretedOption.NamePart

Represents a NamePart.

protos.google.rpc.Status

Represents a Status.

v1.BigQueryReadClient

BigQuery Read API.

The Read API can be used to read data from BigQuery. v1

v1.BigQueryWriteClient

BigQuery Write API.

The Write API can be used to write data to BigQuery.

For supplementary information about the Write API, see: https://cloud.google.com/bigquery/docs/write-api v1

v1beta1.BigQueryStorageClient

BigQuery storage API.

The BigQuery storage API can be used to read data stored in BigQuery.

The v1beta1 API is not yet officially deprecated, and will go through a full deprecation cycle (https://cloud.google.com/products#product-launch-stages) before the service is turned down. However, new code should use the v1 API going forward. v1beta1

Interfaces

protos.google.api.IClientLibrarySettings

Properties of a ClientLibrarySettings.

protos.google.api.ICommonLanguageSettings

Properties of a CommonLanguageSettings.

protos.google.api.ICppSettings

Properties of a CppSettings.

protos.google.api.ICustomHttpPattern

Properties of a CustomHttpPattern.

protos.google.api.IDotnetSettings

Properties of a DotnetSettings.

protos.google.api.IGoSettings

Properties of a GoSettings.

protos.google.api.IHttp

Properties of a Http.

protos.google.api.IHttpRule

Properties of a HttpRule.

protos.google.api.IJavaSettings

Properties of a JavaSettings.

protos.google.api.IMethodSettings

Properties of a MethodSettings.

protos.google.api.INodeSettings

Properties of a NodeSettings.

protos.google.api.IPhpSettings

Properties of a PhpSettings.

protos.google.api.IPublishing

Properties of a Publishing.

protos.google.api.IPythonSettings

Properties of a PythonSettings.

protos.google.api.IResourceDescriptor

Properties of a ResourceDescriptor.

protos.google.api.IResourceReference

Properties of a ResourceReference.

protos.google.api.IRubySettings

Properties of a RubySettings.

protos.google.api.MethodSettings.ILongRunning

Properties of a LongRunning.

protos.google.cloud.bigquery.storage.v1.AppendRowsRequest.IProtoData

Properties of a ProtoData.

protos.google.cloud.bigquery.storage.v1.AppendRowsResponse.IAppendResult

Properties of an AppendResult.

protos.google.cloud.bigquery.storage.v1.IAppendRowsRequest

Properties of an AppendRowsRequest.

protos.google.cloud.bigquery.storage.v1.IAppendRowsResponse

Properties of an AppendRowsResponse.

protos.google.cloud.bigquery.storage.v1.IArrowRecordBatch

Properties of an ArrowRecordBatch.

protos.google.cloud.bigquery.storage.v1.IArrowSchema

Properties of an ArrowSchema.

protos.google.cloud.bigquery.storage.v1.IArrowSerializationOptions

Properties of an ArrowSerializationOptions.

protos.google.cloud.bigquery.storage.v1.IAvroRows

Properties of an AvroRows.

protos.google.cloud.bigquery.storage.v1.IAvroSchema

Properties of an AvroSchema.

protos.google.cloud.bigquery.storage.v1.IAvroSerializationOptions

Properties of an AvroSerializationOptions.

protos.google.cloud.bigquery.storage.v1.IBatchCommitWriteStreamsRequest

Properties of a BatchCommitWriteStreamsRequest.

protos.google.cloud.bigquery.storage.v1.IBatchCommitWriteStreamsResponse

Properties of a BatchCommitWriteStreamsResponse.

protos.google.cloud.bigquery.storage.v1.ICreateReadSessionRequest

Properties of a CreateReadSessionRequest.

protos.google.cloud.bigquery.storage.v1.ICreateWriteStreamRequest

Properties of a CreateWriteStreamRequest.

protos.google.cloud.bigquery.storage.v1.IFinalizeWriteStreamRequest

Properties of a FinalizeWriteStreamRequest.

protos.google.cloud.bigquery.storage.v1.IFinalizeWriteStreamResponse

Properties of a FinalizeWriteStreamResponse.

protos.google.cloud.bigquery.storage.v1.IFlushRowsRequest

Properties of a FlushRowsRequest.

protos.google.cloud.bigquery.storage.v1.IFlushRowsResponse

Properties of a FlushRowsResponse.

protos.google.cloud.bigquery.storage.v1.IGetWriteStreamRequest

Properties of a GetWriteStreamRequest.

protos.google.cloud.bigquery.storage.v1.IProtoRows

Properties of a ProtoRows.

protos.google.cloud.bigquery.storage.v1.IProtoSchema

Properties of a ProtoSchema.

protos.google.cloud.bigquery.storage.v1.IReadRowsRequest

Properties of a ReadRowsRequest.

protos.google.cloud.bigquery.storage.v1.IReadRowsResponse

Properties of a ReadRowsResponse.

protos.google.cloud.bigquery.storage.v1.IReadSession

Properties of a ReadSession.

protos.google.cloud.bigquery.storage.v1.IReadStream

Properties of a ReadStream.

protos.google.cloud.bigquery.storage.v1.IRowError

Properties of a RowError.

protos.google.cloud.bigquery.storage.v1.ISplitReadStreamRequest

Properties of a SplitReadStreamRequest.

protos.google.cloud.bigquery.storage.v1.ISplitReadStreamResponse

Properties of a SplitReadStreamResponse.

protos.google.cloud.bigquery.storage.v1.IStorageError

Properties of a StorageError.

protos.google.cloud.bigquery.storage.v1.IStreamStats

Properties of a StreamStats.

protos.google.cloud.bigquery.storage.v1.ITableFieldSchema

Properties of a TableFieldSchema.

protos.google.cloud.bigquery.storage.v1.ITableSchema

Properties of a TableSchema.

protos.google.cloud.bigquery.storage.v1.IThrottleState

Properties of a ThrottleState.

protos.google.cloud.bigquery.storage.v1.IWriteStream

Properties of a WriteStream.

protos.google.cloud.bigquery.storage.v1.ReadSession.ITableModifiers

Properties of a TableModifiers.

protos.google.cloud.bigquery.storage.v1.ReadSession.ITableReadOptions

Properties of a TableReadOptions.

protos.google.cloud.bigquery.storage.v1.StreamStats.IProgress

Properties of a Progress.

protos.google.cloud.bigquery.storage.v1.TableFieldSchema.IFieldElementType

Properties of a FieldElementType.

protos.google.cloud.bigquery.storage.v1beta1.IArrowRecordBatch

Properties of an ArrowRecordBatch.

protos.google.cloud.bigquery.storage.v1beta1.IArrowSchema

Properties of an ArrowSchema.

protos.google.cloud.bigquery.storage.v1beta1.IAvroRows

Properties of an AvroRows.

protos.google.cloud.bigquery.storage.v1beta1.IAvroSchema

Properties of an AvroSchema.

protos.google.cloud.bigquery.storage.v1beta1.IBatchCreateReadSessionStreamsRequest

Properties of a BatchCreateReadSessionStreamsRequest.

protos.google.cloud.bigquery.storage.v1beta1.IBatchCreateReadSessionStreamsResponse

Properties of a BatchCreateReadSessionStreamsResponse.

protos.google.cloud.bigquery.storage.v1beta1.ICreateReadSessionRequest

Properties of a CreateReadSessionRequest.

protos.google.cloud.bigquery.storage.v1beta1.IFinalizeStreamRequest

Properties of a FinalizeStreamRequest.

protos.google.cloud.bigquery.storage.v1beta1.IProgress

Properties of a Progress.

protos.google.cloud.bigquery.storage.v1beta1.IReadRowsRequest

Properties of a ReadRowsRequest.

protos.google.cloud.bigquery.storage.v1beta1.IReadRowsResponse

Properties of a ReadRowsResponse.

protos.google.cloud.bigquery.storage.v1beta1.IReadSession

Properties of a ReadSession.

protos.google.cloud.bigquery.storage.v1beta1.ISplitReadStreamRequest

Properties of a SplitReadStreamRequest.

protos.google.cloud.bigquery.storage.v1beta1.ISplitReadStreamResponse

Properties of a SplitReadStreamResponse.

protos.google.cloud.bigquery.storage.v1beta1.IStream

Properties of a Stream.

protos.google.cloud.bigquery.storage.v1beta1.IStreamPosition

Properties of a StreamPosition.

protos.google.cloud.bigquery.storage.v1beta1.IStreamStatus

Properties of a StreamStatus.

protos.google.cloud.bigquery.storage.v1beta1.ITableModifiers

Properties of a TableModifiers.

protos.google.cloud.bigquery.storage.v1beta1.ITableReadOptions

Properties of a TableReadOptions.

protos.google.cloud.bigquery.storage.v1beta1.ITableReference

Properties of a TableReference.

protos.google.cloud.bigquery.storage.v1beta1.IThrottleStatus

Properties of a ThrottleStatus.

protos.google.protobuf.DescriptorProto.IExtensionRange

Properties of an ExtensionRange.

protos.google.protobuf.DescriptorProto.IReservedRange

Properties of a ReservedRange.

protos.google.protobuf.EnumDescriptorProto.IEnumReservedRange

Properties of an EnumReservedRange.

protos.google.protobuf.ExtensionRangeOptions.IDeclaration

Properties of a Declaration.

protos.google.protobuf.FeatureSetDefaults.IFeatureSetEditionDefault

Properties of a FeatureSetEditionDefault.

protos.google.protobuf.FieldOptions.IEditionDefault

Properties of an EditionDefault.

protos.google.protobuf.GeneratedCodeInfo.IAnnotation

Properties of an Annotation.

protos.google.protobuf.IAny

Properties of an Any.

protos.google.protobuf.IBoolValue

Properties of a BoolValue.

protos.google.protobuf.IBytesValue

Properties of a BytesValue.

protos.google.protobuf.IDescriptorProto

Properties of a DescriptorProto.

protos.google.protobuf.IDoubleValue

Properties of a DoubleValue.

protos.google.protobuf.IDuration

Properties of a Duration.

protos.google.protobuf.IEmpty

Properties of an Empty.

protos.google.protobuf.IEnumDescriptorProto

Properties of an EnumDescriptorProto.

protos.google.protobuf.IEnumOptions

Properties of an EnumOptions.

protos.google.protobuf.IEnumValueDescriptorProto

Properties of an EnumValueDescriptorProto.

protos.google.protobuf.IEnumValueOptions

Properties of an EnumValueOptions.

protos.google.protobuf.IExtensionRangeOptions

Properties of an ExtensionRangeOptions.

protos.google.protobuf.IFeatureSet

Properties of a FeatureSet.

protos.google.protobuf.IFeatureSetDefaults

Properties of a FeatureSetDefaults.

protos.google.protobuf.IFieldDescriptorProto

Properties of a FieldDescriptorProto.

protos.google.protobuf.IFieldOptions

Properties of a FieldOptions.

protos.google.protobuf.IFileDescriptorProto

Properties of a FileDescriptorProto.

protos.google.protobuf.IFileDescriptorSet

Properties of a FileDescriptorSet.

protos.google.protobuf.IFileOptions

Properties of a FileOptions.

protos.google.protobuf.IFloatValue

Properties of a FloatValue.

protos.google.protobuf.IGeneratedCodeInfo

Properties of a GeneratedCodeInfo.

protos.google.protobuf.IInt32Value

Properties of an Int32Value.

protos.google.protobuf.IInt64Value

Properties of an Int64Value.

protos.google.protobuf.IMessageOptions

Properties of a MessageOptions.

protos.google.protobuf.IMethodDescriptorProto

Properties of a MethodDescriptorProto.

protos.google.protobuf.IMethodOptions

Properties of a MethodOptions.

protos.google.protobuf.IOneofDescriptorProto

Properties of an OneofDescriptorProto.

protos.google.protobuf.IOneofOptions

Properties of an OneofOptions.

protos.google.protobuf.IServiceDescriptorProto

Properties of a ServiceDescriptorProto.

protos.google.protobuf.IServiceOptions

Properties of a ServiceOptions.

protos.google.protobuf.ISourceCodeInfo

Properties of a SourceCodeInfo.

protos.google.protobuf.IStringValue

Properties of a StringValue.

protos.google.protobuf.ITimestamp

Properties of a Timestamp.

protos.google.protobuf.IUInt32Value

Properties of a UInt32Value.

protos.google.protobuf.IUInt64Value

Properties of a UInt64Value.

protos.google.protobuf.IUninterpretedOption

Properties of an UninterpretedOption.

protos.google.protobuf.SourceCodeInfo.ILocation

Properties of a Location.

protos.google.protobuf.UninterpretedOption.INamePart

Properties of a NamePart.

protos.google.rpc.IStatus

Properties of a Status.

Enums

protos.google.api.ClientLibraryDestination

ClientLibraryDestination enum.

protos.google.api.ClientLibraryOrganization

ClientLibraryOrganization enum.

protos.google.api.FieldBehavior

FieldBehavior enum.

protos.google.api.LaunchStage

LaunchStage enum.

protos.google.api.ResourceDescriptor.History

History enum.

protos.google.api.ResourceDescriptor.Style

Style enum.

protos.google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation

MissingValueInterpretation enum.

protos.google.cloud.bigquery.storage.v1.ArrowSerializationOptions.CompressionCodec

CompressionCodec enum.

protos.google.cloud.bigquery.storage.v1.DataFormat

DataFormat enum.

protos.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions.ResponseCompressionCodec

ResponseCompressionCodec enum.

protos.google.cloud.bigquery.storage.v1.RowError.RowErrorCode

RowErrorCode enum.

protos.google.cloud.bigquery.storage.v1.StorageError.StorageErrorCode

StorageErrorCode enum.

protos.google.cloud.bigquery.storage.v1.TableFieldSchema.Mode

Mode enum.

protos.google.cloud.bigquery.storage.v1.TableFieldSchema.Type

Type enum.

protos.google.cloud.bigquery.storage.v1.WriteStream.Type

Type enum.

protos.google.cloud.bigquery.storage.v1.WriteStream.WriteMode

WriteMode enum.

protos.google.cloud.bigquery.storage.v1.WriteStreamView

WriteStreamView enum.

protos.google.cloud.bigquery.storage.v1beta1.DataFormat

DataFormat enum.

protos.google.cloud.bigquery.storage.v1beta1.ShardingStrategy

ShardingStrategy enum.

protos.google.protobuf.Edition

Edition enum.

protos.google.protobuf.ExtensionRangeOptions.VerificationState

VerificationState enum.

protos.google.protobuf.FeatureSet.EnumType

EnumType enum.

protos.google.protobuf.FeatureSet.FieldPresence

FieldPresence enum.

protos.google.protobuf.FeatureSet.JsonFormat

JsonFormat enum.

protos.google.protobuf.FeatureSet.MessageEncoding

MessageEncoding enum.

protos.google.protobuf.FeatureSet.RepeatedFieldEncoding

RepeatedFieldEncoding enum.

protos.google.protobuf.FeatureSet.Utf8Validation

Utf8Validation enum.

protos.google.protobuf.FieldDescriptorProto.Label

Label enum.

protos.google.protobuf.FieldDescriptorProto.Type

Type enum.

protos.google.protobuf.FieldOptions.CType

CType enum.

protos.google.protobuf.FieldOptions.JSType

JSType enum.

protos.google.protobuf.FieldOptions.OptionRetention

OptionRetention enum.

protos.google.protobuf.FieldOptions.OptionTargetType

OptionTargetType enum.

protos.google.protobuf.FileOptions.OptimizeMode

OptimizeMode enum.

protos.google.protobuf.GeneratedCodeInfo.Annotation.Semantic

Semantic enum.

protos.google.protobuf.MethodOptions.IdempotencyLevel

IdempotencyLevel enum.

Variables

_default

_default: {
    v1: typeof v1;
    BigQueryReadClient: typeof v1.BigQueryReadClient;
    BigQueryWriteClient: typeof v1.BigQueryWriteClient;
    managedwriter: typeof managedwriter;
    WriterClient: typeof managedwriter.WriterClient;
}

BigQueryReadClient

BigQueryReadClient: typeof v1.BigQueryReadClient

BigQueryStorageClient

BigQueryStorageClient: typeof v1beta1.BigQueryStorageClient

BigQueryWriteClient

BigQueryWriteClient: typeof v1.BigQueryWriteClient

managedwriter.BufferedStream

BufferedStream = "BUFFERED"

BufferedStream is a form of checkpointed stream, that allows you to advance the offset of visible rows via Flush operations.

managedwriter

managedwriter.CommittedStream

CommittedStream = "COMMITTED"

CommittedStream appends data immediately, but creates a discrete stream for the work so that offset tracking can be used to track writes.

managedwriter

managedwriter.DefaultStream

DefaultStream = "DEFAULT"

DefaultStream most closely mimics the legacy bigquery tabledata.insertAll semantics. Successful inserts are committed immediately, and there's no tracking offsets as all writes go into a "default" stream that always exists for a table.

managedwriter

managedwriter.PendingStream

PendingStream = "PENDING"

PendingStream is a stream in which no data is made visible to readers until the stream is finalized and committed explicitly.

managedwriter

WriterClient

WriterClient: typeof managedwriter.WriterClient

Functions

adapt.convertBigQuerySchemaToStorageTableSchema(schema)

export declare function convertBigQuerySchemaToStorageTableSchema(schema: ITableSchema): StorageTableSchema;

Converts a bigquery Schema into the protobuf-based TableSchema used by the BigQuery Storage WriteClient.

Parameter
Name	Description
`schema`	`ITableSchema` a BigQuery TableSchema StorageTableSchema

Returns
Type	Description
`StorageTableSchema`

adapt.convertStorageSchemaToProto2Descriptor(schema, scope)

export declare function convertStorageSchemaToProto2Descriptor(schema: TableSchema, scope: string): DescriptorProto;

Builds a DescriptorProto for a given table schema using proto2 syntax.

Parameters
Name	Description
`schema`	`TableSchema` a BigQuery Storage TableSchema.
`scope`	`string` scope to namespace protobuf structs.

Returns
Type	Description
`DescriptorProto`	DescriptorProto

adapt.normalizeDescriptor(dp)

export declare function normalizeDescriptor(dp: DescriptorProto): DescriptorProto;

Builds a self-contained DescriptorProto suitable for communicating schema information with the BigQuery Storage write API. It's primarily used for cases where users are interested in sending data using a predefined protocol buffer message.

Parameter
Name	Description
`dp`	`DescriptorProto` DescriptorProto to be bundled. DescriptorProto

Returns
Type	Description
`DescriptorProto`

managedwriter.parseStorageErrors(err)

export declare function parseStorageErrors(err: gax.GoogleError): StorageError[];

The BigQuery Storage API service augments applicable errors with service-specific details in the form of a StorageError message.

Parameter
Name	Description
`err`	`gax.GoogleError`

Returns
Type	Description
`StorageError[]`	{google.cloud.bigquery.storage.v1.StorageError}

managedwriter.setLogFunction(logger)

export declare function setLogFunction(logger: ((msg: string) => void) | null): void;

Sets or disables the log function for all active Firestore instances.

Parameter
Name	Description
`logger`	`((msg: string) => void) \| null` A log function that takes a message (such as `console.log`) or `null` to turn off logging.

Returns
Type	Description
`void`

Type Aliases

BigQueryReadClient

type BigQueryReadClient = v1.BigQueryReadClient;

BigQueryStorageClient

type BigQueryStorageClient = v1beta1.BigQueryStorageClient;

BigQueryWriteClient

type BigQueryWriteClient = v1.BigQueryWriteClient;

protos.google.cloud.bigquery.storage.v1.BigQueryRead.CreateReadSessionCallback

type CreateReadSessionCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1.ReadSession) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1.BigQueryRead.ReadRowsCallback

type ReadRowsCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1.ReadRowsResponse) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1.BigQueryRead.SplitReadStreamCallback

type SplitReadStreamCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1.SplitReadStreamResponse) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1.BigQueryWrite.AppendRowsCallback

type AppendRowsCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1.AppendRowsResponse) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1.BigQueryWrite.BatchCommitWriteStreamsCallback

type BatchCommitWriteStreamsCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1.BatchCommitWriteStreamsResponse) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1.BigQueryWrite.CreateWriteStreamCallback

type CreateWriteStreamCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1.WriteStream) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1.BigQueryWrite.FinalizeWriteStreamCallback

type FinalizeWriteStreamCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1.FinalizeWriteStreamResponse) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1.BigQueryWrite.FlushRowsCallback

type FlushRowsCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1.FlushRowsResponse) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1.BigQueryWrite.GetWriteStreamCallback

type GetWriteStreamCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1.WriteStream) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1beta1.BigQueryStorage.BatchCreateReadSessionStreamsCallback

type BatchCreateReadSessionStreamsCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1beta1.BatchCreateReadSessionStreamsResponse) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1beta1.BigQueryStorage.CreateReadSessionCallback

type CreateReadSessionCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1beta1.ReadSession) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1beta1.BigQueryStorage.FinalizeStreamCallback

type FinalizeStreamCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1beta1.BigQueryStorage.ReadRowsCallback

type ReadRowsCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1beta1.ReadRowsResponse) => void;

Callback as used by .

protos.google.cloud.bigquery.storage.v1beta1.BigQueryStorage.SplitReadStreamCallback

type SplitReadStreamCallback = (error: (Error|null), response?: google.cloud.bigquery.storage.v1beta1.SplitReadStreamResponse) => void;

Callback as used by .

WriterClient

type WriterClient = managedwriter.WriterClient;