Monarch Database API - v1.0.0
    Preparing search index...

    Class Collection

    Index

    Constructors

    Methods

    • Create index (synchronous)

      Parameters

      • field: string
      • Optionaloptions: { unique?: boolean }

      Returns void

    • Create index (async)

      Parameters

      • field: string
      • Optionaloptions: { unique?: boolean }

      Returns Promise<void>

    • Deserialize collection from persistence

      Parameters

      • data: any

      Returns void

    • Get distinct values

      Parameters

      • field: string
      • Optionalquery: Query

      Returns Promise<any[]>

    • Drop index

      Parameters

      • field: string

      Returns Promise<void>

    • Async version of find with options

      Parameters

      • Optionalquery: Query
      • Optionaloptions: { limit?: number; skip?: number }

      Returns Promise<Document[]>

    • Get performance metrics for this collection

      Returns any

    • Get collection statistics

      Returns {
          cacheSize: number;
          documentCount: number;
          indexCount: number;
          memoryUsage: number;
      }

    • Set the change event callback (used by Monarch for change streams)

      Parameters

      • callback: (event: ChangeEvent) => void

      Returns void