@databricks/sdk-uc-catalogs 0.1.0-dev.3 → 0.1.0-dev.5

package/src/v1/client.ts

@@ -1,272 +0,0 @@
-// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
-
-import {VERSION as AUTH_VERSION} from '@databricks/sdk-auth';
-import {createDefault} from '@databricks/sdk-core/clientinfo';
-import type {Logger} from '@databricks/sdk-core/logger';
-import {NoOpLogger} from '@databricks/sdk-core/logger';
-import type {CallOptions} from '@databricks/sdk-options/call';
-import type {ClientOptions} from '@databricks/sdk-options/client';
-import type {HttpClient} from '@databricks/sdk-core/http';
-import {newHttpClient} from './transport';
-import {
-  buildHttpRequest,
-  executeCall,
-  executeHttpCall,
-  marshalRequest,
-  parseResponse,
-} from './utils';
-import pkgJson from '../../package.json' with {type: 'json'};
-import type {
-  CatalogInfo,
-  CreateCatalogRequest,
-  DeleteCatalogRequest,
-  DeleteCatalogResponse,
-  GetCatalogRequest,
-  ListCatalogsRequest,
-  ListCatalogsResponse,
-  UpdateCatalogRequest,
-} from './model';
-import {
-  marshalCreateCatalogRequestSchema,
-  marshalUpdateCatalogRequestSchema,
-  unmarshalCatalogInfoSchema,
-  unmarshalDeleteCatalogResponseSchema,
-  unmarshalListCatalogsResponseSchema,
-} from './model';
-
-// Package identity segment for this client to be used in the User-Agent header.
-const PACKAGE_SEGMENT = {
-  key: 'sdk-js-' + pkgJson.name.replace(/^@[^/]+\/sdk-/, ''),
-  value: pkgJson.version,
-};
-
-export class CatalogsClient {
-  private readonly host: string;
-  // Workspace ID used to route workspace-level calls on unified hosts (SPOG).
-  // When set, workspace-level methods send X-Databricks-Org-Id on every
-  // request.
-  private readonly workspaceId: string | undefined;
-  private readonly httpClient: HttpClient;
-  private readonly logger: Logger;
-  // User-Agent header value. Composed once at construction from
-  // createDefault() merged with this package's identity and the active
-  // credential's name.
-  private readonly userAgent: string;
-
-  constructor(options: ClientOptions) {
-    if (options.host === undefined) {
-      throw new Error('Host is required.');
-    }
-    this.host = options.host.replace(/\/$/, '');
-    this.workspaceId = options.workspaceId;
-    this.logger = options.logger ?? new NoOpLogger();
-    const info = createDefault()
-      .with(PACKAGE_SEGMENT)
-      .with({key: 'sdk-js-auth', value: AUTH_VERSION})
-      .with({key: 'auth', value: options.credentials?.name() ?? 'default'});
-    this.userAgent = info.toString();
-    this.httpClient = newHttpClient(options);
-  }
-
-  /** Creates a new catalog instance in the parent metastore if the caller is a metastore admin or has the **CREATE_CATALOG** privilege. */
-  async createCatalog(
-    req: CreateCatalogRequest,
-    options?: CallOptions
-  ): Promise<CatalogInfo> {
-    const url = `${this.host}/api/2.1/unity-catalog/catalogs`;
-    const body = marshalRequest(req, marshalCreateCatalogRequestSchema);
-    let resp: CatalogInfo | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers({'Content-Type': 'application/json'});
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('POST', url, headers, callSignal, body);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalCatalogInfoSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /** Deletes the catalog that matches the supplied name. The caller must be a metastore admin or the owner of the catalog. */
-  async deleteCatalog(
-    req: DeleteCatalogRequest,
-    options?: CallOptions
-  ): Promise<DeleteCatalogResponse> {
-    const url = `${this.host}/api/2.1/unity-catalog/catalogs/${req.nameArg ?? ''}`;
-    const params = new URLSearchParams();
-    if (req.force !== undefined) {
-      params.append('force', String(req.force));
-    }
-    const query = params.toString();
-    const fullUrl = query !== '' ? `${url}?${query}` : url;
-    let resp: DeleteCatalogResponse | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers();
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('DELETE', fullUrl, headers, callSignal);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalDeleteCatalogResponseSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /**
-   * Gets the specified catalog in a metastore.
-   * The caller must be a metastore admin, the owner of the catalog, or a user that has the **USE_CATALOG** privilege set for their account.
-   */
-  async getCatalog(
-    req: GetCatalogRequest,
-    options?: CallOptions
-  ): Promise<CatalogInfo> {
-    const url = `${this.host}/api/2.1/unity-catalog/catalogs/${req.nameArg ?? ''}`;
-    const params = new URLSearchParams();
-    if (req.includeBrowse !== undefined) {
-      params.append('include_browse', String(req.includeBrowse));
-    }
-    const query = params.toString();
-    const fullUrl = query !== '' ? `${url}?${query}` : url;
-    let resp: CatalogInfo | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers();
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('GET', fullUrl, headers, callSignal);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalCatalogInfoSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /**
-   * Gets an array of catalogs in the metastore.
-   * If the caller is the metastore admin, all catalogs will be retrieved.
-   * Otherwise, only catalogs owned by the caller (or for which the caller has the **USE_CATALOG** privilege) will be retrieved.
-   * There is no guarantee of a specific ordering of the elements in the array.
-   *
-   * 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.
-   */
-  async listCatalogs(
-    req: ListCatalogsRequest,
-    options?: CallOptions
-  ): Promise<ListCatalogsResponse> {
-    const url = `${this.host}/api/2.1/unity-catalog/catalogs`;
-    const params = new URLSearchParams();
-    if (req.includeBrowse !== undefined) {
-      params.append('include_browse', String(req.includeBrowse));
-    }
-    if (req.maxResults !== undefined) {
-      params.append('max_results', String(req.maxResults));
-    }
-    if (req.pageToken !== undefined) {
-      params.append('page_token', req.pageToken);
-    }
-    if (req.includeUnbound !== undefined) {
-      params.append('include_unbound', String(req.includeUnbound));
-    }
-    const query = params.toString();
-    const fullUrl = query !== '' ? `${url}?${query}` : url;
-    let resp: ListCatalogsResponse | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers();
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('GET', fullUrl, headers, callSignal);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalListCatalogsResponseSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  async *listCatalogsIter(
-    req: ListCatalogsRequest,
-    options?: CallOptions
-  ): AsyncGenerator<CatalogInfo> {
-    const pageReq: ListCatalogsRequest = {...req};
-    for (;;) {
-      const resp = await this.listCatalogs(pageReq, options);
-      for (const item of resp.catalogs ?? []) {
-        yield item;
-      }
-      if (resp.nextPageToken === undefined || resp.nextPageToken === '') {
-        return;
-      }
-      pageReq.pageToken = resp.nextPageToken;
-    }
-  }
-
-  /**
-   * Updates the catalog that matches the supplied name.
-   * The caller must be either the owner of the catalog, or a metastore admin (when changing the owner field of the catalog).
-   */
-  async updateCatalog(
-    req: UpdateCatalogRequest,
-    options?: CallOptions
-  ): Promise<CatalogInfo> {
-    const url = `${this.host}/api/2.1/unity-catalog/catalogs/${req.nameArg ?? ''}`;
-    const body = marshalRequest(req, marshalUpdateCatalogRequestSchema);
-    let resp: CatalogInfo | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers({'Content-Type': 'application/json'});
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('PATCH', url, headers, callSignal, body);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalCatalogInfoSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-}

package/src/v1/index.ts

@@ -1,31 +0,0 @@
-// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
-
-export {CatalogsClient} from './client';
-
-export {
-  CatalogIsolationMode,
-  CatalogType,
-  SecurableType,
-  ProvisioningInfo_State,
-} from './model';
-
-export type {
-  AzureEncryptionSettings,
-  CatalogInfo,
-  CatalogInfo_OptionsEntry,
-  CatalogInfo_PropertiesEntry,
-  CreateCatalogRequest,
-  CreateCatalogRequest_OptionsEntry,
-  CreateCatalogRequest_PropertiesEntry,
-  DeleteCatalogRequest,
-  DeleteCatalogResponse,
-  EffectivePredictiveOptimizationFlag,
-  EncryptionSettings,
-  GetCatalogRequest,
-  ListCatalogsRequest,
-  ListCatalogsResponse,
-  ProvisioningInfo,
-  UpdateCatalogRequest,
-  UpdateCatalogRequest_OptionsEntry,
-  UpdateCatalogRequest_PropertiesEntry,
-} from './model';