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

    Class Monarch

    Monarch Database - Enterprise-Grade In-Memory Database

    Refactored from god object pattern into focused, modular components:

    • CollectionManager: Handles collection lifecycle
    • DataOperationsManager: Handles CRUD and data structure operations
    • Separate managers for each enterprise feature

    Supports dependency injection for better testability and flexibility.

    Index

    Constructors

    Methods

    • Add an operation to a transaction

      Parameters

      • transactionId: string
      • collection: string
      • operation: "insert" | "update" | "remove"
      • data: any

      Returns void

    • Authenticate a user

      Parameters

      • username: string
      • password: string

      Returns Promise<any>

    • Authorize a permission for the current context

      Parameters

      • context: any
      • permission: string

      Returns boolean

    • Check resource-level access

      Parameters

      • context: any
      • resource: string
      • permission: string

      Returns boolean

    • Commit a transaction

      Parameters

      • transactionId: string

      Returns void

    • Create a database snapshot

      Returns Promise<string>

    • Create a stored procedure

      Parameters

      • name: string
      • scriptId: string
      • parameters: string[]

      Returns Promise<string>

    • Create a new user

      Parameters

      • username: string
      • password: string
      • roles: string[] = ...

      Returns Promise<any>

    • Decrypt data

      Parameters

      • encryptedData: string

      Returns Promise<any>

    • Delete a user

      Parameters

      • username: string

      Returns void

    • Encrypt data

      Parameters

      • data: any

      Returns Promise<string>

    • Execute a script

      Parameters

      • scriptId: string
      • Optionalcontext: any

      Returns Promise<any>

    • Parameters

      • key: string
      • longitude: number
      • latitude: number
      • member: string
      • Optional_name: string

      Returns Promise<number>

    • Parameters

      • key: string
      • member1: string
      • member2: string
      • Optional_unit: "m" | "km" | "mi" | "ft"

      Returns Promise<number | null>

    • Parameters

      • key: string
      • members: string[]

      Returns Promise<string[]>

    • Parameters

      • key: string
      • members: string[]

      Returns Promise<({ latitude: number; longitude: number } | null)[]>

    • Parameters

      • key: string
      • longitude: number
      • latitude: number
      • radius: number
      • unit: "m" | "km" | "mi" | "ft"
      • Optionaloptions: { count?: number; withCoord?: boolean; withDist?: boolean }

      Returns Promise<any[]>

    • Parameters

      • key: string
      • member: string
      • radius: number
      • unit: "m" | "km" | "mi" | "ft"
      • Optionaloptions: { count?: number; withCoord?: boolean; withDist?: boolean }

      Returns Promise<any[]>

    • Get change stream statistics

      Returns { listenersByCollection: Record<string, number>; totalListeners: number }

    • Get cluster statistics

      Returns Promise<{ health: number; nodes: number; shards: number }>

    • Get all collection names

      Returns string[]

    • Get durability statistics

      Returns Promise<{ lastSync: number; snapshots: number; walSize: number }>

    • Get ML model statistics

      Parameters

      • modelId: string

      Returns Promise<{ accuracy: number; latency: number; throughput: number }>

    • Get query optimization suggestions

      Parameters

      • collectionName: string
      • query: any

      Returns string[]

    • Get script statistics

      Parameters

      • scriptId: string

      Returns Promise<{ avgTime: number; errors: number; executions: number }>

    • Get database statistics Uses aggregate method to avoid Law of Demeter violations

      Returns { collectionCount: number; totalDocuments: number }

    • Get transaction status

      Parameters

      • transactionId: string

      Returns Transaction | undefined

    • Hash a password

      Parameters

      • password: string

      Returns Promise<string>

    • Parameters

      • key: string
      • fields: string[]

      Returns Promise<number>

    • Parameters

      • key: string
      • field: string

      Returns Promise<boolean>

    • Parameters

      • key: string
      • field: string

      Returns Promise<any>

    • Parameters

      • key: string

      Returns Promise<Record<string, any>>

    • Parameters

      • key: string
      • field: string
      • increment: number

      Returns Promise<number>

    • Parameters

      • key: string
      • field: string
      • increment: number

      Returns Promise<number>

    • Parameters

      • key: string

      Returns Promise<string[]>

    • Parameters

      • key: string

      Returns Promise<number>

    • Parameters

      • key: string
      • field: string
      • value: any

      Returns Promise<number>

    • Parameters

      • key: string

      Returns Promise<any[]>

    • Join a cluster

      Parameters

      • config: any

      Returns Promise<void>

    • Leave the cluster

      Returns Promise<void>

    • Parameters

      • key: string
      • index: number

      Returns Promise<any>

    • Parameters

      • key: string

      Returns Promise<number>

    • Load the database state using the configured adapter

      Returns Promise<void>

    • Load an ML model

      Parameters

      • model: any
      • modelData: Buffer

      Returns Promise<string>

    • Load a script

      Parameters

      • script: any

      Returns Promise<string>

    • Parameters

      • key: string

      Returns Promise<any>

    • Parameters

      • key: string
      • values: any[]

      Returns Promise<number>

    • Parameters

      • key: string
      • start: number
      • end: number

      Returns Promise<any[]>

    • Parameters

      • key: string
      • count: number
      • value: any

      Returns Promise<number>

    • Parameters

      • key: string
      • index: number
      • value: any

      Returns Promise<void>

    • Parameters

      • key: string
      • start: number
      • end: number

      Returns Promise<void>

    • Redistribute data across cluster

      Returns Promise<void>

    • Remove a collection

      Parameters

      • name: string

      Returns boolean

    • Remove schema from a collection

      Parameters

      • collectionName: string

      Returns boolean

    • Rollback a transaction

      Parameters

      • transactionId: string

      Returns void

    • Parameters

      • key: string

      Returns Promise<any>

    • Parameters

      • key: string
      • values: any[]

      Returns Promise<number>

    • Run ML inference

      Parameters

      • modelId: string
      • input: number[][]

      Returns Promise<any>

    • Parameters

      • key: string
      • members: any[]

      Returns Promise<number>

    • Save the database state using the configured adapter

      Returns Promise<void>

    • Parameters

      • key: string

      Returns Promise<number>

    • Parameters

      • keys: string[]

      Returns Promise<any[]>

    • Parameters

      • keys: string[]

      Returns Promise<any[]>

    • Parameters

      • key: string
      • member: any

      Returns Promise<boolean>

    • Parameters

      • key: string

      Returns Promise<any[]>

    • Parameters

      • key: string
      • Optionalcount: number

      Returns Promise<any[]>

    • Parameters

      • key: string
      • members: any[]

      Returns Promise<number>

    • Parameters

      • keys: string[]

      Returns Promise<any[]>

    • Train an ML model

      Parameters

      • modelId: string
      • data: any
      • Optionaloptions: any

      Returns Promise<any>

    • Parameters

      • key: string
      • timestamp: number
      • value: number
      • Optionallabels: Record<string, string>

      Returns Promise<void>

    • Parameters

      • key: string
      • OptionalfromTimestamp: number
      • OptionaltoTimestamp: number

      Returns Promise<number | null>

    • Parameters

      • key: string

      Returns Promise<number>

    • Parameters

      • key: string
      • timestamp: number

      Returns Promise<any>

    • Parameters

      • key: string

      Returns Promise<any>

    • Parameters

      • key: string

      Returns Promise<any>

    • Parameters

      • key: string

      Returns Promise<any>

    • Parameters

      • key: string
      • fromTimestamp: number
      • toTimestamp: number

      Returns Promise<any[]>

    • Parameters

      • key: string
      • fromTimestamp: number
      • toTimestamp: number

      Returns Promise<any[]>

    • Remove a change stream listener

      Parameters

      • listenerId: string

      Returns boolean

    • Update user roles

      Parameters

      • username: string
      • roles: string[]

      Returns void

    • Parameters

      • key: string
      • id: string
      • vector: number[]
      • Optionalmetadata: Record<string, any>

      Returns Promise<void>

    • Validate a document against a collection's schema

      Parameters

      • collectionName: string
      • document: any

      Returns { errors?: string[]; valid: boolean }

    • Parameters

      • key: string

      Returns Promise<number>

    • Parameters

      • key: string
      • ids: string[]

      Returns Promise<number>

    • Verify a password

      Parameters

      • password: string
      • hash: string

      Returns Promise<boolean>

    • Parameters

      • key: string
      • id: string

      Returns Promise<any>

    • Parameters

      • key: string
      • queryVector: number[]
      • OptionaltopK: number
      • Optional_includeMetadata: boolean

      Returns Promise<any[]>

    • Parameters

      • key: string
      • id: string
      • fields: Record<string, any>

      Returns Promise<string>

    • Parameters

      • key: string
      • ids: string[]

      Returns Promise<number>

    • Parameters

      • key: string

      Returns Promise<number>

    • Parameters

      • key: string
      • start: string
      • end: string
      • Optional_count: number

      Returns Promise<any[]>

    • Parameters

      • streams: Record<string, string>
      • Optionalcount: number
      • Optionalblock: number

      Returns Promise<Record<string, any[]>>

    • Parameters

      • key: string
      • end: string
      • start: string
      • Optionalcount: number

      Returns Promise<any[]>

    • Parameters

      • key: string
      • strategy: "maxlen" | "minid"
      • threshold: string | number

      Returns Promise<number>

    • Parameters

      • key: string
      • scores: Record<string, number>

      Returns Promise<number>

    • Parameters

      • key: string

      Returns Promise<number>

    • Parameters

      • key: string
      • min: number
      • max: number

      Returns Promise<number>

    • Parameters

      • key: string
      • increment: number
      • member: any

      Returns Promise<number>

    • Parameters

      • key: string
      • start: number
      • end: number
      • OptionalwithScores: boolean

      Returns Promise<any[]>

    • Parameters

      • key: string
      • min: number
      • max: number

      Returns Promise<any[]>

    • Parameters

      • key: string
      • member: any

      Returns Promise<number | null>

    • Parameters

      • key: string
      • members: any[]

      Returns Promise<number>

    • Parameters

      • key: string
      • start: number
      • end: number
      • OptionalwithScores: boolean

      Returns Promise<any[]>

    • Parameters

      • key: string
      • member: any

      Returns Promise<number | null>

    • Parameters

      • key: string
      • member: any

      Returns Promise<number | null>

    Properties

    authorizePermission: (context: any, permission: string) => boolean = ...

    Type Declaration

      • (context: any, permission: string): boolean
      • Authorize a permission for the current context

        Parameters

        • context: any
        • permission: string

        Returns boolean

    decryptData: (encryptedData: string) => Promise<any> = ...

    Type Declaration

      • (encryptedData: string): Promise<any>
      • Decrypt data

        Parameters

        • encryptedData: string

        Returns Promise<any>

    encryptData: (data: any) => Promise<string> = ...

    Type Declaration

      • (data: any): Promise<string>
      • Encrypt data

        Parameters

        • data: any

        Returns Promise<string>