@databricks/sdk-statementexecution 0.34.0 → 0.35.0

package/dist/package.js

@@ -0,0 +1,7 @@
+//#region package.json
+var name = "@databricks/sdk-statementexecution";
+var version = "0.35.0";
+
+//#endregion
+export { name, version };
+//# sourceMappingURL=package.js.map

package/dist/package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.js","names":[],"sources":["../package.json"],"sourcesContent":[""],"mappings":""}

package/dist/v1/client.d.ts

@@ -1,93 +1,97 @@
-import type { CallOptions } from '@databricks/sdk-options/call';
-import type { ClientOptions } from '@databricks/sdk-options/client';
-import type { CancelStatementRequest, CancelStatementResponse, ExecuteStatementRequest, GetResultDataRequest, GetStatementResultRequest, ResultData, StatementResponse } from './model';
-export declare class StatementExecutionClient {
-    private readonly options;
-    private readonly logger;
-    private readonly userAgent;
-    private config;
-    constructor(options: ClientOptions);
-    private resolveConfig;
-    /**
-     * Requests that an executing statement be canceled. Callers must poll for status to see the
-     * terminal state. Cancel response is empty; receiving response indicates successful receipt.
-     */
-    cancelStatement(req: CancelStatementRequest, options?: CallOptions): Promise<CancelStatementResponse>;
-    /**
-     * Execute a SQL statement and optionally await its results for a specified time.
-     *
-     * **Use case: small result sets with INLINE + JSON_ARRAY**
-     *
-     * For flows that generate small and predictable result sets (<= 25 MiB), `INLINE` responses of `JSON_ARRAY` result
-     * data are typically the simplest way to execute and fetch result data.
-     *
-     * **Use case: large result sets with EXTERNAL_LINKS**
-     *
-     * Using `EXTERNAL_LINKS` to fetch result data allows you to fetch large result sets efficiently.
-     * The main differences from using `INLINE` disposition are that the result data is accessed
-     * with  URLs, and
-     * that there are 3 supported formats: `JSON_ARRAY`, `ARROW_STREAM` and `CSV` compared to only `JSON_ARRAY` with
-     * `INLINE`.
-     *
-     * ** URLs**
-     *
-     * External links point to data stored within your workspace's internal storage, in the form of
-     * a  URL. The URLs are valid for only a short
-     * period, <= 15 minutes. Alongside each `external_link` is an expiration field indicating the time at which the URL
-     * is no longer valid. In `EXTERNAL_LINKS` mode, chunks can be resolved and fetched multiple times and in parallel.
-     *
-     * ----
-     *
-     * ### **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.**
-     *
-     * When you use the `EXTERNAL_LINKS` disposition, a
-     * short-lived,  URL is generated, which can be
-     * used to download the results directly
-     * from . As a
-     * short-lived  is
-     * embedded in this  URL, you should protect
-     * the URL.
-     *
-     * Because  URLs are already generated with
-     * embedded temporary s,
-     * you must not set an `Authorization` header in the download requests.
-     *
-     * The `EXTERNAL_LINKS` disposition can be disabled upon request by creating a support
-     * case.
-     *
-     * See also [Security best practices](/sql/admin/sql-execution-tutorial.html#security-best-practices).
-     *
-     * ----
-     *
-     * StatementResponse contains `statement_id` and `status`; other fields might be absent or present depending on
-     * context. If the SQL warehouse fails to execute the provided statement, a 200 response is returned with
-     * `status.state` set to `FAILED` (in contrast to a failure when accepting the request, which results in a non-200
-     * response). Details of the error can be found at `status.error` in case of execution failures.
-     */
-    executeStatement(req: ExecuteStatementRequest, options?: CallOptions): Promise<StatementResponse>;
-    /**
-     * After the statement execution has `SUCCEEDED`, this request can be used to fetch any chunk by
-     * index. Whereas the first chunk with `chunk_index=0` is typically fetched with
-     * :method:statementexecution/executeStatement or :method:statementexecution/getStatement, this
-     * request can be used to fetch subsequent chunks. The response structure is identical to the
-     * nested `result` element described in the :method:statementexecution/getStatement request, and
-     * similarly includes the `next_chunk_index` and `next_chunk_internal_link` fields for simple
-     * iteration through the result set. Depending on `disposition`, the response returns chunks of
-     * data either inline, or as links.
-     */
-    getResultData(req: GetResultDataRequest, options?: CallOptions): Promise<ResultData>;
-    /**
-     * This request can be used to poll for the statement's status. StatementResponse contains
-     * `statement_id` and `status`; other fields might be absent or present depending on context.
-     * When the `status.state` field is `SUCCEEDED` it will also return the result manifest and the
-     * first chunk of the result data. When the statement is in the terminal states `CANCELED`,
-     * `CLOSED` or `FAILED`, it returns HTTP 200 with the state set. After at least 12 hours in
-     * terminal state, the statement is removed from the warehouse and further calls will receive an
-     * HTTP 404 response.
-     *
-     * **NOTE**
-     * This call currently might take up to 5 seconds to get the latest status and result.
-     */
-    getStatementResult(req: GetStatementResultRequest, options?: CallOptions): Promise<StatementResponse>;
+import { CancelStatementRequest, CancelStatementResponse, ExecuteStatementRequest, GetResultDataRequest, GetStatementResultRequest, ResultData, StatementResponse } from "./model.js";
+import { CallOptions } from "@databricks/sdk-options/call";
+import { ClientOptions } from "@databricks/sdk-options/client";
+
+//#region src/v1/client.d.ts
+declare class StatementExecutionClient {
+  private readonly options;
+  private readonly logger;
+  private readonly userAgent;
+  private config;
+  constructor(options: ClientOptions);
+  private resolveConfig;
+  /**
+   * Requests that an executing statement be canceled. Callers must poll for status to see the
+   * terminal state. Cancel response is empty; receiving response indicates successful receipt.
+   */
+  cancelStatement(req: CancelStatementRequest, options?: CallOptions): Promise<CancelStatementResponse>;
+  /**
+   * Execute a SQL statement and optionally await its results for a specified time.
+   *
+   * **Use case: small result sets with INLINE + JSON_ARRAY**
+   *
+   * For flows that generate small and predictable result sets (<= 25 MiB), `INLINE` responses of `JSON_ARRAY` result
+   * data are typically the simplest way to execute and fetch result data.
+   *
+   * **Use case: large result sets with EXTERNAL_LINKS**
+   *
+   * Using `EXTERNAL_LINKS` to fetch result data allows you to fetch large result sets efficiently.
+   * The main differences from using `INLINE` disposition are that the result data is accessed
+   * with  URLs, and
+   * that there are 3 supported formats: `JSON_ARRAY`, `ARROW_STREAM` and `CSV` compared to only `JSON_ARRAY` with
+   * `INLINE`.
+   *
+   * ** URLs**
+   *
+   * External links point to data stored within your workspace's internal storage, in the form of
+   * a  URL. The URLs are valid for only a short
+   * period, <= 15 minutes. Alongside each `external_link` is an expiration field indicating the time at which the URL
+   * is no longer valid. In `EXTERNAL_LINKS` mode, chunks can be resolved and fetched multiple times and in parallel.
+   *
+   * ----
+   *
+   * ### **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.**
+   *
+   * When you use the `EXTERNAL_LINKS` disposition, a
+   * short-lived,  URL is generated, which can be
+   * used to download the results directly
+   * from . As a
+   * short-lived  is
+   * embedded in this  URL, you should protect
+   * the URL.
+   *
+   * Because  URLs are already generated with
+   * embedded temporary s,
+   * you must not set an `Authorization` header in the download requests.
+   *
+   * The `EXTERNAL_LINKS` disposition can be disabled upon request by creating a support
+   * case.
+   *
+   * See also [Security best practices](/sql/admin/sql-execution-tutorial.html#security-best-practices).
+   *
+   * ----
+   *
+   * StatementResponse contains `statement_id` and `status`; other fields might be absent or present depending on
+   * context. If the SQL warehouse fails to execute the provided statement, a 200 response is returned with
+   * `status.state` set to `FAILED` (in contrast to a failure when accepting the request, which results in a non-200
+   * response). Details of the error can be found at `status.error` in case of execution failures.
+   */
+  executeStatement(req: ExecuteStatementRequest, options?: CallOptions): Promise<StatementResponse>;
+  /**
+   * After the statement execution has `SUCCEEDED`, this request can be used to fetch any chunk by
+   * index. Whereas the first chunk with `chunk_index=0` is typically fetched with
+   * :method:statementexecution/executeStatement or :method:statementexecution/getStatement, this
+   * request can be used to fetch subsequent chunks. The response structure is identical to the
+   * nested `result` element described in the :method:statementexecution/getStatement request, and
+   * similarly includes the `next_chunk_index` and `next_chunk_internal_link` fields for simple
+   * iteration through the result set. Depending on `disposition`, the response returns chunks of
+   * data either inline, or as links.
+   */
+  getResultData(req: GetResultDataRequest, options?: CallOptions): Promise<ResultData>;
+  /**
+   * This request can be used to poll for the statement's status. StatementResponse contains
+   * `statement_id` and `status`; other fields might be absent or present depending on context.
+   * When the `status.state` field is `SUCCEEDED` it will also return the result manifest and the
+   * first chunk of the result data. When the statement is in the terminal states `CANCELED`,
+   * `CLOSED` or `FAILED`, it returns HTTP 200 with the state set. After at least 12 hours in
+   * terminal state, the statement is removed from the warehouse and further calls will receive an
+   * HTTP 404 response.
+   *
+   * **NOTE**
+   * This call currently might take up to 5 seconds to get the latest status and result.
+   */
+  getStatementResult(req: GetStatementResultRequest, options?: CallOptions): Promise<StatementResponse>;
 }
+//#endregion
+export { StatementExecutionClient };
 //# sourceMappingURL=client.d.ts.map

package/dist/v1/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/v1/client.ts"],"names":[],"mappings":"AAMA,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,wBAAwB;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAIhC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAInC,OAAO,CAAC,MAAM,CAA4C;gBAE9C,OAAO,EAAE,aAAa;IAUlC,OAAO,CAAC,aAAa;IAKrB;;;OAGG;IACG,eAAe,CACnB,GAAG,EAAE,sBAAsB,EAC3B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,uBAAuB,CAAC;IA0BnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACG,gBAAgB,CACpB,GAAG,EAAE,uBAAuB,EAC5B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,iBAAiB,CAAC;IA0B7B;;;;;;;;;OASG;IACG,aAAa,CACjB,GAAG,EAAE,oBAAoB,EACzB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,UAAU,CAAC;IAyBtB;;;;;;;;;;;OAWG;IACG,kBAAkB,CACtB,GAAG,EAAE,yBAAyB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,iBAAiB,CAAC;CAwB9B"}
+{"version":3,"file":"client.d.ts","names":[],"sources":["../../src/v1/client.ts"],"mappings":";;;;;cAyCa,wBAAA;EAAA,iBACM,OAAA;EAAA,iBACA,MAAA;EAAA,iBAIA,SAAA;EAAA,QAIT,MAAA;cAEI,OAAA,EAAS,aAAA;EAAA,QAUb,aAAA;EAWI;;;;EAFN,eAAA,CACJ,GAAA,EAAK,sBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,uBAAA;EAgFA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAHL,gBAAA,CACJ,GAAA,EAAK,uBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,iBAAA;;;;;;;;;;;EAoCL,aAAA,CACJ,GAAA,EAAK,oBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,UAAA;;;;;;;;;;;;;EAqCL,kBAAA,CACJ,GAAA,EAAK,yBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,iBAAA;AAAA"}