https://github.com/jadbox/mongoose-sql

Mongoose compatible interface for PostgreSQL
https://github.com/jadbox/mongoose-sql

Last synced: about 1 year ago
JSON representation

Mongoose compatible interface for PostgreSQL

• Host: GitHub
• URL: https://github.com/jadbox/mongoose-sql
• Owner: jadbox
• Created: 2016-12-27T22:39:15.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-01-03T18:22:16.000Z (over 4 years ago)
• Last Synced: 2025-04-24T05:01:53.272Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 119 KB
• Stars: 33
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# Mongoose-SQL

Mongoose compatible interface for PostgreSQL



Mongoose-SQL covers the basic API surface of [Mongoose](http://mongoosejs.com) [ORM for Mongo] to interface and migrate data to PostgreSQL. This is effectively a small ORM over PostgreSQL that resembles the Mongoose API.

This library requires ES6 with Node.JS 6+ and uses [Knex](http://knexjs.org/) to interface with PostgreSQL.

```bash

npm install mongoose-sql

```

```js

var db = require("mongoose-sql");

var e = process.environment;

// Create connection: note default environment variables

// returns a Knex instance

db.connect({

    client: e.DB_CLIENT || "pg",

    connection: {

      host: e.DB_HOST || "127.0.0.1",

      user: e.DB_USER || "user",

      password: e.DB_PASSWORD || "",

      database: e.DB_DATABASE || "test"

    }

});

// Get Knex instance if needed

var knex = db.getKnex();

// Use Mongoose-like operations upon PostgreSQL tables

var Cat_Schema = new db.Schema(CatModel);

var Cat = db.model("Cat", Cat_Schema);

Cat.find().exec(myHandler); // find() returns all rows

Cat.findById(123).exec(myHandler); // find by row id

Cat.findOne({name: 'fluffy'}).exec(myHandler); // findOne

Cat.where({name: 'fluffy'}).findOne().exec(myHandler); // find by where

Cat.find().sort('breed').exec(myHandler); // sort

Cat.find().populate('owner').exec(myHandler); // outer left join

var simba = new Cat( { CatObject } );

simba.save(function() {

});

simba.remove(function() {

    

});

// Migrations (WIP)

var mongoose = require("mongoose"); // instance Mongoose

var Cat_Schema_Mongo = new mongoose.Schema(CatModel); // make a mongoose schema

var Cat_Mongo = mongoose.model("Cat", Cat_Schema_Mongo); // make a mongoose model

db.migrateSchemas([Cat_Mongo]).then(function() { // call migrateSchemas with model

    console.log("moved data to PostgreSQL from Mongoose");

});

```

Mongoose API reference:

[http://mongoosejs.com/index.html](http://mongoosejs.com/index.html)

### note that not all Mongoose apis are covered

## Migrations (WIP)

Based client Schema definitions, the library will try to create PostgreSQL tables with fields of the right types.

* One-to-one relationships will have foreign key constraints

* Many-to-many relationships will get their own link table

* Object or list of object key values (without schema links) will become jsonb fields