Function registerGlobalOrm

  • registerGlobalOrm<T>(nitro, config, name?, forkOptionsFactory?): Promise<T>

  • Initializes MikroORM, and register hooks to fork and close it.

    Calls initOrm and registers hooks to automatically enable the entity manager for every request with its own context. Limited configuration of the request hook is available as part of ModuleOptions.

    If you need more fine-grained permissions for ORM instances, consider setting "routeOptions" to "false", and do whatever checks you need, either in a "request" hook from a Nitro plugin, or in a defineRequestEvent() handler function.

    This function also registers a hook to automatically close the ORM on nitro close and unregisters the hooks it registered after the ORM closes successfully. Whether the closing of the ORM is forced or not can be controlled with the runtime config.

    Type Parameters

    • T extends MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>> = MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

      Type of the MikroORM instance. Typically, the MikroORM export of your MikroORM driver.

    Parameters

    • nitro: NitroApp

      The nitro app to add hooks to.

    • config: Options<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

      The config to use for the new instance.

    • name: string = 'default'

      The name to set for this instance.

    • Optional forkOptionsFactory: ((event, name) => undefined | ForkOptions)

      A function to create the fork options for a request. If left undefined, or returns undefined, the default fork options defined in the runtime config are used. This function is called the first time per request, when useEntityManager is used.

        • (event, name): undefined | ForkOptions

        • Parameters

          • event: H3Event<EventHandlerRequest>
          • name: string

          Returns undefined | ForkOptions

    Returns Promise<T>

    The initialized MikroORM instance (same as if you had called useOrm with the same name).

Settings

Member Visibility

Theme