Class ScalarQueryParameter (3.21.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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月10日 UTC.