KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

node-activerecord

★ 57 Open GitHub ↗

A ORM written in Coffeescript that supports multiple database systems (SQL/NoSQL) and ID generation middleware.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# node-activerecord

[![Build Status](https://secure.travis-ci.org/meltingice/node-activerecord.png?branch=master)](http://travis-ci.org/meltingice/node-activerecord)

An ORM written in Coffeescript that supports multiple database systems (SQL, NoSQL, and even REST), as well as ID generation middleware. It is fully extendable to add new database systems and plugins.

**Note:** this project is new and is still evolving rapidly. A lot is done, but there is still a lot to do.

## Install

node-activerecord is available in npm:

```
npm install activerecord
```

Installing node-activerecord will not automatically install the required libraries for every adapter since this could easily make the library very bloated and dependent on things you may or may not need.

### Adapter Libraries

You can use npm to install the required libraries for each adapter:

<table>
  <tr>
    <th>Adapter</th>
    <th>Libraries</th>
  </tr>
  <tr>
    <td>sqlite</td>
    <td>sqlite3</td>
  </tr>
  <tr>
    <td>mysql</td>
    <td>mysql</td>
  </tr>
  <tr>
    <td>redis</td>
    <td>redis</td>
  </tr>
  <tr>
    <td>REST</td>
    <td>restler</td>
  </tr>
</table>

### ID Middleware Libraries

You can also use npm to install the required libraries for any ID generation middleware:

<table>
  <tr>
    <th>Middleware</th>
    <th>Libraries</th>
  </tr>
  <tr>
    <td>sql</td>
    <td><i>none</i></td>
  </tr>
  <tr>
    <td>redis</td>
    <td>redis</td>
  </tr>
</table>

### Built-In Plugins

<table>
  <tr>
    <th>Plugin</th>
    <th>Enabled by Default</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>json</td>
    <td>true</td>
    <td>Allows conversion of a model to a simple JS object and offers field protection</td>
  </tr>
  <tr>
    <td>logger</td>
    <td>false</td>
    <td>A verbose logger that outputs significant logging data to the console</td>
  </tr>
</table>

## Examples

**Configuration**

By default, ActiveRecord assumes SQL ID middleware. This means it checks for the last generated auto-increment ID on the primary key.

``` coffeescript
ActiveRecord = require 'activerecord'

module.exports = new ActiveRecord.Configuration
  sqlite:
    database: "#{__dirname}/test.db"
  mysql:
    host: 'localhost'
    database: 'test'
    user: 'test'
    password: 'password'
  middleware:
    redis:
      host: 'localhost'
```

**Model Definition**

``` coffeescript
ActiveRecord = require 'activerecord'
config = require __dirname + "/config"

# Note: uses sqlite3 by default
class User extends ActiveRecord.Model
  config: config
  fields: ['id', 'username', 'name']
```

**Creating a Record**

``` coffeescript
user = new User()
user.username = "meltingice"
user.name = "Ryan"
user.save()
```

**Retreiving a Record**

``` coffeescript
# Find by primary ID
User.find 1, (err, user) -> console.log user.toJSON()

# Find multiple by primary ID
User.findAll [1, 2], (err, users) ->
  console.log user.toJSON() for user in users

# Find by custom query
User.find "SELECT * FROM users WHERE id < ?", 5, (err, user) ->
  console.log user.toJSON()
```

**Updating a Record**

``` coffeescript
User.find 1, (err, user) ->
  user.name = "Bob"
  user.save (err) -> console.log "updated!"
```

**Deleting a Record**

``` coffeescript
User.find 1, (err, user) ->
  user.delete (err) -> console.log "deleted!"
```

**Model Relations**

``` coffeescript
class User extends ActiveRecord.Model
  config: config
  fields: ['id', 'username', 'name']
  hasMany: -> [
    Message
  ]

class Message extends ActiveRecord.Model
  config: config
  fields: ['id', 'user_id', 'text']
  belongsTo: -> [
    User
  ]

Message.find 1, (message) ->
  message.user (err, user) ->
    console.log user.toJSON()
```

**Non-SQL Middleware**

``` coffeescript
class User extends ActiveRecord.Model
  config: config
  idMiddleware: 'redis'
  idMiddlewareOptions:
    key: 'users:id'

fields: ['id', 'username', 'name']
```

**Plugins**

``` coffeescript
class AltLogger extends ActiveRecord.Plugin
  messages: []

# Callback hooks
  afterCreate: -> messages.push "Created model for #{@tableName()}"; true
  afterUpdate: -> messages.push "Updated model for #{@tableName()}"; true

# Extend the model
  outputLog: -> console.log msg for msg in messages

class User extends ActiveRecord.Model
  config: config
  fields: ['id', 'username', 'name']
  plugins: -> [
    'json'
    AltLogger
  ]

user = new User name: 'foo', username: 'bar'
user.save (err) -> user.outputLog()
```

node-activerecord

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README