Class ArrayQueryParameter (2.27.1)

Version 2.27.1

• 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

ArrayQueryParameter(name, array_type, values)

Named / positional query parameters for array values.

Parameters

Name	Description
name	Optional[str] Parameter name, used via @foo syntax. If None, the parameter can only be addressed via position (?).
array_type	Union[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' and values is empty, the exact item type cannot be deduced, thus a StructQueryParameterType instance needs to be passed in.
values	List[appropriate type] The parameter array values.

Inheritance

builtins.object > google.cloud.bigquery.query._AbstractQueryParameter > ArrayQueryParameter

Methods

from_api_repr

from_api_repr(resource: dict)

Factory: construct parameter from JSON resource.

Parameter

Name	Description
resource	Dict JSON mapping of parameter

Returns

Type	Description
google.cloud.bigquery.query.ArrayQueryParameter	Instance

positional

positional(array_type: str, values: list)

Factory for positional parameters.

Parameters

Name	Description
array_type	Union[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' and values is empty, the exact item type cannot be deduced, thus a StructQueryParameterType instance needs to be passed in.
values	List[appropriate type] The parameter array values.

Returns

Type	Description
google.cloud.bigquery.query.ArrayQueryParameter	Instance without name

to_api_repr

to_api_repr()

Construct JSON API representation for the parameter.

Returns

Type	Description
Dict	JSON mapping

__init__

__init__(name, array_type, values)

Initialize self. See help(type(self)) for accurate signature.

ArrayQueryParameter

ArrayQueryParameter(name, array_type, values)

Named / positional query parameters for array values.

Parameters

Name	Description
name	Optional[str] Parameter name, used via @foo syntax. If None, the parameter can only be addressed via position (?).
array_type	Union[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' and values is empty, the exact item type cannot be deduced, thus a StructQueryParameterType instance needs to be passed in.
values	List[appropriate type] The parameter array values.