No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
scripts
test
.babelrc
.editorconfig
.eslintrc
.gitattributes
.gitignore
.nvmrc
.nycrc
.travis.yml
CHANGELOG.md
LICENSE
README.md
package.json
yarn.lock

README.md

denali-node-orm2

Allows use of Node-ORM2 to talk to your relational database.

Installation

  1. Install this package (denali install denali-node-orm2)
  2. Change your ormAdapter key in /config/environment.js to node-orm2
  3. Make sure your models (if any) have their attributes defined with the attributes that this adapter defines.

Available attributes

In Denali, each ORM defines its own set of model attribute types. If you are shifting from a different ORM adapter, you'll want to confirm that your attribute types match what Node-ORM2 expects. Here are some of the key basic types:

  • text
  • number
  • boolean
  • json
  • date

Node-ORM2 supports additional types (visible here) and can support additional types that match your DB of choice.

Opinions

Currently, this adapter assumes singular table names and snake-cased attribute names. For example, for the Denali model defined below:

export default class Issue extends Model {

  static createdAt = attr('date'); // maps to the issue, created_at column

}

Table names will shift to being pluralized shortly by default but we'd also like both the table name and column naming approach to be configurable in the future to support databases already in use.

Troubleshooting

If you are using the sqlite driver and see a Connection lost - driver does not support reconnection error, double-check the path to your DB. This message can be thrown if the database is not found ...

Developing

  1. Clone the repo down
  2. npm install
  3. denali server
  4. Hit localhost:3000

Tests

$ denali test