Module enums (3.35.0)

API documentation for bigquery.enums module.

Classes

AutoRowIDs

AutoRowIDs(value)

How to handle automatic insert IDs when inserting rows as a stream.

BigLakeFileFormat

BigLakeFileFormat()

API documentation for bigquery.enums.BigLakeFileFormat class.

BigLakeTableFormat

BigLakeTableFormat()

API documentation for bigquery.enums.BigLakeTableFormat class.

Compression

Compression(value)

The compression type to use for exported files. The default value is NONE.

DEFLATE and SNAPPY are only supported for Avro.

CreateDisposition

CreateDisposition()

Specifies whether the job is allowed to create new tables. The default value is CREATE_IF_NEEDED.

Creation, truncation and append actions occur as one atomic update upon job completion.

DatasetView

DatasetView(value)

DatasetView specifies which dataset information is returned.

DecimalTargetType

DecimalTargetType()

The data types that could be used as a target type when converting decimal values.

https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#DecimalTargetType

.. versionadded:: 2.21.0

DefaultPandasDTypes

DefaultPandasDTypes(value)

Default Pandas DataFrem DTypes to convert BigQuery data. These Sentinel values are used instead of None to maintain backward compatibility, and allow Pandas package is not available. For more information: https://stackoverflow.com/a/60605919/101923

DestinationFormat

DestinationFormat()

The exported file format. The default value is CSV.

Tables with nested or repeated fields cannot be exported as CSV.

DeterminismLevel

DeterminismLevel()

Specifies determinism level for JavaScript user-defined functions (UDFs).

https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#DeterminismLevel

Encoding

Encoding()

The character encoding of the data. The default is UTF_8.

BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

EntityTypes

EntityTypes(value)

Enum of allowed entity type names in AccessEntry

JobCreationMode

JobCreationMode()

Documented values for Job Creation Mode.

KeyResultStatementKind

KeyResultStatementKind()

Determines which statement in the script represents the "key result".

The "key result" is used to populate the schema and query results of the script job.

https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#keyresultstatementkind

QueryApiMethod

QueryApiMethod(value)

API method used to start the query. The default value is INSERT.

QueryPriority

QueryPriority()

Specifies a priority for the query. The default value is INTERACTIVE.

RoundingMode

RoundingMode(value)

Rounding mode options that can be used when storing NUMERIC or BIGNUMERIC values.

ROUNDING_MODE_UNSPECIFIED: will default to using ROUND_HALF_AWAY_FROM_ZERO.

ROUND_HALF_AWAY_FROM_ZERO: rounds half values away from zero when applying precision and scale upon writing of NUMERIC and BIGNUMERIC values. For Scale: 0

  • 1.1, 1.2, 1.3, 1.4 => 1
  • 1.5, 1.6, 1.7, 1.8, 1.9 => 2

ROUND_HALF_EVEN: rounds half values to the nearest even value when applying precision and scale upon writing of NUMERIC and BIGNUMERIC values. For Scale: 0

  • 1.1, 1.2, 1.3, 1.4 => 1
  • 1.5 => 2
  • 1.6, 1.7, 1.8, 1.9 => 2
  • 2.5 => 2

SchemaUpdateOption

SchemaUpdateOption()

Specifies an update to the destination table schema as a side effect of a load job.

SourceColumnMatch

SourceColumnMatch(value)

Uses sensible defaults 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.

SourceFormat

SourceFormat()

The format of the data files. The default value is CSV.

Note that the set of allowed values for loading data is different than the set used for external data sources (see ExternalSourceFormat).

SqlTypeNames

SqlTypeNames(value)

Enum of allowed SQL type names in schema.SchemaField.

Datatype used in Legacy SQL.

StandardSqlTypeNames

StandardSqlTypeNames(value)

Enum of allowed SQL type names in schema.SchemaField.

Datatype used in GoogleSQL.

UpdateMode

UpdateMode(value)

Specifies the kind of information to update in a dataset.

WriteDisposition

WriteDisposition()

Specifies the action that occurs if destination table already exists.

The default value is WRITE_APPEND.

Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.