Class Routine (3.1.0)

Routine(routine_ref, **kwargs)

Resource representing a user-defined routine.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/routines

Parameters

Name	Description
routine_ref	`Union[str, google.cloud.bigquery.routine.RoutineReference]` A pointer to a routine. If `routine_ref` is a string, it must included a project ID, dataset ID, and routine ID, each separated by `.`.
``**kwargs``	`Dict` Initial property values.

Inheritance

builtins.object > Routine

Properties

arguments

List[google.cloud.bigquery.routine.RoutineArgument]: Input/output argument of a function or a stored procedure.

In-place modification is not supported. To set, replace the entire property value with the modified list of RoutineArgument objects.

body

str: The body of the routine.

created

Optional[datetime.datetime]: Datetime at which the routine was created (:data:None until set from the server).

Read-only.

dataset_id

str: ID of dataset containing the routine.

description

Optional[str]: Description of the routine (defaults to :data:None).

determinism_level

Optional[str]: (experimental) The determinism level of the JavaScript UDF if defined.

etag

str: ETag for the resource (:data:None until set from the server).

Read-only.

imported_libraries

List[str]: The path of the imported JavaScript libraries.

The language must equal JAVACRIPT.

Examples: Set the imported_libraries to a list of Google Cloud Storage URIs.

.. code-block:: python

   routine = bigquery.Routine("proj.dataset.routine_id")
   routine.imported_libraries = [
       "gs://cloud-samples-data/bigquery/udfs/max-value.js",
   ]

language

Optional[str]: The language of the routine.

Defaults to SQL.

modified

Optional[datetime.datetime]: Datetime at which the routine was last modified (:data:None until set from the server).

Read-only.

path

str: URL path for the routine's APIs.

project

str: ID of the project containing the routine.

reference

google.cloud.bigquery.routine.RoutineReference: Reference describing the ID of this routine.

return_table_type

The return type of a Table Valued Function (TVF) routine.

.. versionadded:: 2.22.0

return_type

google.cloud.bigquery.StandardSqlDataType: Return type of the routine.

If absent, the return type is inferred from body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time.

See: https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#Routine.FIELDS.return_type

routine_id

str: The routine ID.

type_

str: The fine-grained type of the routine.

See: https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#RoutineType

Methods

from_api_repr

from_api_repr(resource: dict)

Factory: construct a routine given its API representation.

Parameter

Name	Description
resource	`Dict[str, object]` Resource, as returned from the API.

Returns

Type	Description
google.cloud.bigquery.routine.Routine	Python object, as parsed from ``resource``.

to_api_repr

to_api_repr()

Construct the API resource representation of this routine.

Returns

Type	Description
Dict[str, object]	Routine represented as an API resource.

init

__init__(routine_ref, **kwargs)

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

Routine

Routine(routine_ref, **kwargs)

Resource representing a user-defined routine.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/routines

Parameters

Name	Description
routine_ref	`Union[str, google.cloud.bigquery.routine.RoutineReference]` A pointer to a routine. If `routine_ref` is a string, it must included a project ID, dataset ID, and routine ID, each separated by `.`.
``**kwargs``	`Dict` Initial property values.