JSPM

  • Created
  • Published
  • Downloads 18037
  • Score
    100M100P100Q144718F
  • License MIT

RedBeanNode is an easy to use ORM tool for Node.js, strongly inspired by RedBeanPHP. It automatically generates the tables and columns on-the-fly

Package Exports

  • redbean-node
  • redbean-node/dist/bean-model
  • redbean-node/dist/bean-model.js
  • redbean-node/dist/redbean-node.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (redbean-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

RedBeanNode

npm pipeline status Coverage Status npm

⚠️Warning: Early Development. Do not use it on production!

RedBeanNode is an easy to use ORM tool for Node.js, strongly inspired by RedBeanPHP.

  • Automatically creates tables and columns as you go
  • No configuration, just fire and forget
  • Ported RedBeanPHP's main features and api design
  • Build on top of knex.js
  • Supports JavaScript & TypeScript
  • async/await or promise friendly

Supported Databases

  • MySQL / MariaDB
  • SQLite

Installation

npm install redbean-node --save

Read More

Docs: http://redbean-node.whatsticker.online

Playground

Try RedBeanNode in browser!

https://runkit.com/louislam/redbeannode-playground

Code Example

This is how you do CRUD in RedBeanNode:

const {R} = require("redbean-node");

// Setup connection
R.setup();

(async () => {
    let post = R.dispense('post');
    post.text = 'Hello World';

    // create or update
    let id = await R.store(post);

    // retrieve
    post = await R.load('post', id);

    console.log(post);

    // delete
    await R.trash(post);

    // close connection
    await R.close();
})();

This automatically generates the tables and columns... on-the-fly. It infers relations based on naming conventions.

Unit Test

Please build the project before run the test.

Additional

Icons made by Vitaly Gorbachev from https://www.flaticon.com