routines

Creates, updates, deletes, gets or lists a routines resource.

Overview

Name	routines
Type	Resource
Id	google.bigquery.routines

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
arguments	array	Optional.
creationTime	string (int64)	Output only. The time when this routine was created, in milliseconds since the epoch.
dataGovernanceType	string	Optional. If set to DATA_MASKING, the function is validated and made available as a masking function. For more information, see Create custom masking routines.
definitionBody	string	Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y)) The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n' The definition_body is return "\n";\n Note that both \n are replaced with linebreaks.
description	string	Optional. The description of the routine, if defined.
determinismLevel	string	Optional. The determinism level of the JavaScript UDF, if defined.
etag	string	Output only. A hash of this resource.
externalRuntimeOptions	object	Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. Preview (id: ExternalRuntimeOptions)
importedLibraries	array	Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
language	string	Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise.
lastModifiedTime	string (int64)	Output only. The time when this routine was last modified, in milliseconds since the epoch.
pythonOptions	object	Optional. Options for the Python UDF. Preview (id: PythonOptions)
remoteFunctionOptions	object	Optional. Remote function specific options. (id: RemoteFunctionOptions)
returnTableType	object	Optional. Can be set only if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return table type is inferred from definition_body at query time in each query that references this routine. If present, then the columns in the evaluated table result will be cast to match the column types specified in return table type, at query time. (id: StandardSqlTableType)
returnType	object	The data type of a variable such as a function argument. Examples include: * INT64: {"typeKind": "INT64"} * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } (id: StandardSqlDataType)
routineReference	object	Id path of a routine. (id: RoutineReference)
routineType	string	Required. The type of routine.
securityMode	string	Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration.
sparkOptions	object	Optional. Spark specific options. (id: SparkOptions)
strictMode	boolean	Optional. Use this option to catch many common errors. Error checking is not exhaustive, and successfully creating a procedure doesn't guarantee that the procedure will successfully execute at runtime. If strictMode is set to TRUE, the procedure body is further checked for errors such as non-existent tables or columns. The CREATE PROCEDURE statement fails if the body fails any of these checks. If strictMode is set to FALSE, the procedure body is checked only for syntax. For procedures that invoke themselves recursively, specify strictMode=FALSE to avoid non-existent procedure errors during validation. Default value is TRUE.

list

Successful response

Name	Datatype	Description
arguments	array	Optional.
creationTime	string (int64)	Output only. The time when this routine was created, in milliseconds since the epoch.
dataGovernanceType	string	Optional. If set to DATA_MASKING, the function is validated and made available as a masking function. For more information, see Create custom masking routines.
definitionBody	string	Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y)) The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n' The definition_body is return "\n";\n Note that both \n are replaced with linebreaks.
description	string	Optional. The description of the routine, if defined.
determinismLevel	string	Optional. The determinism level of the JavaScript UDF, if defined.
etag	string	Output only. A hash of this resource.
externalRuntimeOptions	object	Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. Preview (id: ExternalRuntimeOptions)
importedLibraries	array	Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
language	string	Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise.
lastModifiedTime	string (int64)	Output only. The time when this routine was last modified, in milliseconds since the epoch.
pythonOptions	object	Optional. Options for the Python UDF. Preview (id: PythonOptions)
remoteFunctionOptions	object	Optional. Remote function specific options. (id: RemoteFunctionOptions)
returnTableType	object	Optional. Can be set only if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return table type is inferred from definition_body at query time in each query that references this routine. If present, then the columns in the evaluated table result will be cast to match the column types specified in return table type, at query time. (id: StandardSqlTableType)
returnType	object	The data type of a variable such as a function argument. Examples include: * INT64: {"typeKind": "INT64"} * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } (id: StandardSqlDataType)
routineReference	object	Id path of a routine. (id: RoutineReference)
routineType	string	Required. The type of routine.
securityMode	string	Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration.
sparkOptions	object	Optional. Spark specific options. (id: SparkOptions)
strictMode	boolean	Optional. Use this option to catch many common errors. Error checking is not exhaustive, and successfully creating a procedure doesn't guarantee that the procedure will successfully execute at runtime. If strictMode is set to TRUE, the procedure body is further checked for errors such as non-existent tables or columns. The CREATE PROCEDURE statement fails if the body fails any of these checks. If strictMode is set to FALSE, the procedure body is checked only for syntax. For procedures that invoke themselves recursively, specify strictMode=FALSE to avoid non-existent procedure errors during validation. Default value is TRUE.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectId, +datasetId, +routineId	readMask	Gets the specified routine resource by routine ID.
list	select	projectId, +datasetId	filter, maxResults, pageToken, readMask	Lists all routines in the specified dataset. Requires the READER dataset role.
insert	insert	projectId, +datasetId		Creates a new routine in the dataset.
update	replace	projectId, +datasetId, +routineId		Updates information in an existing routine. The update method replaces the entire Routine resource.
delete	delete	projectId, +datasetId, +routineId		Deletes the routine specified by routineId from the dataset.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
+datasetId	string
+routineId	string
projectId	string
filter	string
maxResults	integer (uint32)
pageToken	string
readMask	string (google-fieldmask)

SELECT examples

get

Gets the specified routine resource by routine ID.

SELECT
arguments,
creationTime,
dataGovernanceType,
definitionBody,
description,
determinismLevel,
etag,
externalRuntimeOptions,
importedLibraries,
language,
lastModifiedTime,
pythonOptions,
remoteFunctionOptions,
returnTableType,
returnType,
routineReference,
routineType,
securityMode,
sparkOptions,
strictMode
FROM google.bigquery.routines
WHERE projectId = '{{ projectId }}' -- required
AND +datasetId = '{{ +datasetId }}' -- required
AND +routineId = '{{ +routineId }}' -- required
AND readMask = '{{ readMask }}';

list

Lists all routines in the specified dataset. Requires the READER dataset role.

SELECT
arguments,
creationTime,
dataGovernanceType,
definitionBody,
description,
determinismLevel,
etag,
externalRuntimeOptions,
importedLibraries,
language,
lastModifiedTime,
pythonOptions,
remoteFunctionOptions,
returnTableType,
returnType,
routineReference,
routineType,
securityMode,
sparkOptions,
strictMode
FROM google.bigquery.routines
WHERE projectId = '{{ projectId }}' -- required
AND +datasetId = '{{ +datasetId }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND readMask = '{{ readMask }}';

INSERT examples

insert

Creates a new routine in the dataset.

INSERT INTO google.bigquery.routines (
data__arguments,
data__dataGovernanceType,
data__definitionBody,
data__description,
data__determinismLevel,
data__externalRuntimeOptions,
data__importedLibraries,
data__language,
data__pythonOptions,
data__remoteFunctionOptions,
data__returnTableType,
data__returnType,
data__routineReference,
data__routineType,
data__securityMode,
data__sparkOptions,
data__strictMode,
projectId,
+datasetId
)
SELECT 
'{{ arguments }}',
'{{ dataGovernanceType }}',
'{{ definitionBody }}',
'{{ description }}',
'{{ determinismLevel }}',
'{{ externalRuntimeOptions }}',
'{{ importedLibraries }}',
'{{ language }}',
'{{ pythonOptions }}',
'{{ remoteFunctionOptions }}',
'{{ returnTableType }}',
'{{ returnType }}',
'{{ routineReference }}',
'{{ routineType }}',
'{{ securityMode }}',
'{{ sparkOptions }}',
{{ strictMode }},
'{{ projectId }}',
'{{ +datasetId }}'
RETURNING
arguments,
creationTime,
dataGovernanceType,
definitionBody,
description,
determinismLevel,
etag,
externalRuntimeOptions,
importedLibraries,
language,
lastModifiedTime,
pythonOptions,
remoteFunctionOptions,
returnTableType,
returnType,
routineReference,
routineType,
securityMode,
sparkOptions,
strictMode
;

Manifest

# Description fields are for documentation purposes
- name: routines
  props:
    - name: projectId
      value: string
      description: Required parameter for the routines resource.
    - name: +datasetId
      value: string
      description: Required parameter for the routines resource.
    - name: arguments
      value: array
      description: >
        Optional.
        
    - name: dataGovernanceType
      value: string
      description: >
        Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask).
        
      valid_values: ['DATA_GOVERNANCE_TYPE_UNSPECIFIED', 'DATA_MASKING']
    - name: definitionBody
      value: string
      description: >
        Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks.
        
    - name: description
      value: string
      description: >
        Optional. The description of the routine, if defined.
        
    - name: determinismLevel
      value: string
      description: >
        Optional. The determinism level of the JavaScript UDF, if defined.
        
      valid_values: ['DETERMINISM_LEVEL_UNSPECIFIED', 'DETERMINISTIC', 'NOT_DETERMINISTIC']
    - name: externalRuntimeOptions
      value: object
      description: >
        Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages)
        
    - name: importedLibraries
      value: array
      description: >
        Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
        
    - name: language
      value: string
      description: >
        Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise.
        
      valid_values: ['LANGUAGE_UNSPECIFIED', 'SQL', 'JAVASCRIPT', 'PYTHON', 'JAVA', 'SCALA']
    - name: pythonOptions
      value: object
      description: >
        Optional. Options for the Python UDF. [Preview](https://cloud.google.com/products/#product-launch-stages)
        
    - name: remoteFunctionOptions
      value: object
      description: >
        Optional. Remote function specific options.
        
    - name: returnTableType
      value: object
      description: >
        Optional. Can be set only if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return table type is inferred from definition_body at query time in each query that references this routine. If present, then the columns in the evaluated table result will be cast to match the column types specified in return table type, at query time.
        
    - name: returnType
      value: object
      description: >
        The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} }
        
    - name: routineReference
      value: object
      description: >
        Id path of a routine.
        
    - name: routineType
      value: string
      description: >
        Required. The type of routine.
        
      valid_values: ['ROUTINE_TYPE_UNSPECIFIED', 'SCALAR_FUNCTION', 'PROCEDURE', 'TABLE_VALUED_FUNCTION', 'AGGREGATE_FUNCTION']
    - name: securityMode
      value: string
      description: >
        Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration.
        
      valid_values: ['SECURITY_MODE_UNSPECIFIED', 'DEFINER', 'INVOKER']
    - name: sparkOptions
      value: object
      description: >
        Optional. Spark specific options.
        
    - name: strictMode
      value: boolean
      description: >
        Optional. Use this option to catch many common errors. Error checking is not exhaustive, and successfully creating a procedure doesn't guarantee that the procedure will successfully execute at runtime. If `strictMode` is set to `TRUE`, the procedure body is further checked for errors such as non-existent tables or columns. The `CREATE PROCEDURE` statement fails if the body fails any of these checks. If `strictMode` is set to `FALSE`, the procedure body is checked only for syntax. For procedures that invoke themselves recursively, specify `strictMode=FALSE` to avoid non-existent procedure errors during validation. Default value is `TRUE`.
        

REPLACE examples

update

Updates information in an existing routine. The update method replaces the entire Routine resource.

REPLACE google.bigquery.routines
SET 
data__arguments = '{{ arguments }}',
data__dataGovernanceType = '{{ dataGovernanceType }}',
data__definitionBody = '{{ definitionBody }}',
data__description = '{{ description }}',
data__determinismLevel = '{{ determinismLevel }}',
data__externalRuntimeOptions = '{{ externalRuntimeOptions }}',
data__importedLibraries = '{{ importedLibraries }}',
data__language = '{{ language }}',
data__pythonOptions = '{{ pythonOptions }}',
data__remoteFunctionOptions = '{{ remoteFunctionOptions }}',
data__returnTableType = '{{ returnTableType }}',
data__returnType = '{{ returnType }}',
data__routineReference = '{{ routineReference }}',
data__routineType = '{{ routineType }}',
data__securityMode = '{{ securityMode }}',
data__sparkOptions = '{{ sparkOptions }}',
data__strictMode = {{ strictMode }}
WHERE 
projectId = '{{ projectId }}' --required
AND +datasetId = '{{ +datasetId }}' --required
AND +routineId = '{{ +routineId }}' --required
RETURNING
arguments,
creationTime,
dataGovernanceType,
definitionBody,
description,
determinismLevel,
etag,
externalRuntimeOptions,
importedLibraries,
language,
lastModifiedTime,
pythonOptions,
remoteFunctionOptions,
returnTableType,
returnType,
routineReference,
routineType,
securityMode,
sparkOptions,
strictMode;

DELETE examples

delete

Deletes the routine specified by routineId from the dataset.

DELETE FROM google.bigquery.routines
WHERE projectId = '{{ projectId }}' --required
AND +datasetId = '{{ +datasetId }}' --required
AND +routineId = '{{ +routineId }}' --required;