Class ScalarQueryParameter (3.17.0)

Version 3.17.0

• 3.27.0 (latest)
• 3.26.0
• 3.25.0
• 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

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

Methods

from_api_repr

from_api_repr(resource: dict) -> google.cloud.bigquery.query.ScalarQueryParameter

Factory: construct parameter from JSON resource.

Parameter
Name	Description
resource	Dict JSON mapping of parameter

Returns
Type	Description
google.cloud.bigquery.query.ScalarQueryParameter	Instance

positional

positional(
    type_: typing.Union[str, google.cloud.bigquery.query.ScalarQueryParameterType],
    value: typing.Optional[
        typing.Union[
            str, int, float, decimal.Decimal, bool, datetime.datetime, datetime.date
        ]
    ],
) -> google.cloud.bigquery.query.ScalarQueryParameter

Factory for positional paramater.

Parameters
Name	Description
type_	typing.Union[str, google.cloud.bigquery.query.ScalarQueryParameterType] Name of parameter type. One of 'STRING', 'INT64', 'FLOAT64', 'NUMERIC', 'BIGNUMERIC', 'BOOL', 'TIMESTAMP', 'DATETIME', or 'DATE'.
value	typing.Union[str, int, float, decimal.Decimal, bool, datetime.datetime, datetime.date, NoneType] The scalar parameter value.

Returns
Type	Description
google.cloud.bigquery.query.ScalarQueryParameter	Instance without name

to_api_repr

to_api_repr() -> dict

Construct JSON API representation for the parameter.

Returns
Type	Description
Dict	JSON mapping