@databricks/sql/dist/DBSQLSession.d.ts

Driver for connection to Databricks SQL via Thrift API.

import Int64 from 'node-int64';
import { TSessionHandle, TProtocolVersion } from '../thrift/TCLIService_types';
import IDBSQLSession, { ExecuteStatementOptions, TypeInfoRequest, CatalogsRequest, SchemasRequest, TablesRequest, TableTypesRequest, ColumnsRequest, FunctionsRequest, PrimaryKeysRequest, CrossReferenceRequest } from './contracts/IDBSQLSession';
import IOperation from './contracts/IOperation';
import Status from './dto/Status';
import InfoValue from './dto/InfoValue';
import IClientContext from './contracts/IClientContext';
export declare function numberToInt64(value: number | bigint | Int64): Int64;
interface DBSQLSessionConstructorOptions {
    handle: TSessionHandle;
    context: IClientContext;
    serverProtocolVersion?: TProtocolVersion;
}
export default class DBSQLSession implements IDBSQLSession {
    private readonly context;
    private readonly sessionHandle;
    private isOpen;
    private serverProtocolVersion?;
    onClose?: () => void;
    private operations;
    /**
     * Helper method to determine if runAsync should be set for metadata operations
     * @private
     * @returns true if supported by protocol version, undefined otherwise
     */
    private getRunAsyncForMetadataOperations;
    constructor({ handle, context, serverProtocolVersion }: DBSQLSessionConstructorOptions);
    get id(): string;
    /**
     * Fetches info
     * @public
     * @param infoType - One of the values TCLIService_types.TGetInfoType
     * @returns Value corresponding to info type requested
     * @example
     * const response = await session.getInfo(thrift.TCLIService_types.TGetInfoType.CLI_DBMS_VER);
     */
    getInfo(infoType: number): Promise<InfoValue>;
    /**
     * Executes statement
     * @public
     * @param statement - SQL statement to be executed
     * @param options - maxRows field is used to specify Direct Results
     * @returns DBSQLOperation
     * @example
     * const operation = await session.executeStatement(query);
     */
    executeStatement(statement: string, options?: ExecuteStatementOptions): Promise<IOperation>;
    private handleStagingOperation;
    private handleStagingGet;
    private handleStagingRemove;
    private handleStagingPut;
    /**
     * Information about supported data types
     * @public
     * @param request
     * @returns DBSQLOperation
     */
    getTypeInfo(request?: TypeInfoRequest): Promise<IOperation>;
    /**
     * Get list of catalogs
     * @public
     * @param request
     * @returns DBSQLOperation
     */
    getCatalogs(request?: CatalogsRequest): Promise<IOperation>;
    /**
     * Get list of schemas
     * @public
     * @param request
     * @returns DBSQLOperation
     */
    getSchemas(request?: SchemasRequest): Promise<IOperation>;
    /**
     * Get list of tables
     * @public
     * @param request
     * @returns DBSQLOperation
     */
    getTables(request?: TablesRequest): Promise<IOperation>;
    /**
     * Get list of supported table types
     * @public
     * @param request
     * @returns DBSQLOperation
     */
    getTableTypes(request?: TableTypesRequest): Promise<IOperation>;
    /**
     * Get full information about columns of the table
     * @public
     * @param request
     * @returns DBSQLOperation
     */
    getColumns(request?: ColumnsRequest): Promise<IOperation>;
    /**
     * Get information about function
     * @public
     * @param request
     * @returns DBSQLOperation
     */
    getFunctions(request: FunctionsRequest): Promise<IOperation>;
    getPrimaryKeys(request: PrimaryKeysRequest): Promise<IOperation>;
    /**
     * Request information about foreign keys between two tables
     * @public
     * @param request
     * @returns DBSQLOperation
     */
    getCrossReference(request: CrossReferenceRequest): Promise<IOperation>;
    /**
     * Closes the session
     * @public
     * @returns Operation status
     */
    close(): Promise<Status>;
    private createOperation;
    private failIfClosed;
    private handleResponse;
}
export {};