@databricks/sdk-uc-functions 0.27.0 → 0.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,391 +1,394 @@
1
- import { z } from 'zod';
2
- export declare const ColumnTypeName: {
3
- readonly BOOLEAN: "BOOLEAN";
4
- readonly BYTE: "BYTE";
5
- readonly SHORT: "SHORT";
6
- readonly INT: "INT";
7
- readonly LONG: "LONG";
8
- readonly FLOAT: "FLOAT";
9
- readonly DOUBLE: "DOUBLE";
10
- readonly DATE: "DATE";
11
- readonly TIMESTAMP: "TIMESTAMP";
12
- readonly STRING: "STRING";
13
- readonly BINARY: "BINARY";
14
- readonly DECIMAL: "DECIMAL";
15
- readonly INTERVAL: "INTERVAL";
16
- readonly ARRAY: "ARRAY";
17
- readonly STRUCT: "STRUCT";
18
- readonly MAP: "MAP";
19
- readonly CHAR: "CHAR";
20
- readonly NULL: "NULL";
21
- readonly USER_DEFINED_TYPE: "USER_DEFINED_TYPE";
22
- readonly TIMESTAMP_NTZ: "TIMESTAMP_NTZ";
23
- readonly VARIANT: "VARIANT";
24
- readonly GEOMETRY: "GEOMETRY";
25
- readonly GEOGRAPHY: "GEOGRAPHY";
26
- readonly TABLE_TYPE: "TABLE_TYPE";
1
+ import { z } from "zod";
2
+
3
+ //#region src/v1/model.d.ts
4
+ declare const ColumnTypeName: {
5
+ readonly BOOLEAN: "BOOLEAN";
6
+ readonly BYTE: "BYTE";
7
+ readonly SHORT: "SHORT";
8
+ readonly INT: "INT";
9
+ readonly LONG: "LONG";
10
+ readonly FLOAT: "FLOAT";
11
+ readonly DOUBLE: "DOUBLE";
12
+ readonly DATE: "DATE";
13
+ readonly TIMESTAMP: "TIMESTAMP";
14
+ readonly STRING: "STRING";
15
+ readonly BINARY: "BINARY";
16
+ readonly DECIMAL: "DECIMAL";
17
+ readonly INTERVAL: "INTERVAL";
18
+ readonly ARRAY: "ARRAY";
19
+ readonly STRUCT: "STRUCT";
20
+ readonly MAP: "MAP";
21
+ readonly CHAR: "CHAR";
22
+ readonly NULL: "NULL";
23
+ readonly USER_DEFINED_TYPE: "USER_DEFINED_TYPE";
24
+ readonly TIMESTAMP_NTZ: "TIMESTAMP_NTZ";
25
+ readonly VARIANT: "VARIANT";
26
+ readonly GEOMETRY: "GEOMETRY";
27
+ readonly GEOGRAPHY: "GEOGRAPHY";
28
+ readonly TABLE_TYPE: "TABLE_TYPE";
27
29
  };
28
- export type ColumnTypeName = (typeof ColumnTypeName)[keyof typeof ColumnTypeName] | (string & {});
29
- export declare const FunctionParameterMode: {
30
- readonly IN: "IN";
30
+ type ColumnTypeName = (typeof ColumnTypeName)[keyof typeof ColumnTypeName] | (string & {});
31
+ declare const FunctionParameterMode: {
32
+ readonly IN: "IN";
31
33
  };
32
- export type FunctionParameterMode = (typeof FunctionParameterMode)[keyof typeof FunctionParameterMode] | (string & {});
33
- export declare const FunctionParameterType: {
34
- readonly PARAM: "PARAM";
35
- readonly COLUMN: "COLUMN";
34
+ type FunctionParameterMode = (typeof FunctionParameterMode)[keyof typeof FunctionParameterMode] | (string & {});
35
+ declare const FunctionParameterType: {
36
+ readonly PARAM: "PARAM";
37
+ readonly COLUMN: "COLUMN";
36
38
  };
37
- export type FunctionParameterType = (typeof FunctionParameterType)[keyof typeof FunctionParameterType] | (string & {});
38
- export declare const FunctionInfo_ParameterStyle: {
39
- readonly S: "S";
39
+ type FunctionParameterType = (typeof FunctionParameterType)[keyof typeof FunctionParameterType] | (string & {});
40
+ declare const FunctionInfo_ParameterStyle: {
41
+ readonly S: "S";
40
42
  };
41
- export type FunctionInfo_ParameterStyle = (typeof FunctionInfo_ParameterStyle)[keyof typeof FunctionInfo_ParameterStyle] | (string & {});
42
- export declare const FunctionInfo_RoutineBody: {
43
- readonly SQL: "SQL";
44
- /**
45
- * When `EXTERNAL` is used,
46
- * * The language of the routine function should be specified in the `external_language` field.
47
- * * The returnParams of the function cannot be used as TABLE return type is not supported.
48
- * * The getSqlDataAccess must be NO_SQL.
49
- */
50
- readonly EXTERNAL: "EXTERNAL";
43
+ type FunctionInfo_ParameterStyle = (typeof FunctionInfo_ParameterStyle)[keyof typeof FunctionInfo_ParameterStyle] | (string & {});
44
+ declare const FunctionInfo_RoutineBody: {
45
+ readonly SQL: "SQL";
46
+ /**
47
+ * When `EXTERNAL` is used,
48
+ * * The language of the routine function should be specified in the `external_language` field.
49
+ * * The returnParams of the function cannot be used as TABLE return type is not supported.
50
+ * * The getSqlDataAccess must be NO_SQL.
51
+ */
52
+ readonly EXTERNAL: "EXTERNAL";
51
53
  };
52
- export type FunctionInfo_RoutineBody = (typeof FunctionInfo_RoutineBody)[keyof typeof FunctionInfo_RoutineBody] | (string & {});
53
- export declare const FunctionInfo_SecurityType: {
54
- readonly DEFINER: "DEFINER";
54
+ type FunctionInfo_RoutineBody = (typeof FunctionInfo_RoutineBody)[keyof typeof FunctionInfo_RoutineBody] | (string & {});
55
+ declare const FunctionInfo_SecurityType: {
56
+ readonly DEFINER: "DEFINER";
55
57
  };
56
- export type FunctionInfo_SecurityType = (typeof FunctionInfo_SecurityType)[keyof typeof FunctionInfo_SecurityType] | (string & {});
57
- export declare const FunctionInfo_SqlDataAccess: {
58
- readonly CONTAINS_SQL: "CONTAINS_SQL";
59
- readonly READS_SQL_DATA: "READS_SQL_DATA";
60
- readonly NO_SQL: "NO_SQL";
58
+ type FunctionInfo_SecurityType = (typeof FunctionInfo_SecurityType)[keyof typeof FunctionInfo_SecurityType] | (string & {});
59
+ declare const FunctionInfo_SqlDataAccess: {
60
+ readonly CONTAINS_SQL: "CONTAINS_SQL";
61
+ readonly READS_SQL_DATA: "READS_SQL_DATA";
62
+ readonly NO_SQL: "NO_SQL";
61
63
  };
62
- export type FunctionInfo_SqlDataAccess = (typeof FunctionInfo_SqlDataAccess)[keyof typeof FunctionInfo_SqlDataAccess] | (string & {});
64
+ type FunctionInfo_SqlDataAccess = (typeof FunctionInfo_SqlDataAccess)[keyof typeof FunctionInfo_SqlDataAccess] | (string & {});
63
65
  /** A connection that is dependent on a SQL object. */
64
- export interface ConnectionDependency {
65
- /** Full name of the dependent connection, in the form of __connection_name__. */
66
- connectionName?: string | undefined;
66
+ interface ConnectionDependency {
67
+ /** Full name of the dependent connection, in the form of __connection_name__. */
68
+ connectionName?: string | undefined;
67
69
  }
68
- export interface CreateFunction {
69
- /** Name of function, relative to parent schema. */
70
- name?: string | undefined;
71
- /** Name of parent Catalog. */
72
- catalogName?: string | undefined;
73
- /** Name of parent Schema relative to its parent Catalog. */
74
- schemaName?: string | undefined;
75
- /** Function input parameters. */
76
- inputParams?: FunctionParameterInfos | undefined;
77
- /** Scalar function return data type. */
78
- dataType?: ColumnTypeName | undefined;
79
- /** Pretty printed function data type. */
80
- fullDataType?: string | undefined;
81
- /** Function language. When **EXTERNAL** is used, the language of the routine function should be specified in the **external_language** field, and the **return_params** of the function cannot be used (as **TABLE** return type is not supported), and the **sql_data_access** field must be **NO_SQL**. */
82
- routineBody?: FunctionInfo_RoutineBody | undefined;
83
- /** Function body. */
84
- routineDefinition?: string | undefined;
85
- /** Function parameter style. **S** is the value for SQL. */
86
- parameterStyle?: FunctionInfo_ParameterStyle | undefined;
87
- /** Whether the function is deterministic. */
88
- isDeterministic?: boolean | undefined;
89
- /** Function SQL data access. */
90
- sqlDataAccess?: FunctionInfo_SqlDataAccess | undefined;
91
- /** Function null call. */
92
- isNullCall?: boolean | undefined;
93
- /** Function security type. */
94
- securityType?: FunctionInfo_SecurityType | undefined;
95
- /** Specific name of the function; Reserved for future use. */
96
- specificName?: string | undefined;
97
- /** Table function return parameters. */
98
- returnParams?: FunctionParameterInfos | undefined;
99
- /** External function name. */
100
- externalName?: string | undefined;
101
- /** External function language. */
102
- externalLanguage?: string | undefined;
103
- /** List of schemes whose objects can be referenced without qualification. */
104
- sqlPath?: string | undefined;
105
- /** Username of current owner of the function. */
106
- owner?: string | undefined;
107
- /** User-provided free-form text description. */
108
- comment?: string | undefined;
109
- /** JSON-serialized key-value pair map, encoded (escaped) as a string. */
110
- properties?: string | undefined;
111
- /** function dependencies. */
112
- routineDependencies?: DependencyList | undefined;
113
- /** Unique identifier of parent metastore. */
114
- metastoreId?: string | undefined;
115
- /** Full name of Function, in form of **catalog_name**.**schema_name**.**function_name** */
116
- fullName?: string | undefined;
117
- /** Time at which this function was created, in epoch milliseconds. */
118
- createdAt?: bigint | undefined;
119
- /** Username of function creator. */
120
- createdBy?: string | undefined;
121
- /** Time at which this function was last modified, in epoch milliseconds. */
122
- updatedAt?: bigint | undefined;
123
- /** Username of user who last modified the function. */
124
- updatedBy?: string | undefined;
125
- /** Id of Function, relative to parent schema. */
126
- functionId?: string | undefined;
127
- /** Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request. */
128
- browseOnly?: boolean | undefined;
70
+ interface CreateFunction {
71
+ /** Name of function, relative to parent schema. */
72
+ name?: string | undefined;
73
+ /** Name of parent Catalog. */
74
+ catalogName?: string | undefined;
75
+ /** Name of parent Schema relative to its parent Catalog. */
76
+ schemaName?: string | undefined;
77
+ /** Function input parameters. */
78
+ inputParams?: FunctionParameterInfos | undefined;
79
+ /** Scalar function return data type. */
80
+ dataType?: ColumnTypeName | undefined;
81
+ /** Pretty printed function data type. */
82
+ fullDataType?: string | undefined;
83
+ /** Function language. When **EXTERNAL** is used, the language of the routine function should be specified in the **external_language** field, and the **return_params** of the function cannot be used (as **TABLE** return type is not supported), and the **sql_data_access** field must be **NO_SQL**. */
84
+ routineBody?: FunctionInfo_RoutineBody | undefined;
85
+ /** Function body. */
86
+ routineDefinition?: string | undefined;
87
+ /** Function parameter style. **S** is the value for SQL. */
88
+ parameterStyle?: FunctionInfo_ParameterStyle | undefined;
89
+ /** Whether the function is deterministic. */
90
+ isDeterministic?: boolean | undefined;
91
+ /** Function SQL data access. */
92
+ sqlDataAccess?: FunctionInfo_SqlDataAccess | undefined;
93
+ /** Function null call. */
94
+ isNullCall?: boolean | undefined;
95
+ /** Function security type. */
96
+ securityType?: FunctionInfo_SecurityType | undefined;
97
+ /** Specific name of the function; Reserved for future use. */
98
+ specificName?: string | undefined;
99
+ /** Table function return parameters. */
100
+ returnParams?: FunctionParameterInfos | undefined;
101
+ /** External function name. */
102
+ externalName?: string | undefined;
103
+ /** External function language. */
104
+ externalLanguage?: string | undefined;
105
+ /** List of schemes whose objects can be referenced without qualification. */
106
+ sqlPath?: string | undefined;
107
+ /** Username of current owner of the function. */
108
+ owner?: string | undefined;
109
+ /** User-provided free-form text description. */
110
+ comment?: string | undefined;
111
+ /** JSON-serialized key-value pair map, encoded (escaped) as a string. */
112
+ properties?: string | undefined;
113
+ /** function dependencies. */
114
+ routineDependencies?: DependencyList | undefined;
115
+ /** Unique identifier of parent metastore. */
116
+ metastoreId?: string | undefined;
117
+ /** Full name of Function, in form of **catalog_name**.**schema_name**.**function_name** */
118
+ fullName?: string | undefined;
119
+ /** Time at which this function was created, in epoch milliseconds. */
120
+ createdAt?: bigint | undefined;
121
+ /** Username of function creator. */
122
+ createdBy?: string | undefined;
123
+ /** Time at which this function was last modified, in epoch milliseconds. */
124
+ updatedAt?: bigint | undefined;
125
+ /** Username of user who last modified the function. */
126
+ updatedBy?: string | undefined;
127
+ /** Id of Function, relative to parent schema. */
128
+ functionId?: string | undefined;
129
+ /** Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request. */
130
+ browseOnly?: boolean | undefined;
129
131
  }
130
- export interface CreateFunctionRequest {
131
- /** Partial __FunctionInfo__ specifying the function to be created. */
132
- functionInfo?: CreateFunction | undefined;
132
+ interface CreateFunctionRequest {
133
+ /** Partial __FunctionInfo__ specifying the function to be created. */
134
+ functionInfo?: CreateFunction | undefined;
133
135
  }
134
136
  /** A credential that is dependent on a SQL object. */
135
- export interface CredentialDependency {
136
- /** Full name of the dependent credential, in the form of __credential_name__. */
137
- credentialName?: string | undefined;
137
+ interface CredentialDependency {
138
+ /** Full name of the dependent credential, in the form of __credential_name__. */
139
+ credentialName?: string | undefined;
138
140
  }
139
- export interface DeleteFunctionRequest {
140
- /** The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) . */
141
- fullNameArg?: string | undefined;
142
- /** Force deletion even if the function is notempty. */
143
- force?: boolean | undefined;
144
- }
145
- export interface DeleteFunctionResponse {
141
+ interface DeleteFunctionRequest {
142
+ /** The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) . */
143
+ fullNameArg?: string | undefined;
144
+ /** Force deletion even if the function is notempty. */
145
+ force?: boolean | undefined;
146
146
  }
147
+ interface DeleteFunctionResponse {}
147
148
  /**
148
149
  * A dependency of a SQL object. One of the following fields must be defined:
149
150
  * __table__, __function__, __connection__, __credential__, __volume__, or __secret__.
150
151
  */
151
- export interface Dependency {
152
- value?: {
153
- $case: 'table';
154
- table: TableDependency;
155
- } | {
156
- $case: 'function';
157
- function: FunctionDependency;
158
- } | {
159
- $case: 'connection';
160
- connection: ConnectionDependency;
161
- } | {
162
- $case: 'credential';
163
- credential: CredentialDependency;
164
- } | undefined;
152
+ interface Dependency {
153
+ value?: {
154
+ $case: 'table';
155
+ table: TableDependency;
156
+ } | {
157
+ $case: 'function';
158
+ function: FunctionDependency;
159
+ } | {
160
+ $case: 'connection';
161
+ connection: ConnectionDependency;
162
+ } | {
163
+ $case: 'credential';
164
+ credential: CredentialDependency;
165
+ } | undefined;
165
166
  }
166
167
  /** A list of dependencies. */
167
- export interface DependencyList {
168
- /** Array of dependencies. */
169
- dependencies?: Dependency[] | undefined;
168
+ interface DependencyList {
169
+ /** Array of dependencies. */
170
+ dependencies?: Dependency[] | undefined;
170
171
  }
171
172
  /** A function that is dependent on a SQL object. */
172
- export interface FunctionDependency {
173
- /** Full name of the dependent function, in the form of __catalog_name__.__schema_name__.__function_name__. */
174
- functionFullName?: string | undefined;
173
+ interface FunctionDependency {
174
+ /** Full name of the dependent function, in the form of __catalog_name__.__schema_name__.__function_name__. */
175
+ functionFullName?: string | undefined;
175
176
  }
176
- export interface FunctionInfo {
177
- /** Name of function, relative to parent schema. */
178
- name?: string | undefined;
179
- /** Name of parent Catalog. */
180
- catalogName?: string | undefined;
181
- /** Name of parent Schema relative to its parent Catalog. */
182
- schemaName?: string | undefined;
183
- /** Function input parameters. */
184
- inputParams?: FunctionParameterInfos | undefined;
185
- /** Scalar function return data type. */
186
- dataType?: ColumnTypeName | undefined;
187
- /** Pretty printed function data type. */
188
- fullDataType?: string | undefined;
189
- /** Function language. When **EXTERNAL** is used, the language of the routine function should be specified in the **external_language** field, and the **return_params** of the function cannot be used (as **TABLE** return type is not supported), and the **sql_data_access** field must be **NO_SQL**. */
190
- routineBody?: FunctionInfo_RoutineBody | undefined;
191
- /** Function body. */
192
- routineDefinition?: string | undefined;
193
- /** Function parameter style. **S** is the value for SQL. */
194
- parameterStyle?: FunctionInfo_ParameterStyle | undefined;
195
- /** Whether the function is deterministic. */
196
- isDeterministic?: boolean | undefined;
197
- /** Function SQL data access. */
198
- sqlDataAccess?: FunctionInfo_SqlDataAccess | undefined;
199
- /** Function null call. */
200
- isNullCall?: boolean | undefined;
201
- /** Function security type. */
202
- securityType?: FunctionInfo_SecurityType | undefined;
203
- /** Specific name of the function; Reserved for future use. */
204
- specificName?: string | undefined;
205
- /** Table function return parameters. */
206
- returnParams?: FunctionParameterInfos | undefined;
207
- /** External function name. */
208
- externalName?: string | undefined;
209
- /** External function language. */
210
- externalLanguage?: string | undefined;
211
- /** List of schemes whose objects can be referenced without qualification. */
212
- sqlPath?: string | undefined;
213
- /** Username of current owner of the function. */
214
- owner?: string | undefined;
215
- /** User-provided free-form text description. */
216
- comment?: string | undefined;
217
- /** JSON-serialized key-value pair map, encoded (escaped) as a string. */
218
- properties?: string | undefined;
219
- /** function dependencies. */
220
- routineDependencies?: DependencyList | undefined;
221
- /** Unique identifier of parent metastore. */
222
- metastoreId?: string | undefined;
223
- /** Full name of Function, in form of **catalog_name**.**schema_name**.**function_name** */
224
- fullName?: string | undefined;
225
- /** Time at which this function was created, in epoch milliseconds. */
226
- createdAt?: bigint | undefined;
227
- /** Username of function creator. */
228
- createdBy?: string | undefined;
229
- /** Time at which this function was last modified, in epoch milliseconds. */
230
- updatedAt?: bigint | undefined;
231
- /** Username of user who last modified the function. */
232
- updatedBy?: string | undefined;
233
- /** Id of Function, relative to parent schema. */
234
- functionId?: string | undefined;
235
- /** Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request. */
236
- browseOnly?: boolean | undefined;
177
+ interface FunctionInfo {
178
+ /** Name of function, relative to parent schema. */
179
+ name?: string | undefined;
180
+ /** Name of parent Catalog. */
181
+ catalogName?: string | undefined;
182
+ /** Name of parent Schema relative to its parent Catalog. */
183
+ schemaName?: string | undefined;
184
+ /** Function input parameters. */
185
+ inputParams?: FunctionParameterInfos | undefined;
186
+ /** Scalar function return data type. */
187
+ dataType?: ColumnTypeName | undefined;
188
+ /** Pretty printed function data type. */
189
+ fullDataType?: string | undefined;
190
+ /** Function language. When **EXTERNAL** is used, the language of the routine function should be specified in the **external_language** field, and the **return_params** of the function cannot be used (as **TABLE** return type is not supported), and the **sql_data_access** field must be **NO_SQL**. */
191
+ routineBody?: FunctionInfo_RoutineBody | undefined;
192
+ /** Function body. */
193
+ routineDefinition?: string | undefined;
194
+ /** Function parameter style. **S** is the value for SQL. */
195
+ parameterStyle?: FunctionInfo_ParameterStyle | undefined;
196
+ /** Whether the function is deterministic. */
197
+ isDeterministic?: boolean | undefined;
198
+ /** Function SQL data access. */
199
+ sqlDataAccess?: FunctionInfo_SqlDataAccess | undefined;
200
+ /** Function null call. */
201
+ isNullCall?: boolean | undefined;
202
+ /** Function security type. */
203
+ securityType?: FunctionInfo_SecurityType | undefined;
204
+ /** Specific name of the function; Reserved for future use. */
205
+ specificName?: string | undefined;
206
+ /** Table function return parameters. */
207
+ returnParams?: FunctionParameterInfos | undefined;
208
+ /** External function name. */
209
+ externalName?: string | undefined;
210
+ /** External function language. */
211
+ externalLanguage?: string | undefined;
212
+ /** List of schemes whose objects can be referenced without qualification. */
213
+ sqlPath?: string | undefined;
214
+ /** Username of current owner of the function. */
215
+ owner?: string | undefined;
216
+ /** User-provided free-form text description. */
217
+ comment?: string | undefined;
218
+ /** JSON-serialized key-value pair map, encoded (escaped) as a string. */
219
+ properties?: string | undefined;
220
+ /** function dependencies. */
221
+ routineDependencies?: DependencyList | undefined;
222
+ /** Unique identifier of parent metastore. */
223
+ metastoreId?: string | undefined;
224
+ /** Full name of Function, in form of **catalog_name**.**schema_name**.**function_name** */
225
+ fullName?: string | undefined;
226
+ /** Time at which this function was created, in epoch milliseconds. */
227
+ createdAt?: bigint | undefined;
228
+ /** Username of function creator. */
229
+ createdBy?: string | undefined;
230
+ /** Time at which this function was last modified, in epoch milliseconds. */
231
+ updatedAt?: bigint | undefined;
232
+ /** Username of user who last modified the function. */
233
+ updatedBy?: string | undefined;
234
+ /** Id of Function, relative to parent schema. */
235
+ functionId?: string | undefined;
236
+ /** Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request. */
237
+ browseOnly?: boolean | undefined;
237
238
  }
238
- export interface FunctionParameterInfo {
239
- /** Name of Parameter. */
240
- name?: string | undefined;
241
- /** Full data type spec, SQL/catalogString text. */
242
- typeText?: string | undefined;
243
- /** Full data type spec, JSON-serialized. */
244
- typeJson?: string | undefined;
245
- /** Name of type (INT, STRUCT, MAP, etc.) */
246
- typeName?: ColumnTypeName | undefined;
247
- /** Digits of precision; required on Create for DecimalTypes. */
248
- typePrecision?: number | undefined;
249
- /** Digits to right of decimal; Required on Create for DecimalTypes. */
250
- typeScale?: number | undefined;
251
- /** Format of IntervalType. */
252
- typeIntervalType?: string | undefined;
253
- /** Ordinal position of column (starting at position 0). */
254
- position?: number | undefined;
255
- /** Function parameter mode. */
256
- parameterMode?: FunctionParameterMode | undefined;
257
- /** Function parameter type. */
258
- parameterType?: FunctionParameterType | undefined;
259
- /** Default value of the parameter. */
260
- parameterDefault?: string | undefined;
261
- /** User-provided free-form text description. */
262
- comment?: string | undefined;
239
+ interface FunctionParameterInfo {
240
+ /** Name of Parameter. */
241
+ name?: string | undefined;
242
+ /** Full data type spec, SQL/catalogString text. */
243
+ typeText?: string | undefined;
244
+ /** Full data type spec, JSON-serialized. */
245
+ typeJson?: string | undefined;
246
+ /** Name of type (INT, STRUCT, MAP, etc.) */
247
+ typeName?: ColumnTypeName | undefined;
248
+ /** Digits of precision; required on Create for DecimalTypes. */
249
+ typePrecision?: number | undefined;
250
+ /** Digits to right of decimal; Required on Create for DecimalTypes. */
251
+ typeScale?: number | undefined;
252
+ /** Format of IntervalType. */
253
+ typeIntervalType?: string | undefined;
254
+ /** Ordinal position of column (starting at position 0). */
255
+ position?: number | undefined;
256
+ /** Function parameter mode. */
257
+ parameterMode?: FunctionParameterMode | undefined;
258
+ /** Function parameter type. */
259
+ parameterType?: FunctionParameterType | undefined;
260
+ /** Default value of the parameter. */
261
+ parameterDefault?: string | undefined;
262
+ /** User-provided free-form text description. */
263
+ comment?: string | undefined;
263
264
  }
264
- export interface FunctionParameterInfos {
265
- parameters?: FunctionParameterInfo[] | undefined;
265
+ interface FunctionParameterInfos {
266
+ parameters?: FunctionParameterInfo[] | undefined;
266
267
  }
267
- export interface GetFunctionRequest {
268
- /** The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__). */
269
- fullNameArg?: string | undefined;
270
- /** Whether to include functions in the response for which the principal can only access selective metadata for */
271
- includeBrowse?: boolean | undefined;
268
+ interface GetFunctionRequest {
269
+ /** The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__). */
270
+ fullNameArg?: string | undefined;
271
+ /** Whether to include functions in the response for which the principal can only access selective metadata for */
272
+ includeBrowse?: boolean | undefined;
272
273
  }
273
- export interface ListFunctionsRequest {
274
- /** Name of parent catalog for functions of interest. */
275
- catalogName?: string | undefined;
276
- /** Parent schema of functions. */
277
- schemaName?: string | undefined;
278
- /** Whether to include functions in the response for which the principal can only access selective metadata for */
279
- includeBrowse?: boolean | undefined;
280
- /**
281
- * Maximum number of functions to return.
282
- * If not set, all the functions are returned (not recommended).
283
- * - when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
284
- * - when set to 0, the page length is set to a server configured value (recommended);
285
- * - when set to a value less than 0, an invalid parameter error is returned;
286
- */
287
- maxResults?: number | undefined;
288
- /** Opaque pagination token to go to next page based on previous query. */
289
- pageToken?: string | undefined;
274
+ interface ListFunctionsRequest {
275
+ /** Name of parent catalog for functions of interest. */
276
+ catalogName?: string | undefined;
277
+ /** Parent schema of functions. */
278
+ schemaName?: string | undefined;
279
+ /** Whether to include functions in the response for which the principal can only access selective metadata for */
280
+ includeBrowse?: boolean | undefined;
281
+ /**
282
+ * Maximum number of functions to return.
283
+ * If not set, all the functions are returned (not recommended).
284
+ * - when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
285
+ * - when set to 0, the page length is set to a server configured value (recommended);
286
+ * - when set to a value less than 0, an invalid parameter error is returned;
287
+ */
288
+ maxResults?: number | undefined;
289
+ /** Opaque pagination token to go to next page based on previous query. */
290
+ pageToken?: string | undefined;
290
291
  }
291
- export interface ListFunctionsResponse {
292
- /** An array of function information objects. */
293
- functions?: FunctionInfo[] | undefined;
294
- /**
295
- * Opaque token to retrieve the next page of results. Absent if there are no more pages.
296
- * __page_token__ should be set to this value for the next request (for the next page of results).
297
- */
298
- nextPageToken?: string | undefined;
292
+ interface ListFunctionsResponse {
293
+ /** An array of function information objects. */
294
+ functions?: FunctionInfo[] | undefined;
295
+ /**
296
+ * Opaque token to retrieve the next page of results. Absent if there are no more pages.
297
+ * __page_token__ should be set to this value for the next request (for the next page of results).
298
+ */
299
+ nextPageToken?: string | undefined;
299
300
  }
300
301
  /** A table that is dependent on a SQL object. */
301
- export interface TableDependency {
302
- /** Full name of the dependent table, in the form of __catalog_name__.__schema_name__.__table_name__. */
303
- tableFullName?: string | undefined;
302
+ interface TableDependency {
303
+ /** Full name of the dependent table, in the form of __catalog_name__.__schema_name__.__table_name__. */
304
+ tableFullName?: string | undefined;
304
305
  }
305
- export interface UpdateFunctionRequest {
306
- /** The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__). */
307
- fullNameArg?: string | undefined;
308
- /** Name of function, relative to parent schema. */
309
- name?: string | undefined;
310
- /** Name of parent Catalog. */
311
- catalogName?: string | undefined;
312
- /** Name of parent Schema relative to its parent Catalog. */
313
- schemaName?: string | undefined;
314
- /** Function input parameters. */
315
- inputParams?: FunctionParameterInfos | undefined;
316
- /** Scalar function return data type. */
317
- dataType?: ColumnTypeName | undefined;
318
- /** Pretty printed function data type. */
319
- fullDataType?: string | undefined;
320
- /** Function language. When **EXTERNAL** is used, the language of the routine function should be specified in the **external_language** field, and the **return_params** of the function cannot be used (as **TABLE** return type is not supported), and the **sql_data_access** field must be **NO_SQL**. */
321
- routineBody?: FunctionInfo_RoutineBody | undefined;
322
- /** Function body. */
323
- routineDefinition?: string | undefined;
324
- /** Function parameter style. **S** is the value for SQL. */
325
- parameterStyle?: FunctionInfo_ParameterStyle | undefined;
326
- /** Whether the function is deterministic. */
327
- isDeterministic?: boolean | undefined;
328
- /** Function SQL data access. */
329
- sqlDataAccess?: FunctionInfo_SqlDataAccess | undefined;
330
- /** Function null call. */
331
- isNullCall?: boolean | undefined;
332
- /** Function security type. */
333
- securityType?: FunctionInfo_SecurityType | undefined;
334
- /** Specific name of the function; Reserved for future use. */
335
- specificName?: string | undefined;
336
- /** Table function return parameters. */
337
- returnParams?: FunctionParameterInfos | undefined;
338
- /** External function name. */
339
- externalName?: string | undefined;
340
- /** External function language. */
341
- externalLanguage?: string | undefined;
342
- /** List of schemes whose objects can be referenced without qualification. */
343
- sqlPath?: string | undefined;
344
- /** Username of current owner of the function. */
345
- owner?: string | undefined;
346
- /** User-provided free-form text description. */
347
- comment?: string | undefined;
348
- /** JSON-serialized key-value pair map, encoded (escaped) as a string. */
349
- properties?: string | undefined;
350
- /** function dependencies. */
351
- routineDependencies?: DependencyList | undefined;
352
- /** Unique identifier of parent metastore. */
353
- metastoreId?: string | undefined;
354
- /** Full name of Function, in form of **catalog_name**.**schema_name**.**function_name** */
355
- fullName?: string | undefined;
356
- /** Time at which this function was created, in epoch milliseconds. */
357
- createdAt?: bigint | undefined;
358
- /** Username of function creator. */
359
- createdBy?: string | undefined;
360
- /** Time at which this function was last modified, in epoch milliseconds. */
361
- updatedAt?: bigint | undefined;
362
- /** Username of user who last modified the function. */
363
- updatedBy?: string | undefined;
364
- /** Id of Function, relative to parent schema. */
365
- functionId?: string | undefined;
366
- /** Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request. */
367
- browseOnly?: boolean | undefined;
306
+ interface UpdateFunctionRequest {
307
+ /** The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__). */
308
+ fullNameArg?: string | undefined;
309
+ /** Name of function, relative to parent schema. */
310
+ name?: string | undefined;
311
+ /** Name of parent Catalog. */
312
+ catalogName?: string | undefined;
313
+ /** Name of parent Schema relative to its parent Catalog. */
314
+ schemaName?: string | undefined;
315
+ /** Function input parameters. */
316
+ inputParams?: FunctionParameterInfos | undefined;
317
+ /** Scalar function return data type. */
318
+ dataType?: ColumnTypeName | undefined;
319
+ /** Pretty printed function data type. */
320
+ fullDataType?: string | undefined;
321
+ /** Function language. When **EXTERNAL** is used, the language of the routine function should be specified in the **external_language** field, and the **return_params** of the function cannot be used (as **TABLE** return type is not supported), and the **sql_data_access** field must be **NO_SQL**. */
322
+ routineBody?: FunctionInfo_RoutineBody | undefined;
323
+ /** Function body. */
324
+ routineDefinition?: string | undefined;
325
+ /** Function parameter style. **S** is the value for SQL. */
326
+ parameterStyle?: FunctionInfo_ParameterStyle | undefined;
327
+ /** Whether the function is deterministic. */
328
+ isDeterministic?: boolean | undefined;
329
+ /** Function SQL data access. */
330
+ sqlDataAccess?: FunctionInfo_SqlDataAccess | undefined;
331
+ /** Function null call. */
332
+ isNullCall?: boolean | undefined;
333
+ /** Function security type. */
334
+ securityType?: FunctionInfo_SecurityType | undefined;
335
+ /** Specific name of the function; Reserved for future use. */
336
+ specificName?: string | undefined;
337
+ /** Table function return parameters. */
338
+ returnParams?: FunctionParameterInfos | undefined;
339
+ /** External function name. */
340
+ externalName?: string | undefined;
341
+ /** External function language. */
342
+ externalLanguage?: string | undefined;
343
+ /** List of schemes whose objects can be referenced without qualification. */
344
+ sqlPath?: string | undefined;
345
+ /** Username of current owner of the function. */
346
+ owner?: string | undefined;
347
+ /** User-provided free-form text description. */
348
+ comment?: string | undefined;
349
+ /** JSON-serialized key-value pair map, encoded (escaped) as a string. */
350
+ properties?: string | undefined;
351
+ /** function dependencies. */
352
+ routineDependencies?: DependencyList | undefined;
353
+ /** Unique identifier of parent metastore. */
354
+ metastoreId?: string | undefined;
355
+ /** Full name of Function, in form of **catalog_name**.**schema_name**.**function_name** */
356
+ fullName?: string | undefined;
357
+ /** Time at which this function was created, in epoch milliseconds. */
358
+ createdAt?: bigint | undefined;
359
+ /** Username of function creator. */
360
+ createdBy?: string | undefined;
361
+ /** Time at which this function was last modified, in epoch milliseconds. */
362
+ updatedAt?: bigint | undefined;
363
+ /** Username of user who last modified the function. */
364
+ updatedBy?: string | undefined;
365
+ /** Id of Function, relative to parent schema. */
366
+ functionId?: string | undefined;
367
+ /** Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request. */
368
+ browseOnly?: boolean | undefined;
368
369
  }
369
- export declare const unmarshalConnectionDependencySchema: z.ZodType<ConnectionDependency>;
370
- export declare const unmarshalCredentialDependencySchema: z.ZodType<CredentialDependency>;
371
- export declare const unmarshalDeleteFunctionResponseSchema: z.ZodType<DeleteFunctionResponse>;
372
- export declare const unmarshalDependencySchema: z.ZodType<Dependency>;
373
- export declare const unmarshalDependencyListSchema: z.ZodType<DependencyList>;
374
- export declare const unmarshalFunctionDependencySchema: z.ZodType<FunctionDependency>;
375
- export declare const unmarshalFunctionInfoSchema: z.ZodType<FunctionInfo>;
376
- export declare const unmarshalFunctionParameterInfoSchema: z.ZodType<FunctionParameterInfo>;
377
- export declare const unmarshalFunctionParameterInfosSchema: z.ZodType<FunctionParameterInfos>;
378
- export declare const unmarshalListFunctionsResponseSchema: z.ZodType<ListFunctionsResponse>;
379
- export declare const unmarshalTableDependencySchema: z.ZodType<TableDependency>;
380
- export declare const marshalConnectionDependencySchema: z.ZodType;
381
- export declare const marshalCreateFunctionSchema: z.ZodType;
382
- export declare const marshalCreateFunctionRequestSchema: z.ZodType;
383
- export declare const marshalCredentialDependencySchema: z.ZodType;
384
- export declare const marshalDependencySchema: z.ZodType;
385
- export declare const marshalDependencyListSchema: z.ZodType;
386
- export declare const marshalFunctionDependencySchema: z.ZodType;
387
- export declare const marshalFunctionParameterInfoSchema: z.ZodType;
388
- export declare const marshalFunctionParameterInfosSchema: z.ZodType;
389
- export declare const marshalTableDependencySchema: z.ZodType;
390
- export declare const marshalUpdateFunctionRequestSchema: z.ZodType;
370
+ declare const unmarshalConnectionDependencySchema: z.ZodType<ConnectionDependency>;
371
+ declare const unmarshalCredentialDependencySchema: z.ZodType<CredentialDependency>;
372
+ declare const unmarshalDeleteFunctionResponseSchema: z.ZodType<DeleteFunctionResponse>;
373
+ declare const unmarshalDependencySchema: z.ZodType<Dependency>;
374
+ declare const unmarshalDependencyListSchema: z.ZodType<DependencyList>;
375
+ declare const unmarshalFunctionDependencySchema: z.ZodType<FunctionDependency>;
376
+ declare const unmarshalFunctionInfoSchema: z.ZodType<FunctionInfo>;
377
+ declare const unmarshalFunctionParameterInfoSchema: z.ZodType<FunctionParameterInfo>;
378
+ declare const unmarshalFunctionParameterInfosSchema: z.ZodType<FunctionParameterInfos>;
379
+ declare const unmarshalListFunctionsResponseSchema: z.ZodType<ListFunctionsResponse>;
380
+ declare const unmarshalTableDependencySchema: z.ZodType<TableDependency>;
381
+ declare const marshalConnectionDependencySchema: z.ZodType;
382
+ declare const marshalCreateFunctionSchema: z.ZodType;
383
+ declare const marshalCreateFunctionRequestSchema: z.ZodType;
384
+ declare const marshalCredentialDependencySchema: z.ZodType;
385
+ declare const marshalDependencySchema: z.ZodType;
386
+ declare const marshalDependencyListSchema: z.ZodType;
387
+ declare const marshalFunctionDependencySchema: z.ZodType;
388
+ declare const marshalFunctionParameterInfoSchema: z.ZodType;
389
+ declare const marshalFunctionParameterInfosSchema: z.ZodType;
390
+ declare const marshalTableDependencySchema: z.ZodType;
391
+ declare const marshalUpdateFunctionRequestSchema: z.ZodType;
392
+ //#endregion
393
+ export { ColumnTypeName, ConnectionDependency, CreateFunction, CreateFunctionRequest, CredentialDependency, DeleteFunctionRequest, DeleteFunctionResponse, Dependency, DependencyList, FunctionDependency, FunctionInfo, FunctionInfo_ParameterStyle, FunctionInfo_RoutineBody, FunctionInfo_SecurityType, FunctionInfo_SqlDataAccess, FunctionParameterInfo, FunctionParameterInfos, FunctionParameterMode, FunctionParameterType, GetFunctionRequest, ListFunctionsRequest, ListFunctionsResponse, TableDependency, UpdateFunctionRequest, marshalConnectionDependencySchema, marshalCreateFunctionRequestSchema, marshalCreateFunctionSchema, marshalCredentialDependencySchema, marshalDependencyListSchema, marshalDependencySchema, marshalFunctionDependencySchema, marshalFunctionParameterInfoSchema, marshalFunctionParameterInfosSchema, marshalTableDependencySchema, marshalUpdateFunctionRequestSchema, unmarshalConnectionDependencySchema, unmarshalCredentialDependencySchema, unmarshalDeleteFunctionResponseSchema, unmarshalDependencyListSchema, unmarshalDependencySchema, unmarshalFunctionDependencySchema, unmarshalFunctionInfoSchema, unmarshalFunctionParameterInfoSchema, unmarshalFunctionParameterInfosSchema, unmarshalListFunctionsResponseSchema, unmarshalTableDependencySchema };
391
394
  //# sourceMappingURL=model.d.ts.map