Package Classes (3.23.0)

Summary of entries of Classes for bigquery.

Classes

Client

Client to bundle configuration needed for API requests.

Project

Wrapper for resource describing a BigQuery project.

AccessEntry

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.

Dataset

Datasets are containers for tables.

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

DatasetListItem

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

DatasetReference

DatasetReferences are pointers to datasets.

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

Connection

DB-API Connection to Google BigQuery.

Cursor

DB-API Cursor to Google BigQuery.

DataError

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

DatabaseError

DB-API error related to the database.

Error

Exception representing all non-warning DB-API errors.

IntegrityError

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

InterfaceError

DB-API error related to the database interface.

InternalError

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

NotSupportedError

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

OperationalError

DB-API error related to the database operation.

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

ProgrammingError

DB-API exception raised for programming errors.

Warning

Exception raised for important DB-API warnings.

EncryptionConfiguration

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

AutoRowIDs

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

Compression

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

DEFLATE and SNAPPY are only supported for Avro.

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.

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

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

The exported file format. The default value is CSV.

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

DeterminismLevel

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

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

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

Enum of allowed entity type names in AccessEntry

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

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

QueryPriority

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

SchemaUpdateOption

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

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

Enum of allowed SQL type names in schema.SchemaField.

StandardSqlTypeNames

An enumeration.

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.

BigtableColumn

Options for a Bigtable column.

BigtableColumnFamily

Options for a Bigtable column family.

BigtableOptions

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

CSVOptions

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

ExternalConfig

Description of an external data source.

ExternalSourceFormat

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

GoogleSheetsOptions

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

HivePartitioningOptions

[Beta] Options that configure hive partitioning.

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

AvroOptions

Options if source format is set to AVRO.

ParquetOptions

Additional options if the PARQUET source format is used.

Compression

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

DEFLATE and SNAPPY are only supported for Avro.

CopyJob

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

CopyJobConfig

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.

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.

DestinationFormat

The exported file format. The default value is CSV.

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

DmlStats

Detailed statistics for DML statements.

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

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.

ExtractJob

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

ExtractJobConfig

Configuration options for extract jobs.

LoadJob

Asynchronous job for loading data into a table.

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

LoadJobConfig

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.

OperationType

Different operation types supported in table copy job.

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

QueryJob

Asynchronous job: query tables.

QueryJobConfig

Configuration options for query jobs.

QueryPlanEntry

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.

QueryPlanEntryStep

Map a single step in a query plan entry.

QueryPriority

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

ReservationUsage

Job resource usage for a reservation.

SchemaUpdateOption

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

ScriptOptions

Options controlling the execution of scripts.

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

ScriptStackFrame

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

ScriptStatistics

Statistics for a child job of a script.

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

TimelineEntry

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.

TransactionInfo

[Alpha] Information of a multi-statement transaction.

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

.. versionadded:: 2.24.0

UnknownJob

A job whose type cannot be determined.

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.

ReservationUsage

Job resource usage for a reservation.

ScriptStackFrame

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

ScriptStatistics

Statistics for a child job of a script.

SessionInfo

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

.. versionadded:: 2.29.0

TransactionInfo

[Alpha] Information of a multi-statement transaction.

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

.. versionadded:: 2.24.0

UnknownJob

A job whose type cannot be determined.

Model

Model represents a machine learning model resource.

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

ModelReference

ModelReferences are pointers to models.

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

TransformColumn

TransformColumn represents a transform column feature.

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

ArrayQueryParameter

Named / positional query parameters for array values.

ArrayQueryParameterType

Type representation for array query parameters.

ConnectionProperty

A connection-level property to customize query behavior.

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

RangeQueryParameter

Named / positional query parameters for range values.

RangeQueryParameterType

Type representation for range query parameters.

ScalarQueryParameter

Named / positional query parameters for scalar values.

ScalarQueryParameterType

Type representation for scalar query parameters.

SqlParameterScalarTypes

Supported scalar SQL query parameter types as type objects.

StructQueryParameter

Named / positional query parameters for struct values.

StructQueryParameterType

Type representation for struct query parameters.

UDFResource

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

DeterminismLevel

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

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

RemoteFunctionOptions

Configuration options for controlling remote BigQuery functions.

Routine

Resource representing a user-defined routine.

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

RoutineArgument

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

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

RoutineReference

A pointer to a routine.

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

RoutineType

The fine-grained type of the routine.

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

.. versionadded:: 2.22.0

FieldElementType

Represents the type of a field element.

PolicyTagList

Define Policy Tags for a column.

SchemaField

Describe a single field within a table schema.

StandardSqlDataType

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"}

StandardSqlField

A field or a column.

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

StandardSqlStructType

Type of a struct field.

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

StandardSqlTableType

A table type.

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

CloneDefinition

Information about base table and clone time of the clone.

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

ColumnReference

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

ForeignKey

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

PartitionRange

Definition of the ranges for range partitioning.

PrimaryKey

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

RangePartitioning

Range-based partitioning configuration for a table.

Row

A BigQuery row.

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

RowIterator

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

SnapshotDefinition

Information about base table and snapshot time of the snapshot.

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

StreamingBuffer

Information about a table's streaming buffer.

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

Table

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

TableConstraints

The TableConstraints defines the primary key and foreign key.

TableListItem

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

TableReference

TableReferences are pointers to tables.

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

TimePartitioning

Configures time-based partitioning for a table.

TimePartitioningType

Specifies the type of time partitioning to perform.

DeleteModelRequest

EncryptionConfiguration

GetModelRequest

ListModelsRequest

ListModelsResponse

Model

AggregateClassificationMetrics

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.

ArimaFittingMetrics

ARIMA model fitting metrics.

ArimaForecastingMetrics

Model evaluation metrics for ARIMA forecasting models.

ArimaSingleModelForecastingMetrics

Model evaluation metrics for a single ARIMA forecasting model.

ArimaOrder

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

BinaryClassificationMetrics

Evaluation metrics for binary classification/classifier models.

BinaryConfusionMatrix

Confusion matrix for binary classification models.

ClusteringMetrics

Evaluation metrics for clustering models.

Cluster

Message containing the information about one cluster.

FeatureValue

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

CategoricalValue

Representative value of a categorical feature.

CategoryCount

Represents the count of a single category within the cluster.

DataFrequency

Type of supported data frequency for time series forecasting models.

DataSplitMethod

Indicates the method to split input data into multiple tables.

DataSplitResult

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

DistanceType

Distance metric used to compute the distance between two points.

EvaluationMetrics

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.

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

FeedbackType

Indicates the training algorithm to use for matrix factorization models.

GlobalExplanation

Global explanations containing the top most important features after training.

Explanation

Explanation for a single feature.

HolidayRegion

Type of supported holiday regions for time series forecasting models.

KmeansEnums

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

KmeansInitializationMethod

Indicates the method used to initialize the centroids for KMeans clustering algorithm.

LabelsEntry

The abstract base class for a message.

LearnRateStrategy

Indicates the learning rate optimization strategy to use.

LossType

Loss metric to evaluate model training performance.

ModelType

Indicates the type of the Model.

MultiClassClassificationMetrics

Evaluation metrics for multi-class classification/classifier models.

ConfusionMatrix

Confusion matrix for multi-class classification models.

Entry

A single entry in the confusion matrix.

Row

A single row in the confusion matrix.

OptimizationStrategy

Indicates the optimization strategy used for training.

RankingMetrics

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

RegressionMetrics

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

SeasonalPeriod

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

SeasonalPeriodType

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

TrainingRun

Information about a single training query run for the model.

IterationResult

Information about a single iteration of the training run.

ArimaResult

(Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results.

ArimaCoefficients

Arima coefficients.

ArimaModelInfo

Arima model information.

ClusterInfo

Information about a single cluster for clustering model.

TrainingOptions

Options used in model training.

LabelClassWeightsEntry

The abstract base class for a message.

ModelReference

Id path of a model.

PatchModelRequest

StandardSqlDataType

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"}} ]}}

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