node package manager


AdonisJS Lucid


Gitter Trello Version Build Status Coverage Status Downloads License

ūüôŹ This repository is the official SQL ORM for adonis framework.

Adonis lucid is a database query builder and ORM for Adonis framework. It also has support for database migrations, seeds and factories.

You can learn more about AdonisJS and all of its awesomeness on ūüĆ≤

Table of Contents

Team Members

Database Supported

Below is the list of databases officially supported by Adonis Lucid.

  • pg
  • sqlite3
  • mysql
  • mysql2
  • mariasql
  • strong-oracle
  • oracle

Getting Started

Lucid is included by default with every new adonis application, but here are the steps, if in case you want to set it up manually.

$ npm i --save adonis-lucid

and then register lucid providers inside the your bootstrap/app.js file.

const providers = [

setting up aliases inside bootstrap/app.js file.

const aliases = {
  Database: 'Adonis/Src/Database',
  Lucid: 'Adonis/Src/Lucid',
  Schema: 'Adonis/Src/Schema'
  Migrations: 'Adonis/Src/Migrations',
  Factory: 'Adonis/Src/Factory'

Official Documentation

Contribution Guidelines

In favor of active development we accept contributions for everyone. You can contribute by submitting a bug, creating pull requests or even improving documentation.

You can find a complete guide to be followed strictly before submitting your pull requests in the Official Documentation.