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

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2026 Databricks, Inc.  All rights reserved.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/v1/client.d.ts

@@ -0,0 +1,127 @@
+import type { CallOptions } from '@databricks/sdk-options/call';
+import type { ClientOptions } from '@databricks/sdk-options/client';
+import type { CreateTableConstraintRequest, CreateTableRequest, DeleteTableConstraintRequest, DeleteTableConstraintRequest_Response, DeleteTableRequest, DeleteTableRequest_Response, GetTableRequest, ListTableSummariesRequest, ListTableSummariesRequest_Response, ListTablesRequest, ListTablesRequest_Response, TableConstraint, TableExistsRequest, TableExistsRequest_Response, TableInfo, TableSummary, UpdateTableRequest, UpdateTableRequest_Response } from './model';
+export declare class TablesClient {
+    private readonly host;
+    private readonly workspaceId;
+    private readonly httpClient;
+    private readonly logger;
+    private readonly userAgent;
+    constructor(options: ClientOptions);
+    /**
+     * 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<DeleteTableRequest_Response>;
+    /**
+     * 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<DeleteTableConstraintRequest_Response>;
+    /**
+     * 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<ListTableSummariesRequest_Response>;
+    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<ListTablesRequest_Response>;
+    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<TableExistsRequest_Response>;
+    /**
+     * 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<UpdateTableRequest_Response>;
+}
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +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,4BAA4B,EAC5B,kBAAkB,EAClB,4BAA4B,EAC5B,qCAAqC,EACrC,kBAAkB,EAClB,2BAA2B,EAC3B,eAAe,EACf,yBAAyB,EACzB,kCAAkC,EAClC,iBAAiB,EACjB,0BAA0B,EAC1B,eAAe,EACf,kBAAkB,EAClB,2BAA2B,EAC3B,SAAS,EACT,YAAY,EACZ,kBAAkB,EAClB,2BAA2B,EAC5B,MAAM,SAAS,CAAC;AAqBjB,qBAAa,YAAY;IACvB,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;IAelC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,WAAW,CACf,GAAG,EAAE,kBAAkB,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,SAAS,CAAC;IAyBrB;;;;;;;;;;OAUG;IACG,qBAAqB,CACzB,GAAG,EAAE,4BAA4B,EACjC,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,eAAe,CAAC;IAyB3B;;;;OAIG;IACG,WAAW,CACf,GAAG,EAAE,kBAAkB,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,2BAA2B,CAAC;IA2BvC;;;;;;;;;;OAUG;IACG,qBAAqB,CACzB,GAAG,EAAE,4BAA4B,EACjC,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qCAAqC,CAAC;IAoCjD;;;;;;;;OAQG;IACG,QAAQ,CACZ,GAAG,EAAE,eAAe,EACpB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,SAAS,CAAC;IAuCrB;;;;;;;;;;;;OAYG;IACG,kBAAkB,CACtB,GAAG,EAAE,yBAAyB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,kCAAkC,CAAC;IAmDvC,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,0BAA0B,CAAC;IAyD/B,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,2BAA2B,CAAC;IA2BvC;;;;OAIG;IACG,WAAW,CACf,GAAG,EAAE,kBAAkB,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,2BAA2B,CAAC;CA2BxC"}