@databricks/sdk-statementexecution 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.
package/LICENSE ADDED
@@ -0,0 +1,203 @@
1
+ Copyright 2026 Databricks, Inc. All rights reserved.
2
+
3
+ Apache License
4
+ Version 2.0, January 2004
5
+ http://www.apache.org/licenses/
6
+
7
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. Definitions.
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. Grant of Copyright License. Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. Grant of Patent License. Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. Redistribution. You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ (a) You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ (b) You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ (c) You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ (d) If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. Trademarks. This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. Disclaimer of Warranty. Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. Limitation of Liability. In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. Accepting Warranty or Additional Liability. While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ END OF TERMS AND CONDITIONS
179
+
180
+ APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "[]"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright [yyyy] [name of copyright owner]
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
@@ -0,0 +1,93 @@
1
+ import type { CallOptions } from '@databricks/sdk-options/call';
2
+ import type { ClientOptions } from '@databricks/sdk-options/client';
3
+ import type { CancelStatementRequest, CancelStatementResponse, ExecuteStatementRequest, GetResultDataRequest, GetStatementResultRequest, ResultData, StatementResponse } from './model';
4
+ export declare class Client {
5
+ private readonly host;
6
+ private readonly workspaceId;
7
+ private readonly httpClient;
8
+ private readonly logger;
9
+ private readonly userAgent;
10
+ constructor(options: ClientOptions);
11
+ /**
12
+ * Requests that an executing statement be canceled. Callers must poll for status to see the
13
+ * terminal state. Cancel response is empty; receiving response indicates successful receipt.
14
+ */
15
+ cancelStatement(req: CancelStatementRequest, options?: CallOptions): Promise<CancelStatementResponse>;
16
+ /**
17
+ * Execute a SQL statement and optionally await its results for a specified time.
18
+ *
19
+ * **Use case: small result sets with INLINE + JSON_ARRAY**
20
+ *
21
+ * For flows that generate small and predictable result sets (<= 25 MiB), `INLINE` responses of `JSON_ARRAY` result
22
+ * data are typically the simplest way to execute and fetch result data.
23
+ *
24
+ * **Use case: large result sets with EXTERNAL_LINKS**
25
+ *
26
+ * Using `EXTERNAL_LINKS` to fetch result data allows you to fetch large result sets efficiently.
27
+ * The main differences from using `INLINE` disposition are that the result data is accessed
28
+ * with URLs, and
29
+ * that there are 3 supported formats: `JSON_ARRAY`, `ARROW_STREAM` and `CSV` compared to only `JSON_ARRAY` with
30
+ * `INLINE`.
31
+ *
32
+ * ** URLs**
33
+ *
34
+ * External links point to data stored within your workspace's internal storage, in the form of
35
+ * a URL. The URLs are valid for only a short
36
+ * period, <= 15 minutes. Alongside each `external_link` is an expiration field indicating the time at which the URL
37
+ * is no longer valid. In `EXTERNAL_LINKS` mode, chunks can be resolved and fetched multiple times and in parallel.
38
+ *
39
+ * ----
40
+ *
41
+ * ### **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.**
42
+ *
43
+ * When you use the `EXTERNAL_LINKS` disposition, a
44
+ * short-lived, URL is generated, which can be
45
+ * used to download the results directly
46
+ * from . As a
47
+ * short-lived is
48
+ * embedded in this URL, you should protect
49
+ * the URL.
50
+ *
51
+ * Because URLs are already generated with
52
+ * embedded temporary s,
53
+ * you must not set an `Authorization` header in the download requests.
54
+ *
55
+ * The `EXTERNAL_LINKS` disposition can be disabled upon request by creating a support
56
+ * case.
57
+ *
58
+ * See also [Security best practices](/sql/admin/sql-execution-tutorial.html#security-best-practices).
59
+ *
60
+ * ----
61
+ *
62
+ * StatementResponse contains `statement_id` and `status`; other fields might be absent or present depending on
63
+ * context. If the SQL warehouse fails to execute the provided statement, a 200 response is returned with
64
+ * `status.state` set to `FAILED` (in contrast to a failure when accepting the request, which results in a non-200
65
+ * response). Details of the error can be found at `status.error` in case of execution failures.
66
+ */
67
+ executeStatement(req: ExecuteStatementRequest, options?: CallOptions): Promise<StatementResponse>;
68
+ /**
69
+ * After the statement execution has `SUCCEEDED`, this request can be used to fetch any chunk by
70
+ * index. Whereas the first chunk with `chunk_index=0` is typically fetched with
71
+ * :method:statementexecution/executeStatement or :method:statementexecution/getStatement, this
72
+ * request can be used to fetch subsequent chunks. The response structure is identical to the
73
+ * nested `result` element described in the :method:statementexecution/getStatement request, and
74
+ * similarly includes the `next_chunk_index` and `next_chunk_internal_link` fields for simple
75
+ * iteration through the result set. Depending on `disposition`, the response returns chunks of
76
+ * data either inline, or as links.
77
+ */
78
+ getResultData(req: GetResultDataRequest, options?: CallOptions): Promise<ResultData>;
79
+ /**
80
+ * This request can be used to poll for the statement's status. StatementResponse contains
81
+ * `statement_id` and `status`; other fields might be absent or present depending on context.
82
+ * When the `status.state` field is `SUCCEEDED` it will also return the result manifest and the
83
+ * first chunk of the result data. When the statement is in the terminal states `CANCELED`,
84
+ * `CLOSED` or `FAILED`, it returns HTTP 200 with the state set. After at least 12 hours in
85
+ * terminal state, the statement is removed from the warehouse and further calls will receive an
86
+ * HTTP 404 response.
87
+ *
88
+ * **NOTE**
89
+ * This call currently might take up to 5 seconds to get the latest status and result.
90
+ */
91
+ getStatementResult(req: GetStatementResultRequest, options?: CallOptions): Promise<StatementResponse>;
92
+ }
93
+ //# sourceMappingURL=client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/v1/client.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAC;AAWlE,OAAO,KAAK,EACV,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,oBAAoB,EACpB,yBAAyB,EACzB,UAAU,EACV,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAejB,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAI9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAIhC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBAEvB,OAAO,EAAE,aAAa;IAiBlC;;;OAGG;IACG,eAAe,CACnB,GAAG,EAAE,sBAAsB,EAC3B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,uBAAuB,CAAC;IAyBnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACG,gBAAgB,CACpB,GAAG,EAAE,uBAAuB,EAC5B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,iBAAiB,CAAC;IAyB7B;;;;;;;;;OASG;IACG,aAAa,CACjB,GAAG,EAAE,oBAAoB,EACzB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,UAAU,CAAC;IAwBtB;;;;;;;;;;;OAWG;IACG,kBAAkB,CACtB,GAAG,EAAE,yBAAyB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,iBAAiB,CAAC;CAuB9B"}
@@ -0,0 +1,214 @@
1
+ // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
2
+ import { VERSION as AUTH_VERSION } from '@databricks/sdk-auth';
3
+ import { createDefault } from '@databricks/sdk-core/clientinfo';
4
+ import { NoOpLogger } from '@databricks/sdk-core/logger';
5
+ import { newHttpClient } from './transport';
6
+ import { buildHttpRequest, executeCall, executeHttpCall, marshalRequest, parseResponse, } from './utils';
7
+ import pkgJson from '../../package.json' with { type: 'json' };
8
+ import { marshalCancelStatementRequestSchema, marshalExecuteStatementRequestSchema, unmarshalCancelStatementResponseSchema, unmarshalResultDataSchema, unmarshalStatementResponseSchema, } from './model';
9
+ // Package identity segment for this client to be used in the User-Agent header.
10
+ const PACKAGE_SEGMENT = {
11
+ key: 'sdk-js-' + pkgJson.name.replace(/^@[^/]+\/sdk-/, ''),
12
+ value: pkgJson.version,
13
+ };
14
+ export class Client {
15
+ host;
16
+ // Workspace ID used to route workspace-level calls on unified hosts (SPOG).
17
+ // When set, workspace-level methods send X-Databricks-Org-Id on every
18
+ // request.
19
+ workspaceId;
20
+ httpClient;
21
+ logger;
22
+ // User-Agent header value. Composed once at construction from
23
+ // createDefault() merged with this package's identity and the active
24
+ // credential's name.
25
+ userAgent;
26
+ constructor(options) {
27
+ if (options.host === undefined) {
28
+ throw new Error('Host is required.');
29
+ }
30
+ this.host = options.host.replace(/\/$/, '');
31
+ this.workspaceId = options.workspaceId;
32
+ this.logger = options.logger ?? new NoOpLogger();
33
+ let info = createDefault().with(PACKAGE_SEGMENT);
34
+ if (options.credentials !== undefined) {
35
+ info = info
36
+ .with({ key: 'sdk-js-auth', value: AUTH_VERSION })
37
+ .with({ key: 'auth', value: options.credentials.name() });
38
+ }
39
+ this.userAgent = info.toString();
40
+ this.httpClient = newHttpClient(options);
41
+ }
42
+ /**
43
+ * Requests that an executing statement be canceled. Callers must poll for status to see the
44
+ * terminal state. Cancel response is empty; receiving response indicates successful receipt.
45
+ */
46
+ async cancelStatement(req, options) {
47
+ const url = `${this.host}/api/2.0/sql/statements/${req.statementId ?? ''}/cancel`;
48
+ const body = marshalRequest(req, marshalCancelStatementRequestSchema);
49
+ let resp;
50
+ const call = async (callSignal) => {
51
+ const headers = new Headers({ 'Content-Type': 'application/json' });
52
+ if (this.workspaceId !== undefined) {
53
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
54
+ }
55
+ headers.set('User-Agent', this.userAgent);
56
+ const httpReq = buildHttpRequest('POST', url, headers, callSignal, body);
57
+ const respBody = await executeHttpCall({
58
+ request: httpReq,
59
+ httpClient: this.httpClient,
60
+ logger: this.logger,
61
+ });
62
+ resp = parseResponse(respBody, unmarshalCancelStatementResponseSchema);
63
+ };
64
+ await executeCall(call, options);
65
+ if (resp === undefined) {
66
+ throw new Error('API call completed without a result.');
67
+ }
68
+ return resp;
69
+ }
70
+ /**
71
+ * Execute a SQL statement and optionally await its results for a specified time.
72
+ *
73
+ * **Use case: small result sets with INLINE + JSON_ARRAY**
74
+ *
75
+ * For flows that generate small and predictable result sets (<= 25 MiB), `INLINE` responses of `JSON_ARRAY` result
76
+ * data are typically the simplest way to execute and fetch result data.
77
+ *
78
+ * **Use case: large result sets with EXTERNAL_LINKS**
79
+ *
80
+ * Using `EXTERNAL_LINKS` to fetch result data allows you to fetch large result sets efficiently.
81
+ * The main differences from using `INLINE` disposition are that the result data is accessed
82
+ * with URLs, and
83
+ * that there are 3 supported formats: `JSON_ARRAY`, `ARROW_STREAM` and `CSV` compared to only `JSON_ARRAY` with
84
+ * `INLINE`.
85
+ *
86
+ * ** URLs**
87
+ *
88
+ * External links point to data stored within your workspace's internal storage, in the form of
89
+ * a URL. The URLs are valid for only a short
90
+ * period, <= 15 minutes. Alongside each `external_link` is an expiration field indicating the time at which the URL
91
+ * is no longer valid. In `EXTERNAL_LINKS` mode, chunks can be resolved and fetched multiple times and in parallel.
92
+ *
93
+ * ----
94
+ *
95
+ * ### **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.**
96
+ *
97
+ * When you use the `EXTERNAL_LINKS` disposition, a
98
+ * short-lived, URL is generated, which can be
99
+ * used to download the results directly
100
+ * from . As a
101
+ * short-lived is
102
+ * embedded in this URL, you should protect
103
+ * the URL.
104
+ *
105
+ * Because URLs are already generated with
106
+ * embedded temporary s,
107
+ * you must not set an `Authorization` header in the download requests.
108
+ *
109
+ * The `EXTERNAL_LINKS` disposition can be disabled upon request by creating a support
110
+ * case.
111
+ *
112
+ * See also [Security best practices](/sql/admin/sql-execution-tutorial.html#security-best-practices).
113
+ *
114
+ * ----
115
+ *
116
+ * StatementResponse contains `statement_id` and `status`; other fields might be absent or present depending on
117
+ * context. If the SQL warehouse fails to execute the provided statement, a 200 response is returned with
118
+ * `status.state` set to `FAILED` (in contrast to a failure when accepting the request, which results in a non-200
119
+ * response). Details of the error can be found at `status.error` in case of execution failures.
120
+ */
121
+ async executeStatement(req, options) {
122
+ const url = `${this.host}/api/2.0/sql/statements/`;
123
+ const body = marshalRequest(req, marshalExecuteStatementRequestSchema);
124
+ let resp;
125
+ const call = async (callSignal) => {
126
+ const headers = new Headers({ 'Content-Type': 'application/json' });
127
+ if (this.workspaceId !== undefined) {
128
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
129
+ }
130
+ headers.set('User-Agent', this.userAgent);
131
+ const httpReq = buildHttpRequest('POST', url, headers, callSignal, body);
132
+ const respBody = await executeHttpCall({
133
+ request: httpReq,
134
+ httpClient: this.httpClient,
135
+ logger: this.logger,
136
+ });
137
+ resp = parseResponse(respBody, unmarshalStatementResponseSchema);
138
+ };
139
+ await executeCall(call, options);
140
+ if (resp === undefined) {
141
+ throw new Error('API call completed without a result.');
142
+ }
143
+ return resp;
144
+ }
145
+ /**
146
+ * After the statement execution has `SUCCEEDED`, this request can be used to fetch any chunk by
147
+ * index. Whereas the first chunk with `chunk_index=0` is typically fetched with
148
+ * :method:statementexecution/executeStatement or :method:statementexecution/getStatement, this
149
+ * request can be used to fetch subsequent chunks. The response structure is identical to the
150
+ * nested `result` element described in the :method:statementexecution/getStatement request, and
151
+ * similarly includes the `next_chunk_index` and `next_chunk_internal_link` fields for simple
152
+ * iteration through the result set. Depending on `disposition`, the response returns chunks of
153
+ * data either inline, or as links.
154
+ */
155
+ async getResultData(req, options) {
156
+ const url = `${this.host}/api/2.0/sql/statements/${req.statementId ?? ''}/result/chunks/${String(req.chunkIndex ?? '')}`;
157
+ let resp;
158
+ const call = async (callSignal) => {
159
+ const headers = new Headers();
160
+ if (this.workspaceId !== undefined) {
161
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
162
+ }
163
+ headers.set('User-Agent', this.userAgent);
164
+ const httpReq = buildHttpRequest('GET', url, headers, callSignal);
165
+ const respBody = await executeHttpCall({
166
+ request: httpReq,
167
+ httpClient: this.httpClient,
168
+ logger: this.logger,
169
+ });
170
+ resp = parseResponse(respBody, unmarshalResultDataSchema);
171
+ };
172
+ await executeCall(call, options);
173
+ if (resp === undefined) {
174
+ throw new Error('API call completed without a result.');
175
+ }
176
+ return resp;
177
+ }
178
+ /**
179
+ * This request can be used to poll for the statement's status. StatementResponse contains
180
+ * `statement_id` and `status`; other fields might be absent or present depending on context.
181
+ * When the `status.state` field is `SUCCEEDED` it will also return the result manifest and the
182
+ * first chunk of the result data. When the statement is in the terminal states `CANCELED`,
183
+ * `CLOSED` or `FAILED`, it returns HTTP 200 with the state set. After at least 12 hours in
184
+ * terminal state, the statement is removed from the warehouse and further calls will receive an
185
+ * HTTP 404 response.
186
+ *
187
+ * **NOTE**
188
+ * This call currently might take up to 5 seconds to get the latest status and result.
189
+ */
190
+ async getStatementResult(req, options) {
191
+ const url = `${this.host}/api/2.0/sql/statements/${req.statementId ?? ''}`;
192
+ let resp;
193
+ const call = async (callSignal) => {
194
+ const headers = new Headers();
195
+ if (this.workspaceId !== undefined) {
196
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
197
+ }
198
+ headers.set('User-Agent', this.userAgent);
199
+ const httpReq = buildHttpRequest('GET', url, headers, callSignal);
200
+ const respBody = await executeHttpCall({
201
+ request: httpReq,
202
+ httpClient: this.httpClient,
203
+ logger: this.logger,
204
+ });
205
+ resp = parseResponse(respBody, unmarshalStatementResponseSchema);
206
+ };
207
+ await executeCall(call, options);
208
+ if (resp === undefined) {
209
+ throw new Error('API call completed without a result.');
210
+ }
211
+ return resp;
212
+ }
213
+ }
214
+ //# sourceMappingURL=client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/v1/client.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAE/E,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,sBAAsB,CAAC;AAE7D,OAAO,EAAC,aAAa,EAAC,MAAM,iCAAiC,CAAC;AAE9D,OAAO,EAAC,UAAU,EAAC,MAAM,6BAA6B,CAAC;AAIvD,OAAO,EAAC,aAAa,EAAC,MAAM,aAAa,CAAC;AAC1C,OAAO,EACL,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,cAAc,EACd,aAAa,GACd,MAAM,SAAS,CAAC;AACjB,OAAO,OAAO,MAAM,oBAAoB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAU7D,OAAO,EACL,mCAAmC,EACnC,oCAAoC,EACpC,sCAAsC,EACtC,yBAAyB,EACzB,gCAAgC,GACjC,MAAM,SAAS,CAAC;AAEjB,gFAAgF;AAChF,MAAM,eAAe,GAAG;IACtB,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC;IAC1D,KAAK,EAAE,OAAO,CAAC,OAAO;CACvB,CAAC;AAEF,MAAM,OAAO,MAAM;IACA,IAAI,CAAS;IAC9B,4EAA4E;IAC5E,sEAAsE;IACtE,WAAW;IACM,WAAW,CAAqB;IAChC,UAAU,CAAa;IACvB,MAAM,CAAS;IAChC,8DAA8D;IAC9D,qEAAqE;IACrE,qBAAqB;IACJ,SAAS,CAAS;IAEnC,YAAY,OAAsB;QAChC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QACjD,IAAI,IAAI,GAAG,aAAa,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACjD,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,GAAG,IAAI;iBACR,IAAI,CAAC,EAAC,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,YAAY,EAAC,CAAC;iBAC/C,IAAI,CAAC,EAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,EAAC,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CACnB,GAA2B,EAC3B,OAAqB;QAErB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,2BAA2B,GAAG,CAAC,WAAW,IAAI,EAAE,SAAS,CAAC;QAClF,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,EAAE,mCAAmC,CAAC,CAAC;QACtE,IAAI,IAAyC,CAAC;QAC9C,MAAM,IAAI,GAAS,KAAK,EAAE,UAAwB,EAAiB,EAAE;YACnE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAC,cAAc,EAAE,kBAAkB,EAAC,CAAC,CAAC;YAClE,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACnC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1C,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;YACzE,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;gBACrC,OAAO,EAAE,OAAO;gBAChB,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB,CAAC,CAAC;YACH,IAAI,GAAG,aAAa,CAAC,QAAQ,EAAE,sCAAsC,CAAC,CAAC;QACzE,CAAC,CAAC;QACF,MAAM,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACjC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,KAAK,CAAC,gBAAgB,CACpB,GAA4B,EAC5B,OAAqB;QAErB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,0BAA0B,CAAC;QACnD,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,EAAE,oCAAoC,CAAC,CAAC;QACvE,IAAI,IAAmC,CAAC;QACxC,MAAM,IAAI,GAAS,KAAK,EAAE,UAAwB,EAAiB,EAAE;YACnE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAC,cAAc,EAAE,kBAAkB,EAAC,CAAC,CAAC;YAClE,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACnC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1C,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;YACzE,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;gBACrC,OAAO,EAAE,OAAO;gBAChB,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB,CAAC,CAAC;YACH,IAAI,GAAG,aAAa,CAAC,QAAQ,EAAE,gCAAgC,CAAC,CAAC;QACnE,CAAC,CAAC;QACF,MAAM,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACjC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CACjB,GAAyB,EACzB,OAAqB;QAErB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,2BAA2B,GAAG,CAAC,WAAW,IAAI,EAAE,kBAAkB,MAAM,CAAC,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,CAAC;QACzH,IAAI,IAA4B,CAAC;QACjC,MAAM,IAAI,GAAS,KAAK,EAAE,UAAwB,EAAiB,EAAE;YACnE,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;YAC9B,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACnC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1C,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAClE,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;gBACrC,OAAO,EAAE,OAAO;gBAChB,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB,CAAC,CAAC;YACH,IAAI,GAAG,aAAa,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC;QAC5D,CAAC,CAAC;QACF,MAAM,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACjC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,kBAAkB,CACtB,GAA8B,EAC9B,OAAqB;QAErB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,2BAA2B,GAAG,CAAC,WAAW,IAAI,EAAE,EAAE,CAAC;QAC3E,IAAI,IAAmC,CAAC;QACxC,MAAM,IAAI,GAAS,KAAK,EAAE,UAAwB,EAAiB,EAAE;YACnE,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;YAC9B,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACnC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1C,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAClE,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;gBACrC,OAAO,EAAE,OAAO;gBAChB,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB,CAAC,CAAC;YACH,IAAI,GAAG,aAAa,CAAC,QAAQ,EAAE,gCAAgC,CAAC,CAAC;QACnE,CAAC,CAAC;QACF,MAAM,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACjC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
@@ -0,0 +1,4 @@
1
+ export { Client } from './client';
2
+ export { ColumnTypeName, Disposition, Format, ServiceErrorCode, TimeoutAction, StatementStatus_State, } from './model';
3
+ export type { CancelStatementRequest, CancelStatementResponse, ChunkInfo, ColumnInfo, ExecuteStatementRequest, ExternalLink, ExternalLink_HttpHeadersEntry, GetResultDataRequest, GetStatementResultRequest, QueryTag, ResultData, ResultManifest, Schema, ServiceError, StatementParameter, StatementResponse, StatementStatus, } from './model';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/v1/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAEhC,OAAO,EACL,cAAc,EACd,WAAW,EACX,MAAM,EACN,gBAAgB,EAChB,aAAa,EACb,qBAAqB,GACtB,MAAM,SAAS,CAAC;AAEjB,YAAY,EACV,sBAAsB,EACtB,uBAAuB,EACvB,SAAS,EACT,UAAU,EACV,uBAAuB,EACvB,YAAY,EACZ,6BAA6B,EAC7B,oBAAoB,EACpB,yBAAyB,EACzB,QAAQ,EACR,UAAU,EACV,cAAc,EACd,MAAM,EACN,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,EACjB,eAAe,GAChB,MAAM,SAAS,CAAC"}
@@ -0,0 +1,4 @@
1
+ // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
2
+ export { Client } from './client';
3
+ export { ColumnTypeName, Disposition, Format, ServiceErrorCode, TimeoutAction, StatementStatus_State, } from './model';
4
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/v1/index.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAE/E,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAEhC,OAAO,EACL,cAAc,EACd,WAAW,EACX,MAAM,EACN,gBAAgB,EAChB,aAAa,EACb,qBAAqB,GACtB,MAAM,SAAS,CAAC"}