Client to bundle configuration needed for API requests.

Wrapper for resource describing a BigQuery project.

Represents grant of an access role to an entity.

An entry must have exactly one of the allowedxref_EntityTypes. If anything butview,routine,ordataset are set, arole is also required.role is omitted forview,routine,dataset, because they are always read-only.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/datasets.

Represents a textual expression in the Common Expression Language (CEL) syntax.

Typically used for filtering or policy rules, such as in IAM Conditionsor BigQuery row/column access policies.

See:https://cloud.google.com/iam/docs/reference/rest/Shared.Types/Exprhttps://github.com/google/cel-spec

Datasets are containers for tables.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#resource-dataset

A read-only dataset resource from a list operation.

For performance reasons, the BigQuery API only includes some of thedataset properties when listing datasets. Notably,xref_access_entries is missing.

For a full list of the properties that the BigQuery API returns, see theREST documentation for datasets.list<https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/list>_.

DatasetReferences are pointers to datasets.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference

DB-API Connection to Google BigQuery.

DB-API Cursor to Google BigQuery.

DB-API error due to problems with the processed data.

DB-API error related to the database.

Exception representing all non-warning DB-API errors.

DB-API error when integrity of the database is affected.

DB-API error related to the database interface.

DB-API error when the database encounters an internal error.

DB-API error for operations not supported by the database or API.

DB-API error related to the database operation.

These errors are not necessarily under the control of the programmer.

DB-API exception raised for programming errors.

Exception raised for important DB-API warnings.

Custom encryption configuration (e.g., Cloud KMS keys).

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

API documentation forbigquery.enums.BigLakeFileFormat class.

API documentation forbigquery.enums.BigLakeTableFormat class.

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

DEFLATE andSNAPPY areonly supported for Avro.

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.

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

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

The exported file format. The default value isCSV.

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

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

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

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.

Enum of allowed entity type names in AccessEntry

Documented values for Job Creation Mode.

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

API method used to start the query. The default value isINSERT.

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

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

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

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

Enum of allowed SQL type names in schema.SchemaField.

Datatype used in Legacy SQL.

Enum of allowed SQL type names in schema.SchemaField.

Datatype used in GoogleSQL.

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.

Options for a Bigtable column.

Options for a Bigtable column family.

Options that describe how to treat Bigtable tables as BigQuery tables.

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

Options defining open source compatible datasets living in the BigQuery catalog.Contains metadata of open source database, schema or namespace representedby the current dataset.

Metadata about open source compatible table. The fields contained in theseoptions correspond to hive metastore's table level properties.

Description of an external data source.

The format for external data files.

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

Options that describe how to treat Google Sheets as BigQuery tables.

[Beta] Options that configure hive partitioning.

Options if source format is set to AVRO.

Additional options if the PARQUET source format is used.

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

DEFLATE andSNAPPY areonly supported for Avro.

Asynchronous job: copy data into a table from other tables.

Configuration options for copy jobs.

All properties in this class are optional. Values which are :data:None ->server defaults. Set properties on the constructed configuration by usingthe property name as the name of a keyword argument.

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.

The exported file format. The default value isCSV.

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

Detailed statistics for DML statements.

https://cloud.google.com/bigquery/docs/reference/rest/v2/DmlStats

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.

Asynchronous job: extract data from a table into Cloud Storage.

Configuration options for extract jobs.

All properties in this class are optional. Values which are :data:None ->server defaults. Set properties on the constructed configuration by usingthe property name as the name of a keyword argument.

Asynchronous job for loading data into a table.

Can load from Google Cloud Storage URIs or from a file.

Configuration options for load jobs.

Set properties on the constructed configuration by using the property nameas the name of a keyword argument. Values which are unset or :data:Noneuse the BigQuery REST API default values. See theBigQuery REST APIreference documentation<https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationLoad>_for a list of default values.

Required options differ based on thesource_format value.For example, the BigQuery API's default value forsource_format is"CSV".When loading a CSV file, eitherschema must be set orautodetect must be set to:data:True.

Different operation types supported in table copy job.

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

Asynchronous job: query tables.

Configuration options for query jobs.

All properties in this class are optional. Values which are :data:None ->server defaults. Set properties on the constructed configuration by usingthe property name as the name of a keyword argument.

QueryPlanEntry represents a single stage of a query execution plan.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/Job#ExplainQueryStagefor the underlying API representation within query statistics.

Map a single step in a query plan entry.

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

Job resource usage for a reservation.

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

Options controlling the execution of scripts.

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

Stack frame showing the line/column/procedure name where the currentevaluation happened.

Statistics for a child job of a script.

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

TimelineEntry represents progress of a query job at a particularpoint in time.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/Job#querytimelinesamplefor the underlying API representation within query statistics.

[Alpha] Information of a multi-statement transaction.

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

.. versionadded:: 2.24.0

A job whose type cannot be determined.

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.

Job resource usage for a reservation.

Stack frame showing the line/column/procedure name where the currentevaluation happened.

Statistics for a child job of a script.

[Preview] Information of the session if this job is part of one.

.. versionadded:: 2.29.0

[Alpha] Information of a multi-statement transaction.

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

.. versionadded:: 2.24.0

A job whose type cannot be determined.

Model represents a machine learning model resource.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/models

ModelReferences are pointers to models.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/models#modelreference

TransformColumn represents a transform column feature.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/models#transformcolumn

Named / positional query parameters for array values.

Type representation for array query parameters.

A connection-level property to customize query behavior.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/ConnectionProperty

Named / positional query parameters for range values.

Type representation for range query parameters.

Named / positional query parameters for scalar values.

Type representation for scalar query parameters.

Supported scalar SQL query parameter types as type objects.

Name / positional query parameters for struct values.

Type representation for struct query parameters.

Describe a single user-defined function (UDF) resource.

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

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

Configuration options for controlling remote BigQuery functions.

Resource representing a user-defined routine.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/routines

Input/output argument of a function or a stored procedure.

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

A pointer to a routine.

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

The fine-grained type of the routine.

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

.. versionadded:: 2.22.0

Represents the type of a field element.

Metadata about the foreign data type definition such as the system in which thetype is defined.

Define Policy Tags for a column.

Describe a single field within a table schema.

Serializer and deserializer information.

Contains information about how a table's data is stored and accessed by opensource query engines.

The type of a variable, e.g., a function argument.

See:https://cloud.google.com/bigquery/docs/reference/rest/v2/StandardSqlDataType

Examples:

INT64: {type_kind="INT64"}ARRAY: {type_kind="ARRAY", array_element_type="STRING"}STRUCT<x STRING, y ARRAY>: {    type_kind="STRUCT",    struct_type={        fields=[            {name="x", type={type_kind="STRING"}},            {                name="y",                type={type_kind="ARRAY", array_element_type="DATE"}            }        ]    }}RANGE: {type_kind="RANGE", range_element_type="DATETIME"}

A field or a column.

See:https://cloud.google.com/bigquery/docs/reference/rest/v2/StandardSqlField

Type of a struct field.

See:https://cloud.google.com/bigquery/docs/reference/rest/v2/StandardSqlDataType#StandardSqlStructType

A table type.

See:https://cloud.google.com/workflows/docs/reference/googleapis/bigquery/v2/Overview#StandardSqlTableType

Configuration for managed tables for Apache Iceberg, formerly known as BigLake.

Information about base table and clone time of the clone.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#clonedefinition

The pair of the foreign key column and primary key column.

Represents a foreign key constraint on a table's columns.

Definition of the ranges for range partitioning.

Represents the primary key constraint on a table's columns.

Range-based partitioning configuration for a table.

A BigQuery row.

Values can be accessed by position (index), by key like a dict,or as properties.

A class for iterating through HTTP/JSON API row list responses.

Information about base table and snapshot time of the snapshot.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#snapshotdefinition

Information about a table's streaming buffer.

Seehttps://cloud.google.com/bigquery/streaming-data-into-bigquery.

Tables represent a set of rows whose values correspond to a schema.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#resource-table

The TableConstraints defines the primary key and foreign key.

A read-only table resource from a list operation.

For performance reasons, the BigQuery API only includes some of the tableproperties when listing tables. Notably,xref_schema andxref_num_rows are missing.

For a full list of the properties that the BigQuery API returns, see theREST documentation for tables.list<https://cloud.google.com/bigquery/docs/reference/rest/v2/tables/list>_.

TableReferences are pointers to tables.

Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablereference

Configures time-based partitioning for a table.

Specifies the type of time partitioning to perform.

Aggregate metrics for classification/classifier models. Formulti-class models, the metrics are either macro-averaged ormicro-averaged. When macro-averaged, the metrics are calculatedfor each label and then an unweighted average is taken of thosevalues. When micro-averaged, the metric is calculated globallyby counting the total number of correctly predicted rows.

ARIMA model fitting metrics.

Model evaluation metrics for ARIMA forecasting models.

Model evaluation metrics for a single ARIMA forecastingmodel.

Arima order, can be used for both non-seasonal and seasonalparts.

Evaluation metrics for binary classification/classifiermodels.

Confusion matrix for binary classification models.

Evaluation metrics for clustering models.

Message containing the information about one cluster.

Representative value of a single feature within the cluster.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Representative value of a categorical feature.

Represents the count of a single category within the cluster.

Type of supported data frequency for time series forecastingmodels.

Indicates the method to split input data into multipletables.

Data split result. This contains references to the trainingand evaluation data tables that were used to train the model.

Distance metric used to compute the distance between twopoints.

Evaluation metrics of a model. These are either computed onall training data or just the eval data based on whether evaldata was used during training. These are not present forimported models.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Indicates the training algorithm to use for matrixfactorization models.

Global explanations containing the top most importantfeatures after training.

Explanation for a single feature.

Type of supported holiday regions for time series forecastingmodels.

API documentation forbigquery_v2.types.Model.KmeansEnums class.

Indicates the method used to initialize the centroids forKMeans clustering algorithm.

The abstract base class for a message.

Indicates the learning rate optimization strategy to use.

Loss metric to evaluate model training performance.

Indicates the type of the Model.

Evaluation metrics for multi-class classification/classifiermodels.

Confusion matrix for multi-class classification models.

A single entry in the confusion matrix.

A single row in the confusion matrix.

Indicates the optimization strategy used for training.

Evaluation metrics used by weighted-ALS models specified byfeedback_type=implicit.

Evaluation metrics for regression and explicit feedback typematrix factorization models.

API documentation forbigquery_v2.types.Model.SeasonalPeriod class.

API documentation forbigquery_v2.types.Model.SeasonalPeriod.SeasonalPeriodType class.

Information about a single training query run for the model.

Information about a single iteration of the training run.

(Auto-)arima fitting result. Wrap everything in ArimaResultfor easier refactoring if we want to use model-specificiteration results.

Arima coefficients.

Arima model information.

Information about a single cluster for clustering model.

Options used in model training.

The abstract base class for a message.

Id path of a model.

The type of a variable, e.g., a function argument. Examples: INT64:{type_kind="INT64"} ARRAY: {type_kind="ARRAY",array_element_type="STRING"} STRUCT<x STRING, y ARRAY>:{type_kind="STRUCT", struct_type={fields=[ {name="x",type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY",array_element_type="DATE"}} ]}}

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

API documentation forbigquery_v2.types.StandardSqlDataType.TypeKind class.

A field or a column.

A table type

Client for interacting with the Google BigQuery API.

Define API Datasets.

Define class for the custom encryption configuration.

API documentation forbigquery.enums module.

Define classes that describe external data sources.

These are used for both Table.externalDataConfiguration andJob.configuration.query.tableDefinitions.

API documentation forbigquery.format_options module.

Base classes and helpers for job classes.

Define resources for the BigQuery ML Models API.

BigQuery query processing.

API documentation forbigquery.retry module.

Schemas for BigQuery tables / queries.

API documentation forbigquery.standard_sql module.

Define API Tables.