Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
SqlDatabase
✓ import { SqlDatabase } from 'mumba-microservice-sql';
✗ import SqlDatabase from 'mumba-microservice-sql';
Named export, not default. Requires a DI container with 'config' registered.
db
✓ const db = container.get('db');
✗ import { db } from 'mumba-microservice-sql';
The db instance is not directly exported; it is registered in the DI container as 'db'.
dbModels
✓ const models = container.get('dbModels');
✗ import { dbModels } from 'mumba-microservice-sql';
Models are retrieved from the container, not imported directly from the package.
Shows instantiation of SqlDatabase with config and registration in a DI container, plus model registration.
import { Container } from 'dicontainer';
import config from './config';
import { SqlDatabase } from 'mumba-microservice-sql';
const container = new Container();
container.object('config', () => config);
// Register SQL database module
const sqlDb = new SqlDatabase(config);
container.instance('db', sqlDb);
// Register a model
container.factory('fooModel', (c: any) => {
const db = c.get('db');
return db.sequelize.define('foo', { name: Sequelize.STRING });
}, ['dbModels']);
// Initialize
container.init();
Errors
Common errors & fixes
Cannot find module 'mumba-microservice-sql'
Package not installed.
fixRun npm install mumba-microservice-sql --save
Sequelize is not defined
Missing Sequelize peer dependency.
fixInstall sequelize: npm install sequelize
Property 'knex' does not exist on type 'Config'
TypeScript config type missing knex property for migrations.
fixAdd 'knex?: string' to your Config type definition.
Audit
Dependencies
sequelizerequiredORM used for SQL database operations
dicontaineroptionalDI container integration for model registration
knexoptionalUsed for database migrations
mysqloptionalRequired for MySQL migrations