BigQuery Storage ManagedWriter

https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter
Admin
BigQuery Storage ManagedWriter provides a client library for streaming data into Google Cloud...
Tokens:16,634
Snippets:150
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### WithProtoMapping examples for Timestamp and Interval

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

Example usage of WithProtoMapping to map BigQuery Timestamp fields to google.protobuf.Timestamp and Interval fields to google.protobuf.Duration. These functions return Option values.

```go
// WithTimestampAsTimestamp defines that table fields of type Timestamp, are mapped
// as Google's WKT timestamppb.Timestamp.
func WithTimestampAsTimestamp() Option {
	return WithProtoMapping(ProtoMapping{
		FieldType: storagepb.TableFieldSchema_TIMESTAMP,
		TypeName:  "google.protobuf.Timestamp",
		Type:      descriptorpb.FieldDescriptorProto_TYPE_MESSAGE,
	})
}

// WithIntervalAsDuration defines that table fields of type Interval, are mapped
// as Google's WKT durationpb.Duration
func WithIntervalAsDuration() Option {
	return WithProtoMapping(ProtoMapping{
		FieldType: storagepb.TableFieldSchema_INTERVAL,
		TypeName:  "google.protobuf.Duration",
		Type:      descriptorpb.FieldDescriptorProto_TYPE_MESSAGE,
	})
}

```

--------------------------------

### FlushRows to advance flush point in buffered stream

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

For buffered streams, FlushRows advances the flush point to make written rows visible. This example flushes the first 1000 rows after writing 1500+ rows.

```go
// We've written 1500+ rows in the stream, and want to advance the flush point
// ahead to make the first 1000 rows available.
flushOffset, err := managedStream.FlushRows(ctx, 1000)

```

--------------------------------

### WithMissingValueInterpretations usage example

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Example usage of WithMissingValueInterpretations: missing values in the "foo" column are interpreted as null, while missing values in the "bar" column are treated as the default value.

```go
WithMissingValueInterpretations(map[string]storagepb.AppendRowsRequest_MissingValueInterpretation{
				"foo": storagepb.AppendRowsRequest_DEFAULT_VALUE,
				"bar": storagepb.AppendRowsRequest_NULL_VALUE,
	  })
```

--------------------------------

### Client.NewClient

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

NewClient instantiates a new client. The context provided here is retained and used for background connection management between the client and the BigQuery Storage service.

```APIDOC
## Client.NewClient

### Description
NewClient instantiates a new client. The context provided here is retained and used for background connection management between the client and the BigQuery Storage service.

### Method
NewClient

### Endpoint
func NewClient(ctx context.Context, projectID string, opts ...option.ClientOption) (c *Client, err error)

### Parameters
#### Context
- **ctx** (context.Context) - Required - The context for the call.

#### Parameters
- **projectID** (string) - Required - The project ID.
- **opts** (...option.ClientOption) - Optional - Client options.

### Response
#### Success Response
- **c** (*Client) - The new client.
- **err** (error) - Any error encountered.

### Response Example
```go
client, err := NewClient(ctx, "project-id")
```
```

--------------------------------

### Enable multiplexing with WithMultiplexing and WithMultiplexPoolLimit

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Instantiate a managedwriter client with multiplexing enabled and a pool limit of 3. This is experimental and only works with default streams; explicit streams (Committed, Buffered, Pending) cannot use it. The context provided here maintains background gRPC connections.

```go
ctx := context.Background()
client, err := managedwriter.NewClient(ctx, projectID,
	WithMultiplexing,
	WithMultiplexPoolLimit(3),
)
if err != nil {
	// TODO: Handle error.
}

```

--------------------------------

### WithMultiplexing

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Enables connection sharing when instantiating a Client, with writes to default streams only leveraging the multiplex pool.

```APIDOC
## WithMultiplexing

### Description
Enables connection sharing for the client. Writes to default streams can leverage a shared pool of connections per destination region.

### Signature
`func WithMultiplexing() option.ClientOption`

### Returns
- **option.ClientOptions** - The client option for enabling multiplexing.

### Notes
This option is EXPERIMENTAL and subject to change.

```

--------------------------------

### Create a managedwriter client

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Creates a client for the BigQuery Storage write API. The client is used to create managed streams. Handle the error appropriately.

```go
ctx := context.Background()
client, err := managedwriter.NewClient(ctx, projectID)
if err != nil {
	// TODO: Handle error.
}
```

--------------------------------

### Create a ManagedStream with implicit stream construction

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Creates a ManagedStream by supplying destination table and stream type options, allowing the stream to be constructed implicitly. Handle the error.

```go
// Alternately, allow the ManagedStream to handle stream construction by supplying
// additional options.
tableName := fmt.Sprintf("projects/%s/datasets/%s/tables/%s", myProject, myDataset, myTable)
manageStream, err := client.NewManagedStream(ctx,
	WithDestinationTable(tableName),
	WithType(managedwriter.BufferedStream),
	WithSchemaDescriptor(descriptorProto))
if err != nil {
	// TODO: Handle error.
}
```

--------------------------------

### WithDefaultAppendRowsCallOption

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Creates an experimental ClientOption that controls gax.CallOptions for the AppendRows bidi stream connections created by the client.

```APIDOC
## WithDefaultAppendRowsCallOption

### Description
Provides an EXPERIMENTAL ClientOption to set gax.CallOptions for the underlying AppendRows connections. This option is propagated to all connections created by the client. Note: individual writers can override with `WithAppendRowsCallOption`.

### Signature
`func WithDefaultAppendRowsCallOption(o gax.CallOption) option.ClientOption`

### Parameters
- **o** (gax.CallOption) - The call option to apply.

### Returns
- **option.ClientOption** - The client option.

### Notes
This option is EXPERIMENTAL and subject to change.

```

--------------------------------

### func StorageSchemaToProto3Descriptor(inSchema *storagepb.TableSchema, scope string) (protoreflect.Descriptor, error)

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

Builds a protoreflect.Descriptor for a given table schema using proto3 syntax. Note that the write API doesn't yet support proto3 behaviors, but this is provided for completeness.

```APIDOC
## func StorageSchemaToProto3Descriptor

### Description
Builds a protoreflect.Descriptor for a given table schema using proto3 syntax. NOTE: Currently the write API doesn't yet support proto3 behaviors (default value, wrapper types, etc), but this is provided for completeness.

### Function Signature
```go
func StorageSchemaToProto3Descriptor(inSchema *storagepb.TableSchema, scope string) (protoreflect.Descriptor, error)
```

### Parameters
- **inSchema** (*storagepb.TableSchema) - Required - The table schema to convert.
- **scope** (string) - Required - The scope for the descriptor.

### Returns
- **(protoreflect.Descriptor, error)** - The resulting descriptor and an error if conversion fails.
```

--------------------------------

### WithProtoMapping

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

Function to create a ProtoConversionOption that overrides the protobuf type used for a given BigQuery field type or field path.

```APIDOC
## WithProtoMapping

### Description
WithProtoMapping allows setting an override on which field descriptor proto type is going to be used for the given BigQuery Table field type or field path. It returns a ProtoConversionOption that can be used to customize proto descriptor conversion.

### Function Signature
func WithProtoMapping(protoMapping ProtoMapping) ProtoConversionOption

### Parameters
- **protoMapping** (ProtoMapping) - Required - The mapping configuration that specifies the BigQuery field type or field path and the corresponding protobuf type to use.

### Return Value
- **ProtoConversionOption** - The option to customize proto descriptor conversion.

### Example
```go
// WithTimestampAsTimestamp defines that table fields of type Timestamp, are mapped
// as Google's WKT timestamppb.Timestamp.
func WithTimestampAsTimestamp() Option {
	return WithProtoMapping(ProtoMapping{
		FieldType: storagepb.TableFieldSchema_TIMESTAMP,
		TypeName:  "google.protobuf.Timestamp",
		Type:      descriptorpb.FieldDescriptorProto_TYPE_MESSAGE,
	})
}

// WithIntervalAsDuration defines that table fields of type Interval, are mapped
// as Google's WKT durationpb.Duration
func WithIntervalAsDuration() Option {
	return WithProtoMapping(ProtoMapping{
		FieldType: storagepb.TableFieldSchema_INTERVAL,
		TypeName:  "google.protobuf.Duration",
		Type:      descriptorpb.FieldDescriptorProto_TYPE_MESSAGE,
	})
}
```
```

--------------------------------

### func StorageSchemaToProtoDescriptorWithOptions(inSchema *storagepb.TableSchema, scope string, opts ...ProtoConversionOption) (protoreflect.Descriptor, error)

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

Builds a protoreflect.Descriptor for a given table schema with extra configuration options. Uses proto2 syntax by default.

```APIDOC
## func StorageSchemaToProtoDescriptorWithOptions

### Description
Builds a protoreflect.Descriptor for a given table schema with extra configuration options. Uses proto2 syntax by default.

### Function Signature
```go
func StorageSchemaToProtoDescriptorWithOptions(inSchema *storagepb.TableSchema, scope string, opts ...ProtoConversionOption) (protoreflect.Descriptor, error)
```

### Parameters
- **inSchema** (*storagepb.TableSchema) - Required - The table schema to convert.
- **scope** (string) - Required - The scope for the descriptor.
- **opts** (...ProtoConversionOption) - Optional - Additional conversion options.

### Returns
- **(protoreflect.Descriptor, error)** - The resulting descriptor and an error if conversion fails.
```

--------------------------------

### func StorageSchemaToProto2Descriptor(inSchema *storagepb.TableSchema, scope string) (protoreflect.Descriptor, error)

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

Builds a protoreflect.Descriptor for a given table schema using proto2 syntax.

```APIDOC
## func StorageSchemaToProto2Descriptor

### Description
Builds a protoreflect.Descriptor for a given table schema using proto2 syntax.

### Function Signature
```go
func StorageSchemaToProto2Descriptor(inSchema *storagepb.TableSchema, scope string) (protoreflect.Descriptor, error)
```

### Parameters
- **inSchema** (*storagepb.TableSchema) - Required - The table schema to convert.
- **scope** (string) - Required - The scope for the descriptor.

### Returns
- **(protoreflect.Descriptor, error)** - The resulting descriptor and an error if conversion fails.
```

--------------------------------

### Client.CreateWriteStream

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

CreateWriteStream creates a write stream to the given table. Additionally, every table has a special 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.

```APIDOC
## Client.CreateWriteStream

### Description
CreateWriteStream creates a write stream to the given table. Additionally, every table has a special 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.

### Method
CreateWriteStream

### Endpoint
func (c *Client) CreateWriteStream(ctx context.Context, req *storagepb.CreateWriteStreamRequest, opts ...gax.CallOption) (*storagepb.WriteStream, error)

### Parameters
#### Context
- **ctx** (context.Context) - Required - The context for the call.

#### Request Body
- **req** (*storagepb.CreateWriteStreamRequest) - Required - The request to create a write stream.
- **opts** (...gax.CallOption) - Optional - Call options.

### Response
#### Success Response
- **WriteStream** (*storagepb.WriteStream) - The created write stream.
- **error** (error) - Any error encountered.

### Response Example
```go
stream, err := client.CreateWriteStream(ctx, req)
```
```

--------------------------------

### type WriterOption

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

WriterOption are variadic options used to configure a ManagedStream instance.

```APIDOC
## type WriterOption

### Description
WriterOption are variadic options used to configure a ManagedStream instance.

### Signature
`type WriterOption func(*ManagedStream)`
```

--------------------------------

### ProtoConversionOption interface

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

Defines the ProtoConversionOption interface used to customize proto descriptor conversion. It contains filtered or unexported methods.

```go
type ProtoConversionOption interface {
	// contains filtered or unexported methods
}

```

--------------------------------

### Create a ManagedStream with an explicit stream name

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Creates a ManagedStream using an explicit stream identifier (default or created by CreateWriteStream) and registers the schema descriptor. Handle the error.

```go
// Create a ManagedStream using an explicit stream identifer, either a default
// stream or one explicitly created by CreateWriteStream.
managedStream, err := client.NewManagedStream(ctx,
	WithStreamName(streamName),
	WithSchemaDescriptor(descriptorProto))
if err != nil {
	// TODO: Handle error.
}
```

--------------------------------

### func WithDataOrigin

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

WithDataOrigin attaches an origin context to the instrumentation metrics emitted by the library.

```APIDOC
## func WithDataOrigin

### Description
WithDataOrigin is used to attach an origin context to the instrumentation metrics emitted by the library.

### Signature
`func WithDataOrigin(dataOrigin string) WriterOption`
```

--------------------------------

### Finalize and BatchCommitWriteStreams for pending streams

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Finalizes a managed stream and commits it atomically with other streams using BatchCommitWriteStreams. Shows how to commit data from multiple streams together.

```go
// First, finalize the stream we're writing into.
totalRows, err := managedStream.Finalize(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &storagepb.BatchCommitWriteStreamsRequest{
	Parent: parentName,
	WriteStreams: []string{managedStream.StreamName()},
}
// Using the client, we can commit data from multple streams to the same
// table atomically.
resp, err := client.BatchCommitWriteStreams(ctx, req)

```

--------------------------------

### func StorageTableSchemaToBQSchema(in *storagepb.TableSchema) (bigquery.Schema, error)

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

Converts a TableSchema from the BigQuery Storage WriteClient into the equivalent BigQuery Schema.

```APIDOC
## func StorageTableSchemaToBQSchema

### Description
Converts a TableSchema from the BigQuery Storage WriteClient into the equivalent BigQuery Schema.

### Function Signature
```go
func StorageTableSchemaToBQSchema(in *storagepb.TableSchema) (bigquery.Schema, error)
```

### Parameters
- **in** (*storagepb.TableSchema) - Required - The TableSchema to convert.

### Returns
- **(bigquery.Schema, error)** - The converted BigQuery Schema and an error if conversion fails.
```

--------------------------------

### Convert a compiled message descriptor to DescriptorProto

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Converts the descriptor of a compiled protocol buffer message into a DescriptorProto for use with the write API. This is for static .proto definitions.

```go
m := &myprotopackage.MyCompiledMessage{}
descriptorProto := protodesc.ToDescriptorProto(m.ProtoReflect().Descriptor())
```

--------------------------------

### WithDefaultInflightRequests

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Sets an experimental client default limit for the number of in-flight AppendRows write requests per connection.

```APIDOC
## WithDefaultInflightRequests

### Description
Sets an EXPERIMENTAL ClientOption for controlling the default limit of in-flight AppendRows write requests on each connection created by the client.

### Signature
`func WithDefaultInflightRequests(n int) option.ClientOption`

### Parameters
- **n** (int) - The request limit.

### Returns
- **option.ClientOption** - The client option.

### Notes
This option is EXPERIMENTAL and subject to change.

```

--------------------------------

### WithMaxInflightRequests function signature

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Bounds the inflight appends on the write connection. This WriterOption is ignored for ManagedStreams that participate in multiplexing. See WithDefaultInflightRequests ClientOption for setting a default when instantiating a client.

```go
func WithMaxInflightRequests(n int) WriterOption
```

--------------------------------

### WithDefaultInflightBytes

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Sets an experimental default byte limit for in-flight AppendRows write requests across all connections created by the client.

```APIDOC
## WithDefaultInflightBytes

### Description
Provides an EXPERIMENTAL ClientOption for controlling the default byte limit of in-flight AppendRows write requests per connection for the client.

### Signature
`func WithDefaultInflightBytes(n int) option.ClientOption`

### Parameters
- **n** (int) - The byte limit value.

### Returns
- **option.ClientOption** - The client option.

### Notes
This option is EXPERIMENTAL and subject to change. Note: `

```

--------------------------------

### WithProtoMapping function signature

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

Function signature for WithProtoMapping, which sets an override for which field descriptor proto type is used for a given BigQuery Table field type or field path. See the BigQuery Storage Write API supported protocol buffer data types for accepted types.

```go
func WithProtoMapping(protoMapping ProtoMapping) ProtoConversionOption

```

--------------------------------

### func BQSchemaToStorageTableSchema(in bigquery.Schema) (*storagepb.TableSchema, error)

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

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

```APIDOC
## func BQSchemaToStorageTableSchema

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

### Function Signature
```go
func BQSchemaToStorageTableSchema(in bigquery.Schema) (*storagepb.TableSchema, error)
```

### Parameters
- **in** (bigquery.Schema) - Required - The BigQuery schema to convert.

### Returns
- **(*storagepb.TableSchema, error)** - The converted TableSchema and an error if conversion fails.
```

--------------------------------

### AppendResult.Ready

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Ready blocks until the append request has reached a completed state, which may be a successful append or an error.

```APIDOC
## AppendResult.Ready

### Description
Ready blocks until the append request has reached a completed state, which may be a successful append or an error.

### Method
Ready

### Endpoint
func (ar *AppendResult) Ready() <-chan struct{}

### Response
#### Success Response
- **<-chan struct{}** (<-chan struct{}) - A channel that is closed when the append request has reached a completed state.

### Response Example
```go
<-ar.Ready()
```
```

--------------------------------

### WithStreamName function signature

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Allows users to set the stream name this writer will append to explicitly. By default, the managed client will create the stream when instantiated if necessary. Supplying this option causes other options which affect stream construction such as WithStreamType and WithDestinationTable to be ignored.

```go
func WithStreamName(name string) WriterOption
```

--------------------------------

### func NormalizeDescriptor(in protoreflect.MessageDescriptor) (*descriptorpb.DescriptorProto, error)

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

Builds a self-contained DescriptorProto suitable for communicating schema information with the BigQuery Storage write API. It inlines all messages as nested submessages and handles enum encapsulation and oneof clearing.

```APIDOC
## func NormalizeDescriptor

### Description
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. The method rewrites the DescriptorProto to inline all messages as nested submessages, handles encapsulation of enum types, clears oneof indices, and rewrites proto3 descriptors into equivalent proto2 form.

### Function Signature
```go
func NormalizeDescriptor(in protoreflect.MessageDescriptor) (*descriptorpb.DescriptorProto, error)
```

### Parameters
- **in** (protoreflect.MessageDescriptor) - Required - The message descriptor to normalize.

### Returns
- **(*descriptorpb.DescriptorProto, error)** - The normalized DescriptorProto and an error if normalization fails.
```

--------------------------------

### WithMultiplexPoolLimit

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Defines the maximum size for the client-side multiplex pool per destination region. Ignored if multiplexing is not enabled.

```APIDOC
## WithMultiplexPoolLimit

### Description
Provides an EXPERIMENTAL option to set the maximum shared connection pool size for multiplexing. If multiplexing is not enabled, this setting is ignored.

### Signature
`func WithMultiplexPoolLimit(maxSize int) option.ClientOption`

### Parameters
- **maxSize** (int) - The maximum pool size.

### Returns
- **option.ClientOption** - The client option.

### Notes
This option is EXPERIMENTAL and subject to change.

```

--------------------------------

### WithTraceID function signature

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Allows instruments requests to the service with a custom trace prefix. This is generally for diagnostic purposes only.

```go
func WithTraceID(traceID string) WriterOption
```

--------------------------------

### Normalize a descriptor with adapt.NormalizeDescriptor

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Normalizes a descriptor for messages using advanced features like nested messages or enums, producing a self-contained DescriptorProto. Handle the error.

```go
m := &myprotopackage.MyCompiledMessage{}
descriptorProto, err := adapt.NormalizeDescriptor(m.ProtoReflect().Descriptor())
if err != nil {
	// TODO: Handle error.
}
```

--------------------------------

### WithStreamName

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Allows users to set the stream name this writer will append to explicitly. By default, the managed client will create the stream when instantiated if necessary.

```APIDOC
## WithStreamName

### Description
Allows users to set the stream name this writer will append to explicitly. By default, the managed client will create the stream when instantiated if necessary.

### Signature
```go
func WithStreamName(name string) WriterOption
```

### Parameters
- **name** (string) - Required - The stream name to append to.

### Notes
- Supplying this option causes other options which affect stream construction such as WithStreamType and WithDestinationTable to be ignored.
```

--------------------------------

### type ProtoMapping

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

A type used to map BigQuery schema types to protobuf types during conversion.

```APIDOC
## type ProtoMapping

### Description
A type used to map BigQuery schema types to protobuf types during conversion.

### Type Definition
```go
type ProtoMapping map[string]string
```
```

--------------------------------

### WithMaxInflightBytes function signature

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Bounds the inflight append request bytes on the write connection. This WriterOption is ignored for ManagedStreams that participate in multiplexing. See WithDefaultInflightBytes ClientOption for setting a default when instantiating a client.

```go
func WithMaxInflightBytes(n int) WriterOption
```

--------------------------------

### ProtoMapping struct definition

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

ProtoMapping struct used to override protobuf types when converting from a BigQuery Schema to a Protobuf Descriptor. FieldPath should be in the format `fieldA.subFieldB.anotherSubFieldC`.

```go
type ProtoMapping struct {
	// FieldPath should be in the `fieldA.subFieldB.anotherSubFieldC`.
	FieldPath string
	// FieldType is the BigQuery Table field type to be overrided
	FieldType storagepb.TableFieldSchema_Type
	// TypeName is the full qualified path name for the protobuf type.
	// Example: ".google.protobuf.Timestamp", ".google.protobuf.Duration", etc
	TypeName string
	// Type is the final DescriptorProto Type
	Type descriptorpb.FieldDescriptorProto_Type
}

```

--------------------------------

### WithTraceID

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Allows instruments requests to the service with a custom trace prefix. This is generally for diagnostic purposes only.

```APIDOC
## WithTraceID

### Description
Allows instruments requests to the service with a custom trace prefix. This is generally for diagnostic purposes only.

### Signature
```go
func WithTraceID(traceID string) WriterOption
```

### Parameters
- **traceID** (string) - Required - The custom trace prefix.
```

--------------------------------

### type ProtoConversionOption

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter/adapt

A function type for options that can be passed to StorageSchemaToProtoDescriptorWithOptions to customize conversion behavior.

```APIDOC
## type ProtoConversionOption

### Description
A function type for options that can be passed to StorageSchemaToProtoDescriptorWithOptions to customize conversion behavior.

### Type Definition
```go
type ProtoConversionOption func(*protoConversionOptions)
```

### Functions
#### func WithProtoMapping(protoMapping ProtoMapping) ProtoConversionOption

### Description
Returns a ProtoConversionOption that sets the proto mapping for the conversion.

### Function Signature
```go
func WithProtoMapping(protoMapping ProtoMapping) ProtoConversionOption
```

### Parameters
- **protoMapping** (ProtoMapping) - Required - The proto mapping to use.

### Returns
- **ProtoConversionOption** - The option to pass to StorageSchemaToProtoDescriptorWithOptions.
```

--------------------------------

### Client.GetWriteStream

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

GetWriteStream returns information about a given WriteStream.

```APIDOC
## Client.GetWriteStream

### Description
GetWriteStream returns information about a given WriteStream.

### Method
GetWriteStream

### Endpoint
func (c *Client) GetWriteStream(ctx context.Context, req *storagepb.GetWriteStreamRequest, opts ...gax.CallOption) (*storagepb.WriteStream, error)

### Parameters
#### Context
- **ctx** (context.Context) - Required - The context for the call.

#### Request Body
- **req** (*storagepb.GetWriteStreamRequest) - Required - The request to get information about a write stream.
- **opts** (...gax.CallOption) - Optional - Call options.

### Response
#### Success Response
- **WriteStream** (*storagepb.WriteStream) - The write stream information.
- **error** (error) - Any error encountered.

### Response Example
```go
stream, err := client.GetWriteStream(ctx, req)
```
```

--------------------------------

### TableParentFromParts

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Constructs a table identifier string in the form 'projects/{project}/datasets/{dataset}/tables/{table}' from individual identifiers.

```APIDOC
## TableParentFromParts

### Description
Constructs a table identifier using individual identifiers and returns a string.

### Function
`TableParentFromParts(project, dataset, table string) string`

### Returns
- **string** - Table identifier in the form `projects/{project}/datasets/{dataset}/tables/{table}`.

```

--------------------------------

### WithType function signature

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Sets the stream type for the managed stream.

```go
func WithType(st StreamType) WriterOption
```

--------------------------------

### WithType

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Sets the stream type for the managed stream.

```APIDOC
## WithType

### Description
Sets the stream type for the managed stream.

### Signature
```go
func WithType(st StreamType) WriterOption
```

### Parameters
- **st** (StreamType) - Required - The stream type to set.
```

--------------------------------

### AppendRows with offset for deduplication

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Defines proto messages, encodes them, and appends to a managed stream with an offset. The AppendRows call returns a future-like result that blocks until the write completes or errors.

```go
	// Define a couple of messages.
	mesgs := []*myprotopackage.MyCompiledMessage{
		{
			UserName: proto.String("johndoe"),
			EmailAddress: proto.String("jd@mycompany.mydomain"),
			FavoriteNumbers: []proto.Int64{1,42,12345},
		},
		{
			UserName: proto.String("janesmith"),
			EmailAddress: proto.String("smith@othercompany.otherdomain"),
			FavoriteNumbers: []proto.Int64{1,3,5,7,9},
		},
	}

	// Encode the messages into binary format.
	encoded := make([][]byte, len(mesgs))
	for k, v := range mesgs{
		b, err := proto.Marshal(v)
		if err != nil {
			// TODO: Handle error.
		}
		encoded[k] = b
 	}

	// Send the rows to the service, and specify an offset for managing deduplication.
	result, err := managedStream.AppendRows(ctx, encoded, WithOffset(0))

	// Block until the write is complete and return the result.
	returnedOffset, err := result.GetResult(ctx)
	if err != nil {
		// TODO: Handle error.
	}

```

--------------------------------

### WithSchemaDescriptor function signature

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Describes the format of the serialized data being sent by AppendRows calls on the stream.

```go
func WithSchemaDescriptor(dp *descriptorpb.DescriptorProto) WriterOption
```

--------------------------------

### WithMissingValueInterpretations function signature

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Controls how missing values are interpreted for individual columns. Provide a map keyed by field name to specify the interpretation (DEFAULT_VALUE or NULL_VALUE). Missing fields not in the map default to NULL unless overridden. Field names must be top-level column names, not struct field paths.

```go
func WithMissingValueInterpretations(mvi map[string]storagepb.AppendRowsRequest_MissingValueInterpretation) WriterOption
```

--------------------------------

### Client.Close

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Close releases resources held by the client.

```APIDOC
## Client.Close

### Description
Close releases resources held by the client.

### Method
Close

### Endpoint
func (c *Client) Close() error

### Response
#### Success Response
- **error** (error) - Any error encountered.

### Response Example
```go
err := client.Close()
```
```

--------------------------------

### Extract structured error details with apierror

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Shows how to extract service-specific StorageError details from an append error using apierror.FromError and ExtractProtoMessage. The StorageError does not implement Go's error interface.

```go
// By way of example, let's assume the response from an append call returns an error.
_, err := result.GetResult(ctx)
if err != nil {
	if apiErr, ok := apierror.FromError(err); ok {
		// We now have an instance of APIError, which directly exposes more specific
		// details about multiple failure conditions include transport-level errors.
		storageErr := &storagepb.StorageError{}
		if e := apiErr.Details().ExtractProtoMessage(storageErr); e != nil {
			// storageErr now contains service-specific information about the error.
			log.Printf("Received service-specific error code %s", storageErr.GetCode().String())
		}
	}
}

```

--------------------------------

### Client.NewManagedStream

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

NewManagedStream establishes a new managed stream for appending data into a table. Context here is retained for use by the underlying streaming connections the managed stream may create.

```APIDOC
## Client.NewManagedStream

### Description
NewManagedStream establishes a new managed stream for appending data into a table. Context here is retained for use by the underlying streaming connections the managed stream may create.

### Method
NewManagedStream

### Endpoint
func (c *Client) NewManagedStream(ctx context.Context, opts ...WriterOption) (*ManagedStream, error)

### Parameters
#### Context
- **ctx** (context.Context) - Required - The context for the call.

#### Parameters
- **opts** (...WriterOption) - Optional - Writer options.

### Response
#### Success Response
- **ManagedStream** (*ManagedStream) - The new managed stream.
- **error** (error) - Any error encountered.

### Response Example
```go
stream, err := client.NewManagedStream(ctx)
```
```

--------------------------------

### Client.BatchCommitWriteStreams

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

BatchCommitWriteStreams 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.

```APIDOC
## Client.BatchCommitWriteStreams

### Description
BatchCommitWriteStreams 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.

### Method
BatchCommitWriteStreams

### Endpoint
func (c *Client) BatchCommitWriteStreams(ctx context.Context, req *storagepb.BatchCommitWriteStreamsRequest, opts ...gax.CallOption) (*storagepb.BatchCommitWriteStreamsResponse, error)

### Parameters
#### Context
- **ctx** (context.Context) - Required - The context for the call.

#### Request Body
- **req** (*storagepb.BatchCommitWriteStreamsRequest) - Required - The request to commit a group of PENDING streams.
- **opts** (...gax.CallOption) - Optional - Call options.

### Response
#### Success Response
- **BatchCommitWriteStreamsResponse** (*storagepb.BatchCommitWriteStreamsResponse) - The response to the commit request.
- **error** (error) - Any error encountered.

### Response Example
```go
resp, err := client.BatchCommitWriteStreams(ctx, req)
```
```

--------------------------------

### WithMaxInflightRequests

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Bounds the inflight appends on the write connection. This option is ignored for ManagedStreams that participate in multiplexing.

```APIDOC
## WithMaxInflightRequests

### Description
Bounds the inflight appends on the write connection. This option is ignored for ManagedStreams that participate in multiplexing.

### Signature
```go
func WithMaxInflightRequests(n int) WriterOption
```

### Parameters
- **n** (int) - Required - The maximum number of inflight append requests.

### Notes
- See the WithDefaultInflightRequests ClientOption for setting a default when instantiating a client, rather than setting this limit per-writer.
```

--------------------------------

### WithSchemaDescriptor

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Describes the format of the serialized data being sent by AppendRows calls on the stream.

```APIDOC
## WithSchemaDescriptor

### Description
Describes the format of the serialized data being sent by AppendRows calls on the stream.

### Signature
```go
func WithSchemaDescriptor(dp *descriptorpb.DescriptorProto) WriterOption
```

### Parameters
- **dp** (*descriptorpb.DescriptorProto) - Required - The descriptor proto describing the data format.
```

--------------------------------

### func (*ManagedStream) Close

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Close closes a managed stream.

```APIDOC
## func (*ManagedStream) Close

### Description
Close closes a managed stream.

### Method
Close

### Signature
`func (ms *ManagedStream) Close() error`
```

--------------------------------

### func EnableWriteRetries

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

EnableWriteRetries enables ManagedStream to automatically retry failed appends. It is best suited for at-least-once append semantics.

```APIDOC
## func EnableWriteRetries

### Description
EnableWriteRetries enables ManagedStream to automatically retry failed appends. Enabling retries is best suited for cases where users want to achieve at-least-once append semantics. Use of automatic retries may complicate patterns where the user is designing for exactly-once append semantics.

### Signature
`func EnableWriteRetries(enable bool) WriterOption`
```

--------------------------------

### func WithDestinationTable

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

WithDestinationTable specifies the destination table to which a created stream will append rows.

```APIDOC
## func WithDestinationTable

### Description
WithDestinationTable specifies the destination table to which a created stream will append rows. Format of the table: `projects/{projectid}/datasets/{dataset}/tables/{table}`

### Signature
`func WithDestinationTable(destTable string) WriterOption`
```

--------------------------------

### WithOffset

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Sets the explicit offset value for a specific append request.

```APIDOC
## WithOffset

### Description
Sets an explicit offset value for a single append request.

### Signature
`func WithOffset(offset int64) AppendOption`

### Parameters
- **offset** (int64) - The offset value to use.

### Returns
- **AppendOption** - The append option for setting the offset.

```

--------------------------------

### TableParentFromStreamName

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Extracts the parent table prefix from a stream name. Invalid stream IDs return the original stream name.

```APIDOC
## TableParentFromStreamName

### Description
Extracts the parent table prefix from a stream name. If the stream name is invalid, returns the original stream name.

### Signature
`func TableParentFromStreamName(streamName string) string`

### Parameters
- **streamName** (string) - The stream name to extract the parent from.

### Returns
- **string** - The parent table prefix, or the original stream name if invalid.

```

--------------------------------

### WithMaxInflightBytes

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Bounds the inflight append request bytes on the write connection. This option is ignored for ManagedStreams that participate in multiplexing.

```APIDOC
## WithMaxInflightBytes

### Description
Bounds the inflight append request bytes on the write connection. This option is ignored for ManagedStreams that participate in multiplexing.

### Signature
```go
func WithMaxInflightBytes(n int) WriterOption
```

### Parameters
- **n** (int) - Required - The maximum inflight append request bytes.

### Notes
- See the WithDefaultInflightBytes ClientOption for setting a default when instantiating a client, rather than setting this limit per-writer.
```

--------------------------------

### ManagedStream.AppendRows

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

AppendRows appends data to the managed stream.

```APIDOC
## ManagedStream.AppendRows

### Description
AppendRows appends data to the managed stream.

### Method
AppendRows

### Endpoint
func (ms *ManagedStream) AppendRows(ctx context.Context, data [][]byte, opts ...AppendOption) (*AppendResult, error)

### Parameters
#### Context
- **ctx** (context.Context) - Required - The context for the call.

#### Parameters
- **data** ([][]byte) - Required - The data rows to append.
- **opts** (...AppendOption) - Optional - Append options.

### Response
#### Success Response
- **AppendResult** (*AppendResult) - The result of the append operation.
- **error** (error) - Any error encountered.

### Response Example
```go
result, err := stream.AppendRows(ctx, data)
```
```

--------------------------------

### UpdateDefaultMissingValueInterpretation

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Creates an AppendOption to update the default missing value interpretation setting for a stream.

```APIDOC
## UpdateDefaultMissingValueInterpretation

### Description
Updates the default missing-value interpretation for the managed stream and retains it for subsequent writes.

### Signature
`func UpdateDefaultMissingValueInterpretation(def storagepb.AppendRowsRequest_MissingValueInterpretation) AppendOption`

### Parameters
- **def** (storagepb.AppendRowsRequest_MissingValueInterpretation) - The default missing value interpretation.

### Returns
- **AppendOption** - The append option.

```

--------------------------------

### WithMissingValueInterpretations

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Controls how missing values are interpreted for individual columns. Missing values are fields present in user schema but missing in rows.

```APIDOC
## WithMissingValueInterpretations

### Description
Controls how missing values are interpreted for individual columns. Missing values are fields present in user schema but missing in rows. The key is the field name, and the value is the interpretation of missing values for the field.

### Signature
```go
func WithMissingValueInterpretations(mvi map[string]storagepb.AppendRowsRequest_MissingValueInterpretation) WriterOption
```

### Parameters
- **mvi** (map[string]storagepb.AppendRowsRequest_MissingValueInterpretation) - Required - A map indicating how to interpret missing values for some fields.

### Example
```go
WithMissingValueInterpretations(map[string]storagepb.AppendRowsRequest_MissingValueInterpretation{
    "foo": storagepb.AppendRowsRequest_DEFAULT_VALUE,
    "bar": storagepb.AppendRowsRequest_NULL_VALUE,
})
```

### Notes
- If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL unless overridden with a default missing value interpretation.
- Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.
```

--------------------------------

### AppendResult.FullResponse

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

FullResponse returns the full content of the AppendRowsResponse, and any error encountered while processing the append. The AppendRowResponse may contain an embedded error. An embedded error in the response will be converted and returned as the error response, so this method may return both the AppendRowsResponse and an error. This call blocks until the result is ready, or context is no longer valid.

```APIDOC
## AppendResult.FullResponse

### Description
FullResponse returns the full content of the AppendRowsResponse, and any error encountered while processing the append. The AppendRowResponse may contain an embedded error. An embedded error in the response will be converted and returned as the error response, so this method may return both the AppendRowsResponse and an error. This call blocks until the result is ready, or context is no longer valid.

### Method
FullResponse

### Endpoint
func (ar *AppendResult) FullResponse(ctx context.Context) (*storagepb.AppendRowsResponse, error)

### Parameters
#### Context
- **ctx** (context.Context) - Required - The context for the call.

### Response
#### Success Response
- **AppendRowsResponse** (*storagepb.AppendRowsResponse) - The full content of the AppendRowsResponse.
- **error** (error) - Any error encountered while processing the append.

### Response Example
```go
resp, err := ar.FullResponse(ctx)
```
```

--------------------------------

### AppendResult.TotalAttempts

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

TotalAttempts returns the number of times this write was attempted. This call blocks until the result is ready, or context is no longer valid.

```APIDOC
## AppendResult.TotalAttempts

### Description
TotalAttempts returns the number of times this write was attempted. This call blocks until the result is ready, or context is no longer valid.

### Method
TotalAttempts

### Endpoint
func (ar *AppendResult) TotalAttempts(ctx context.Context) (int, error)

### Parameters
#### Context
- **ctx** (context.Context) - Required - The context for the call.

### Response
#### Success Response
- **int** (int) - The number of times this write was attempted.
- **error** (error) - Any error encountered while processing the append.

### Response Example
```go
attempts, err := ar.TotalAttempts(ctx)
```
```

--------------------------------

### UpdateSchemaDescriptor

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Updates the descriptor message schema associated with a fake append stream.

```APIDOC
## UpdateSchemaDescriptor

### Description
Updates the descriptor message schema associated with a given stream. Used to provide the schema for the stream.

### Signature
`func UpdateSchemaDescriptor(schema *descriptorpb.DescriptorProto) AppendOption`

### Parameters
- **schema** (*descriptorpb.DescriptorProto) - The descriptor prototype for the new schema.

### Returns
- **AppendOption** - The append option for schema update.

```

--------------------------------

### AppendResult.UpdatedSchema

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

UpdatedSchema returns the updated schema for a table if supplied by the backend as part of the append response. This call blocks until the result is ready, or context is no longer valid.

```APIDOC
## AppendResult.UpdatedSchema

### Description
UpdatedSchema returns the updated schema for a table if supplied by the backend as part of the append response. This call blocks until the result is ready, or context is no longer valid.

### Method
UpdatedSchema

### Endpoint
func (ar *AppendResult) UpdatedSchema(ctx context.Context) (*storagepb.TableSchema, error)

### Parameters
#### Context
- **ctx** (context.Context) - Required - The context for the call.

### Response
#### Success Response
- **TableSchema** (*storagepb.TableSchema) - The updated schema for a table if supplied by the backend.
- **error** (error) - Any error encountered while processing the append.

### Response Example
```go
schema, err := ar.UpdatedSchema(ctx)
```
```

--------------------------------

### func (*ManagedStream) Finalize

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Finalize marks a stream as complete, ensuring no further data can be appended. It cannot be used on a DefaultStream. Finalizing does not advance the current offset of a BufferedStream, nor does it commit data in a PendingStream.

```APIDOC
## func (*ManagedStream) Finalize

### Description
Finalize is used to mark a stream as complete, and thus ensure no further data can be appended to the stream. You cannot finalize a DefaultStream, as it always exists. Finalizing does not advance the current offset of a BufferedStream, nor does it commit data in a PendingStream.

### Method
Finalize

### Signature
`func (ms *ManagedStream) Finalize(ctx context.Context, opts ...gax.CallOption) (int64, error)`
```

--------------------------------

### type StreamType

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

StreamType indicates the type of stream this write client is managing. It defines constants for DefaultStream, CommittedStream, BufferedStream, and PendingStream.

```APIDOC
## type StreamType

### Description
StreamType indicates the type of stream this write client is managing.

### Constants
- `DefaultStream` (StreamType) - 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.
- `CommittedStream` (StreamType) - CommittedStream appends data immediately, but creates a discrete stream for the work so that offset tracking can be used to track writes.
- `BufferedStream` (StreamType) - BufferedStream is a form of checkpointed stream, that allows you to advance the offset of visible rows via Flush operations.
- `PendingStream` (StreamType) - PendingStream is a stream in which no data is made visible to readers until the stream is finalized and committed explicitly.
```

--------------------------------

### UpdateMissingValueInterpretations

Source: https://pkg.go.dev/cloud.google.com/go/bigquery/storage/managedwriter

Updates per-column missing-value interpretations for the managed stream and retains them for later append operations.

```APIDOC
## UpdateMissingValueInterpretations

### Description
Updates the per-column missing-value interpretation settings for a managed stream.

### Signature
`func UpdateMissingValueInterpretations(mvi map[string]storagepb.AppendRowsRequest_MissingValueInterpretation) AppendOption`

### Parameters
- **mvi** (map[string]storagepb.AppendRowsRequest_MissingValueInterpretation) - Map of column names to missing value interpretations.

### Returns
- **AppendOption** - The append option for updating missing value interpretations.

```
Tokens:
Raw