@liorandb/core 1.0.13 → 1.0.14

package/src/ipc/index.ts

@@ -1,7 +1,5 @@
 import { dbQueue } from "./queue.js";
 
-type AnyFn = (...args: any[]) => Promise<any>;
-
 /* -------------------------------- COLLECTION PROXY -------------------------------- */
 
 class CollectionProxy {
@@ -19,6 +17,17 @@ class CollectionProxy {
     });
   }
 
+  private callIndex(method: string, params: any[]): Promise<any> {
+    return dbQueue.exec("index", {
+      db: this.dbName,
+      col: this.collectionName,
+      method,
+      params
+    });
+  }
+
+  /* ------------------------------ CRUD ------------------------------ */
+
   insertOne = (doc: any) => this.call("insertOne", [doc]);
   insertMany = (docs: any[]) => this.call("insertMany", [docs]);
   find = (query?: any) => this.call("find", [query]);
@@ -31,6 +40,13 @@ class CollectionProxy {
   deleteMany = (filter: any) => this.call("deleteMany", [filter]);
   countDocuments = (filter?: any) =>
     this.call("countDocuments", [filter]);
+
+  /* ------------------------------ INDEX ----------------------------- */
+
+  createIndex = (def: any) => this.callIndex("createIndex", [def]);
+  dropIndex = (field: string) => this.callIndex("dropIndex", [field]);
+  listIndexes = () => this.callIndex("listIndexes", []);
+  rebuildIndexes = () => this.callIndex("rebuildIndexes", []);
 }
 
 /* -------------------------------- DATABASE PROXY -------------------------------- */
@@ -53,4 +69,4 @@ class LioranManagerIPC {
 }
 
 export const manager = new LioranManagerIPC();
-export type { CollectionProxy, DBProxy };
+export type { CollectionProxy, DBProxy };

package/src/types/index.ts

@@ -1,13 +1,63 @@
+/* ----------------------------- MANAGER OPTIONS ----------------------------- */
+
 export interface LioranManagerOptions {
   rootPath?: string
-  encryptionKey?: string | Buffer,
+  encryptionKey?: string | Buffer
   ipc?: boolean
 }
 
+/* ----------------------------- UPDATE OPTIONS ----------------------------- */
+
 export interface UpdateOptions {
   upsert?: boolean
 }
 
+/* --------------------------------- QUERY --------------------------------- */
+
 export type Query<T = any> = Partial<T> & {
   [key: string]: any
 }
+
+/* --------------------------------- INDEX --------------------------------- */
+
+export type IndexType = "hash" | "btree"
+
+export interface IndexDefinition<T = any> {
+  field: keyof T | string
+  unique?: boolean
+  sparse?: boolean
+  type?: IndexType
+}
+
+export interface IndexMetadata {
+  field: string
+  unique: boolean
+  sparse: boolean
+  type: IndexType
+  createdAt: number
+}
+
+/* ----------------------------- QUERY PLANNER ------------------------------ */
+
+export interface QueryExplainPlan {
+  indexUsed?: string
+  indexType?: IndexType
+  scannedDocuments: number
+  returnedDocuments: number
+  executionTimeMs: number
+}
+
+/* ------------------------------ COLLECTION -------------------------------- */
+
+export interface CollectionIndexAPI<T = any> {
+  createIndex(def: IndexDefinition<T>): Promise<void>
+  dropIndex(field: keyof T | string): Promise<void>
+  listIndexes(): Promise<IndexMetadata[]>
+  rebuildIndexes(): Promise<void>
+}
+
+/* ------------------------------- DATABASE --------------------------------- */
+
+export interface DatabaseIndexAPI {
+  rebuildAllIndexes(): Promise<void>
+}