Class CSVOptions (3.35.0)

CSVOptions()

Options that describe how to treat CSV files as BigQuery tables.

Properties

allow_jagged_rows

bool: If :data:True, BigQuery treats missing trailing columns as null values. Defaults to :data:False.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.allow_jagged_rows

allow_quoted_newlines

bool: If :data:True, quoted data sections that contain newline characters in a CSV file are allowed. Defaults to :data:False.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.allow_quoted_newlines

encoding

field_delimiter

str: The separator for fields in a CSV file. Defaults to comma (',').

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.field_delimiter

null_markers

Optional[Iterable[str]]: A list of strings represented as SQL NULL values in a CSV file.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.null_markers

preserve_ascii_control_characters

bool: Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '' to '') are preserved.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.preserve_ascii_control_characters

quote_character

str: The value that is used to quote data sections in a CSV file.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.quote

skip_leading_rows

source_column_match

Optional[google.cloud.bigquery.enums.SourceColumnMatch]: Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible.

Acceptable values are:

SOURCE_COLUMN_MATCH_UNSPECIFIED: Unspecified column name match option.
POSITION: matches by position. This assumes that the columns are ordered
the same way as the schema.
NAME: matches by name. This reads the header row as column names and
reorders columns to match the field names in the schema.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.source_column_match

Methods

from_api_repr

from_api_repr(resource: dict) -> google.cloud.bigquery.external_config.CSVOptions

Factory: construct a .external_config.CSVOptions instance given its API representation.

Parameter
Name Description
resource Dict[str, Any]

Definition of a .external_config.CSVOptions instance in the same representation as is returned from the API.

Returns
Type Description
CSVOptions Configuration parsed from resource.

to_api_repr

to_api_repr() -> dict

Build an API representation of this object.

Returns
Type Description
Dict[str, Any] A dictionary in the format used by the BigQuery API.