patio

Build Status Coverage Status

NPM

Patio

Patio is a Sequel inspired query engine.

Installation

To install patio run

npm install comb patio

If you want to use the patio executable for migrations

npm install -g patio

Running Tests

To run the tests 

  1. make test

To run just the postgres tests

  1. make test-pg

To run just the mysql tests

  1. make test-mysql

Why Use Patio?

Patio is different because it allows the developers to choose the level of abtraction they are comfortable with.

If you want to use the ORM functionality you can. If you don't you can just use the Database and Datasets as a querying API, and if you need to you can write plain SQL

Concepts

  1. Model definitions are defined by the tables in the database.

    As you add models the definition is automatically defined from the table definition. This is particularly useful when you want to define your model from a schema designed using another tool (i.e. ActiveRecord, Sequel, etc...)

  2. Patio tries to stay out of your way when querying.

    When you define a model you still have the freedom to do any type of query you want.

    Only want certain columns?

    1.  MyModel.select("id", "name", "created").forEach(function(record){
    2.      //record only has the id, name, and created columns
    3.  });

    You want to join with another table?

    1.  MyModel.join("otherTable", {id: patio.sql.identifier("myModelId"}).forEach(function(record){
    2.      //Record has columns from your join table now!
    3.  });

    You want to run raw SQL?

    1.  MyModel.db.run("select * from my_model where name = 'Bob'").all().chain(function(records){
    2.      //all records with a name that equals bob.
    3.  });

    You want to just query the database and not use a model?

    1.  var DB = patio.connect("pg://test:test@127.0.0.1:5432/test_db");
    2.  DB.from("myTable").filter({id: [1,2,3]}).all().function(records){
    3.     //records with id IN (1,2,3)
    4.  });

Getting Started

All the code for this example can be found here

  1. Create a new database

    PostgreSQL

    1.  psql -c "CREATE DATABASE reademe_example"

    MySQL

    1.  mysql -e "CREATE DATABASE readme_example"

  2. Create a migration

    1.  mkdir migration
    2.  patio migration-file -n createInitialTables ./migration

    This will add a migration name createdInitialTables in your migration directory.

  3. Add the following code to your migration

    1.  module.exports = {
    2.      //up is called when you migrate your database up
    3.      up: function (db) {
    4.          //create a table called state;
    5.          return db
    6.              .createTable("state", function () {
    7.                  this.primaryKey("id");
    8.                  this.name(String);
    9.                  this.population("integer");
    10.                  this.founded(Date);
    11.                  this.climate(String);
    12.                  this.description("text");
    13.              })
    14.              .chain(function () {
    15.                  //create another table called capital
    16.                  return db.createTable("capital", function () {
    17.                      this.primaryKey("id");
    18.                      this.population("integer");
    19.                      this.name(String);
    20.                      this.founded(Date);
    21.                      this.foreignKey("stateId", "state", {key: "id", onDelete: "CASCADE"});
    22.                  });
    23.              });
    24.      },
    26.      //down is called when you migrate your database down
    27.      down: function (db) {
    28.          //drop the state and capital tables
    29.          return db.dropTable("capital", "state");
    30.      }
    31.  };

  4. Run your migration

    1.  patio migrate -v --camelize -u "<DB_CONNECTION_STRING>" -d ./migration

  1. Connect and query!

    1.  var patio = require("patio");
    3.  //set camelize = true if you want snakecase database columns as camelcase
    4.  patio.camelize = true;
    5.  patio.connect("pg://postgres@127.0.0.1:5432/readme_example");
    7.  //define a State model with a relationship to capital
    8.  var State = patio.addModel("state").oneToOne("capital");
    10.  //define a Capital model with a relationship to State
    11.  var Capital = patio.addModel("capital").manyToOne("state");
    13.  //save a state
    14.  State
    15.      .save({
    16.          name: "Nebraska",
    17.          population: 1796619,
    18.          founded: new Date(1867, 2, 4),
    19.          climate: "continental",
    20.          //notice the capital relationship is inline
    21.          capital: {
    22.              name: "Lincoln",
    23.              founded: new Date(1856, 0, 1),
    24.              population: 258379
    25.          }
    26.      })
    27.      .chain(function () {
    28.          //save a Capital
    29.          return Capital.save({
    30.              name: "Austin",
    31.              founded: new Date(1835, 0, 1),
    32.              population: 790390,
    33.              //define the state inline
    34.              state: {
    35.                  name: "Texas",
    36.                  population: 25674681,
    37.                  founded: new Date(1845, 11, 29)
    38.              }
    39.          });
    40.      })
    41.      .chain(function () {
    42.          //Query all the states by name
    43.          return State.order("name").forEach(function (state) {
    44.              //Get the associated capital
    45.              return state.capital.chain(function (capital) {
    46.                  console.log("%s's capital is %s.", state.name, capital.name);
    47.              });
    48.          });
    49.      })
    50.      .chain(process.exit, function (err) {
    51.          console.log(err)
    52.          process.exit(1);
    53.      });

Guides

Features

Documentation generated using coddoc.