Forest Admin - API reference
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _collections: { [collectionName: string]: SequelizeCollection }
    _nativeQueryConnections: { [connectionName: string]: unknown }
    sequelize: Sequelize = null

    We can't directly use the Sequelize version we install in the package.json as the customer's version may be different. To ensure compatibility, we need to only import types from Sequelize, and use the customer sequelize version to deal with the data manipulation.

    Accessors

    • get collections(): T[]

      Returns T[]

    • get nativeQueryConnections(): Record<string, unknown>

      Returns Record<string, unknown>

    • get schema(): DataSourceSchema

      Returns DataSourceSchema

    Methods

    • Parameters

      • connectionName: string
      • definition: unknown

      Returns void

    • Parameters

      Returns Promise<unknown>