As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

google.cloud.bigquery.query.ArrayQueryParameter

class google.cloud.bigquery.query.ArrayQueryParameter(name, array_type, values)[source]

Named / positional query parameters for array values.

Parameters
  • 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.

__init__(name, array_type, values)[source]

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

Methods

__init__(name, array_type, values)

Initialize self.

from_api_repr(resource)

Factory: construct parameter from JSON resource.

positional(array_type, values)

Factory for positional parameters.

to_api_repr()

Construct JSON API representation for the parameter.

classmethod from_api_repr(resource)[source]

Factory: construct parameter from JSON resource.

Parameters

resource (Dict) – JSON mapping of parameter

Returns

Instance

Return type

google.cloud.bigquery.query.ArrayQueryParameter

classmethod positional(array_type, values)[source]

Factory for positional parameters.

Parameters
  • 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

Instance without name

Return type

google.cloud.bigquery.query.ArrayQueryParameter

to_api_repr()[source]

Construct JSON API representation for the parameter.

Returns

JSON mapping

Return type

Dict