chore: indexeddbm table metadata (#43)

* add: table metadata

* update: tests

* update: const

* bump: version

* cleanup

* update: changes

* fix: build

* fix: test

* update: test name

Author: vpbs2

meerkat-dbm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devrev/meerkat-dbm",
-  "version": "0.0.135",
+  "version": "0.0.136",
   "dependencies": {
     "tslib": "^2.3.0",
     "@duckdb/duckdb-wasm": "^1.28.0",

meerkat-dbm/src/dbm/dbm.spec.ts

@@ -4,21 +4,29 @@ import {
   FileBufferStore,
   FileData,
   FileManagerType,
+  Table,
 } from '../file-manager/file-manager-type';
 import { DBM, DBMConstructorOptions } from './dbm';
 import { InstanceManagerType } from './instance-manager';
 
 export class MockFileManager implements FileManagerType {
   private fileBufferStore: Record<string, FileBufferStore> = {};
+  private tables: Record<string, Table> = {};
 
   async bulkRegisterFileBuffer(props: FileBufferStore[]): Promise<void> {
     for (const prop of props) {
       this.fileBufferStore[prop.fileName] = prop;
+      this.tables[prop.tableName] = this.tables[prop.tableName] || {
+        files: [],
+      };
+      this.tables[prop.tableName].files.push(...props);
     }
   }
 
   async registerFileBuffer(prop: FileBufferStore): Promise<void> {
     this.fileBufferStore[prop.fileName] = prop;
+    this.tables[prop.tableName] = this.tables[prop.tableName] || { files: [] };
+    this.tables[prop.tableName].files.push(prop);
   }
 
   async getFileBuffer(name: string): Promise<Uint8Array> {
@@ -101,6 +109,14 @@ export class MockFileManager implements FileManagerType {
     return data;
   }
 
+  async getTableData(tableName: string): Promise<Table | undefined> {
+    return this.tables[tableName];
+  }
+
+  async setTableMetadata(table: string, metadata: object): Promise<void> {
+    this.tables[table].metadata = metadata;
+  }
+
   onDBShutdownHandler = jest.fn(async () => {
     // do nothing
   });

meerkat-dbm/src/file-manager/file-manager-type.ts

@@ -14,7 +14,8 @@ export interface FileManagerType {
   registerFileBuffer: (props: FileBufferStore) => Promise<void>;
   getFileBuffer: (name: string) => Promise<Uint8Array | undefined>;
   mountFileBufferByTableNames: (tableName: string[]) => Promise<void>;
-  getFilesByTableName(tableName: string): Promise<FileData[]>;
+  getTableData(tableName: string): Promise<Table | undefined>;
+  setTableMetadata(tableName: string, metadata: object): Promise<void>;
   dropFilesByTableName(tableName: string, fileNames: string[]): Promise<void>;
   getFilesNameForTables(tableNames: string[]): Promise<
     {

meerkat-dbm/src/file-manager/indexed-db/indexed-db-file-manager.spec.ts

@@ -154,13 +154,16 @@ describe('IndexedDBFileManager', () => {
     expect(fileBufferData2[0].buffer).toEqual(new Uint8Array([1]));
   });
 
-  it('should return the files for a table stored', async () => {
-    const fileData = await fileManager.getFilesByTableName('taxi1');
+  it('should return the table data', async () => {
+    const fileData = await fileManager.getTableData('taxi1');
 
-    expect(fileData).toEqual([
-      { fileName: 'taxi1.parquet', fileType: 'parquet' },
-      { fileName: 'taxi2.parquet', fileType: 'parquet' },
-    ]);
+    expect(fileData).toEqual({
+      files: [
+        { fileName: 'taxi1.parquet', fileType: 'parquet' },
+        { fileName: 'taxi2.parquet', fileType: 'parquet' },
+      ],
+      tableName: 'taxi1',
+    });
   });
 
   it('should drop the file buffers for a table', async () => {
@@ -201,4 +204,14 @@ describe('IndexedDBFileManager', () => {
       fileBufferData2.some((file) => file.fileName !== 'taxi2.parquet')
     ).toBe(true);
   });
+
+  it('should set the metadata for a table', async () => {
+    await fileManager.setTableMetadata('taxi1', { test: 'test' });
+
+    const tableData = await indexedDB.tablesKey.toArray();
+
+    expect(tableData[0].metadata).toEqual({ test: 'test' });
+  });
 });
+
+

meerkat-dbm/src/file-manager/indexed-db/indexed-db-file-manager.ts

@@ -2,7 +2,6 @@ import { InstanceManagerType } from '../../dbm/instance-manager';
 import { mergeFileBufferStoreIntoTable } from '../../utils/merge-file-buffer-store-into-table';
 import {
   FileBufferStore,
-  FileData,
   FileManagerConstructorOptions,
   FileManagerType,
   Table,
@@ -199,12 +198,21 @@ export class IndexedDBFileManager implements FileManagerType {
   }
 
   /**
-   * Get the list of files for the specified table name
+   * Get the table data from the IndexedDB
    */
-  async getFilesByTableName(tableName: string): Promise<FileData[]> {
+  async getTableData(tableName: string): Promise<Table | undefined> {
     const tableData = await this.indexedDB.tablesKey.get(tableName);
 
-    return tableData?.files ?? [];
+    return tableData;
+  }
+
+  /**
+   * Set the metadata for the table
+   */
+  async setTableMetadata(tableName: string, metadata: object): Promise<void> {
+    await this.indexedDB.tablesKey.update(tableName, {
+      metadata,
+    });
   }
 
   /**

meerkat-dbm/src/file-manager/memory-file-manager.ts

@@ -1,9 +1,9 @@
 import { InstanceManagerType } from '../dbm/instance-manager';
 import {
   FileBufferStore,
-  FileData,
   FileManagerConstructorOptions,
   FileManagerType,
+  Table,
 } from './file-manager-type';
 
 export class MemoryDBFileManager implements FileManagerType {
@@ -56,10 +56,15 @@ export class MemoryDBFileManager implements FileManagerType {
     return [];
   }
 
-  async getFilesByTableName(tableName: string): Promise<FileData[]> {
+  async getTableData(tableName: string): Promise<Table | undefined> {
     // not needed for memory file manager
-    return [];
+    return;
   }
+
+  async setTableMetadata(table: string, metadata: object): Promise<void> {
+    // not needed for memory file manager
+  }
+
   async dropFilesByTableName(
     tableName: string,
     fileNames: string[]