BeanORM

BeanORM is a lightweight ORM library for Node.js, similar to RedBeanPHP, with automatic table and field creation, full CRUD support, relationships, and versatility.

Installation

npm install eredbean

Supported Databases

• MySQL
• PostgreSQL
• SQLite

Usage Example

import Bean from '@elv1bro/beanorm';

// MySQL/PostgreSQL
const mysqlConfig = {
  type: 'mysql',
  host: 'localhost',
  user: 'username',
  password: 'password',
  database: 'mydb'
};

// SQLite
const sqliteConfig = {
  type: 'sqlite',
  filename: './database.sqlite'
};

const user = new Bean('user', sqliteConfig);
user.set('name', 'Alice');
user.set('email', '[email protected]');
await user.save();

const user2 = await Bean.load('user', user._id);
user2.set('name', 'Alice Smith');
await user2.save();

await user2.delete();

🤖 AI Assistant Instructions

Project Metadata

We've prepared an automatically generated file PROJECT_METHODS.json with detailed information about methods and project structure.

How to Use Metadata

1. Examine the PROJECT_METHODS.json file in the project root
2. Pay attention to class methods:
   • BaseModel: Basic model operations
   • Bean: Main ORM class
   • Repository: Data repository management
   • TableMetadataCache: Table metadata caching

# Quick metadata view
cat PROJECT_METHODS.json

Generating Metadata

To update metadata, use the command:

npm run generate-ai-metadata

Key Classes and Their Methods

BaseModel

• constructor(): Model initialization
• set(): Setting field values
• save(): Saving the model
• delete(): Deleting the model
• Static methods load() and find()

Bean

• Extends BaseModel
• Additional methods hasOne() and hasMany() for relationships
• Support for working with different database adapters (MySQL, PostgreSQL, SQLite)

Repository

• Low-level data operations
• Methods create(), findById(), find(), deleteById()
• Raw SQL query support

TableMetadataCache

• Table structure caching
• Methods getTableStructure(), setTableStructure()
• Performance optimization

Code Study Recommendations

• Start with Bean.js - the ORM's central class
• Study BaseModel.js to understand basic logic
• Analyze adapters in src/adapters/
• Look at examples in the use/ directory

License

MIT License