Package google-cloud-bigquery

Reference API documentation for google-cloud-bigquery.

Packages

dbapi

API documentation for bigquery.dbapi package.

types

API documentation for bigquery_v2.types package.

Classes

Client

Client to bundle configuration needed for API requests.

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

EncryptionConfiguration

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

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.

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.

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.

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.

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

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.

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

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.

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

DeterminismLevel

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

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

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

PolicyTagList

Define Policy Tags for a column.

SchemaField

Describe a single field within a table schema.

PartitionRange

Definition of the ranges for range partitioning.

.. note:: Beta. The integer range partitioning feature is in a pre-release state and might change or have limited support.

RangePartitioning

Range-based partitioning configuration for a table.

.. note:: Beta. The integer range partitioning feature is in a pre-release state and might change or have limited support.

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

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

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.

Modules

enums

API documentation for bigquery.enums module.

format_options

API documentation for bigquery.format_options module.

base

Base classes and helpers for job classes.

query

BigQuery query processing.