- 3.25.0 (latest)
- 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
BigQuery query processing.
Classes
ArrayQueryParameter
ArrayQueryParameter(name, array_type, values)
Named / positional query parameters for array values.
Parameters | |
---|---|
Name | Description |
name |
Optional[str]
Parameter name, used via |
array_type |
Union[str, ScalarQueryParameterType, StructQueryParameterType]
The type of array elements. If given as a string, it must be one of |
values |
List[appropriate type]
The parameter array values. |
ArrayQueryParameterType
ArrayQueryParameterType(array_type, *, name=None, description=None)
Type representation for array query parameters.
Parameters | |
---|---|
Name | Description |
array_type |
Union[ScalarQueryParameterType, StructQueryParameterType]
The type of array elements. |
name |
Optional[str]
The name of the query parameter. Primarily used if the type is one of the subfields in |
description |
Optional[str]
The query parameter description. Primarily used if the type is one of the subfields in |
ConnectionProperty
ConnectionProperty(key: str = "", value: str = "")
A connection-level property to customize query behavior.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/ConnectionProperty
Parameters | |
---|---|
Name | Description |
key |
str
The key of the property to set, for example, |
value |
str
The value of the property to set. |
RangeQueryParameter
RangeQueryParameter(range_element_type, start=None, end=None, name=None)
Named / positional query parameters for range values.
Parameters | |
---|---|
Name | Description |
range_element_type |
Union[str, RangeQueryParameterType]
The type of range elements. It must be one of 'TIMESTAMP', 'DATE', or 'DATETIME'. |
start |
Optional[Union[ScalarQueryParameter, str]]
The start of the range value. Must be the same type as range_element_type. If not provided, it's interpreted as UNBOUNDED. |
end |
Optional[Union[ScalarQueryParameter, str]]
The end of the range value. Must be the same type as range_element_type. If not provided, it's interpreted as UNBOUNDED. |
name |
Optional[str]
Parameter name, used via |
RangeQueryParameterType
RangeQueryParameterType(type_, *, name=None, description=None)
Type representation for range query parameters.
Parameters | |
---|---|
Name | Description |
type_ |
Union[ScalarQueryParameterType, str]
Type of range element, must be one of 'TIMESTAMP', 'DATETIME', or 'DATE'. |
name |
Optional[str]
The name of the query parameter. Primarily used if the type is one of the subfields in |
description |
Optional[str]
The query parameter description. Primarily used if the type is one of the subfields in |
ScalarQueryParameter
ScalarQueryParameter(
name: typing.Optional[str],
type_: typing.Optional[
typing.Union[str, google.cloud.bigquery.query.ScalarQueryParameterType]
],
value: typing.Optional[
typing.Union[
str, int, float, decimal.Decimal, bool, datetime.datetime, datetime.date
]
],
)
Named / positional query parameters for scalar values.
Parameters | |
---|---|
Name | Description |
name |
typing.Optional[str]
Parameter name, used via |
type_ |
typing.Union[str, google.cloud.bigquery.query.ScalarQueryParameterType, NoneType]
Name of parameter type. See SqlTypeNames and SqlParameterScalarTypes for supported types. |
value |
typing.Union[str, int, float, decimal.Decimal, bool, datetime.datetime, datetime.date, NoneType]
The scalar parameter value. |
ScalarQueryParameterType
ScalarQueryParameterType(type_, *, name=None, description=None)
Type representation for scalar query parameters.
Parameters | |
---|---|
Name | Description |
type_ |
str
One of 'STRING', 'INT64', 'FLOAT64', 'NUMERIC', 'BOOL', 'TIMESTAMP', 'DATETIME', or 'DATE'. |
name |
Optional[str]
The name of the query parameter. Primarily used if the type is one of the subfields in |
description |
Optional[str]
The query parameter description. Primarily used if the type is one of the subfields in |
SqlParameterScalarTypes
SqlParameterScalarTypes()
Supported scalar SQL query parameter types as type objects.
StructQueryParameter
StructQueryParameter(name, *sub_params)
Named / positional query parameters for struct values.
Parameter | |
---|---|
Name | Description |
name |
Optional[str]
Parameter name, used via |
StructQueryParameterType
StructQueryParameterType(*fields, name=None, description=None)
Type representation for struct query parameters.
Parameters | |
---|---|
Name | Description |
fields |
Iterable[Union[ ArrayQueryParameterType, ScalarQueryParameterType, StructQueryParameterType ]]
An non-empty iterable describing the struct's field types. |
name |
Optional[str]
The name of the query parameter. Primarily used if the type is one of the subfields in |
description |
Optional[str]
The query parameter description. Primarily used if the type is one of the subfields in |
UDFResource
UDFResource(udf_type, value)
Describe a single user-defined function (UDF) resource.
Parameters | |
---|---|
Name | Description |
udf_type |
str
The type of the resource ('inlineCode' or 'resourceUri') |
value |
str See: https://cloud.google.com/bigquery/user-defined-functions#api
The inline code or resource URI. |