Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://cloud.google.com/bigquery/docs/reference/rest/v2/routines below:

REST Resource: routines | BigQuery

• Resource: Routine
  • JSON representation
• RoutineReference
  • JSON representation
• RoutineType
• Language
• Argument
  • JSON representation
• ArgumentKind
• Mode
• StandardSqlTableType
  • JSON representation
• DeterminismLevel
• RemoteFunctionOptions
  • JSON representation
• SparkOptions
  • JSON representation
• DataGovernanceType
• PythonOptions
  • JSON representation
• ExternalRuntimeOptions
  • JSON representation
• Methods

A user-defined function or a stored procedure.

{
  "etag": string,
  "routineReference": {
    object (RoutineReference)
  },
  "routineType": enum (RoutineType),
  "creationTime": string,
  "lastModifiedTime": string,
  "language": enum (Language),
  "arguments": [
    {
      object (Argument)
    }
  ],
  "returnType": {
    object (StandardSqlDataType)
  },
  "returnTableType": {
    object (StandardSqlTableType)
  },
  "importedLibraries": [
    string
  ],
  "definitionBody": string,
  "description": string,
  "determinismLevel": enum (DeterminismLevel),
  "strictMode": boolean,
  "remoteFunctionOptions": {
    object (RemoteFunctionOptions)
  },
  "sparkOptions": {
    object (SparkOptions)
  },
  "dataGovernanceType": enum (DataGovernanceType),
  "pythonOptions": {
    object (PythonOptions)
  },
  "externalRuntimeOptions": {
    object (ExternalRuntimeOptions)
  }
}

string

Output only. A hash of this resource.

object (RoutineReference)

Required. Reference describing the ID of this routine.

enum (RoutineType)

Required. The type of routine.

string (int64 format)

Output only. The time when this routine was created, in milliseconds since the epoch.

string (int64 format)

Output only. The time when this routine was last modified, in milliseconds since the epoch.

enum (Language)

Optional. Defaults to "SQL" if remoteFunctionOptions field is absent, not set otherwise.

object (Argument)

Optional.

object (StandardSqlDataType)

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:

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

object (StandardSqlTableType)

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.

string

Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.

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.

If definitionBody references another routine, then that routine must be fully qualified with its project ID.

string

Optional. The description of the routine, if defined.

enum (DeterminismLevel)

Optional. The determinism level of the JavaScript UDF, if defined.

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.

object (RemoteFunctionOptions)

Optional. Remote function specific options.

object (SparkOptions)

Optional. Spark specific options.

enum (DataGovernanceType)

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.

object (PythonOptions)

Optional. Options for the Python UDF. Preview

object (ExternalRuntimeOptions)

Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. Preview

Id path of a routine.

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

string

Required. The ID of the project containing this routine.

string

Required. The ID of the dataset containing this routine.

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.

The fine-grained type of the routine.

The language of the routine.

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

string

Optional. The name of this argument. Can be absent for function return argument.

enum (ArgumentKind)

Optional. Defaults to FIXED_TYPE.

enum (Mode)

Optional. Specifies whether the argument is input or output. Can be set for procedures only.

object (StandardSqlDataType)

Set if argumentKind == FIXED_TYPE.

Represents the kind of a given argument.

The input/output mode of the argument.

A table type

JavaScript UDF determinism levels.

If all JavaScript UDFs are DETERMINISTIC, the query result is potentially cacheable (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.

Options for a remote user-defined function.

{
  "endpoint": string,
  "connection": string,
  "userDefinedContext": {
    string: string,
    ...
  },
  "maxBatchingRows": string
}

string

Endpoint of the user-provided remote service, e.g. https://us-east1-my_gcf_project.cloudfunctions.net/remote_add

string

Fully qualified name of the user-provided connection object which holds the authentication information to send requests to the remote service. Format: "projects/{projectId}/locations/{locationId}/connections/{connectionId}"

map (key: string, value: string)

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.

string (int64 format)

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.

Options for a user-defined Spark routine.

{
  "connection": string,
  "runtimeVersion": string,
  "containerImage": string,
  "properties": {
    string: string,
    ...
  },
  "mainFileUri": string,
  "pyFileUris": [
    string
  ],
  "jarUris": [
    string
  ],
  "fileUris": [
    string
  ],
  "archiveUris": [
    string
  ],
  "mainClass": string
}

string

Fully qualified name of the user-provided Spark connection object. Format: "projects/{projectId}/locations/{locationId}/connections/{connectionId}"

string

Runtime version. If not specified, the default runtime version is used.

string

Custom container image for the runtime environment.

map (key: string, value: string)

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.

string

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.

string

Python files to be placed on the PYTHONPATH for PySpark application. Supported file types: .py, .egg, and .zip. For more information about Apache Spark, see Apache Spark.

string

JARs to include on the driver and executor CLASSPATH. For more information about Apache Spark, see Apache Spark.

string

Files to be placed in the working directory of each executor. For more information about Apache Spark, see Apache Spark.

string

Archive files to be extracted into the working directory of each executor. For more information about Apache Spark, see Apache Spark.

string

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.

Data governance type values. Only supports DATA_MASKING.

Options for a user-defined Python function.

{
  "entryPoint": string,
  "packages": [
    string
  ]
}

string

Required. The name of the function defined in Python code as the entry point when the Python UDF is invoked.

string

Optional. A list of Python package names along with versions to be installed. Example: ["pandas>=2.1", "google-cloud-translate==3.11"]. For more information, see Use third-party packages.

Options for the runtime of the external system.

{
  "containerMemory": string,
  "containerCpu": number,
  "runtimeConnection": string,
  "maxBatchingRows": string,
  "runtimeVersion": string
}

string

Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see Configure container limits for Python UDFs

number

Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see Configure container limits for Python UDFs

string

Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: "projects/{projectId}/locations/{locationId}/connections/{connectionId}"

string (int64 format)

Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch.

string

Optional. Language runtime version. Example: python-3.11.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4