Orquestrador Database Code7

3.0.0-beta.0.2636 verified Sat Apr 25 auth: no javascript

Configures, sets up database models and implements CRUD methods. Version 3.0.0-beta.0.2636 is a pre-release with beta stability, likely used in the Orchy stack. Release cadence is tied to the Orchy ecosystem, with frequent beta updates. Differentiator: opinionated database configuration for Code7's microservices architecture, models with built-in CRUD, and full TypeScript support. Not meant for general-purpose use, but for integrated systems within the Code7 platform.

Common errors

error Error: Cannot find module 'orquestrador-database-code7' ↓

cause Package not installed or typo in require/import.

fix

Run npm install orquestrador-database-code7@beta and ensure import path is correct.

error TypeError: db.configureDatabase is not a function ↓

cause Incorrect import: using named import as default.

fix

Use import { configureDatabase } from 'orquestrador-database-code7' instead of import configureDatabase from ....

error TypeError: Cannot read properties of undefined (reading 'host') ↓

cause Missing database configuration object or environment variable.

fix

Ensure you pass a config object with valid host, port, etc., or set environment variables DB_HOST, DB_PORT, DB_USER, DB_PASS, DB_NAME.

Warnings

deprecated Version 2.x API is deprecated. Upgrade to 3.x beta for new API. ↓

fix Migrate to version 3.x: update imports and use `configureDatabase` instead of `setupDatabase`.

breaking `setupDatabase` renamed to `configureDatabase` in v3.0.0-beta. ↓

fix Replace `import { setupDatabase }` with `import { configureDatabase }` and adjust parameters.

gotcha The package expects environment variables; missing DB_HOST causes silent fallback to localhost which may not be intended. ↓

fix Always explicitly set environment variables or use a config object with validation.

deprecated `crudMethods` will be removed in v4; use model instance methods directly. ↓

fix After v4, call `User.create()` and `User.find()` directly instead of using `crudMethods`.

Install

npm install orquestrador-database-code7

yarn add orquestrador-database-code7

pnpm add orquestrador-database-code7

Imports

orquestrador-database-code7

wrong

const db = require('orquestrador-database-code7')

correct

import { configureDatabase } from 'orquestrador-database-code7'

ESM-only; CommonJS require will fail.

createModel

wrong

import { Model } from 'orquestrador-database-code7'

correct

import { createModel } from 'orquestrador-database-code7'

The correct export is `createModel`, not `Model`.

DatabaseConfig

wrong

import { DatabaseConfig } from 'orquestrador-database-code7'

correct

import type { DatabaseConfig } from 'orquestrador-database-code7'

DatabaseConfig is a TypeScript type, so use `import type`.

Quickstart

Configures a Postgres database, creates a User model with CRUD methods, then creates and fetches records.

import { configureDatabase, createModel, crudMethods } from 'orquestrador-database-code7';

const config = {
  type: 'postgres',
  host: process.env.DB_HOST ?? 'localhost',
  port: Number(process.env.DB_PORT) ?? 5432,
  username: process.env.DB_USER ?? 'user',
  password: process.env.DB_PASS ?? 'pass',
  database: process.env.DB_NAME ?? 'mydb',
};

const db = configureDatabase(config);
const User = createModel('User', {
  name: String,
  email: String,
});

const methods = crudMethods(User);

async function main() {
  const user = await methods.create({ name: 'Jane', email: 'jane@example.com' });
  const users = await methods.find({});
  console.log(users);
}

main();