Google BigQuery v2 API - Class TableSchemaBuilder (3.11.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

Google.Cloud.BigQuery.V2.dll

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

public void Add(TableFieldSchema field)

Adds the given field to the schema being built.

Parameter
Name	Description
`field`	`TableFieldSchema` The field to add. Must not be null.

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
Name	Description
`name`	`string` The name of the field. Must be a valid field name.
`nestedSchema`	`TableSchema` The schema for the nested field. Must not be null.
`mode`	`BigQueryFieldMode` The mode of the field. Must be a defined member within BigQueryFieldMode.
`description`	`string` The description of the field. May be null.

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
Name	Description
`name`	`string` The name of the field. Must be a valid field name.
`type`	`BigQueryDbType` The type of the field. Must be a defined member within BigQueryDbType, other than `Struct` or `Array`.
`mode`	`BigQueryFieldMode` The mode of the field. Must be a defined member within BigQueryFieldMode.
`description`	`string` The description of the field. May be null.

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
Name	Description
`name`	`string` The name of the field. Must be a valid field name.
`nestedSchema`	`TableSchemaBuilder` The schema for the nested field, in the form of a TableSchemaBuilder. Must not be null.
`mode`	`BigQueryFieldMode` The mode of the field. Must be a defined member within BigQueryFieldMode.
`description`	`string` The description of the field. May be null.

public TableSchema Build()

Constructs a TableSchema from this builder.

Returns
Type	Description
`TableSchema`	A TableSchema from the fields added to this builder.

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

Modifies the field with fieldName by running the given action.

Parameters
Name	Description
`fieldName`	`string` The name of the field to be modified. Must not be null.
`fieldModifier`	`ActionTableFieldSchema` An action to be performed on the given field.

Returns
Type	Description
`TableSchemaBuilder`	This TableSchemaBuilder after having applied the modification. For the purposes of method chaining.

Exceptions
Type	Description
`ArgumentException`	`fieldName` is not present within the schema being built.