@databricks/sdk-uc-functions 0.0.0-dev → 0.1.0-dev.1

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.
@@ -0,0 +1,113 @@
1
+ // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
2
+ import { execute } from '@databricks/sdk-core/api';
3
+ import { ApiError } from '@databricks/sdk-core/apierror';
4
+ import JSONBig from 'json-bigint';
5
+ // JSON codec that preserves int64 precision. On the way in, large integer
6
+ // literals come back as bigint instead of being rounded to JS Number. On the
7
+ // way out, bigint values are emitted as raw JSON number digits.
8
+ const jsonBigint = JSONBig({ useNativeBigInt: true });
9
+ /**
10
+ * Translates public CallOptions to the internal Options shape accepted by
11
+ * execute(). Even though the shapes match today, this isolates the public
12
+ * API from the executor's internal type so they can diverge.
13
+ */
14
+ export async function executeCall(call, options) {
15
+ const opts = {
16
+ ...(options?.retrier !== undefined && { retrier: options.retrier }),
17
+ ...(options?.rateLimiter !== undefined && {
18
+ rateLimiter: options.rateLimiter,
19
+ }),
20
+ ...(options?.timeout !== undefined && { timeout: options.timeout }),
21
+ };
22
+ return execute(options?.signal, call, opts);
23
+ }
24
+ async function readAll(body) {
25
+ if (body === null) {
26
+ return new Uint8Array(0);
27
+ }
28
+ const reader = body.getReader();
29
+ const chunks = [];
30
+ for (;;) {
31
+ const { done, value } = await reader.read();
32
+ if (done) {
33
+ break;
34
+ }
35
+ chunks.push(value);
36
+ }
37
+ const totalLength = chunks.reduce((acc, chunk) => acc + chunk.length, 0);
38
+ const result = new Uint8Array(totalLength);
39
+ let offset = 0;
40
+ for (const chunk of chunks) {
41
+ result.set(chunk, offset);
42
+ offset += chunk.length;
43
+ }
44
+ return result;
45
+ }
46
+ export async function executeHttpCall(opts) {
47
+ opts.logger.debug('HTTP request', {
48
+ method: opts.request.method,
49
+ url: opts.request.url,
50
+ });
51
+ let resp;
52
+ try {
53
+ resp = await opts.httpClient.send(opts.request);
54
+ }
55
+ catch (e) {
56
+ opts.logger.debug('HTTP request failed');
57
+ throw e;
58
+ }
59
+ const body = await readAll(resp.body);
60
+ opts.logger.debug('HTTP response', {
61
+ statusCode: resp.statusCode,
62
+ body: new TextDecoder().decode(body),
63
+ });
64
+ const apiErr = ApiError.fromHttpError(resp.statusCode, resp.headers, body);
65
+ if (apiErr !== undefined) {
66
+ throw apiErr;
67
+ }
68
+ return body;
69
+ }
70
+ export function buildHttpRequest(method, url, headers, signal, body) {
71
+ const req = { url, method, headers };
72
+ if (body !== undefined) {
73
+ req.body = body;
74
+ }
75
+ if (signal !== undefined) {
76
+ req.signal = signal;
77
+ }
78
+ return req;
79
+ }
80
+ export function parseResponse(body, schema) {
81
+ const text = new TextDecoder().decode(body);
82
+ const parsed = jsonBigint.parse(text);
83
+ return schema.parse(parsed);
84
+ }
85
+ export function marshalRequest(data, schema) {
86
+ return jsonBigint.stringify(schema.parse(data));
87
+ }
88
+ export function flattenQueryParams(prefix, value, params) {
89
+ if (value === null || value === undefined) {
90
+ return;
91
+ }
92
+ if (Array.isArray(value)) {
93
+ // arrays of objects are not yet supported
94
+ for (const item of value) {
95
+ params.append(prefix, String(item));
96
+ }
97
+ }
98
+ else if (typeof value === 'object') {
99
+ for (const [key, val] of Object.entries(value)) {
100
+ flattenQueryParams(`${prefix}.${key}`, val, params);
101
+ }
102
+ }
103
+ else if (typeof value === 'string' ||
104
+ typeof value === 'number' ||
105
+ typeof value === 'boolean' ||
106
+ typeof value === 'bigint') {
107
+ params.append(prefix, String(value));
108
+ }
109
+ else {
110
+ throw new Error(`Unsupported query parameter type: ${typeof value}`);
111
+ }
112
+ }
113
+ //# sourceMappingURL=utils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/v1/utils.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAG/E,OAAO,EAAC,OAAO,EAAC,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAC,QAAQ,EAAC,MAAM,+BAA+B,CAAC;AAQvD,OAAO,OAAO,MAAM,aAAa,CAAC;AAGlC,0EAA0E;AAC1E,6EAA6E;AAC7E,gEAAgE;AAChE,MAAM,UAAU,GAAG,OAAO,CAAC,EAAC,eAAe,EAAE,IAAI,EAAC,CAAC,CAAC;AAQpD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,IAAU,EACV,OAAqB;IAErB,MAAM,IAAI,GAAY;QACpB,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,SAAS,IAAI,EAAC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAC,CAAC;QACjE,GAAG,CAAC,OAAO,EAAE,WAAW,KAAK,SAAS,IAAI;YACxC,WAAW,EAAE,OAAO,CAAC,WAAW;SACjC,CAAC;QACF,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,SAAS,IAAI,EAAC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAC,CAAC;KAClE,CAAC;IACF,OAAO,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9C,CAAC;AAED,KAAK,UAAU,OAAO,CACpB,IAAuC;IAEvC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IAChC,MAAM,MAAM,GAAiB,EAAE,CAAC;IAChC,SAAS,CAAC;QACR,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QAC1C,IAAI,IAAI,EAAE,CAAC;YACT,MAAM;QACR,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IACD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACzE,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC;IAC3C,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;IACzB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,IAAqB;IAErB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE;QAChC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;QAC3B,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;KACtB,CAAC,CAAC;IAEH,IAAI,IAAkB,CAAC;IACvB,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,MAAM,CAAC,CAAC;IACV,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEtC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE;QACjC,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,IAAI,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;KACrC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC3E,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,MAAM,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,MAAc,EACd,GAAW,EACX,OAAgB,EAChB,MAAoB,EACpB,IAA0C;IAE1C,MAAM,GAAG,GAAgB,EAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAC,CAAC;IAChD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;IAClB,CAAC;IACD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,aAAa,CAAI,IAAgB,EAAE,MAAoB;IACrE,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAY,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/C,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAa,EAAE,MAAiB;IAC7D,OAAO,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,MAAc,EACd,KAAc,EACd,MAAuB;IAEvB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO;IACT,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,0CAA0C;QAC1C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,EAAE,CAAC;YAC1E,kBAAkB,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;SAAM,IACL,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,SAAS;QAC1B,OAAO,KAAK,KAAK,QAAQ,EACzB,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,qCAAqC,OAAO,KAAK,EAAE,CAAC,CAAC;IACvE,CAAC;AACH,CAAC"}
package/package.json CHANGED
@@ -1,7 +1,41 @@
1
1
  {
2
2
  "name": "@databricks/sdk-uc-functions",
3
- "version": "0.0.0-dev",
4
- "description": "Bootstrap placeholder; real contents in a later release.",
5
- "main": "index.js",
6
- "license": "Apache-2.0"
3
+ "version": "0.1.0-dev.1",
4
+ "description": "",
5
+ "type": "module",
6
+ "exports": {
7
+ "./v1": {
8
+ "types": "./dist/v1/index.d.ts",
9
+ "import": "./dist/v1/index.js"
10
+ }
11
+ },
12
+ "files": [
13
+ "dist",
14
+ "src",
15
+ "LICENSE"
16
+ ],
17
+ "scripts": {
18
+ "build": "tsc -b",
19
+ "lint": "eslint src --ext .ts",
20
+ "lint:fix": "eslint src --ext .ts --fix",
21
+ "format": "prettier --write \"src/**/*.ts\"",
22
+ "format:check": "prettier --check \"src/**/*.ts\"",
23
+ "typecheck": "tsc --noEmit",
24
+ "clean": "rm -rf dist tsconfig.tsbuildinfo",
25
+ "test": "echo 'no tests'",
26
+ "test:browser": "echo 'no tests'"
27
+ },
28
+ "author": "Databricks",
29
+ "license": "Apache-2.0",
30
+ "dependencies": {
31
+ "@databricks/sdk-auth": ">=0.1.0-dev.2 <1.0.0",
32
+ "@databricks/sdk-core": ">=0.1.0-dev.3 <1.0.0",
33
+ "@databricks/sdk-options": ">=0.1.0-dev.2 <1.0.0",
34
+ "@js-temporal/polyfill": "^0.5.0",
35
+ "json-bigint": "^1.0.0",
36
+ "zod": "^4.3.6"
37
+ },
38
+ "engines": {
39
+ "node": ">=22.0.0"
40
+ }
7
41
  }
@@ -0,0 +1,304 @@
1
+ // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
2
+
3
+ import {VERSION as AUTH_VERSION} from '@databricks/sdk-auth';
4
+ import type {Call} from '@databricks/sdk-core/api';
5
+ import {createDefault} from '@databricks/sdk-core/clientinfo';
6
+ import type {Logger} from '@databricks/sdk-core/logger';
7
+ import {NoOpLogger} from '@databricks/sdk-core/logger';
8
+ import type {CallOptions} from '@databricks/sdk-options/call';
9
+ import type {ClientOptions} from '@databricks/sdk-options/client';
10
+ import type {HttpClient} from '@databricks/sdk-core/http';
11
+ import {newHttpClient} from './transport';
12
+ import {
13
+ buildHttpRequest,
14
+ executeCall,
15
+ executeHttpCall,
16
+ marshalRequest,
17
+ parseResponse,
18
+ } from './utils';
19
+ import pkgJson from '../../package.json' with {type: 'json'};
20
+ import type {
21
+ CreateFunctionRequest,
22
+ DeleteFunctionRequest,
23
+ DeleteFunctionRequest_Response,
24
+ FunctionInfo,
25
+ GetFunctionRequest,
26
+ ListFunctionsRequest,
27
+ ListFunctionsRequest_Response,
28
+ UpdateFunctionRequest,
29
+ } from './model';
30
+ import {
31
+ marshalCreateFunctionRequestSchema,
32
+ marshalUpdateFunctionRequestSchema,
33
+ unmarshalDeleteFunctionRequest_ResponseSchema,
34
+ unmarshalFunctionInfoSchema,
35
+ unmarshalListFunctionsRequest_ResponseSchema,
36
+ } from './model';
37
+
38
+ // Package identity segment for this client to be used in the User-Agent header.
39
+ const PACKAGE_SEGMENT = {
40
+ key: 'sdk-js-' + pkgJson.name.replace(/^@[^/]+\/sdk-/, ''),
41
+ value: pkgJson.version,
42
+ };
43
+
44
+ export class FunctionsClient {
45
+ private readonly host: string;
46
+ // Workspace ID used to route workspace-level calls on unified hosts (SPOG).
47
+ // When set, workspace-level methods send X-Databricks-Org-Id on every
48
+ // request.
49
+ private readonly workspaceId: string | undefined;
50
+ private readonly httpClient: HttpClient;
51
+ private readonly logger: Logger;
52
+ // User-Agent header value. Composed once at construction from
53
+ // createDefault() merged with this package's identity and the active
54
+ // credential's name.
55
+ private readonly userAgent: string;
56
+
57
+ constructor(options: ClientOptions) {
58
+ if (options.host === undefined) {
59
+ throw new Error('Host is required.');
60
+ }
61
+ this.host = options.host.replace(/\/$/, '');
62
+ this.workspaceId = options.workspaceId;
63
+ this.logger = options.logger ?? new NoOpLogger();
64
+ const info = createDefault()
65
+ .with(PACKAGE_SEGMENT)
66
+ .with({key: 'sdk-js-auth', value: AUTH_VERSION})
67
+ .with({key: 'auth', value: options.credentials?.name() ?? 'default'});
68
+ this.userAgent = info.toString();
69
+ this.httpClient = newHttpClient(options);
70
+ }
71
+
72
+ /**
73
+ * **WARNING: This API is experimental and will change in future versions**
74
+ *
75
+ * Creates a new function
76
+ *
77
+ * The user must have the following permissions in order for the function to be created:
78
+ * - **USE_CATALOG** on the function's parent catalog
79
+ * - **USE_SCHEMA** and **CREATE_FUNCTION** on the function's parent schema
80
+ */
81
+ async createFunction(
82
+ req: CreateFunctionRequest,
83
+ options?: CallOptions
84
+ ): Promise<FunctionInfo> {
85
+ const url = `${this.host}/api/2.1/unity-catalog/functions`;
86
+ const body = marshalRequest(req, marshalCreateFunctionRequestSchema);
87
+ let resp: FunctionInfo | undefined;
88
+ const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
89
+ const headers = new Headers({'Content-Type': 'application/json'});
90
+ if (this.workspaceId !== undefined) {
91
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
92
+ }
93
+ headers.set('User-Agent', this.userAgent);
94
+ const httpReq = buildHttpRequest('POST', url, headers, callSignal, body);
95
+ const respBody = await executeHttpCall({
96
+ request: httpReq,
97
+ httpClient: this.httpClient,
98
+ logger: this.logger,
99
+ });
100
+ resp = parseResponse(respBody, unmarshalFunctionInfoSchema);
101
+ };
102
+ await executeCall(call, options);
103
+ if (resp === undefined) {
104
+ throw new Error('API call completed without a result.');
105
+ }
106
+ return resp;
107
+ }
108
+
109
+ /**
110
+ * Deletes the function that matches the supplied name.
111
+ * For the deletion to succeed, the user must satisfy one of the following conditions:
112
+ * - Is the owner of the function's parent catalog
113
+ * - Is the owner of the function's parent schema and have the **USE_CATALOG** privilege on its parent catalog
114
+ * - Is the owner of the function itself and have both the **USE_CATALOG** privilege on its parent catalog and the **USE_SCHEMA** privilege on its parent schema
115
+ */
116
+ async deleteFunction(
117
+ req: DeleteFunctionRequest,
118
+ options?: CallOptions
119
+ ): Promise<DeleteFunctionRequest_Response> {
120
+ const url = `${this.host}/api/2.1/unity-catalog/functions/${req.fullNameArg ?? ''}`;
121
+ const params = new URLSearchParams();
122
+ if (req.force !== undefined) {
123
+ params.append('force', String(req.force));
124
+ }
125
+ const query = params.toString();
126
+ const fullUrl = query !== '' ? `${url}?${query}` : url;
127
+ let resp: DeleteFunctionRequest_Response | undefined;
128
+ const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
129
+ const headers = new Headers();
130
+ if (this.workspaceId !== undefined) {
131
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
132
+ }
133
+ headers.set('User-Agent', this.userAgent);
134
+ const httpReq = buildHttpRequest('DELETE', fullUrl, headers, callSignal);
135
+ const respBody = await executeHttpCall({
136
+ request: httpReq,
137
+ httpClient: this.httpClient,
138
+ logger: this.logger,
139
+ });
140
+ resp = parseResponse(
141
+ respBody,
142
+ unmarshalDeleteFunctionRequest_ResponseSchema
143
+ );
144
+ };
145
+ await executeCall(call, options);
146
+ if (resp === undefined) {
147
+ throw new Error('API call completed without a result.');
148
+ }
149
+ return resp;
150
+ }
151
+
152
+ /**
153
+ * Gets a function from within a parent catalog and schema.
154
+ * For the fetch to succeed, the user must satisfy one of the following requirements:
155
+ * - Is a metastore admin
156
+ * - Is an owner of the function's parent catalog
157
+ * - Have the **USE_CATALOG** privilege on the function's parent catalog and be the owner of the function
158
+ * - Have the **USE_CATALOG** privilege on the function's parent catalog, the **USE_SCHEMA** privilege on the function's parent schema, and the **EXECUTE** privilege on the function itself
159
+ */
160
+ async getFunction(
161
+ req: GetFunctionRequest,
162
+ options?: CallOptions
163
+ ): Promise<FunctionInfo> {
164
+ const url = `${this.host}/api/2.1/unity-catalog/functions/${req.fullNameArg ?? ''}`;
165
+ const params = new URLSearchParams();
166
+ if (req.includeBrowse !== undefined) {
167
+ params.append('include_browse', String(req.includeBrowse));
168
+ }
169
+ const query = params.toString();
170
+ const fullUrl = query !== '' ? `${url}?${query}` : url;
171
+ let resp: FunctionInfo | undefined;
172
+ const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
173
+ const headers = new Headers();
174
+ if (this.workspaceId !== undefined) {
175
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
176
+ }
177
+ headers.set('User-Agent', this.userAgent);
178
+ const httpReq = buildHttpRequest('GET', fullUrl, headers, callSignal);
179
+ const respBody = await executeHttpCall({
180
+ request: httpReq,
181
+ httpClient: this.httpClient,
182
+ logger: this.logger,
183
+ });
184
+ resp = parseResponse(respBody, unmarshalFunctionInfoSchema);
185
+ };
186
+ await executeCall(call, options);
187
+ if (resp === undefined) {
188
+ throw new Error('API call completed without a result.');
189
+ }
190
+ return resp;
191
+ }
192
+
193
+ /**
194
+ * List functions within the specified parent catalog and schema.
195
+ * If the user is a metastore admin, all functions are returned in the output list.
196
+ * Otherwise, the user must have the **USE_CATALOG** privilege on the catalog and the **USE_SCHEMA** privilege on the schema, and the output list contains only functions for which either the user has the **EXECUTE** privilege or the user is the owner.
197
+ * There is no guarantee of a specific ordering of the elements in the array.
198
+ *
199
+ * NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.
200
+ *
201
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token.
202
+ * Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.
203
+ */
204
+ async listFunctions(
205
+ req: ListFunctionsRequest,
206
+ options?: CallOptions
207
+ ): Promise<ListFunctionsRequest_Response> {
208
+ const url = `${this.host}/api/2.1/unity-catalog/functions`;
209
+ const params = new URLSearchParams();
210
+ if (req.catalogName !== undefined) {
211
+ params.append('catalog_name', req.catalogName);
212
+ }
213
+ if (req.schemaName !== undefined) {
214
+ params.append('schema_name', req.schemaName);
215
+ }
216
+ if (req.includeBrowse !== undefined) {
217
+ params.append('include_browse', String(req.includeBrowse));
218
+ }
219
+ if (req.maxResults !== undefined) {
220
+ params.append('max_results', String(req.maxResults));
221
+ }
222
+ if (req.pageToken !== undefined) {
223
+ params.append('page_token', req.pageToken);
224
+ }
225
+ const query = params.toString();
226
+ const fullUrl = query !== '' ? `${url}?${query}` : url;
227
+ let resp: ListFunctionsRequest_Response | undefined;
228
+ const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
229
+ const headers = new Headers();
230
+ if (this.workspaceId !== undefined) {
231
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
232
+ }
233
+ headers.set('User-Agent', this.userAgent);
234
+ const httpReq = buildHttpRequest('GET', fullUrl, headers, callSignal);
235
+ const respBody = await executeHttpCall({
236
+ request: httpReq,
237
+ httpClient: this.httpClient,
238
+ logger: this.logger,
239
+ });
240
+ resp = parseResponse(
241
+ respBody,
242
+ unmarshalListFunctionsRequest_ResponseSchema
243
+ );
244
+ };
245
+ await executeCall(call, options);
246
+ if (resp === undefined) {
247
+ throw new Error('API call completed without a result.');
248
+ }
249
+ return resp;
250
+ }
251
+
252
+ async *listFunctionsIter(
253
+ req: ListFunctionsRequest,
254
+ options?: CallOptions
255
+ ): AsyncGenerator<FunctionInfo> {
256
+ const pageReq: ListFunctionsRequest = {...req};
257
+ for (;;) {
258
+ const resp = await this.listFunctions(pageReq, options);
259
+ for (const item of resp.functions ?? []) {
260
+ yield item;
261
+ }
262
+ if (resp.nextPageToken === undefined || resp.nextPageToken === '') {
263
+ return;
264
+ }
265
+ pageReq.pageToken = resp.nextPageToken;
266
+ }
267
+ }
268
+
269
+ /**
270
+ * Updates the function that matches the supplied name.
271
+ * Only the owner of the function can be updated. If the user is not a metastore admin, the user must be a member of the group that is the new function owner.
272
+ * - Is a metastore admin
273
+ * - Is the owner of the function's parent catalog
274
+ * - Is the owner of the function's parent schema and has the **USE_CATALOG** privilege on its parent catalog
275
+ * - Is the owner of the function itself and has the **USE_CATALOG** privilege on its parent catalog as well as the **USE_SCHEMA** privilege on the function's parent schema.
276
+ */
277
+ async updateFunction(
278
+ req: UpdateFunctionRequest,
279
+ options?: CallOptions
280
+ ): Promise<FunctionInfo> {
281
+ const url = `${this.host}/api/2.1/unity-catalog/functions/${req.fullNameArg ?? ''}`;
282
+ const body = marshalRequest(req, marshalUpdateFunctionRequestSchema);
283
+ let resp: FunctionInfo | undefined;
284
+ const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
285
+ const headers = new Headers({'Content-Type': 'application/json'});
286
+ if (this.workspaceId !== undefined) {
287
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
288
+ }
289
+ headers.set('User-Agent', this.userAgent);
290
+ const httpReq = buildHttpRequest('PATCH', url, headers, callSignal, body);
291
+ const respBody = await executeHttpCall({
292
+ request: httpReq,
293
+ httpClient: this.httpClient,
294
+ logger: this.logger,
295
+ });
296
+ resp = parseResponse(respBody, unmarshalFunctionInfoSchema);
297
+ };
298
+ await executeCall(call, options);
299
+ if (resp === undefined) {
300
+ throw new Error('API call completed without a result.');
301
+ }
302
+ return resp;
303
+ }
304
+ }
@@ -0,0 +1,33 @@
1
+ // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
2
+
3
+ export {FunctionsClient} from './client';
4
+
5
+ export {
6
+ ColumnTypeName,
7
+ FunctionParameterMode,
8
+ FunctionParameterType,
9
+ FunctionInfo_ParameterStyle,
10
+ FunctionInfo_RoutineBody,
11
+ FunctionInfo_SecurityType,
12
+ FunctionInfo_SqlDataAccess,
13
+ } from './model';
14
+
15
+ export type {
16
+ ConnectionDependency,
17
+ CreateFunction,
18
+ CreateFunctionRequest,
19
+ CredentialDependency,
20
+ DeleteFunctionRequest,
21
+ DeleteFunctionRequest_Response,
22
+ Dependency,
23
+ DependencyList,
24
+ FunctionDependency,
25
+ FunctionInfo,
26
+ FunctionParameterInfo,
27
+ FunctionParameterInfos,
28
+ GetFunctionRequest,
29
+ ListFunctionsRequest,
30
+ ListFunctionsRequest_Response,
31
+ TableDependency,
32
+ UpdateFunctionRequest,
33
+ } from './model';