Package google-cloud-bigquery (2.27.1) Stay organized with collections Save and categorize content based on your preferences.
- 3.39.0 (latest)
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.27.0
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.1
- 3.22.0
- 3.21.0
- 3.20.1
- 3.19.0
- 3.18.0
- 3.17.2
- 3.16.0
- 3.15.0
- 3.14.1
- 3.13.0
- 3.12.0
- 3.11.4
- 3.4.0
- 3.3.6
- 3.2.0
- 3.1.0
- 3.0.1
- 2.34.4
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.1
- 2.29.0
- 2.28.1
- 2.27.1
- 2.26.0
- 2.25.2
- 2.24.1
- 2.23.3
- 2.22.1
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.1
- 2.15.0
- 2.14.0
- 2.13.1
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.2
- 2.5.0
- 2.4.0
- 2.3.1
- 2.2.0
- 2.1.0
- 2.0.0
- 1.28.2
- 1.27.2
- 1.26.1
- 1.25.0
- 1.24.0
- 1.23.1
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
Reference API documentation forgoogle-cloud-bigquery.
Packages
dbapi
API documentation forbigquery.dbapi package.
types
API documentation forbigquery_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 allowedENTITY_TYPES. Ifanything butview orroutine are set, arole is also required.role is omitted forview androutine, because they are alwaysread-only.
Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/datasets.
Dataset
Datasets are containers for tables.
Seehttps://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 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>_.
DatasetReference
DatasetReferences are pointers to datasets.
Seehttps://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 differentthan the set used for loading data (seeSourceFormat).
GoogleSheetsOptions
Options that describe how to treat Google Sheets as BigQuery tables.
Compression
The compression type to use for exported files. The default value isNONE.
DEFLATE andSNAPPY areonly 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 usingthe property name as the name of a keyword argument.
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.
DestinationFormat
The exported file format. The default value isCSV.
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 isUTF_8.
BigQuery decodes the data after the raw, binary data has beensplit 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 usingthe 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.
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.
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 usingthe property name as the name of a keyword argument.
QueryPlanEntry
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.
QueryPlanEntryStep
Map a single step in a query plan entry.
QueryPriority
Specifies a priority for the query. The default value isINTERACTIVE.
ReservationUsage
Job resource usage for a reservation.
SchemaUpdateOption
Specifies an update to the destination table schema as a side effect ofa load job.
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).
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 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.
Model
Model represents a machine learning model resource.
Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/models
ModelReference
ModelReferences are pointers to models.
Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/models#modelreference
ArrayQueryParameter
Named / positional query parameters for array values.
ScalarQueryParameter
Named / positional query parameters for scalar values.
ScalarQueryParameterType
Type representation for scalar query parameters.
StructQueryParameter
Named / positional query parameters for struct values.
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
Routine
Resource representing a user-defined routine.
Seehttps://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-releasestate 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-releasestate 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.
Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#snapshotdefinition
Table
Tables represent a set of rows whose values correspond to a schema.
Seehttps://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 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>_.
TableReference
TableReferences are pointers to tables.
Seehttps://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 forbigquery.enums module.
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.