Package Classes (3.26.0)

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 allowed xref_EntityTypes. If anything but view, routine, or dataset are set, a role is also required. role is omitted for view, routine, dataset, because they are always read-only.

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

Datasets are containers for tables.

See https://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 the dataset properties when listing datasets. Notably, xref_access_entries is missing.

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

DatasetReferences are pointers to datasets.

See https://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.

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

DEFLATE and SNAPPY are only supported for Avro.

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.

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

The exported file format. The default value is CSV.

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 is UTF_8.

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

Enum of allowed entity type names in AccessEntry

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 is INSERT.

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

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

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

Enum of allowed SQL type names in schema.SchemaField.

An enumeration.

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.

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.

Description of an external data source.

The format for external data files.

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

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 is NONE.

DEFLATE and SNAPPY are only 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 using the property name as the name of a keyword argument.

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.

The exported file format. The default value is CSV.

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 is UTF_8.

BigQuery decodes the data after the raw, binary data has been split 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 using the 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 name as the name of a keyword argument. Values which are unset or :data:None use the BigQuery REST API default values. See the BigQuery REST API reference documentation <https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationLoad>_ for a list of default values.

Required options differ based on the source_format value. For example, the BigQuery API's default value for source_format is "CSV". When loading a CSV file, either schema must be set or autodetect 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 using the property name as the name of a keyword argument.

QueryPlanEntry represents a single stage of a query execution plan.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#ExplainQueryStage for 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 is INTERACTIVE.

Job resource usage for a reservation.

Specifies an update to the destination table schema as a side effect of a 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 current evaluation happened.

Statistics for a child job of a script.

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

TimelineEntry represents progress of a query job at a particular point in time.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#querytimelinesample for 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 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.

Job resource usage for a reservation.

Stack frame showing the line/column/procedure name where the current evaluation 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.

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

ModelReferences are pointers to models.

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

TransformColumn represents a transform column feature.

See https://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.

See https://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.

See https://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.

Define Policy Tags for a column.

Describe a single field within a table schema.

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

Information about base table and clone time of the clone.

See https://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.

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

Information about a table's streaming buffer.

See https://cloud.google.com/bigquery/streaming-data-into-bigquery.

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

See https://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 table properties when listing tables. Notably, xref_schema and xref_num_rows are missing.

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

TableReferences are pointers to tables.

See https://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. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by 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 forecasting model.

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

Evaluation metrics for binary classification/classifier models.

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 has oneof_ 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 other members.

.. _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 forecasting models.

Indicates the method to split input data into multiple tables.

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

Distance metric used to compute the distance between two points.

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

This message has oneof_ 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 other members.

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

Indicates the training algorithm to use for matrix factorization models.

Global explanations containing the top most important features after training.

Explanation for a single feature.

Type of supported holiday regions for time series forecasting models.

API documentation for bigquery_v2.types.Model.KmeansEnums class.

Indicates the method used to initialize the centroids for KMeans 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/classifier models.

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 by feedback_type=implicit.

Evaluation metrics for regression and explicit feedback type matrix factorization models.

API documentation for bigquery_v2.types.Model.SeasonalPeriod class.

API documentation for bigquery_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 ArimaResult for easier refactoring if we want to use model-specific iteration 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 has oneof_ 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 other members.

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

API documentation for bigquery_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 for bigquery.enums module.

Define classes that describe external data sources.

These are used for both Table.externalDataConfiguration and Job.configuration.query.tableDefinitions.

API documentation for bigquery.format_options module.

Base classes and helpers for job classes.

Define resources for the BigQuery ML Models API.

BigQuery query processing.

API documentation for bigquery.retry module.

Schemas for BigQuery tables / queries.

API documentation for bigquery.standard_sql module.

Define API Tables.