fix(metadata): accept null and empty primary-key namespace

Signed-off-by: Vu Anh Phung <vu.phung@databricks.com>

Author: vuanhphung

lib/contracts/IDBSQLSession.ts

@@ -122,8 +122,8 @@ export type FunctionsRequest = {
 };
 
 export type PrimaryKeysRequest = {
-  catalogName?: string;
-  schemaName: string;
+  catalogName?: string | null;
+  schemaName?: string | null;
   tableName: string;
   /**
    * @deprecated This option is no longer supported and will be removed in future releases

lib/kernel/KernelSessionBackend.ts

@@ -393,19 +393,8 @@ export default class KernelSessionBackend implements ISessionBackend {
 
   public async getPrimaryKeys(request: PrimaryKeysRequest): Promise<IOperationBackend> {
     this.failIfClosed();
-    // The kernel requires a catalog for primary-key lookup (`Identifier::new`
-    // rejects an empty string). The Thrift backend can forward an undefined
-    // catalog and let the server resolve a default; the kernel path cannot,
-    // so reject up front with a clear, actionable message rather than passing
-    // `''` and surfacing the kernel's opaque "identifier must not be empty".
-    if (request.catalogName === undefined || request.catalogName === '') {
-      throw new HiveDriverError(
-        'kernel getPrimaryKeys requires a catalog — pass `catalogName` explicitly. (The Thrift backend ' +
-          'can omit it and let the server resolve a default; the kernel kernel path requires it.)',
-      );
-    }
     return this.runMetadata(() =>
-      this.connection.getPrimaryKeys(request.catalogName as string, request.schemaName, request.tableName),
+      this.connection.getPrimaryKeys(request.catalogName, request.schemaName, request.tableName),
     );
   }
 

lib/thrift-backend/ThriftSessionBackend.ts

@@ -302,8 +302,8 @@ export default class ThriftSessionBackend implements ISessionBackend {
     const driver = await this.context.getDriver();
     const response = await driver.getPrimaryKeys({
       sessionHandle: this.sessionHandle,
-      catalogName: request.catalogName,
-      schemaName: request.schemaName,
+      catalogName: request.catalogName ?? undefined,
+      schemaName: request.schemaName ?? undefined,
       tableName: request.tableName,
       runAsync: this.getRunAsyncForMetadataOperations(),
       ...getDirectResultsOptions(request.maxRows, this.context.getConfig()),

native/kernel/index.d.ts

@@ -514,6 +514,21 @@ describe('DBSQLSession', () => {
   });
 
   describe('getPrimaryKeys', () => {
+    it('should omit null namespace fields and preserve empty strings for Thrift', async () => {
+      for (const catalogName of [undefined, null, '', 'catalog']) {
+        for (const schemaName of [undefined, null, '', 'schema']) {
+          const context = new ClientContextStub();
+          const session = createSessionForTest({ handle: sessionHandleStub, context });
+          // eslint-disable-next-line no-await-in-loop
+          const result = await session.getPrimaryKeys({ catalogName, schemaName, tableName: 't1' });
+          expect(result).instanceOf(DBSQLOperation);
+          expect(context.driver.getPrimaryKeysReq?.catalogName).to.equal(catalogName ?? undefined);
+          expect(context.driver.getPrimaryKeysReq?.schemaName).to.equal(schemaName ?? undefined);
+          expect(context.driver.getPrimaryKeysReq?.tableName).to.equal('t1');
+        }
+      }
+    });
+
     it('should run operation', async () => {
       const session = createSessionForTest({ handle: sessionHandleStub, context: new ClientContextStub() });
       const result = await session.getPrimaryKeys({

tests/unit/DBSQLSession.test.ts

@@ -1094,25 +1094,19 @@ describe('KernelSessionBackend', () => {
     ]);
   });
 
-  it('getPrimaryKeys rejects an omitted catalog up front (the kernel requires one)', async () => {
+  it('getPrimaryKeys forwards null, omitted, and empty namespace names unchanged', async () => {
     const connection = new FakeNativeConnection();
     const session = makeSession(connection);
-    for (const request of [
-      { schemaName: 'def', tableName: 't' },
-      { catalogName: '', schemaName: 'def', tableName: 't' },
-    ]) {
-      let thrown: unknown;
-      try {
+    const expected: unknown[][] = [];
+    for (const catalogName of [undefined, null, '', 'main']) {
+      for (const schemaName of [undefined, null, '', 'def']) {
         // eslint-disable-next-line no-await-in-loop
-        await session.getPrimaryKeys(request);
-      } catch (err) {
-        thrown = err;
+        const operation = await session.getPrimaryKeys({ catalogName, schemaName, tableName: 't' });
+        expect(operation).to.be.instanceOf(KernelOperationBackend);
+        expected.push(['getPrimaryKeys', catalogName, schemaName, 't']);
       }
-      expect(thrown, `expected reject for ${JSON.stringify(request)}`).to.be.instanceOf(HiveDriverError);
-      expect((thrown as Error).message).to.match(/requires a catalog/);
     }
-    // The kernel call must NOT be reached (no empty-identifier sent over FFI).
-    expect(connection.metadataCalls.filter((c) => c[0] === 'getPrimaryKeys')).to.have.length(0);
+    expect(connection.metadataCalls).to.deep.equal(expected);
   });
 
   it('getInfo synthesizes the three server-answered info types and rejects the rest', async () => {