adonis-lucid

library3.0.16jsnpmunverified

Official SQL ORM for the AdonisJS framework, providing a query builder, Active Record style ORM, migrations, seeds, and factories. Current version 3.0.16 supports multiple databases including PostgreSQL, MySQL, SQLite, and Oracle. Designed exclusively for AdonisJS, it requires manual provider and alias registration in app/bootstrap. This version is a work-in-progress for AdonisJS v2. Breaking changes expected from earlier betas. Differentiators: deep integration with AdonisJS IoC, schema builder, and factory support.

database

npm install adonis-lucid

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ADONIS-LUCID

adonis-lucid

databasejavascriptv3.0.16

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Database

✓ import Database from '@ioc:Adonis/Src/Database'

✗ const Database = use('Database')

Use '@ioc:Adonis/Src/Database' for type-safe imports in AdonisJS v5+; older versions used use()

Lucid

✓ import { Lucid } from '@ioc:Adonis/Src/Lucid'

✗ const Lucid = use('Adonis/Src/Lucid')

Base model class. Use '@ioc:Adonis/Src/Lucid' in v5; older versions via use()

Schema

✓ import Schema from '@ioc:Adonis/Src/Schema'

✗ const Schema = use('Schema')

Schema builder for migrations. Import from '@ioc:Adonis/Src/Schema' in v5+

Factory

✓ import Factory from '@ioc:Adonis/Src/Factory'

✗ use('Factory')

Factory for seeding data. Import '@ioc:Adonis/Src/Factory' in v5+

Shows provider registration, alias setup, and basic usage with Database and Lucid model.

// In app/bootstrap.js (AdonisJS v5) const providers = [ 'adonis-lucid/providers/DatabaseProvider', 'adonis-lucid/providers/LucidProvider', 'adonis-lucid/providers/SchemaProvider', 'adonis-lucid/providers/MigrationsProvider', 'adonis-lucid/providers/CommandsProvider', 'adonis-lucid/providers/FactoryProvider', 'adonis-lucid/providers/SeederProvider', ] const aliases = { Database: 'Adonis/Src/Database', Lucid: 'Adonis/Src/Lucid', Schema: 'Adonis/Src/Schema', Migrations: 'Adonis/Src/Migrations', Factory: 'Adonis/Src/Factory', } // In a controller const Database = use('Database') const users = await Database.table('users').where('active', true) // Model example const Lucid = use('Lucid') class User extends Lucid { static get table () { return 'users' } }

Debug

Known issues

breakingAdonisJS v2 uses use() for imports; v5 uses @ioc: paths. v2 will break in v5.

fix

Use '@ioc:Adonis/Src/...' imports in AdonisJS v5+.

affects: <=2.0

deprecatedStrong-oracle and mariasql drivers are deprecated; use mysql2 or pg instead.

fix

Switch to mysql2 (mysql) or pg (postgres).

affects: >=3.0

gotchaLucid is NOT a standalone ORM; it requires AdonisJS framework IoC container.

fix

Use within an AdonisJS app, not as a standalone package.

affects: *

gotchaManual registration of all 7 providers is required unless using adonis-fullstack-app.

fix

Register all providers in app/bootstrap.js as shown in README.

affects: >=3.0

gotchaFactory and Seeder providers are separate; Omitting them breaks seed/factory commands.

fix

Include FactoryProvider and SeederProvider.

affects: >=3.0

Errors

Common errors & fixes

Cannot find module 'adonis-lucid/providers/...'

Missing provider file or wrong path in providers array.

fix

Ensure you've installed the package: npm i adonis-lucid --save, and use exact provider names from README.

use is not defined (ReferenceError)

Using use() outside of AdonisJS IoC context, e.g., in a standalone script.

fix

Only use use() inside AdonisJS controllers, models, or lifecycle hooks; for standalone scripts, require AdonisJS environment.

Knex: Unknown connection config "mariasql"

Using deprecated mariasql driver in config/database.js.

fix

Switch to mysql2 client in config/database.js and remove mariasql dependency.

Cannot find module '@ioc:Adonis/Src/Database'

Using AdonisJS v5 syntax in AdonisJS v2 project.

fix

Use 'use('Database')' in v2 or update to v5 with proper provider registration.

Upgrade

Version history

3.0.16latest on npm

Audit

Dependencies

knexrequiredUnderlying SQL query builder for Lucid

@adonisjs/frameworkrequiredAdonisJS framework core required for IoC container

Agent activity

35 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/adonisjs/adonis-lucid ↗

packageadonis-lucid ↗

homepagehttps://github.com/adonisjs/adonis-lucid#readme ↗