support for session params

Signed-off-by: Sreekanth Vadigi <[email protected]>

Author: sreekanth-db

examples/session_params.js

@@ -0,0 +1,29 @@
+const { DBSQLClient } = require('..');
+
+const client = new DBSQLClient();
+
+const host = process.env.DATABRICKS_HOST;
+const path = process.env.DATABRICKS_HTTP_PATH;
+const token = process.env.DATABRICKS_TOKEN;
+
+client
+  .connect({ host, path, token })
+  .then(async (client) => {
+    const session = await client.openSession({
+      configuration: {
+        QUERY_TAGS: 'team:engineering,test:session-params,driver:node',
+        ansi_mode: 'false',
+      },
+    });
+
+    const op = await session.executeStatement('SELECT 1');
+    const rows = await op.fetchAll();
+    console.log(rows);
+    await op.close();
+
+    await session.close();
+    await client.close();
+  })
+  .catch((error) => {
+    console.log(error);
+  });

lib/DBSQLClient.ts

@@ -221,6 +221,7 @@ export default class DBSQLClient extends EventEmitter implements IDBSQLClient, I
     const response = await this.driver.openSession({
       client_protocol_i64: new Int64(TProtocolVersion.SPARK_CLI_SERVICE_PROTOCOL_V8),
       ...getInitialNamespaceOptions(request.initialCatalog, request.initialSchema),
+      configuration: request.configuration,
       canUseMultipleCatalogs: true,
     });
 

lib/contracts/IDBSQLClient.ts

@@ -38,6 +38,7 @@ export type ConnectionOptions = {
 export interface OpenSessionRequest {
   initialCatalog?: string;
   initialSchema?: string;
+  configuration?: { [key: string]: string };
 }
 
 export default interface IDBSQLClient {

tests/e2e/query_parameters.test.ts

@@ -17,6 +17,9 @@ const openSession = async () => {
   return connection.openSession({
     initialCatalog: config.catalog,
     initialSchema: config.schema,
+    configuration: {
+      QUERY_TAGS: 'test:e2e,driver:node',
+    },
   });
 };
 

tests/unit/DBSQLClient.test.ts

@@ -185,6 +185,16 @@ describe('DBSQLClient.openSession', () => {
     }
   });
 
+  it('should pass session configuration to OpenSessionReq', async () => {
+    const client = new DBSQLClient();
+    const thriftClient = new ThriftClientStub();
+    sinon.stub(client, 'getClient').returns(Promise.resolve(thriftClient));
+
+    const configuration = { QUERY_TAGS: 'team:engineering', ansi_mode: 'true' };
+    await client.openSession({ configuration });
+    expect(thriftClient.openSessionReq?.configuration).to.deep.equal(configuration);
+  });
+
   it('should affect session behavior based on protocol version', async () => {
     const client = new DBSQLClient();
     const thriftClient = new ThriftClientStub();