@databricks/sdk-uc-tables 0.34.0 → 0.36.0

package/dist/package.js

@@ -0,0 +1,7 @@
+//#region package.json
+var name = "@databricks/sdk-uc-tables";
+var version = "0.36.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,127 +1,131 @@
-import type { CallOptions } from '@databricks/sdk-options/call';
-import type { ClientOptions } from '@databricks/sdk-options/client';
-import type { CreateTableConstraintRequest, CreateTableRequest, DeleteTableConstraintRequest, DeleteTableConstraintResponse, DeleteTableRequest, DeleteTableResponse, GetTableRequest, ListTableSummariesRequest, ListTableSummariesResponse, ListTablesRequest, ListTablesResponse, TableConstraint, TableExistsRequest, TableExistsResponse, TableInfo, TableSummary, UpdateTableRequest, UpdateTableResponse } from './model';
-export declare class TablesClient {
-    private readonly options;
-    private readonly logger;
-    private readonly userAgent;
-    private config;
-    constructor(options: ClientOptions);
-    private resolveConfig;
-    /**
-     * Creates a new table in the specified catalog and schema.
-     *
-     * To create an external delta table, the caller must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema
-     * and the **EXTERNAL_USE_LOCATION** privilege on the external location. These privileges must always be granted explicitly,
-     * and cannot be inherited through ownership or **ALL_PRIVILEGES**.
-     *
-     * Standard UC permissions needed to create tables still apply: **USE_CATALOG** on the parent catalog (or ownership of
-     * the parent catalog), **CREATE_TABLE** and **USE_SCHEMA** on the parent schema (or ownership of the parent schema),
-     * and **CREATE_EXTERNAL_TABLE** on external location.
-     *
-     * The **columns** field needs to be in a Spark compatible format, so we recommend you use Spark to create these tables.
-     * The API itself does not validate the correctness of the column spec. If the spec is not Spark compatible,
-     * the tables may not be readable by Databricks Runtime.
-     *
-     *
-     *
-     *
-     *
-     *
-     *
-     * NOTE: The Create Table API for external clients only supports creating **external delta tables**. The values shown
-     * in the respective enums are all values supported by <Databricks>, however for this specific Create Table API,
-     * only **table_type** **EXTERNAL** and **data_source_format** **DELTA** are supported. Additionally, column masks
-     * are not supported when creating tables through this API.
-     */
-    createTable(req: CreateTableRequest, options?: CallOptions): Promise<TableInfo>;
-    /**
-     * Creates a new table constraint.
-     *
-     * For the table constraint creation to succeed, the user must satisfy both of these conditions:
-     * - the user must have the **USE_CATALOG** privilege on the table's parent catalog,
-     * the **USE_SCHEMA** privilege on the table's parent schema, and be the owner of the table.
-     * - if the new constraint is a __ForeignKeyConstraint__,
-     * the user must have the **USE_CATALOG** privilege on the referenced parent table's catalog,
-     * the **USE_SCHEMA** privilege on the referenced parent table's schema,
-     * and be the owner of the referenced parent table.
-     */
-    createTableConstraint(req: CreateTableConstraintRequest, options?: CallOptions): Promise<TableConstraint>;
-    /**
-     * Deletes a table from the specified parent catalog and schema.
-     * The caller must be the owner of the parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner of the parent schema,
-     * or be the owner of the table and have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
-     */
-    deleteTable(req: DeleteTableRequest, options?: CallOptions): Promise<DeleteTableResponse>;
-    /**
-     * Deletes a table constraint.
-     *
-     * For the table constraint deletion to succeed, the user must satisfy both of these conditions:
-     * - the user must have the **USE_CATALOG** privilege on the table's parent catalog,
-     * the **USE_SCHEMA** privilege on the table's parent schema, and be the owner of the table.
-     * - if __cascade__ argument is **true**, the user must have the following permissions on all of the child tables:
-     * the **USE_CATALOG** privilege on the table's catalog,
-     * the **USE_SCHEMA** privilege on the table's schema,
-     * and be the owner of the table.
-     */
-    deleteTableConstraint(req: DeleteTableConstraintRequest, options?: CallOptions): Promise<DeleteTableConstraintResponse>;
-    /**
-     * Gets a table from the metastore for a specific catalog and schema.
-     * The caller must satisfy one of the following requirements:
-     * * Be a metastore admin
-     * * Be the owner of the parent catalog
-     * * Be the owner of the parent schema and have the **USE_CATALOG** privilege on the parent catalog
-     * * Have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema,
-     * and either be the table owner or have the **SELECT** privilege on the table.
-     */
-    getTable(req: GetTableRequest, options?: CallOptions): Promise<TableInfo>;
-    /**
-     * Gets an array of summaries for tables for a schema and catalog within the metastore. The table summaries returned are either:
-     *
-     * * summaries for tables (within the current metastore and parent catalog and schema), when the user is a metastore admin, or:
-     * * summaries for tables and schemas (within the current metastore and parent catalog)
-     * for which the user has ownership or the **SELECT** privilege on the table and ownership or **USE_SCHEMA** privilege on the schema,
-     * provided that the user also has ownership or the **USE_CATALOG** privilege on the parent catalog.
-     *
-     * There is no guarantee of a specific ordering of the elements in the array.
-     *
-     * PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token.
-     * Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.
-     */
-    listTableSummaries(req: ListTableSummariesRequest, options?: CallOptions): Promise<ListTableSummariesResponse>;
-    listTableSummariesIter(req: ListTableSummariesRequest, options?: CallOptions): AsyncGenerator<TableSummary>;
-    /**
-     * Gets an array of all tables for the current metastore under the parent catalog and schema.
-     * The caller must be a metastore admin or an owner of (or have the **SELECT** privilege on) the table.
-     * For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
-     * There is no guarantee of a specific ordering of the elements in the array.
-     *
-     * NOTE: **view_dependencies** and **table_constraints** are not returned by ListTables queries.
-     *
-     * NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.
-     *
-     * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token.
-     * Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.
-     */
-    listTables(req: ListTablesRequest, options?: CallOptions): Promise<ListTablesResponse>;
-    listTablesIter(req: ListTablesRequest, options?: CallOptions): AsyncGenerator<TableInfo>;
-    /**
-     * Gets if a table exists in the metastore for a specific catalog and schema.
-     * The caller must satisfy one of the following requirements:
-     * * Be a metastore admin
-     * * Be the owner of the parent catalog
-     * * Be the owner of the parent schema and have the **USE_CATALOG** privilege on the parent catalog
-     * * Have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema,
-     * and either be the table owner or have the **SELECT** privilege on the table.
-     * * Have **BROWSE** privilege on the parent catalog
-     * * Have **BROWSE** privilege on the parent schema
-     */
-    tableExists(req: TableExistsRequest, options?: CallOptions): Promise<TableExistsResponse>;
-    /**
-     * Change the owner of the table.
-     * The caller must be the owner of the parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner of the parent schema,
-     * or be the owner of the table and have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
-     */
-    updateTable(req: UpdateTableRequest, options?: CallOptions): Promise<UpdateTableResponse>;
+import { CreateTableConstraintRequest, CreateTableRequest, DeleteTableConstraintRequest, DeleteTableConstraintResponse, DeleteTableRequest, DeleteTableResponse, GetTableRequest, ListTableSummariesRequest, ListTableSummariesResponse, ListTablesRequest, ListTablesResponse, TableConstraint, TableExistsRequest, TableExistsResponse, TableInfo, TableSummary, UpdateTableRequest, UpdateTableResponse } 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 TablesClient {
+  private readonly options;
+  private readonly logger;
+  private readonly userAgent;
+  private config;
+  constructor(options: ClientOptions);
+  private resolveConfig;
+  /**
+   * Creates a new table in the specified catalog and schema.
+   *
+   * To create an external delta table, the caller must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema
+   * and the **EXTERNAL_USE_LOCATION** privilege on the external location. These privileges must always be granted explicitly,
+   * and cannot be inherited through ownership or **ALL_PRIVILEGES**.
+   *
+   * Standard UC permissions needed to create tables still apply: **USE_CATALOG** on the parent catalog (or ownership of
+   * the parent catalog), **CREATE_TABLE** and **USE_SCHEMA** on the parent schema (or ownership of the parent schema),
+   * and **CREATE_EXTERNAL_TABLE** on external location.
+   *
+   * The **columns** field needs to be in a Spark compatible format, so we recommend you use Spark to create these tables.
+   * The API itself does not validate the correctness of the column spec. If the spec is not Spark compatible,
+   * the tables may not be readable by Databricks Runtime.
+   *
+   *
+   *
+   *
+   *
+   *
+   *
+   * NOTE: The Create Table API for external clients only supports creating **external delta tables**. The values shown
+   * in the respective enums are all values supported by <Databricks>, however for this specific Create Table API,
+   * only **table_type** **EXTERNAL** and **data_source_format** **DELTA** are supported. Additionally, column masks
+   * are not supported when creating tables through this API.
+   */
+  createTable(req: CreateTableRequest, options?: CallOptions): Promise<TableInfo>;
+  /**
+   * Creates a new table constraint.
+   *
+   * For the table constraint creation to succeed, the user must satisfy both of these conditions:
+   * - the user must have the **USE_CATALOG** privilege on the table's parent catalog,
+   * the **USE_SCHEMA** privilege on the table's parent schema, and be the owner of the table.
+   * - if the new constraint is a __ForeignKeyConstraint__,
+   * the user must have the **USE_CATALOG** privilege on the referenced parent table's catalog,
+   * the **USE_SCHEMA** privilege on the referenced parent table's schema,
+   * and be the owner of the referenced parent table.
+   */
+  createTableConstraint(req: CreateTableConstraintRequest, options?: CallOptions): Promise<TableConstraint>;
+  /**
+   * Deletes a table from the specified parent catalog and schema.
+   * The caller must be the owner of the parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner of the parent schema,
+   * or be the owner of the table and have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
+   */
+  deleteTable(req: DeleteTableRequest, options?: CallOptions): Promise<DeleteTableResponse>;
+  /**
+   * Deletes a table constraint.
+   *
+   * For the table constraint deletion to succeed, the user must satisfy both of these conditions:
+   * - the user must have the **USE_CATALOG** privilege on the table's parent catalog,
+   * the **USE_SCHEMA** privilege on the table's parent schema, and be the owner of the table.
+   * - if __cascade__ argument is **true**, the user must have the following permissions on all of the child tables:
+   * the **USE_CATALOG** privilege on the table's catalog,
+   * the **USE_SCHEMA** privilege on the table's schema,
+   * and be the owner of the table.
+   */
+  deleteTableConstraint(req: DeleteTableConstraintRequest, options?: CallOptions): Promise<DeleteTableConstraintResponse>;
+  /**
+   * Gets a table from the metastore for a specific catalog and schema.
+   * The caller must satisfy one of the following requirements:
+   * * Be a metastore admin
+   * * Be the owner of the parent catalog
+   * * Be the owner of the parent schema and have the **USE_CATALOG** privilege on the parent catalog
+   * * Have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema,
+   * and either be the table owner or have the **SELECT** privilege on the table.
+   */
+  getTable(req: GetTableRequest, options?: CallOptions): Promise<TableInfo>;
+  /**
+   * Gets an array of summaries for tables for a schema and catalog within the metastore. The table summaries returned are either:
+   *
+   * * summaries for tables (within the current metastore and parent catalog and schema), when the user is a metastore admin, or:
+   * * summaries for tables and schemas (within the current metastore and parent catalog)
+   * for which the user has ownership or the **SELECT** privilege on the table and ownership or **USE_SCHEMA** privilege on the schema,
+   * provided that the user also has ownership or the **USE_CATALOG** privilege on the parent catalog.
+   *
+   * There is no guarantee of a specific ordering of the elements in the array.
+   *
+   * PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token.
+   * Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.
+   */
+  listTableSummaries(req: ListTableSummariesRequest, options?: CallOptions): Promise<ListTableSummariesResponse>;
+  listTableSummariesIter(req: ListTableSummariesRequest, options?: CallOptions): AsyncGenerator<TableSummary>;
+  /**
+   * Gets an array of all tables for the current metastore under the parent catalog and schema.
+   * The caller must be a metastore admin or an owner of (or have the **SELECT** privilege on) the table.
+   * For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
+   * There is no guarantee of a specific ordering of the elements in the array.
+   *
+   * NOTE: **view_dependencies** and **table_constraints** are not returned by ListTables queries.
+   *
+   * NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.
+   *
+   * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token.
+   * Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.
+   */
+  listTables(req: ListTablesRequest, options?: CallOptions): Promise<ListTablesResponse>;
+  listTablesIter(req: ListTablesRequest, options?: CallOptions): AsyncGenerator<TableInfo>;
+  /**
+   * Gets if a table exists in the metastore for a specific catalog and schema.
+   * The caller must satisfy one of the following requirements:
+   * * Be a metastore admin
+   * * Be the owner of the parent catalog
+   * * Be the owner of the parent schema and have the **USE_CATALOG** privilege on the parent catalog
+   * * Have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema,
+   * and either be the table owner or have the **SELECT** privilege on the table.
+   * * Have **BROWSE** privilege on the parent catalog
+   * * Have **BROWSE** privilege on the parent schema
+   */
+  tableExists(req: TableExistsRequest, options?: CallOptions): Promise<TableExistsResponse>;
+  /**
+   * Change the owner of the table.
+   * The caller must be the owner of the parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner of the parent schema,
+   * or be the owner of the table and have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
+   */
+  updateTable(req: UpdateTableRequest, options?: CallOptions): Promise<UpdateTableResponse>;
 }
+//#endregion
+export { TablesClient };
 //# 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,4BAA4B,EAC5B,kBAAkB,EAClB,4BAA4B,EAC5B,6BAA6B,EAC7B,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,EACf,yBAAyB,EACzB,0BAA0B,EAC1B,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,SAAS,EACT,YAAY,EACZ,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,SAAS,CAAC;AAqBjB,qBAAa,YAAY;IACvB,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;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,WAAW,CACf,GAAG,EAAE,kBAAkB,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,SAAS,CAAC;IA0BrB;;;;;;;;;;OAUG;IACG,qBAAqB,CACzB,GAAG,EAAE,4BAA4B,EACjC,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,eAAe,CAAC;IA0B3B;;;;OAIG;IACG,WAAW,CACf,GAAG,EAAE,kBAAkB,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,mBAAmB,CAAC;IAyB/B;;;;;;;;;;OAUG;IACG,qBAAqB,CACzB,GAAG,EAAE,4BAA4B,EACjC,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,6BAA6B,CAAC;IAqCzC;;;;;;;;OAQG;IACG,QAAQ,CACZ,GAAG,EAAE,eAAe,EACpB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,SAAS,CAAC;IAwCrB;;;;;;;;;;;;OAYG;IACG,kBAAkB,CACtB,GAAG,EAAE,yBAAyB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,0BAA0B,CAAC;IAiD/B,sBAAsB,CAC3B,GAAG,EAAE,yBAAyB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,cAAc,CAAC,YAAY,CAAC;IAc/B;;;;;;;;;;;;OAYG;IACG,UAAU,CACd,GAAG,EAAE,iBAAiB,EACtB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,kBAAkB,CAAC;IA0DvB,cAAc,CACnB,GAAG,EAAE,iBAAiB,EACtB,OAAO,CAAC,EAAE,WAAW,GACpB,cAAc,CAAC,SAAS,CAAC;IAc5B;;;;;;;;;;OAUG;IACG,WAAW,CACf,GAAG,EAAE,kBAAkB,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,mBAAmB,CAAC;IAyB/B;;;;OAIG;IACG,WAAW,CACf,GAAG,EAAE,kBAAkB,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,mBAAmB,CAAC;CAyBhC"}
+{"version":3,"file":"client.d.ts","names":[],"sources":["../../src/v1/client.ts"],"mappings":";;;;;cA0Da,YAAA;EAAA,iBACM,OAAA;EAAA,iBACA,MAAA;EAAA,iBAIA,SAAA;EAAA,QAIT,MAAA;cAEI,OAAA,EAAS,aAAA;EAAA,QAUb,aAAA;EAiCI;;;;;;;;;;;;;;;;;;;;;;;;;;EAFN,WAAA,CACJ,GAAA,EAAK,kBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,SAAA;EA0SJ;;;;;;;;;;;EArQD,qBAAA,CACJ,GAAA,EAAK,4BAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,eAAA;EA4XJ;;;;;EA7VD,WAAA,CACJ,GAAA,EAAK,kBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,mBAAA;EAjIM;;;;;;;;;;;EAqKX,qBAAA,CACJ,GAAA,EAAK,4BAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,6BAAA;EAlHT;;;;;;;;;EAgKI,QAAA,CACJ,GAAA,EAAK,eAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,SAAA;EA3FL;;;;;;;;;;;;;EAgJA,kBAAA,CACJ,GAAA,EAAK,yBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,0BAAA;EAiDJ,sBAAA,CACL,GAAA,EAAK,yBAAA,EACL,OAAA,GAAU,WAAA,GACT,cAAA,CAAe,YAAA;EA9GX;;;;;;;;;;;;;EAyID,UAAA,CACJ,GAAA,EAAK,iBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,kBAAA;EA0DJ,cAAA,CACL,GAAA,EAAK,iBAAA,EACL,OAAA,GAAU,WAAA,GACT,cAAA,CAAe,SAAA;EA7FhB;;;;;;;;;;;EAsHI,WAAA,CACJ,GAAA,EAAK,kBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,mBAAA;EA/BJ;;;;;EA6DD,WAAA,CACJ,GAAA,EAAK,kBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,mBAAA;AAAA"}