@databricks/sql/dist/contracts/IDBSQLClient.d.ts

Driver for connection to Databricks SQL via Thrift API.

import IDBSQLLogger from './IDBSQLLogger';
import IDBSQLSession from './IDBSQLSession';
import IAuthentication from '../connection/contracts/IAuthentication';
import { ProxyOptions } from '../connection/contracts/IConnectionOptions';
import OAuthPersistence from '../connection/auth/DatabricksOAuth/OAuthPersistence';
export interface ClientOptions {
    logger?: IDBSQLLogger;
}
type AuthOptions = {
    authType?: 'access-token';
    token: string;
} | {
    authType: 'databricks-oauth';
    persistence?: OAuthPersistence;
    azureTenantId?: string;
    oauthClientId?: string;
    oauthClientSecret?: string;
    useDatabricksOAuthInAzure?: boolean;
} | {
    authType: 'custom';
    provider: IAuthentication;
};
export type ConnectionOptions = {
    host: string;
    port?: number;
    path: string;
    userAgentEntry?: string;
    socketTimeout?: number;
    proxy?: ProxyOptions;
} & AuthOptions;
export interface OpenSessionRequest {
    initialCatalog?: string;
    initialSchema?: string;
}
export default interface IDBSQLClient {
    connect(options: ConnectionOptions): Promise<IDBSQLClient>;
    openSession(request?: OpenSessionRequest): Promise<IDBSQLSession>;
    close(): Promise<void>;
}
export {};