docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/bigquery_v2.routines.html b/docs/dyn/bigquery_v2.routines.html
index 04e89fa..2b01d1e 100644
--- a/docs/dyn/bigquery_v2.routines.html
+++ b/docs/dyn/bigquery_v2.routines.html
@@ -75,6 +75,9 @@
<h1><a href="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.routines.html">routines</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#delete">delete(projectId, datasetId, routineId)</a></code></p>
<p class="firstline">Deletes the routine specified by routineId from the dataset.</p>
<p class="toc_element">
@@ -84,16 +87,21 @@
<code><a href="#insert">insert(projectId, datasetId, body=None)</a></code></p>
<p class="firstline">Creates a new routine in the dataset.</p>
<p class="toc_element">
- <code><a href="#list">list(projectId, datasetId, readMask=None, filter=None, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Lists all routines in the specified dataset. Requires the READER dataset</p>
+ <code><a href="#list">list(projectId, datasetId, pageToken=None, readMask=None, filter=None, maxResults=None)</a></code></p>
+<p class="firstline">Lists all routines in the specified dataset. Requires the READER dataset role.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(projectId, datasetId, routineId, body=None)</a></code></p>
-<p class="firstline">Updates information in an existing routine. The update method replaces the</p>
+<p class="firstline">Updates information in an existing routine. The update method replaces the entire Routine resource.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="delete">delete(projectId, datasetId, routineId)</code>
<pre>Deletes the routine specified by routineId from the dataset.
@@ -112,122 +120,54 @@
projectId: string, Required. Project ID of the requested routine (required)
datasetId: string, Required. Dataset ID of the requested routine (required)
routineId: string, Required. Routine ID of the requested routine (required)
- readMask: string, If set, only the Routine fields in the field mask are returned in the
-response. If unset, all Routine fields are returned.
+ readMask: string, If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.
Returns:
An object of the form:
{ # A user-defined function or a stored procedure.
- "definitionBody": "A 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.
- "routineReference": { # Required. Reference describing the ID of this routine.
- "projectId": "A String", # [Required] The ID of the project containing this routine.
- "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
- "routineId": "A 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.
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch.
+ "returnType": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definition_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. 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 return_type is `{type_kind: "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.
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
},
- "determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.
- "language": "A String", # Optional. Defaults to "SQL".
- "description": "A String", # Optional. [Experimental] The description of the routine if defined.
- "etag": "A String", # Output only. A hash of this resource.
- "routineType": "A String", # Required. The type of routine.
- "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
- # the epoch.
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
+ "mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only.
+ "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
+ "dataType": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Required unless argument_kind = ANY_TYPE.
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
},
- "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
- "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
- "mode": "A String", # Optional. Specifies whether the argument is input or output.
- # Can be set for procedures only.
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
- ],
- "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
- # imported JAVASCRIPT libraries.
- "A String",
- ],
- "returnType": { # The type of a variable, e.g., a function argument. # Optional if language = "SQL"; required otherwise.
- #
- # If absent, the return type is inferred from definition_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.
- #
- # 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 return_type is `{type_kind: "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.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
},
- "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
- # since the epoch.
- }</pre>
+ ],
+ "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch.
+ "routineType": "A String", # Required. The type of routine.
+ "description": "A String", # Optional. [Experimental] The description of the routine if defined.
+ "language": "A String", # Optional. Defaults to "SQL".
+ "definitionBody": "A 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.
+ "determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.
+ "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
+ "A String",
+ ],
+ "etag": "A String", # Output only. A hash of this resource.
+ "routineReference": { # Required. Reference describing the ID of this routine.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
+ "projectId": "A String", # [Required] The ID of the project containing this routine.
+ "routineId": "A 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.
+ },
+ }</pre>
</div>
<div class="method">
@@ -241,372 +181,158 @@
The object takes the form of:
{ # A user-defined function or a stored procedure.
- "definitionBody": "A 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.
- "routineReference": { # Required. Reference describing the ID of this routine.
- "projectId": "A String", # [Required] The ID of the project containing this routine.
- "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
- "routineId": "A 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.
- },
- "determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.
- "language": "A String", # Optional. Defaults to "SQL".
- "description": "A String", # Optional. [Experimental] The description of the routine if defined.
- "etag": "A String", # Output only. A hash of this resource.
- "routineType": "A String", # Required. The type of routine.
- "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
- # the epoch.
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- },
- "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
- "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
- "mode": "A String", # Optional. Specifies whether the argument is input or output.
- # Can be set for procedures only.
- },
- ],
- "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
- # imported JAVASCRIPT libraries.
- "A String",
- ],
- "returnType": { # The type of a variable, e.g., a function argument. # Optional if language = "SQL"; required otherwise.
- #
- # If absent, the return type is inferred from definition_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.
- #
- # 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 return_type is `{type_kind: "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.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- },
- "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
- # since the epoch.
- }
-
-
-Returns:
- An object of the form:
-
- { # A user-defined function or a stored procedure.
- "definitionBody": "A 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.
- "routineReference": { # Required. Reference describing the ID of this routine.
- "projectId": "A String", # [Required] The ID of the project containing this routine.
- "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
- "routineId": "A 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.
- },
- "determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.
- "language": "A String", # Optional. Defaults to "SQL".
- "description": "A String", # Optional. [Experimental] The description of the routine if defined.
- "etag": "A String", # Output only. A hash of this resource.
- "routineType": "A String", # Required. The type of routine.
- "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
- # the epoch.
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- },
- "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
- "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
- "mode": "A String", # Optional. Specifies whether the argument is input or output.
- # Can be set for procedures only.
- },
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch.
+ "returnType": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definition_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. 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 return_type is `{type_kind: "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.
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
],
- "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
- # imported JAVASCRIPT libraries.
- "A String",
- ],
- "returnType": { # The type of a variable, e.g., a function argument. # Optional if language = "SQL"; required otherwise.
- #
- # If absent, the return type is inferred from definition_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.
- #
- # 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 return_type is `{type_kind: "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.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
+ "mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only.
+ "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
+ "dataType": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Required unless argument_kind = ANY_TYPE.
"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [
# Object with schema name: StandardSqlField
],
},
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
- "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
- # since the epoch.
- }</pre>
+ },
+ ],
+ "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch.
+ "routineType": "A String", # Required. The type of routine.
+ "description": "A String", # Optional. [Experimental] The description of the routine if defined.
+ "language": "A String", # Optional. Defaults to "SQL".
+ "definitionBody": "A 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.
+ "determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.
+ "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
+ "A String",
+ ],
+ "etag": "A String", # Output only. A hash of this resource.
+ "routineReference": { # Required. Reference describing the ID of this routine.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
+ "projectId": "A String", # [Required] The ID of the project containing this routine.
+ "routineId": "A 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.
+ },
+}
+
+
+Returns:
+ An object of the form:
+
+ { # A user-defined function or a stored procedure.
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch.
+ "returnType": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definition_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. 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 return_type is `{type_kind: "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.
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
+ "mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only.
+ "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
+ "dataType": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Required unless argument_kind = ANY_TYPE.
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ },
+ ],
+ "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch.
+ "routineType": "A String", # Required. The type of routine.
+ "description": "A String", # Optional. [Experimental] The description of the routine if defined.
+ "language": "A String", # Optional. Defaults to "SQL".
+ "definitionBody": "A 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.
+ "determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.
+ "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
+ "A String",
+ ],
+ "etag": "A String", # Output only. A hash of this resource.
+ "routineReference": { # Required. Reference describing the ID of this routine.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
+ "projectId": "A String", # [Required] The ID of the project containing this routine.
+ "routineId": "A 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.
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(projectId, datasetId, readMask=None, filter=None, pageToken=None, maxResults=None)</code>
- <pre>Lists all routines in the specified dataset. Requires the READER dataset
-role.
+ <code class="details" id="list">list(projectId, datasetId, pageToken=None, readMask=None, filter=None, maxResults=None)</code>
+ <pre>Lists all routines in the specified dataset. Requires the READER dataset role.
Args:
projectId: string, Required. Project ID of the routines to list (required)
datasetId: string, Required. Dataset ID of the routines to list (required)
- readMask: string, If set, then only the Routine fields in the field mask, as well as
-project_id, dataset_id and routine_id, are returned in the response.
-If unset, then the following Routine fields are returned:
-etag, project_id, dataset_id, routine_id, routine_type, creation_time,
-last_modified_time, and language.
- filter: string, If set, then only the Routines matching this filter are returned.
-The current supported form is either "routine_type:<RoutineType>" or
-"routineType:<RoutineType>", where <RoutineType> is a RoutineType enum.
-Example: "routineType:SCALAR_FUNCTION".
- pageToken: string, Page token, returned by a previous call, to request the next page of
-results
- maxResults: integer, The maximum number of results to return in a single response page.
-Leverage the page tokens to iterate through the entire collection.
+ pageToken: string, Page token, returned by a previous call, to request the next page of results
+ readMask: string, If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.
+ filter: string, If set, then only the Routines matching this filter are returned. The current supported form is either "routine_type:" or "routineType:", where is a RoutineType enum. Example: "routineType:SCALAR_FUNCTION".
+ maxResults: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
Returns:
An object of the form:
{
- "routines": [ # Routines in the requested dataset. Unless read_mask is set in the request,
- # only the following fields are populated:
- # etag, project_id, dataset_id, routine_id, routine_type, creation_time,
- # last_modified_time, and language.
+ "routines": [ # Routines in the requested dataset. Unless read_mask is set in the request, only the following fields are populated: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.
{ # A user-defined function or a stored procedure.
- "definitionBody": "A 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.
- "routineReference": { # Required. Reference describing the ID of this routine.
- "projectId": "A String", # [Required] The ID of the project containing this routine.
- "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
- "routineId": "A 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.
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch.
+ "returnType": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definition_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. 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 return_type is `{type_kind: "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.
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
},
- "determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.
- "language": "A String", # Optional. Defaults to "SQL".
- "description": "A String", # Optional. [Experimental] The description of the routine if defined.
- "etag": "A String", # Output only. A hash of this resource.
- "routineType": "A String", # Required. The type of routine.
- "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
- # the epoch.
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- },
- "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
- "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
- "mode": "A String", # Optional. Specifies whether the argument is input or output.
- # Can be set for procedures only.
- },
- ],
- "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
- # imported JAVASCRIPT libraries.
- "A String",
- ],
- "returnType": { # The type of a variable, e.g., a function argument. # Optional if language = "SQL"; required otherwise.
- #
- # If absent, the return type is inferred from definition_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.
- #
- # 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 return_type is `{type_kind: "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.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- },
- "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
- # since the epoch.
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
+ "mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only.
+ "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
+ "dataType": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Required unless argument_kind = ANY_TYPE.
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ },
+ ],
+ "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch.
+ "routineType": "A String", # Required. The type of routine.
+ "description": "A String", # Optional. [Experimental] The description of the routine if defined.
+ "language": "A String", # Optional. Defaults to "SQL".
+ "definitionBody": "A 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.
+ "determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.
+ "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
+ "A String",
+ ],
+ "etag": "A String", # Output only. A hash of this resource.
+ "routineReference": { # Required. Reference describing the ID of this routine.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
+ "projectId": "A String", # [Required] The ID of the project containing this routine.
+ "routineId": "A 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.
+ },
+ },
],
"nextPageToken": "A String", # A token to request the next page of results.
}</pre>
@@ -628,8 +354,7 @@
<div class="method">
<code class="details" id="update">update(projectId, datasetId, routineId, body=None)</code>
- <pre>Updates information in an existing routine. The update method replaces the
-entire Routine resource.
+ <pre>Updates information in an existing routine. The update method replaces the entire Routine resource.
Args:
projectId: string, Required. Project ID of the routine to update (required)
@@ -639,230 +364,96 @@
The object takes the form of:
{ # A user-defined function or a stored procedure.
- "definitionBody": "A 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.
- "routineReference": { # Required. Reference describing the ID of this routine.
- "projectId": "A String", # [Required] The ID of the project containing this routine.
- "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
- "routineId": "A 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.
- },
- "determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.
- "language": "A String", # Optional. Defaults to "SQL".
- "description": "A String", # Optional. [Experimental] The description of the routine if defined.
- "etag": "A String", # Output only. A hash of this resource.
- "routineType": "A String", # Required. The type of routine.
- "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
- # the epoch.
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- },
- "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
- "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
- "mode": "A String", # Optional. Specifies whether the argument is input or output.
- # Can be set for procedures only.
- },
- ],
- "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
- # imported JAVASCRIPT libraries.
- "A String",
- ],
- "returnType": { # The type of a variable, e.g., a function argument. # Optional if language = "SQL"; required otherwise.
- #
- # If absent, the return type is inferred from definition_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.
- #
- # 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 return_type is `{type_kind: "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.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- },
- "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
- # since the epoch.
- }
-
-
-Returns:
- An object of the form:
-
- { # A user-defined function or a stored procedure.
- "definitionBody": "A 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.
- "routineReference": { # Required. Reference describing the ID of this routine.
- "projectId": "A String", # [Required] The ID of the project containing this routine.
- "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
- "routineId": "A 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.
- },
- "determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.
- "language": "A String", # Optional. Defaults to "SQL".
- "description": "A String", # Optional. [Experimental] The description of the routine if defined.
- "etag": "A String", # Output only. A hash of this resource.
- "routineType": "A String", # Required. The type of routine.
- "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
- # the epoch.
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- },
- "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
- "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
- "mode": "A String", # Optional. Specifies whether the argument is input or output.
- # Can be set for procedures only.
- },
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch.
+ "returnType": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definition_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. 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 return_type is `{type_kind: "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.
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
],
- "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
- # imported JAVASCRIPT libraries.
- "A String",
- ],
- "returnType": { # The type of a variable, e.g., a function argument. # Optional if language = "SQL"; required otherwise.
- #
- # If absent, the return type is inferred from definition_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.
- #
- # 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 return_type is `{type_kind: "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.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
+ "mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only.
+ "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
+ "dataType": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Required unless argument_kind = ANY_TYPE.
"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [
# Object with schema name: StandardSqlField
],
},
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
- "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
- # since the epoch.
- }</pre>
+ },
+ ],
+ "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch.
+ "routineType": "A String", # Required. The type of routine.
+ "description": "A String", # Optional. [Experimental] The description of the routine if defined.
+ "language": "A String", # Optional. Defaults to "SQL".
+ "definitionBody": "A 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.
+ "determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.
+ "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
+ "A String",
+ ],
+ "etag": "A String", # Output only. A hash of this resource.
+ "routineReference": { # Required. Reference describing the ID of this routine.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
+ "projectId": "A String", # [Required] The ID of the project containing this routine.
+ "routineId": "A 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.
+ },
+}
+
+
+Returns:
+ An object of the form:
+
+ { # A user-defined function or a stored procedure.
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch.
+ "returnType": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definition_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. 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 return_type is `{type_kind: "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.
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
+ "mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only.
+ "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
+ "dataType": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Required unless argument_kind = ANY_TYPE.
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ },
+ ],
+ "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch.
+ "routineType": "A String", # Required. The type of routine.
+ "description": "A String", # Optional. [Experimental] The description of the routine if defined.
+ "language": "A String", # Optional. Defaults to "SQL".
+ "definitionBody": "A 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.
+ "determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.
+ "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
+ "A String",
+ ],
+ "etag": "A String", # Output only. A hash of this resource.
+ "routineReference": { # Required. Reference describing the ID of this routine.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
+ "projectId": "A String", # [Required] The ID of the project containing this routine.
+ "routineId": "A 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.
+ },
+ }</pre>
</div>
</body></html>
\ No newline at end of file