@databricks/sdk-queries 0.1.0-dev.3 → 0.1.0-dev.4

package/src/v1/client.ts

@@ -1,297 +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 {
-  CreateQueryRequest,
-  Empty,
-  GetQueryRequest,
-  ListQueriesRequest,
-  ListQueriesResponse,
-  ListQueryObjectsResponseQuery,
-  ListVisualizationsForQueryRequest,
-  ListVisualizationsForQueryResponse,
-  Query,
-  TrashQueryRequest,
-  UpdateQueryRequest,
-  Visualization,
-} from './model';
-import {
-  marshalCreateQueryRequestSchema,
-  marshalUpdateQueryRequestSchema,
-  unmarshalEmptySchema,
-  unmarshalListQueriesResponseSchema,
-  unmarshalListVisualizationsForQueryResponseSchema,
-  unmarshalQuerySchema,
-} 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 QueriesClient {
-  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 query. */
-  async createQuery(
-    req: CreateQueryRequest,
-    options?: CallOptions
-  ): Promise<Query> {
-    const url = `${this.host}/api/2.0/sql/queries`;
-    const body = marshalRequest(req, marshalCreateQueryRequestSchema);
-    let resp: Query | 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, unmarshalQuerySchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /** Gets a query. */
-  async getQuery(req: GetQueryRequest, options?: CallOptions): Promise<Query> {
-    const url = `${this.host}/api/2.0/sql/queries/${req.id ?? ''}`;
-    let resp: Query | 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', url, headers, callSignal);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalQuerySchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /** Gets a list of queries accessible to the user, ordered by creation time. **Warning:** Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban. */
-  async listQueries(
-    req: ListQueriesRequest,
-    options?: CallOptions
-  ): Promise<ListQueriesResponse> {
-    const url = `${this.host}/api/2.0/sql/queries`;
-    const params = new URLSearchParams();
-    if (req.pageToken !== undefined) {
-      params.append('page_token', req.pageToken);
-    }
-    if (req.pageSize !== undefined) {
-      params.append('page_size', String(req.pageSize));
-    }
-    const query = params.toString();
-    const fullUrl = query !== '' ? `${url}?${query}` : url;
-    let resp: ListQueriesResponse | 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, unmarshalListQueriesResponseSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  async *listQueriesIter(
-    req: ListQueriesRequest,
-    options?: CallOptions
-  ): AsyncGenerator<ListQueryObjectsResponseQuery> {
-    const pageReq: ListQueriesRequest = {...req};
-    for (;;) {
-      const resp = await this.listQueries(pageReq, options);
-      for (const item of resp.results ?? []) {
-        yield item;
-      }
-      if (resp.nextPageToken === undefined || resp.nextPageToken === '') {
-        return;
-      }
-      pageReq.pageToken = resp.nextPageToken;
-    }
-  }
-
-  /** Gets a list of visualizations on a query. */
-  async listVisualizationsForQuery(
-    req: ListVisualizationsForQueryRequest,
-    options?: CallOptions
-  ): Promise<ListVisualizationsForQueryResponse> {
-    const url = `${this.host}/api/2.0/sql/queries/${req.id ?? ''}/visualizations`;
-    const params = new URLSearchParams();
-    if (req.pageToken !== undefined) {
-      params.append('page_token', req.pageToken);
-    }
-    if (req.pageSize !== undefined) {
-      params.append('page_size', String(req.pageSize));
-    }
-    const query = params.toString();
-    const fullUrl = query !== '' ? `${url}?${query}` : url;
-    let resp: ListVisualizationsForQueryResponse | 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,
-        unmarshalListVisualizationsForQueryResponseSchema
-      );
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  async *listVisualizationsForQueryIter(
-    req: ListVisualizationsForQueryRequest,
-    options?: CallOptions
-  ): AsyncGenerator<Visualization> {
-    const pageReq: ListVisualizationsForQueryRequest = {...req};
-    for (;;) {
-      const resp = await this.listVisualizationsForQuery(pageReq, options);
-      for (const item of resp.results ?? []) {
-        yield item;
-      }
-      if (resp.nextPageToken === undefined || resp.nextPageToken === '') {
-        return;
-      }
-      pageReq.pageToken = resp.nextPageToken;
-    }
-  }
-
-  /** Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and cannot be used for alerts. You can restore a trashed query through the UI. A trashed query is permanently deleted after 30 days. */
-  async trashQuery(
-    req: TrashQueryRequest,
-    options?: CallOptions
-  ): Promise<Empty> {
-    const url = `${this.host}/api/2.0/sql/queries/${req.id ?? ''}`;
-    let resp: Empty | 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', url, headers, callSignal);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalEmptySchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /** Updates a query. */
-  async updateQuery(
-    req: UpdateQueryRequest,
-    options?: CallOptions
-  ): Promise<Query> {
-    const url = `${this.host}/api/2.0/sql/queries/${req.id ?? ''}`;
-    const body = marshalRequest(req, marshalUpdateQueryRequestSchema);
-    let resp: Query | 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, unmarshalQuerySchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-}

package/src/v1/index.ts

@@ -1,39 +0,0 @@
-// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
-
-export {QueriesClient} from './client';
-
-export {
-  DatePrecision,
-  LifecycleState,
-  RunAsMode,
-  DateRangeValue_DynamicDateRange,
-  DateValue_DynamicDate,
-} from './model';
-
-export type {
-  CreateQueryRequest,
-  CreateQueryRequestQuery,
-  DateRange,
-  DateRangeValue,
-  DateValue,
-  Empty,
-  EnumValue,
-  GetQueryRequest,
-  ListQueriesRequest,
-  ListQueriesResponse,
-  ListQueryObjectsResponseQuery,
-  ListVisualizationsForQueryRequest,
-  ListVisualizationsForQueryResponse,
-  MultiValuesOptions,
-  NumericValue,
-  Query,
-  QueryBackedValue,
-  QueryParameter,
-  TextValue,
-  TrashQueryRequest,
-  UpdateQueryRequest,
-  UpdateQueryRequestQuery,
-  Visualization,
-} from './model';
-
-export {updateQueryRequestQueryFieldMask} from './model';