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.ScalarQueryParameter

class google.cloud.bigquery.query.ScalarQueryParameter(name, type_, value)

Named / positional query parameters for scalar values.

Parameters

• name (Optional[str]) – Parameter name, used via @foo syntax. If None, the parameter can only be addressed via position (?).

• type (str) – Name of parameter type. One of ‘STRING’, ‘INT64’, ‘FLOAT64’, ‘NUMERIC’, ‘BOOL’, ‘TIMESTAMP’, ‘DATETIME’, or ‘DATE’.

• value (Union[str, int, float, decimal.Decimal, bool, datetime.datetime, datetime.date]) – The scalar parameter value.

__init__(name, type_, value)

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

Methods

__init__(name, type_, value)	Initialize self.
from_api_repr(resource)	Factory: construct parameter from JSON resource.
positional(type_, value)	Factory for positional paramater.
to_api_repr()	Construct JSON API representation for the parameter.

classmethod from_api_repr(resource)

Factory: construct parameter from JSON resource.

Parameters

resource (Dict) – JSON mapping of parameter

Returns

Instance

Return type

google.cloud.bigquery.query.ScalarQueryParameter

classmethod positional(type_, value)

Factory for positional paramater.

Parameters

• type (str) – Name of parameter type. One of ‘STRING’, ‘INT64’, ‘FLOAT64’, ‘NUMERIC’, ‘BOOL’, ‘TIMESTAMP’, ‘DATETIME’, or ‘DATE’.

• value (Union[str, int, float, decimal.Decimal, bool, datetime.datetime, datetime.date]) – The scalar parameter value.

Returns

Instance without name

Return type

google.cloud.bigquery.query.ScalarQueryParameter

to_api_repr()

Construct JSON API representation for the parameter.

Returns

JSON mapping

Return type

Dict