Socket
Socket
Sign inDemoInstall

objection

Package Overview
Dependencies
4
Maintainers
2
Versions
200
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

objection


Version published
Maintainers
2
Created

Package description

What is objection?

Objection.js is an ORM (Object-Relational Mapper) for Node.js, built on top of the SQL query builder Knex.js. It aims to provide a powerful and flexible way to interact with SQL databases using JavaScript, while maintaining a clean and intuitive API.

What are objection's main functionalities?

Model Definition

Defines a model class that maps to a database table. In this example, the `Person` class represents the `persons` table in the database.

const { Model } = require('objection');

class Person extends Model {
  static get tableName() {
    return 'persons';
  }
}

Querying

Performs a query to fetch all persons older than 30 years. Objection.js provides a fluent API for building SQL queries.

const people = await Person.query().where('age', '>', 30);

Relations

Defines relationships between models. In this example, a `Person` can have many `Animal` pets, establishing a one-to-many relationship.

class Person extends Model {
  static get tableName() {
    return 'persons';
  }

  static get relationMappings() {
    const Animal = require('./Animal');
    return {
      pets: {
        relation: Model.HasManyRelation,
        modelClass: Animal,
        join: {
          from: 'persons.id',
          to: 'animals.ownerId'
        }
      }
    };
  }
}

Eager Loading

Fetches related data in a single query. This example fetches persons along with their pets using eager loading.

const peopleWithPets = await Person.query().withGraphFetched('pets');

Validation

Defines a JSON schema for model validation. This example ensures that `firstName` and `lastName` are required fields and must be strings of a certain length.

class Person extends Model {
  static get jsonSchema() {
    return {
      type: 'object',
      required: ['firstName', 'lastName'],
      properties: {
        id: { type: 'integer' },
        firstName: { type: 'string', minLength: 1, maxLength: 255 },
        lastName: { type: 'string', minLength: 1, maxLength: 255 }
      }
    };
  }
}

Other packages similar to objection

Readme

Source

Build Status Coverage Status Join the chat at https://gitter.im/Vincit/objection.js

Objection.js

Objection.js is an ORM for Node.js that aims to stay out of your way and make it as easy as possible to use the full power of SQL and the underlying database engine.

Objection.js is built on the wonderful SQL query builder knex. All databases supported by knex are supported by objection.js. SQLite3, Postgres and MySQL are thoroughly tested.

What objection.js gives you:

What objection.js doesn't give you:

  • A custom query DSL. SQL is used as a query language.
  • Automatic database schema creation and migration. For simple things it is useful that the database schema is automatically generated from the model definitions, but usually just gets in your way when doing anything non-trivial. Objection.js leaves the schema related things to you. knex has a great migration tool that we recommend for this job. Check out the example project.

Objection.js uses Promises and coding practices that make it ready for the future. We use Well known OOP techniques and ES6 compatible classes and inheritance in the codebase. You can even use things like ES7 async/await using a transpiler such as Babel. Check out our ES6 and ES7 example projects.

Shortcuts:

Blog posts and tutorials:

Keywords

FAQs

Last updated on 04 Sep 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc