Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AkeraCatalog

akera.io implementation of a meta-data catalog.

Hierarchy

  • AkeraCatalog

Index

Constructors

Methods

Constructors

constructor

  • new AkeraCatalog(webApp: AkeraWeb, broker: string): AkeraCatalog

  • Parameters

    • webApp: AkeraWeb

      The @akera/web web handler.

    • broker: string

      The broker name.

    Returns AkeraCatalog

Methods

getCatalog

  • getCatalog(fullLoad?: boolean, dbName?: string, tableName?: string): Promise<ICatalog>

  • Return a meta-data catalog information for the application server.

    If no database or table name is specified the complete catalog for all connected databases is created. Depending on the database structure this might take considerable amount of time so partial database/table catalogs are recommended.

    Parameters

    • Default value fullLoad: boolean = false

      Flag to load the complete table information (fields, indexes).

    • Optional dbName: string

      The database name for 'partial' catalog.

    • Optional tableName: string

      The table name for 'partial' catalog.

    Returns Promise<ICatalog>