Logo for jsDocs.io

@adonisjs/lucid

  • Version 21.3.0
  • Published
  • 872 kB
  • 14 dependencies
  • MIT license

Install

npm i @adonisjs/lucid
yarn add @adonisjs/lucid
pnpm add @adonisjs/lucid

Overview

SQL ORM built on top of Active Record pattern

Index

Variables

Functions

Namespaces

Variables

variable stubsRoot

const stubsRoot: string;

    Functions

    function configure

    configure: (command: Configure) => Promise<void>;

    • Configures the package

    function defineConfig

    defineConfig: (config: DatabaseConfig) => DatabaseConfig;

      Namespaces

      namespace errors

      module 'build/src/errors.d.ts' {}

      • The client is not supported by Lucid

      variable E_INCOMPLETE_REPLICAS_CONFIG

      const E_INCOMPLETE_REPLICAS_CONFIG: new (args?: any, options?: ErrorOptions) => any;

        variable E_INVALID_DATE_COLUMN_VALUE

        const E_INVALID_DATE_COLUMN_VALUE: new (
            args: [string, string | null],
            options?: ErrorOptions
        ) => any;

          variable E_INVALID_REPLICAS_CONFIG

          const E_INVALID_REPLICAS_CONFIG: new (args?: any, options?: ErrorOptions) => any;

            variable E_MISSING_MODEL_ATTRIBUTE

            const E_MISSING_MODEL_ATTRIBUTE: new (
                args: [string, string, string],
                options?: ErrorOptions
            ) => any;

              variable E_MISSING_SCHEMA_FILES

              const E_MISSING_SCHEMA_FILES: new (args?: any, options?: ErrorOptions) => any;

                variable E_MODEL_DELETED

                const E_MODEL_DELETED: new (args?: any, options?: ErrorOptions) => any;

                  variable E_ROW_NOT_FOUND

                  const E_ROW_NOT_FOUND: new (args?: any, options?: ErrorOptions) => any;

                    variable E_RUNTIME_EXCEPTION

                    const E_RUNTIME_EXCEPTION: new (args?: any, options?: ErrorOptions) => any;

                      variable E_UNABLE_ACQUIRE_LOCK

                      const E_UNABLE_ACQUIRE_LOCK: new (args?: any, options?: ErrorOptions) => any;

                        variable E_UNABLE_RELEASE_LOCK

                        const E_UNABLE_RELEASE_LOCK: new (args?: any, options?: ErrorOptions) => any;

                          variable E_UNDEFINED_RELATIONSHIP

                          const E_UNDEFINED_RELATIONSHIP: new (args?: any, options?: ErrorOptions) => any;

                            variable E_UNMANAGED_DB_CONNECTION

                            const E_UNMANAGED_DB_CONNECTION: new (args: [string], options?: ErrorOptions) => any;

                              variable E_UNSUPPORTED_CLIENT

                              const E_UNSUPPORTED_CLIENT: new (args: [string], options?: ErrorOptions) => any;

                              • The client is not supported by Lucid

                              Package Files (5)

                              Dependencies (14)

                              Dev Dependencies (36)

                              Peer Dependencies (3)

                              Badge

                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@adonisjs/lucid.

                              • Markdown
                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@adonisjs/lucid)
                              • HTML
                                <a href="https://www.jsdocs.io/package/@adonisjs/lucid"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>