Module query (3.18.0)

BigQuery query processing.

Classes

ArrayQueryParameter

ArrayQueryParameter(name,array_type,values)

Named / positional query parameters for array values.

Parameters
NameDescription
nameOptional[str]

Parameter name, used via@foo syntax. If None, the parameter can only be addressed via position (?).

array_typeUnion[str, ScalarQueryParameterType, StructQueryParameterType]

The type of array elements. If given as a string, it must be one of'STRING','INT64','FLOAT64','NUMERIC','BIGNUMERIC','BOOL','TIMESTAMP','DATE', or'STRUCT'/'RECORD'. If the type is'STRUCT'/'RECORD' andvalues is empty, the exact item type cannot be deduced, thus aStructQueryParameterType instance needs to be passed in.

valuesList[appropriate type]

The parameter array values.

ArrayQueryParameterType

ArrayQueryParameterType(array_type,*,name=None,description=None)

Type representation for array query parameters.

Parameters
NameDescription
array_typeUnion[ScalarQueryParameterType, StructQueryParameterType]

The type of array elements.

nameOptional[str]

The name of the query parameter. Primarily used if the type is one of the subfields inStructQueryParameterType instance.

descriptionOptional[str]

The query parameter description. Primarily used if the type is one of the subfields inStructQueryParameterType instance.

ConnectionProperty

ConnectionProperty(key:str="",value:str="")

A connection-level property to customize query behavior.

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

Parameters
NameDescription
keystr

The key of the property to set, for example,'time_zone' or'session_id'.

valuestr

The value of the property to set.

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
NameDescription
nametyping.Optional[str]

Parameter name, used via@foo syntax. If None, the parameter can only be addressed via position (?).

type_typing.Union[str,google.cloud.bigquery.query.ScalarQueryParameterType, NoneType]

Name of parameter type. SeeSqlTypeNames andSqlParameterScalarTypes for supported types.

valuetyping.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
NameDescription
type_str

One of 'STRING', 'INT64', 'FLOAT64', 'NUMERIC', 'BOOL', 'TIMESTAMP', 'DATETIME', or 'DATE'.

nameOptional[str]

The name of the query parameter. Primarily used if the type is one of the subfields inStructQueryParameterType instance.

descriptionOptional[str]

The query parameter description. Primarily used if the type is one of the subfields inStructQueryParameterType instance.

SqlParameterScalarTypes

SqlParameterScalarTypes()

Supported scalar SQL query parameter types as type objects.

StructQueryParameter

StructQueryParameter(name,*sub_params)

Named / positional query parameters for struct values.

Parameter
NameDescription
nameOptional[str]

Parameter name, used via@foo syntax. If None, the parameter can only be addressed via position (?).

StructQueryParameterType

StructQueryParameterType(*fields,name=None,description=None)

Type representation for struct query parameters.

Parameters
NameDescription
fieldsIterable[Union[ ArrayQueryParameterType, ScalarQueryParameterType, StructQueryParameterType ]]

An non-empty iterable describing the struct's field types.

nameOptional[str]

The name of the query parameter. Primarily used if the type is one of the subfields inStructQueryParameterType instance.

descriptionOptional[str]

The query parameter description. Primarily used if the type is one of the subfields inStructQueryParameterType instance.

UDFResource

UDFResource(udf_type,value)

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

Parameters
NameDescription
udf_typestr

The type of the resource ('inlineCode' or 'resourceUri')

valuestr See: https://cloud.google.com/bigquery/user-defined-functions#api

The inline code or resource URI.

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.