A multi-database ORM supporting MySQL, PostgreSQL, MongoDB, and Snowflake
npm install adaptus2-ormA comprehensive, production-ready ORM that supports multiple databases including MySQL, PostgreSQL, MongoDB, and Snowflake with a unified interface.
``bash`
npm install adaptus2-ormor
yarn add adaptus2-orm
bash
For MySQL
npm install mysql2For PostgreSQL
npm install pgFor MongoDB
npm install mongodbFor Snowflake
npm install snowflake-sdk
`Quick Start
javascript
const ORM = require('adaptus2-orm');// Configuration
const config = {
type: 'mysql',
host: 'localhost',
port: 3306,
user: 'your_user',
password: 'your_password',
database: 'your_database'
};
// Initialize connection
async function main() {
try {
// Get database connection
const connection = await ORM.getDbConnection(config);
// Create a record
const result = await ORM.create(config, 'users', {
name: 'John Doe',
email: 'john@example.com',
age: 30
});
// Read records
const users = await ORM.read(config, 'users', {
where: { age: { $gte: 18 } },
orderBy: 'name',
limit: 10
});
// Update records
await ORM.update(config, 'users', {
where: { id: 1 },
data: { age: 31 }
});
// Delete records
await ORM.deleteRecord(config, 'users', {
where: { id: 1 }
});
} catch (error) {
console.error('Error:', error);
}
}
main();
`Configuration
$3
bash
MySQL
MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_USER=root
MYSQL_PASSWORD=password
MYSQL_DATABASE=myappPostgreSQL
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
POSTGRES_USER=postgres
POSTGRES_PASSWORD=password
POSTGRES_DATABASE=myappMongoDB
MONGODB_URI=mongodb://localhost:27017/myapp
MONGODB_HOST=localhost
MONGODB_PORT=27017
MONGODB_USER=
MONGODB_PASSWORD=
MONGODB_DATABASE=myappSnowflake
SNOWFLAKE_ACCOUNT=your_account
SNOWFLAKE_USER=your_user
SNOWFLAKE_PASSWORD=your_password
SNOWFLAKE_WAREHOUSE=your_warehouse
SNOWFLAKE_DATABASE=your_database
SNOWFLAKE_SCHEMA=PUBLIC
`$3
javascript
const config = {
type: 'postgresql', // mysql | postgresql | mongodb | snowflake
host: 'localhost',
port: 5432,
user: 'postgres',
password: 'password',
database: 'myapp',
// Optional pool settings
connectionLimit: 10, // For MySQL
max: 10, // For PostgreSQL
maxPoolSize: 10, // For MongoDB
// SSL configuration (optional)
ssl: {
rejectUnauthorized: false
}
};
`API Reference
$3
####
Establishes and returns a database connection.javascript
const connection = await ORM.getDbConnection(config);
`####
Creates a new record in the specified table.javascript
const result = await ORM.create(config, 'users', {
name: 'Jane Doe',
email: 'jane@example.com'
});
`####
Reads records from the specified table.javascript
const users = await ORM.read(config, 'users', {
where: { active: true },
orderBy: 'created_at',
order: 'DESC',
limit: 20,
offset: 0
});
`####
Updates records in the specified table.javascript
await ORM.update(config, 'users', {
where: { id: 1 },
data: { email: 'newemail@example.com' }
});
`####
Deletes records from the specified table.javascript
await ORM.deleteRecord(config, 'users', {
where: { active: false }
});
`####
Executes raw SQL/query.javascript
const result = await ORM.query(config,
'SELECT * FROM users WHERE age > ?',
[18]
);
`$3
The ORM includes a powerful query builder for constructing complex queries:
javascript
const { QueryBuilder } = require('adaptus2-orm');const queryBuilder = QueryBuilder.create('mysql')
.table('users')
.select(['id', 'name', 'email'])
.where('active', true)
.whereIn('department', ['engineering', 'marketing'])
.orderBy('created_at', 'DESC')
.limit(10);
// Get the SQL and parameters
const { sql, params } = queryBuilder.toSQL();
// Execute the query
const result = await ORM.query(config, sql, params);
`$3
javascript
// Create a table
await ORM.createTable(config, 'products', {
columns: {
id: { type: 'integer', primaryKey: true, autoIncrement: true },
name: { type: 'string', required: true },
price: { type: 'decimal', precision: 10, scale: 2 },
in_stock: { type: 'boolean', default: true },
created_at: { type: 'timestamp', default: 'CURRENT_TIMESTAMP' }
},
indexes: {
idx_name: { columns: ['name'], unique: true },
idx_price: { columns: ['price'] }
}
});// Check if table exists
const exists = await ORM.tableExists(config, 'products');
`$3
javascript
const { MigrationManager } = require('adaptus2-orm');const migrationManager = new MigrationManager(ORM, config);
// Initialize migration system
await migrationManager.initialize();
// Create a new migration
await migrationManager.create('add_users_table');
// Run pending migrations
await migrationManager.migrate();
// Rollback last migration
await migrationManager.rollback();
// Get migration status
const status = await migrationManager.status();
`$3
javascript
// For relational databases
const adapter = ORM.databaseManager.getAdapter(config.type);
const connection = await ORM.getDbConnection(config);// Begin transaction
const txResult = await adapter.beginTransaction(connection);
try {
// Perform operations
await ORM.create(config, 'orders', orderData);
await ORM.update(config, 'inventory', updateData);
// Commit transaction
await adapter.commit(connection);
} catch (error) {
// Rollback on error
await adapter.rollback(connection);
throw error;
}
`Database-Specific Features
$3
- Connection pooling with mysql2
- Prepared statements for security
- SSL/TLS support
- Automatic reconnection$3
- Native prepared statements
- JSONB support
- Arrays and custom types
- Connection pooling with pg-pool$3
- Native MongoDB driver
- Aggregation pipeline support
- GridFS for file storage
- Change streams support$3
- Warehouse management
- Schema switching
- VARIANT type for JSON
- Bulk loading capabilitiesExamples
$3
javascript
const ORM = require('adaptus2-orm');const config = {
type: 'postgresql',
host: 'localhost',
port: 5432,
user: 'postgres',
password: 'password',
database: 'myapp'
};
async function crudExample() {
// Create
const user = await ORM.create(config, 'users', {
name: 'Alice Smith',
email: 'alice@example.com',
age: 28
});
// Read one
const fetchedUser = await ORM.read(config, 'users', {
where: { id: user.data.record.id }
});
// Read many with conditions
const youngUsers = await ORM.read(config, 'users', {
where: { age: { $lt: 30 } },
orderBy: 'age',
order: 'ASC'
});
// Update
await ORM.update(config, 'users', {
where: { id: user.data.record.id },
data: { age: 29 }
});
// Delete
await ORM.deleteRecord(config, 'users', {
where: { id: user.data.record.id }
});
}
crudExample().catch(console.error);
`$3
javascript
// migrations/20240501_create_users_table.js
module.exports = {
up: async (orm, config) => {
await orm.createTable(config, 'users', {
columns: {
id: { type: 'integer', primaryKey: true, autoIncrement: true },
name: { type: 'string', required: true },
email: { type: 'string', required: true, unique: true },
password: { type: 'string', required: true },
created_at: { type: 'timestamp', default: 'CURRENT_TIMESTAMP' },
updated_at: { type: 'timestamp', default: 'CURRENT_TIMESTAMP' }
},
indexes: {
idx_email: { columns: ['email'], unique: true }
}
});
}, down: async (orm, config) => {
await orm.query(config, 'DROP TABLE IF EXISTS users');
}
};
`Testing
bash
Run all tests
npm testRun tests in watch mode
npm run test:watchRun tests with coverage
npm run test:coverage
`Contributing
1. Fork the repository
2. Create your feature branch (
)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature`)This project is licensed under the MIT License - see the LICENSE file for details.
- Inspired by various ORM libraries like Sequelize, TypeORM, and Mongoose
- Built with love for the Node.js community
- Special thanks to all contributors
Open a discussion on Github or join the contribution and submit a PR, thanks!
---