- Resource: Routine
- RoutineReference
- RoutineType
- Language
- Argument
- ArgumentKind
- Mode
- StandardSqlTableType
- DeterminismLevel
- RemoteFunctionOptions
- SparkOptions
- DataGovernanceType
- Methods
Resource: Routine
A user-defined function or a stored procedure.
JSON representation |
---|
{ "etag": string, "routineReference": { object ( |
Fields | |
---|---|
etag |
Output only. A hash of this resource. |
routine |
Required. Reference describing the ID of this routine. |
routine |
Required. The type of routine. |
creation |
Output only. The time when this routine was created, in milliseconds since the epoch. |
last |
Output only. The time when this routine was last modified, in milliseconds since the epoch. |
language |
Optional. Defaults to "SQL" if remoteFunctionOptions field is absent, not set otherwise. |
arguments[] |
Optional. |
return |
Optional if language = "SQL"; required otherwise. Cannot be set if routineType = "TABLE_VALUED_FUNCTION". 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:
The returnType is Suppose the function Then the inferred return type of |
return |
Optional. Can be set only if routineType = "TABLE_VALUED_FUNCTION". If absent, the return table type is inferred from definitionBody 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. |
imported |
Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. |
definition |
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:
The definitionBody is If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement:
The definitionBody is
Note that both \n are replaced with linebreaks. |
description |
Optional. The description of the routine, if defined. |
determinism |
Optional. The determinism level of the JavaScript UDF, if defined. |
strict |
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 If Default value is |
remote |
Optional. Remote function specific options. |
spark |
Optional. Spark specific options. |
data |
Optional. If set to |
RoutineReference
Id path of a routine.
JSON representation |
---|
{ "projectId": string, "datasetId": string, "routineId": string } |
Fields | |
---|---|
project |
Required. The ID of the project containing this routine. |
dataset |
Required. The ID of the dataset containing this routine. |
routine |
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 |
Default value. |
SCALAR_FUNCTION |
Non-built-in persistent scalar function. |
PROCEDURE |
Stored procedure. |
TABLE_VALUED_FUNCTION |
Non-built-in persistent TVF. |
Language
The language of the routine.
Enums | |
---|---|
LANGUAGE_UNSPECIFIED |
Default value. |
SQL |
SQL language. |
JAVASCRIPT |
JavaScript language. |
PYTHON |
Python language. |
JAVA |
Java language. |
SCALA |
Scala language. |
Argument
Input/output argument of a function or a stored procedure.
JSON representation |
---|
{ "name": string, "argumentKind": enum ( |
Fields | |
---|---|
name |
Optional. The name of this argument. Can be absent for function return argument. |
argument |
Optional. Defaults to FIXED_TYPE. |
mode |
Optional. Specifies whether the argument is input or output. Can be set for procedures only. |
data |
Required unless argumentKind = ANY_TYPE. |
ArgumentKind
Represents the kind of a given argument.
Enums | |
---|---|
ARGUMENT_KIND_UNSPECIFIED |
Default value. |
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 |
Default value. |
IN |
The argument is input-only. |
OUT |
The argument is output-only. |
INOUT |
The argument is both an input and an output. |
StandardSqlTableType
A table type
JSON representation |
---|
{
"columns": [
{
object ( |
Fields | |
---|---|
columns[] |
The columns in this table type |
DeterminismLevel
JavaScript UDF determinism levels.
If all JavaScript UDFs are DETERMINISTIC, the query result is potentially cachable (see below). If any JavaScript UDF is NOT_DETERMINISTIC, the query result is not cacheable.
Even if a JavaScript UDF is deterministic, many other factors can prevent usage of cached query results. Example factors include but not limited to: DDL/DML, non-deterministic SQL function calls, update of referenced tables/views/UDFs or imported JavaScript libraries.
SQL UDFs cannot have determinism specified. Their determinism is automatically determined.
Enums | |
---|---|
DETERMINISM_LEVEL_UNSPECIFIED |
The determinism of the UDF is unspecified. |
DETERMINISTIC |
The UDF is deterministic, meaning that 2 function calls with the same inputs always produce the same result, even across 2 query runs. |
NOT_DETERMINISTIC |
The UDF is not deterministic. |
RemoteFunctionOptions
Options for a remote user-defined function.
JSON representation |
---|
{ "endpoint": string, "connection": string, "userDefinedContext": { string: string, ... }, "maxBatchingRows": string } |
Fields | |
---|---|
endpoint |
Endpoint of the user-provided remote service, e.g. |
connection |
Fully qualified name of the user-provided connection object which holds the authentication information to send requests to the remote service. Format: |
user |
User-defined context as a set of key/value pairs, which will be sent as function invocation context together with batched arguments in the requests to the remote service. The total number of bytes of keys and values must be less than 8KB. |
max |
Max number of rows in each batch sent to the remote service. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. |
SparkOptions
Options for a user-defined Spark routine.
JSON representation |
---|
{ "connection": string, "runtimeVersion": string, "containerImage": string, "properties": { string: string, ... }, "mainFileUri": string, "pyFileUris": [ string ], "jarUris": [ string ], "fileUris": [ string ], "archiveUris": [ string ], "mainClass": string } |
Fields | |
---|---|
connection |
Fully qualified name of the user-provided Spark connection object. Format: |
runtime |
Runtime version. If not specified, the default runtime version is used. |
container |
Custom container image for the runtime environment. |
properties |
Configuration properties as a set of key/value pairs, which will be passed on to the Spark application. For more information, see Apache Spark and the procedure option list. |
main |
The main file/jar URI of the Spark application. Exactly one of the definitionBody field and the mainFileUri field must be set for Python. Exactly one of mainClass and mainFileUri field should be set for Java/Scala language type. |
py |
Python files to be placed on the PYTHONPATH for PySpark application. Supported file types: |
jar |
JARs to include on the driver and executor CLASSPATH. For more information about Apache Spark, see Apache Spark. |
file |
Files to be placed in the working directory of each executor. For more information about Apache Spark, see Apache Spark. |
archive |
Archive files to be extracted into the working directory of each executor. For more information about Apache Spark, see Apache Spark. |
main |
The fully qualified name of a class in jarUris, for example, com.example.wordcount. Exactly one of mainClass and main_jar_uri field should be set for Java/Scala language type. |
DataGovernanceType
Data governance type values. Only supports DATA_MASKING
.
Enums | |
---|---|
DATA_GOVERNANCE_TYPE_UNSPECIFIED |
The data governance type is unspecified. |
DATA_MASKING |
The data governance type is data masking. |
Methods |
|
---|---|
|
Deletes the routine specified by routineId from the dataset. |
|
Gets the specified routine resource by routine ID. |
|
Creates a new routine in the dataset. |
|
Lists all routines in the specified dataset. |
|
Updates information in an existing routine. |