orm2 中文文檔

flybywind 發(fā)布于2019-06-25 18:19 / 2772人閱讀

摘要：譯者飛龍來源安裝所支持的版本支持。，和版本的測試在上運行。如果你使用了，你可能想使用這一簡單的中間件，使集成變得更容易。在多個連接之間定義的模型會在中連接。不要忘記在之前使用它，最好在你的公共素材文件夾之后。

譯者：飛龍

來源：Object Relational Mapping

安裝

npm install orm

所支持的Node.js版本

支持 0.8, 0.10, 0.12, iojs-1.5 。

0.10.x，0.12.x 和 iojs-1.5 版本的測試在 Travis CI 上運行。如果你想要的話，可以在本地運行測試：

npm test

DBMS 支持

MySQL & MariaDB

PostgreSQL

Amazon Redshift

SQLite

MongoDB （beta版，到現(xiàn)在為止缺少聚合）

特性

創(chuàng)建模型，同步，刪除，批量創(chuàng)建，獲取，查找，移除，計數(shù)，聚合函數(shù)

創(chuàng)建模型的關(guān)聯(lián)，查找，檢查，創(chuàng)建和移除

定義自定義的驗證器（有一些內(nèi)建的驗證器，會在保存之前檢查實例的屬性 -- 詳見enforce

模型實例的緩存和一致性（兩次獲取表中的一行，獲取到相同的對象，修改其中一個就是修改全部）

插件：MySQL FTS，Pagination （分頁），Transaction （事務(wù)），Timestamps （時間戳），Migrations （遷移）

介紹

這是一個 Node.js 對象關(guān)系映射模塊。

示例：

var orm = require("orm");

orm.connect("mysql://username:password@host/database", function (err, db) {
  if (err) throw err;

    var Person = db.define("person", {
        name      : String,
        surname   : String,
        age       : Number, // FLOAT
        male      : Boolean,
        continent : [ "Europe", "America", "Asia", "Africa", "Australia", "Antartica" ], // ENUM type
        photo     : Buffer, // BLOB/BINARY
        data      : Object // JSON encoded
    }, {
        methods: {
            fullName: function () {
                return this.name + " " + this.surname;
            }
        },
        validations: {
            age: orm.enforce.ranges.number(18, undefined, "under-age")
        }
    });

    // add the table to the database
    db.sync(function(err) { 
        if (err) throw err;

        // add a row to the person table
        Person.create({ id: 1, name: "John", surname: "Doe", age: 27 }, function(err) {
            if (err) throw err;

                // query the person table by surname
                Person.find({ surname: "Doe" }, function (err, people) {
                    // SQL: "SELECT * FROM person WHERE surname = "Doe""
                    if (err) throw err;

                    console.log("People found: %d", people.length);
                    console.log("First person: %s, age %d", people[0].fullName(), people[0].age);

                    people[0].age = 16;
                    people[0].save(function (err) {
                        // err.msg = "under-age";
                });
            });

        });
    });
});

Promise

你可以使用開啟Promise的包裝庫。

Express

如果你使用了Express，你可能想使用這一簡單的中間件，使集成變得更容易。

var express = require("express");
var orm = require("orm");
var app = express();

app.use(orm.express("mysql://username:password@host/database", {
    define: function (db, models, next) {
        models.person = db.define("person", { ... });
        next();
    }
}));
app.listen(80);

app.get("/", function (req, res) {
    // req.models is a reference to models used above in define()
    req.models.person.find(...);
});

你可以多次調(diào)用orm.express來獲取多個數(shù)據(jù)庫的連接。在多個連接之間定義的模型會在req.models中連接。不要忘記在app.use(app.router)之前使用它，最好在你的公共素材文件夾之后。

示例

請見examples/anontxt，里面有一個基于express的應(yīng)用示例。