Blame - docs/dyn/bigquery_v2.routines.html - platform/external/python/google-api-python-client

2020-07-22 17:02:09 -0700

[diff] [blame]

135

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

136

"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".

137

"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").

138

},

139

"arguments": [ # Optional.

140

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

141

"argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.

142

"mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only.

143

"name": "A String", # Optional. The name of this argument. Can be absent for function return argument.

144

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

145

"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".

146

"fields": [

147

# Object with schema name: StandardSqlField

148

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

149

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

150

"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".

151

"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

152

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

153

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

154

],

155

"creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch.

156

"routineType": "A String", # Required. The type of routine.

157

"description": "A String", # Optional. [Experimental] The description of the routine if defined.

158

"language": "A String", # Optional. Defaults to "SQL".

159

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

160

"determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.

161

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

162

"A String",

163

],

164

"etag": "A String", # Output only. A hash of this resource.

165

"routineReference": { # Required. Reference describing the ID of this routine.

166

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

167

"projectId": "A String", # [Required] The ID of the project containing this routine.

168

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

169

},

170

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

174

<code class="details" id="insert">insert(projectId, datasetId, body=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

175

<pre>Creates a new routine in the dataset.

176

177

Args:

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

178

projectId: string, Required. Project ID of the new routine (required)

179

datasetId: string, Required. Dataset ID of the new routine (required)

180

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

181

The object takes the form of:

182

183

{ # A user-defined function or a stored procedure.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

184

"lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch.

185

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

186

"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".

187

"fields": [

188

# Object with schema name: StandardSqlField

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

189

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

190

},

191

"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".

192

"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").

193

},

194

"arguments": [ # Optional.

195

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

196

"argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.

197

"mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only.

198

"name": "A String", # Optional. The name of this argument. Can be absent for function return argument.

199

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

200

"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".

201

"fields": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

202

# Object with schema name: StandardSqlField

203

],

204

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

205

"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

206

"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

207

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

208

},

209

],

210

"creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch.

211

"routineType": "A String", # Required. The type of routine.

212

"description": "A String", # Optional. [Experimental] The description of the routine if defined.

213

"language": "A String", # Optional. Defaults to "SQL".

214

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

215

"determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.

216

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

217

"A String",

218

],

219

"etag": "A String", # Output only. A hash of this resource.

220

"routineReference": { # Required. Reference describing the ID of this routine.

221

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

222

"projectId": "A String", # [Required] The ID of the project containing this routine.

223

"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:

230

231

{ # A user-defined function or a stored procedure.

232

"lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch.

233

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

234

"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".

235

"fields": [

236

# Object with schema name: StandardSqlField

237

],

238

},

239

"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".

240

"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").

241

},

242

"arguments": [ # Optional.

243

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

244

"argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.

245

"mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only.

246

"name": "A String", # Optional. The name of this argument. Can be absent for function return argument.

247

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

248

"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".

249

"fields": [

250

# Object with schema name: StandardSqlField

251

],

252

},

253

"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".

254

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

259

"routineType": "A String", # Required. The type of routine.

260

"description": "A String", # Optional. [Experimental] The description of the routine if defined.

261

"language": "A String", # Optional. Defaults to "SQL".

262

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

263

"determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.

264

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

265

"A String",

266

],

267

"etag": "A String", # Output only. A hash of this resource.

268

"routineReference": { # Required. Reference describing the ID of this routine.

269

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

270

"projectId": "A String", # [Required] The ID of the project containing this routine.

271

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

272

},

273

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

277

<code class="details" id="list">list(projectId, datasetId, pageToken=None, readMask=None, filter=None, maxResults=None)</code>

278

<pre>Lists all routines in the specified dataset. Requires the READER dataset role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

279

280

Args:

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

281

projectId: string, Required. Project ID of the routines to list (required)

282

datasetId: string, Required. Dataset ID of the routines to list (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

283

pageToken: string, Page token, returned by a previous call, to request the next page of results

284

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.

285

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

286

maxResults: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

287

288

Returns:

289

An object of the form:

290

291

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

292

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

293

{ # A user-defined function or a stored procedure.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

294

"lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch.

295

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

296

"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".

297

"fields": [

298

# Object with schema name: StandardSqlField

299

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

300

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

301

"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".

302

"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

303

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

304

"arguments": [ # Optional.

305

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

306

"argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.

307

"mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only.

308

"name": "A String", # Optional. The name of this argument. Can be absent for function return argument.

309

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

310

"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".

311

"fields": [

312

# Object with schema name: StandardSqlField

313

],

314

},

315

"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".

316

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

321

"routineType": "A String", # Required. The type of routine.

322

"description": "A String", # Optional. [Experimental] The description of the routine if defined.

323

"language": "A String", # Optional. Defaults to "SQL".

324

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

325

"determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.

326

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

327

"A String",

328

],

329

"etag": "A String", # Output only. A hash of this resource.

330

"routineReference": { # Required. Reference describing the ID of this routine.

331

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

332

"projectId": "A String", # [Required] The ID of the project containing this routine.

333

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

334

},

335

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

336

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

337

"nextPageToken": "A String", # A token to request the next page of results.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

343

<pre>Retrieves the next page of results.

344

345

Args:

346

previous_request: The request for the previous page. (required)

347

previous_response: The response from the request for the previous page. (required)

348

349

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

350

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

351

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

356

<code class="details" id="update">update(projectId, datasetId, routineId, body=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

357

<pre>Updates information in an existing routine. The update method replaces the entire Routine resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

358

359

Args:

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

360

projectId: string, Required. Project ID of the routine to update (required)

361

datasetId: string, Required. Dataset ID of the routine to update (required)

362

routineId: string, Required. Routine ID of the routine to update (required)

363

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

364

The object takes the form of:

365

366

{ # A user-defined function or a stored procedure.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

367

"lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch.

368

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

369

"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".

370

"fields": [

371

# Object with schema name: StandardSqlField

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

372

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

373

},

374

"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".

375

"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").

376

},

377

"arguments": [ # Optional.

378

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

379

"argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.

380

"mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only.

381

"name": "A String", # Optional. The name of this argument. Can be absent for function return argument.

382

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

383

"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".

384

"fields": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

385

# Object with schema name: StandardSqlField

386

],

387

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

388

"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

389

"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

390

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

391

},

392

],

393

"creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch.

394

"routineType": "A String", # Required. The type of routine.

395

"description": "A String", # Optional. [Experimental] The description of the routine if defined.

396

"language": "A String", # Optional. Defaults to "SQL".

397

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

398

"determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.

399

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

400

"A String",

401

],

402

"etag": "A String", # Output only. A hash of this resource.

403

"routineReference": { # Required. Reference describing the ID of this routine.

404

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

405

"projectId": "A String", # [Required] The ID of the project containing this routine.

406

"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:

413

414

{ # A user-defined function or a stored procedure.

415

"lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch.

416

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

417

"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".

418

"fields": [

419

# Object with schema name: StandardSqlField

420

],

421

},

422

"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".

423

"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").

424

},

425

"arguments": [ # Optional.

426

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

427

"argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.

428

"mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only.

429

"name": "A String", # Optional. The name of this argument. Can be absent for function return argument.

430

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

431

"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".

432

"fields": [

433

# Object with schema name: StandardSqlField

434

],

435

},

436

"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".

437

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

442

"routineType": "A String", # Required. The type of routine.

443

"description": "A String", # Optional. [Experimental] The description of the routine if defined.

444

"language": "A String", # Optional. Defaults to "SQL".

445

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

446

"determinismLevel": "A String", # Optional. [Experimental] The determinism level of the JavaScript UDF if defined.

447

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

448

"A String",

449

],

450

"etag": "A String", # Output only. A hash of this resource.

451

"routineReference": { # Required. Reference describing the ID of this routine.

452

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

453

"projectId": "A String", # [Required] The ID of the project containing this routine.

454

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

455

},

456

}</pre>

Bu Sun Kim