REST Resource: routines

• Resource: Routine
  • JSON representation
• RoutineReference
  • JSON representation
• RoutineType
• Language
• Argument
  • JSON representation
• ArgumentKind
• Mode
• Methods

Resource: Routine

A user-defined function or a stored procedure.

JSON representation
{ "etag": string, "routineReference": { object (RoutineReference) }, "routineType": enum (RoutineType), "creationTime": string, "lastModifiedTime": string, "language": enum (Language), "arguments": [ { object (Argument) } ], "returnType": { object (StandardSqlDataType) }, "importedLibraries": [ string ], "definitionBody": string, "description": string }

Fields
etag	string Output only. A hash of this resource.
routineReference	object (RoutineReference) Required. Reference describing the ID of this routine.
routineType	enum (RoutineType) Required. The type of routine.
creationTime	string (int64 format) Output only. The time when this routine was created, in milliseconds since the epoch.
lastModifiedTime	string (int64 format) Output only. The time when this routine was last modified, in milliseconds since the epoch.
language	enum (Language) Optional. Defaults to "SQL".
arguments[]	object (Argument) Optional.
returnType	object (StandardSqlDataType) Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definitionBody 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. For example, for the functions created with the following statements: CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y); CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1)); CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1)); The returnType is {typeKind: "FLOAT64"} for Add and Decrement, and is absent for Increment (inferred as FLOAT64 at query time). Suppose the function Add is replaced by CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y); Then the inferred return type of Increment is automatically changed to INT64 at query time, while the return type of Decrement remains FLOAT64.
importedLibraries[]	string Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
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 definitionBody 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 definitionBody is return "\n";\n Note that both \n are replaced with linebreaks.
description	string Optional. [Experimental] The description of the routine if defined.

RoutineReference

Id path of a routine.

JSON representation
{ "projectId": string, "datasetId": string, "routineId": string }

Fields
projectId	string Required. The ID of the project containing this routine.
datasetId	string Required. The ID of the dataset containing this routine.
routineId	string Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

RoutineType

The fine-grained type of the routine.

Enums
ROUTINE_TYPE_UNSPECIFIED
SCALAR_FUNCTION	Non-builtin permanent scalar function.
PROCEDURE	Stored procedure.

Language

The language of the routine.

Enums
LANGUAGE_UNSPECIFIED
SQL	SQL language.
JAVASCRIPT	JavaScript language.

Argument

Input/output argument of a function or a stored procedure.

JSON representation
{ "name": string, "argumentKind": enum (ArgumentKind), "mode": enum (Mode), "dataType": { object (StandardSqlDataType) } }

Fields
name	string Optional. The name of this argument. Can be absent for function return argument.
argumentKind	enum (ArgumentKind) Optional. Defaults to FIXED_TYPE.
mode	enum (Mode) Optional. Specifies whether the argument is input or output. Can be set for procedures only.
dataType	object (StandardSqlDataType) Required unless argumentKind = ANY_TYPE.

ArgumentKind

Enums
ARGUMENT_KIND_UNSPECIFIED
FIXED_TYPE	The argument is a variable with fully specified type, which can be a struct or an array, but not a table.
ANY_TYPE	The argument is any type, including struct or array, but not a table. To be added: FIXED_TABLE, ANY_TABLE

Mode

The input/output mode of the argument.

Enums
MODE_UNSPECIFIED
IN	The argument is input-only.
OUT	The argument is output-only.
INOUT	The argument is both an input and an output.

Methods
delete	Deletes the routine specified by routineId from the dataset.
get	Gets the specified routine resource by routine ID.
insert	Creates a new routine in the dataset.
list	Lists all routines in the specified dataset.
update	Updates information in an existing routine.