waterline2

If you're using Waterline today, you should definitely visit the stable v0.x Waterline code base here if you haven't already.

That said if you are interested in contributing to features like recursive, cross-adapter joins (aka "populate deep"), advanced aggregations, and WHERE ("whose") subqueries, then the many months of research and toil in this repo is the place to start.

Still curious? You should read this GitHub issue.

Stilllllllllllllll curious??!!!?!?

Okay. First, check out [Introduction to Waterline2](./Introduction to Waterline2.pdf) for background on what this even is. Then see see ROADMAP.md for what's planned and the contribution guidelines. Feel free to send suggestions, etc. as PRs. If you've caught the bug and are interested in becoming a bigger part of the project, please reach out to @mikermcneil, @particlebanana, or @sgress454 on Twitter.

If you're feeling experimental, you can actually use parts of WL2 in your existing Sails app right now, as long as you're using the >=0.10.x version of Waterline and/or Sails. There are some pretty heavy crutches involved, and it's not particularly easy to set up right now, but cool to see nonetheless. And obviously extremely important for testing if you're looking to get involved as a contributor. Check out USAGE_WITH_SAILS.md for details. As long as you're comfortable with npm link, you should have no problem getting it to work.

Usage

First, clone this repo and run npm install. Then do:

$ node

And:

var Waterline = require('./');

Making Some ORM(s)

var orm = Waterline({
  models: {
    user: { datastore: 'appDB' }
  },
  datastores:{
    appDB: { adapter: 'wlmemory' }
  },
  adapters:{
    wlmemory: require('./standalone/wl-memory.adapter')
  },
});

console.log(orm);

//------[ORM]------
// • 1 model(s)
// • 1 datastore(s)
// • 1 adapter(s)
//-----------------

See ontologies.md for more details.

Querying

See querying.md.

Constructors

See constructors.md.

Everything Else

See the source code. Play around with it, have a good time you know

Contributing

See ROADMAP.md.

License

MIT

mikermcneil / waterline2