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

2020-12-09 08:56:03 -0800

[diff] [blame]

133

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

134

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

135

"fields": [

136

# Object with schema name: StandardSqlField

137

],

138

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

139

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

140

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

141

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

142

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

143

},

144

],

145

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

146

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

147

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

148

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

149

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

150

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

151

"A String",

152

],

153

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

154

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

155

"returnTableType": { # A table type # Optional. Set only if Routine is a "TABLE_VALUED_FUNCTION". TODO(b/173344646) - Update return_type documentation to say it cannot be set for TABLE_VALUED_FUNCTION before preview launch.

156

"columns": [ # The columns in this table type

157

{ # A field or a column.

158

"name": "A String", # Optional. The name of this field. Can be absent for struct fields.

159

"type": { # 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. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).

160

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

161

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

162

"fields": [

163

# Object with schema name: StandardSqlField

164

],

165

},

166

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

},

},

],

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

171

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

172

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

173

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

174

"fields": [

175

# Object with schema name: StandardSqlField

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

176

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

177

},

178

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

179

},

180

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

181

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

182

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

183

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

184

},

185

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

186

}</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]

190

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

Bu Sun Kim

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

[diff] [blame]

191

<pre>Creates a new routine in the dataset.

192

193

Args:

Dan O'Meara

dd49464

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

[diff] [blame]

194

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

195

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

196

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

197

The object takes the form of:

198

199

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

200

"arguments": [ # Optional.

201

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

202

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

203

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

204

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

205

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

206

"fields": [

207

# Object with schema name: StandardSqlField

208

],

209

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

210

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

211

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

212

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

213

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

214

},

215

],

216

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

217

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

218

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

219

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

220

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

221

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

222

"A String",

223

],

224

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

225

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

226

"returnTableType": { # A table type # Optional. Set only if Routine is a "TABLE_VALUED_FUNCTION". TODO(b/173344646) - Update return_type documentation to say it cannot be set for TABLE_VALUED_FUNCTION before preview launch.

227

"columns": [ # The columns in this table type

228

{ # A field or a column.

229

"name": "A String", # Optional. The name of this field. Can be absent for struct fields.

230

"type": { # 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. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).

231

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

232

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

233

"fields": [

234

# Object with schema name: StandardSqlField

235

],

236

},

237

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

},

},

],

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

242

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

243

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

244

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

245

"fields": [

246

# Object with schema name: StandardSqlField

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

247

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

248

},

249

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

250

},

251

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

252

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

253

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

254

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

255

},

256

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

}

Returns:

An object of the form:

262

263

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

264

"arguments": [ # Optional.

265

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

266

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

267

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

268

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

269

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

270

"fields": [

271

# Object with schema name: StandardSqlField

272

],

273

},

274

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

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

275

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

276

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

277

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

278

},

279

],

280

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

281

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

282

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

283

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

284

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

285

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

286

"A String",

287

],

288

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

289

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

290

"returnTableType": { # A table type # Optional. Set only if Routine is a "TABLE_VALUED_FUNCTION". TODO(b/173344646) - Update return_type documentation to say it cannot be set for TABLE_VALUED_FUNCTION before preview launch.

291

"columns": [ # The columns in this table type

292

{ # A field or a column.

293

"name": "A String", # Optional. The name of this field. Can be absent for struct fields.

294

"type": { # 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. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).

295

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

296

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

297

"fields": [

298

# Object with schema name: StandardSqlField

299

],

300

},

301

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

},

},

],

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

306

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

307

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

308

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

309

"fields": [

310

# Object with schema name: StandardSqlField

311

],

312

},

313

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

314

},

315

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

316

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

317

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

318

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

319

},

320

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

321

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

325

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

Dmitry Frenkel

3e17f89

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

[diff] [blame]

326

<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]

327

328

Args:

Dan O'Meara

dd49464

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

[diff] [blame]

329

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

330

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

331

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

332

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

333

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

334

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.

Bu Sun Kim

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

[diff] [blame]

335

336

Returns:

337

An object of the form:

338

339

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

340

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

341

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

342

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

343

"arguments": [ # Optional.

344

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

345

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

346

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

347

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

348

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

349

"fields": [

350

# Object with schema name: StandardSqlField

351

],

352

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

353

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

354

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

355

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

356

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

357

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

358

],

359

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

360

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

361

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

362

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

363

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

364

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

365

"A String",

366

],

367

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

368

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

369

"returnTableType": { # A table type # Optional. Set only if Routine is a "TABLE_VALUED_FUNCTION". TODO(b/173344646) - Update return_type documentation to say it cannot be set for TABLE_VALUED_FUNCTION before preview launch.

370

"columns": [ # The columns in this table type

371

{ # A field or a column.

372

"name": "A String", # Optional. The name of this field. Can be absent for struct fields.

373

"type": { # 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. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).

374

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

375

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

376

"fields": [

377

# Object with schema name: StandardSqlField

378

],

379

},

380

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

},

},

],

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

385

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

386

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

387

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

388

"fields": [

389

# Object with schema name: StandardSqlField

390

],

391

},

392

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

393

},

394

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

395

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

396

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

397

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

398

},

399

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

400

},

401

],

402

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

407

<pre>Retrieves the next page of results.

408

409

Args:

410

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

411

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

412

413

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

414

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]

415

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]

420

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

Dmitry Frenkel

3e17f89

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

[diff] [blame]

421

<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]

422

423

Args:

Dan O'Meara

dd49464

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

[diff] [blame]

424

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

425

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

426

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

427

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

428

The object takes the form of:

429

430

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

431

"arguments": [ # Optional.

432

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

433

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

434

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

435

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

436

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

437

"fields": [

438

# Object with schema name: StandardSqlField

439

],

440

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

441

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

442

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

443

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

444

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

445

},

446

],

447

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

448

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

449

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

450

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

451

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

452

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

453

"A String",

454

],

455

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

456

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

457

"returnTableType": { # A table type # Optional. Set only if Routine is a "TABLE_VALUED_FUNCTION". TODO(b/173344646) - Update return_type documentation to say it cannot be set for TABLE_VALUED_FUNCTION before preview launch.

458

"columns": [ # The columns in this table type

459

{ # A field or a column.

460

"name": "A String", # Optional. The name of this field. Can be absent for struct fields.

461

"type": { # 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. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).

462

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

463

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

464

"fields": [

465

# Object with schema name: StandardSqlField

466

],

467

},

468

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

},

},

],

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

473

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

474

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

475

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

476

"fields": [

477

# Object with schema name: StandardSqlField

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

478

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

479

},

480

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

481

},

482

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

483

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

484

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

485

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

486

},

487

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

}

Returns:

An object of the form:

493

494

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

495

"arguments": [ # Optional.

496

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

497

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

498

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

499

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

500

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

501

"fields": [

502

# Object with schema name: StandardSqlField

503

],

504

},

505

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

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

506

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

507

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

508

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

509

},

510

],

511

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

512

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

513

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

514

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

515

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

516

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

517

"A String",

518

],

519

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

520

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

521

"returnTableType": { # A table type # Optional. Set only if Routine is a "TABLE_VALUED_FUNCTION". TODO(b/173344646) - Update return_type documentation to say it cannot be set for TABLE_VALUED_FUNCTION before preview launch.

522

"columns": [ # The columns in this table type

523

{ # A field or a column.

524

"name": "A String", # Optional. The name of this field. Can be absent for struct fields.

525

"type": { # 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. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).

526

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

527

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

528

"fields": [

529

# Object with schema name: StandardSqlField

530

],

531

},

532

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

},

},

],

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

537

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

538

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

539

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

540

"fields": [

541

# Object with schema name: StandardSqlField

542

],

543

},

544

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

545

},

546

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

547

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

548

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

549

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

550

},

551

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

552

}</pre>

Bu Sun Kim