Class RangeQueryParameter (3.22.0)

RangeQueryParameter(range_element_type, start=None, end=None, name=None)

Named / positional query parameters for range values.

Parameters
Name Description
range_element_type Union[str, RangeQueryParameterType]

The type of range elements. It must be one of 'TIMESTAMP', 'DATE', or 'DATETIME'.
start Optional[Union[ScalarQueryParameter, str]]

The start of the range value. Must be the same type as range_element_type. If not provided, it's interpreted as UNBOUNDED.
end Optional[Union[ScalarQueryParameter, str]]

The end of the range value. Must be the same type as range_element_type. If not provided, it's interpreted as UNBOUNDED.
name Optional[str]

Parameter name, used via @foo syntax. If None, the parameter can only be addressed via position (?).

Methods

from_api_repr

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

Factory: construct parameter from JSON resource.

Parameter
Name Description
resource Dict

JSON mapping of parameter
Returns
Type Description
google.cloud.bigquery.query.RangeQueryParameter Instance

positional

positional(
    range_element_type, start=None, end=None
) -> google.cloud.bigquery.query.RangeQueryParameter

Factory for positional parameters.

Parameters
Name Description
range_element_type Union[str, RangeQueryParameterType]

The type of range elements. It must be one of 'TIMESTAMP', 'DATE', or 'DATETIME'.
start Optional[Union[ScalarQueryParameter, str]]

The start of the range value. Must be the same type as range_element_type. If not provided, it's interpreted as UNBOUNDED.
end Optional[Union[ScalarQueryParameter, str]]

The end of the range value. Must be the same type as range_element_type. If not provided, it's interpreted as UNBOUNDED.
Returns
Type Description
google.cloud.bigquery.query.RangeQueryParameter Instance without name.

to_api_repr

to_api_repr() -> dict

Construct JSON API representation for the parameter.

Returns
Type Description
Dict JSON mapping