Google BigQuery v2 API - Class TableSchemaBuilder (3.5.0)

public sealed class TableSchemaBuilder : IEnumerable

Reference documentation and code samples for the Google BigQuery v2 API class TableSchemaBuilder.

Class making it simple to create a TableSchema.

Inheritance

object > TableSchemaBuilder

Implements

IEnumerable

Namespace

Google.Cloud.BigQuery.V2

Assembly

Google.Cloud.BigQuery.V2.dll

Remarks

This class only implements IEnumerable in order to allow it to be used in collection initializers.

Methods

Add(TableFieldSchema)

public void Add(TableFieldSchema field)

Adds the given field to the schema being built.

Parameter
NameDescription
fieldTableFieldSchema

The field to add. Must not be null.

Add(string, TableSchema, BigQueryFieldMode, string)

public void Add(string name, TableSchema nestedSchema, BigQueryFieldMode mode = BigQueryFieldMode.Nullable, string description = null)

Creates a nested field with the specified schema, and adds it to the schema being built.

Parameters
NameDescription
namestring

The name of the field. Must be a valid field name.

nestedSchemaTableSchema

The schema for the nested field. Must not be null.

modeBigQueryFieldMode

The mode of the field. Must be a defined member within BigQueryFieldMode.

descriptionstring

The description of the field. May be null.

Add(string, BigQueryDbType, BigQueryFieldMode, string)

public void Add(string name, BigQueryDbType type, BigQueryFieldMode mode = BigQueryFieldMode.Nullable, string description = null)

Creates a field with the specified details, and adds it to the schema being built.

Parameters
NameDescription
namestring

The name of the field. Must be a valid field name.

typeBigQueryDbType

The type of the field. Must be a defined member within BigQueryDbType, other than Struct or Array.

modeBigQueryFieldMode

The mode of the field. Must be a defined member within BigQueryFieldMode.

descriptionstring

The description of the field. May be null.

Add(string, TableSchemaBuilder, BigQueryFieldMode, string)

public void Add(string name, TableSchemaBuilder nestedSchema, BigQueryFieldMode mode = BigQueryFieldMode.Nullable, string description = null)

Creates a nested field with the specified schema, and adds it to the schema being built. This method simply delegates to Add(string, TableSchema, BigQueryFieldMode, string) after calling Build() on nestedSchema.

Parameters
NameDescription
namestring

The name of the field. Must be a valid field name.

nestedSchemaTableSchemaBuilder

The schema for the nested field, in the form of a TableSchemaBuilder. Must not be null.

modeBigQueryFieldMode

The mode of the field. Must be a defined member within BigQueryFieldMode.

descriptionstring

The description of the field. May be null.

Build()

public TableSchema Build()

Constructs a TableSchema from this builder.

Returns
TypeDescription
TableSchema

A TableSchema from the fields added to this builder.

ModifyField(string, Action<TableFieldSchema>)

public TableSchemaBuilder ModifyField(string fieldName, Action<TableFieldSchema> fieldModifier)

Modifies the field with fieldName by running the given action.

Parameters
NameDescription
fieldNamestring

The name of the field to be modified. Must not be null.

fieldModifierActionTableFieldSchema

An action to be performed on the given field.

Returns
TypeDescription
TableSchemaBuilder

This TableSchemaBuilder after having applied the modification. For the purposes of method chaining.

Exceptions
TypeDescription
ArgumentException

fieldName is not present within the schema being built.