Module enums (3.36.0)

API documentation forbigquery.enums module.

Classes

AutoRowIDs

AutoRowIDs(value)

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

BigLakeFileFormat

BigLakeFileFormat()

API documentation forbigquery.enums.BigLakeFileFormat class.

BigLakeTableFormat

BigLakeTableFormat()

API documentation forbigquery.enums.BigLakeTableFormat class.

Compression

Compression(value)

The compression type to use for exported files. The default value isNONE.

DEFLATE andSNAPPY areonly supported for Avro.

CreateDisposition

CreateDisposition()

Specifies whether the job is allowed to create new tables. The defaultvalue isCREATE_IF_NEEDED.

Creation, truncation and append actions occur as one atomic updateupon 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. TheseSentinel 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 isCSV.

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

BigQuery decodes the data after the raw, binary data has beensplit 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 isINSERT.

QueryPriority

QueryPriority()

Specifies a priority for the query. The default value isINTERACTIVE.

RoundingMode

RoundingMode(value)

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

ROUNDING_MODE_UNSPECIFIED: will default to using ROUND_HALF_AWAY_FROM_ZERO.

ROUND_HALF_AWAY_FROM_ZERO: rounds half values away from zero when applyingprecision 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 applyingprecision 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 ofa 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, columnsare matched by position. This is done to keep the behavior backward-compatible.

SourceFormat

SourceFormat()

The format of the data files. The default value isCSV.

Note that the set of allowed values for loading data is differentthan the set used for external data sources (seeExternalSourceFormat).

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

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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-16 UTC.