- 3.27.0 (latest)
- 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
QueryJobConfig(**kwargs)
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.
Inheritance
builtins.object > google.cloud.bigquery.job.base._JobConfig > QueryJobConfigProperties
allow_large_results
bool: Allow large query results tables (legacy SQL, only)
clustering_fields
Optional[List[str]]: Fields defining clustering for the table
(Defaults to :data:None
).
Clustering fields are immutable after table creation.
.. note::
BigQuery supports clustering for both partitioned and non-partitioned tables.
connection_properties
Connection properties.
.. versionadded:: 2.29.0
create_disposition
google.cloud.bigquery.job.CreateDisposition: Specifies behavior for creating tables.
create_session
[Preview] If :data:True
, creates a new session, where
session_info will contain a
random server generated session id.
If :data:False
, runs query with an existing session_id
passed in
connection_properties,
otherwise runs query in non-session mode.
.. versionadded:: 2.29.0
default_dataset
google.cloud.bigquery.dataset.DatasetReference: the default dataset
to use for unqualified table names in the query or :data:None
if not
set.
The default_dataset
setter accepts:
- a Dataset, or
- a DatasetReference, or
- a
str
of the fully-qualified dataset ID in standard SQL format. The value must included a project ID and dataset ID separated by.
. For example:your-project.your_dataset
.
destination
google.cloud.bigquery.table.TableReference: table where results are
written or :data:None
if not set.
The destination
setter accepts:
- a Table, or
- a TableReference, or
- a
str
of the fully-qualified table ID in standard SQL format. The value must included a project ID, dataset ID, and table ID, each separated by.
. For example:your-project.your_dataset.your_table
.
destination_encryption_configuration
google.cloud.bigquery.encryption_configuration.EncryptionConfiguration: Custom encryption configuration for the destination table.
Custom encryption configuration (e.g., Cloud KMS keys) or :data:None
if using default encryption.
dry_run
bool: :data:True
if this query should be a dry run to estimate
costs.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfiguration.FIELDS.dry_run
flatten_results
bool: Flatten nested/repeated fields in results. (Legacy SQL only)
labels
Dict[str, str]: Labels for the job.
This method always returns a dict. Once a job has been created on the server, its labels cannot be modified anymore.
Type | Description |
ValueError | If ``value`` type is invalid. |
maximum_billing_tier
int: Deprecated. Changes the billing tier to allow high-compute queries.
maximum_bytes_billed
int: Maximum bytes to be billed for this job or :data:None
if not set.
priority
google.cloud.bigquery.job.QueryPriority: Priority of the query.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationQuery.FIELDS.priority
query_parameters
List[Union[google.cloud.bigquery.query.ArrayQueryParameter, google.cloud.bigquery.query.ScalarQueryParameter, google.cloud.bigquery.query.StructQueryParameter]]: list of parameters for parameterized query (empty by default)
range_partitioning
Optional[google.cloud.bigquery.table.RangePartitioning]: Configures range-based partitioning for destination table.
.. note:: Beta. The integer range partitioning feature is in a pre-release state and might change or have limited support.
Only specify at most one of xref_time_partitioning or xref_range_partitioning.
Type | Description |
ValueError | If the value is not RangePartitioning or :data:`None`. |
schema_update_options
List[google.cloud.bigquery.job.SchemaUpdateOption]: Specifies updates to the destination table schema to allow as a side effect of the query job.
script_options
Options controlling the execution of scripts.
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#scriptoptions
table_definitions
Dict[str, google.cloud.bigquery.external_config.ExternalConfig]:
Definitions for external tables or :data:None
if not set.
time_partitioning
Optional[google.cloud.bigquery.table.TimePartitioning]: Specifies time-based partitioning for the destination table.
Only specify at most one of xref_time_partitioning or xref_range_partitioning.
Type | Description |
ValueError | If the value is not TimePartitioning or :data:`None`. |
udf_resources
List[google.cloud.bigquery.query.UDFResource]: user defined function resources (empty by default)
use_legacy_sql
bool: Use legacy SQL syntax.
use_query_cache
bool: Look for the query result in the cache.
write_disposition
google.cloud.bigquery.job.WriteDisposition: Action that occurs if the destination table already exists.
Methods
__setattr__
__setattr__(name, value)
Override to be able to raise error if an unknown property is being set
from_api_repr
from_api_repr(resource: dict)
Factory: construct a job configuration given its API representation
Name | Description |
resource |
Dict
A job configuration in the same representation as is returned from the API. |
Type | Description |
google.cloud.bigquery.job._JobConfig | Configuration parsed from ``resource``. |
to_api_repr
to_api_repr()
Build an API representation of the query job config.
Type | Description |
Dict | A dictionary in the format used by the BigQuery API. |
__init__
__init__(**kwargs)
Initialize self. See help(type(self)) for accurate signature.
QueryJobConfig
QueryJobConfig(**kwargs)
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.