Class Routine (3.17.0) 

Routine(routine_ref, **kwargs)

Resource representing a user-defined routine.

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

Parameters

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

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.

data_governance_type

Optional[str]: If set to DATA_MASKING, the function is validated and made available as a masking function.

Exceptions
TypeDescription
ValueErrorIf the value is not :data:string or :data:None.

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.

remote_function_options

Optional[google.cloud.bigquery.routine.RemoteFunctionOptions]: Configures remote function options for a routine.

Exceptions
TypeDescription
ValueErrorIf the value is not RemoteFunctionOptions or :data:None.

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) -> google.cloud.bigquery.routine.routine.Routine

Factory: construct a routine given its API representation.

Parameter
NameDescription
resource Dict[str, object]

Resource, as returned from the API.

Returns
TypeDescription
google.cloud.bigquery.routine.RoutinePython object, as parsed from resource.

to_api_repr

to_api_repr() -> dict

Construct the API resource representation of this routine.

Returns
TypeDescription
Dict[str, object]Routine represented as an API resource.