Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JSDOCatalog

A JSDO catalog implementation.

Hierarchy

  • JSDOCatalog

Index

Constructors

Methods

Constructors

constructor

  • new JSDOCatalog(_handler: JSDOHandler, _broker: string, _asDataset?: boolean, _sqlSafe?: boolean): JSDOCatalog

  • Parameters

    • _handler: JSDOHandler

      The JSDO data access handler.

    • _broker: string

      The broker name.

    • Default value _asDataset: boolean = true

      If to use the dataset as data structure for business entities.

    • Default value _sqlSafe: boolean = true

      If to 'translate' the table/field names to be SQL safe.

    Returns JSDOCatalog

Methods

getCatalog

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

  • Returns a JSDO catalog information. If no database or table parameters are set the complete catalog for all connected databases is created, this might take some time depending on the database(s) structures so 'partial' catalogs for specific database/tables are recommended.

    Parameters

    • Optional dbName: string

      The database name.

    • Optional tableName: string

      The table name.

    Returns Promise<ICatalog>