docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/bigquery_v2.routines.html b/docs/dyn/bigquery_v2.routines.html
index 229ee52..e45766f 100644
--- a/docs/dyn/bigquery_v2.routines.html
+++ b/docs/dyn/bigquery_v2.routines.html
@@ -84,7 +84,7 @@
<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>
+ <code><a href="#list">list(projectId, datasetId, pageToken=None, maxResults=None, readMask=None, filter=None)</a></code></p>
<p class="firstline">Lists all routines in the specified dataset. Requires the READER dataset</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -119,12 +119,37 @@
An object of the form:
{ # A user-defined function or a stored procedure.
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "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.
+ "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"}}
+ # ]}}
+ "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").
+ "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",
],
- "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. # Optional if language = "SQL"; required otherwise.
#
# If absent, the return type is inferred from definition_body at query time
@@ -156,16 +181,18 @@
# {name="x", type={type_kind="STRING"}},
# {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
# ]}}
+ "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").
"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").
},
"language": "A String", # Optional. Defaults to "SQL".
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
+ # since the epoch.
"description": "A String", # Optional. [Experimental] The description of the routine if defined.
"etag": "A String", # Output only. A hash of this resource.
"definitionBody": "A String", # Required. The body of the routine.
@@ -199,33 +226,6 @@
"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.
},
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "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.
- "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"}}
- # ]}}
- "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").
- },
- },
- ],
}</pre>
</div>
@@ -240,12 +240,37 @@
The object takes the form of:
{ # A user-defined function or a stored procedure.
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "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.
+ "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"}}
+ # ]}}
+ "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").
+ "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",
],
- "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. # Optional if language = "SQL"; required otherwise.
#
# If absent, the return type is inferred from definition_body at query time
@@ -277,16 +302,18 @@
# {name="x", type={type_kind="STRING"}},
# {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
# ]}}
+ "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").
"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").
},
"language": "A String", # Optional. Defaults to "SQL".
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
+ # since the epoch.
"description": "A String", # Optional. [Experimental] The description of the routine if defined.
"etag": "A String", # Output only. A hash of this resource.
"definitionBody": "A String", # Required. The body of the routine.
@@ -320,33 +347,6 @@
"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.
},
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "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.
- "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"}}
- # ]}}
- "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").
- },
- },
- ],
}
@@ -354,12 +354,37 @@
An object of the form:
{ # A user-defined function or a stored procedure.
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "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.
+ "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"}}
+ # ]}}
+ "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").
+ "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",
],
- "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. # Optional if language = "SQL"; required otherwise.
#
# If absent, the return type is inferred from definition_body at query time
@@ -391,16 +416,18 @@
# {name="x", type={type_kind="STRING"}},
# {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
# ]}}
+ "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").
"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").
},
"language": "A String", # Optional. Defaults to "SQL".
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
+ # since the epoch.
"description": "A String", # Optional. [Experimental] The description of the routine if defined.
"etag": "A String", # Output only. A hash of this resource.
"definitionBody": "A String", # Required. The body of the routine.
@@ -434,44 +461,21 @@
"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.
},
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "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.
- "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"}}
- # ]}}
- "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").
- },
- },
- ],
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(projectId, datasetId, readMask=None, filter=None, pageToken=None, maxResults=None)</code>
+ <code class="details" id="list">list(projectId, datasetId, pageToken=None, maxResults=None, readMask=None, filter=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)
+ 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.
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:
@@ -481,10 +485,6 @@
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.
Returns:
An object of the form:
@@ -495,12 +495,37 @@
# etag, project_id, dataset_id, routine_id, routine_type, creation_time,
# last_modified_time, and language.
{ # A user-defined function or a stored procedure.
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "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.
+ "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"}}
+ # ]}}
+ "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").
+ "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",
],
- "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. # Optional if language = "SQL"; required otherwise.
#
# If absent, the return type is inferred from definition_body at query time
@@ -532,16 +557,18 @@
# {name="x", type={type_kind="STRING"}},
# {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
# ]}}
+ "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").
"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").
},
"language": "A String", # Optional. Defaults to "SQL".
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
+ # since the epoch.
"description": "A String", # Optional. [Experimental] The description of the routine if defined.
"etag": "A String", # Output only. A hash of this resource.
"definitionBody": "A String", # Required. The body of the routine.
@@ -575,33 +602,6 @@
"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.
},
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "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.
- "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"}}
- # ]}}
- "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").
- },
- },
- ],
},
],
"nextPageToken": "A String", # A token to request the next page of results.
@@ -635,12 +635,37 @@
The object takes the form of:
{ # A user-defined function or a stored procedure.
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "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.
+ "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"}}
+ # ]}}
+ "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").
+ "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",
],
- "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. # Optional if language = "SQL"; required otherwise.
#
# If absent, the return type is inferred from definition_body at query time
@@ -672,16 +697,18 @@
# {name="x", type={type_kind="STRING"}},
# {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
# ]}}
+ "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").
"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").
},
"language": "A String", # Optional. Defaults to "SQL".
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
+ # since the epoch.
"description": "A String", # Optional. [Experimental] The description of the routine if defined.
"etag": "A String", # Output only. A hash of this resource.
"definitionBody": "A String", # Required. The body of the routine.
@@ -715,33 +742,6 @@
"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.
},
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "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.
- "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"}}
- # ]}}
- "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").
- },
- },
- ],
}
@@ -749,12 +749,37 @@
An object of the form:
{ # A user-defined function or a stored procedure.
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "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.
+ "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"}}
+ # ]}}
+ "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").
+ "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",
],
- "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. # Optional if language = "SQL"; required otherwise.
#
# If absent, the return type is inferred from definition_body at query time
@@ -786,16 +811,18 @@
# {name="x", type={type_kind="STRING"}},
# {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
# ]}}
+ "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").
"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").
},
"language": "A String", # Optional. Defaults to "SQL".
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
+ # since the epoch.
"description": "A String", # Optional. [Experimental] The description of the routine if defined.
"etag": "A String", # Output only. A hash of this resource.
"definitionBody": "A String", # Required. The body of the routine.
@@ -829,33 +856,6 @@
"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.
},
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "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.
- "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"}}
- # ]}}
- "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").
- },
- },
- ],
}</pre>
</div>