@multisystemsuite/core

Unified API that orchestrates every Database Reliability Toolkit module in one DatabaseToolkit class. Re-exports all feature packages.

Version: 1.0.1 · License: MIT

npm readme: @multisystemsuite/core on npm

Installation

pnpm add @multisystemsuite/core

This is the recommended package for most applications. It includes query analysis, migrations, observability, health, security, and more.

Quick start

import { DatabaseToolkit } from '@multisystemsuite/core';

const toolkit = new DatabaseToolkit({
  queryThreshold: 1000,
  serviceName: 'billing-api',
  migrationsDir: './migrations',
});

await toolkit.initialize();

const analysis = toolkit.trackQuery({
  query: 'SELECT * FROM orders WHERE user_id = ?',
  executionTime: 1800,
  rowsExamined: 50000,
  rowsReturned: 12,
});

console.log(analysis);
// { severity, score, issue, recommendation, fingerprint, ... }

const report = await toolkit.generateReport();

DatabaseToolkit API

Constructor options

| Option | Type | Default | Description | |--------|------|---------|-------------| | queryThreshold | number | 1000 | Slow query threshold (ms) | | migrationsDir | string | ./migrations | SQL migrations folder | | serviceName | string | — | Service label for metrics | | plugins | Plugin[] | [] | Plugins to load on init |

Properties

| Property | Type | Description | |----------|------|-------------| | queryAnalyzer | QueryAnalyzer | Query performance engine | | indexAdvisor | IndexAdvisor | Index recommendations | | migrator | DbMigrator | Schema migrations | | transactionManager | TransactionManager | Transactions & saga | | deadlockGuard | DeadlockGuard | Deadlock retry wrapper | | concurrencyLock | ConcurrencyLock | Row / distributed locks | | observability | DbObservability | Metrics exporters | | healthCheck | DbHealthCheck | Health scoring | | connectionMonitor | ConnectionMonitor | Pool & leak monitoring | | queryCache | QueryCache | Query result cache | | securityScanner | SecurityScanner | SQL & secret scanning |

Methods

| Method | Description | |--------|-------------| | initialize() | Initialize registered plugins | | trackQuery(input) | Track query → analysis + index + observability | | generateReport() | Combined slow queries, indexes, health, security, metrics | | use(plugin) | Register a plugin (chainable) |

Re-exported packages

Import everything from one place:

import {
  DatabaseToolkit,
  QueryAnalyzer,
  IndexAdvisor,
  DbMigrator,
  TransactionManager,
  DeadlockGuard,
  ConcurrencyLock,
  DbObservability,
  DbHealthCheck,
  ConnectionMonitor,
  QueryCache,
  SecurityScanner,
} from '@multisystemsuite/core';

Related packages (npm)

| Package | Documentation | |---------|----------------| | Query Analyzer | @multisystemsuite/query-analyzer | | Index Advisor | @multisystemsuite/index-advisor | | DB Migrator | @multisystemsuite/db-migrator | | Transaction Manager | @multisystemsuite/transaction-manager | | Deadlock Guard | @multisystemsuite/deadlock-guard | | Concurrency Lock | @multisystemsuite/concurrency-lock | | DB Observability | @multisystemsuite/db-observability | | DB Health Check | @multisystemsuite/db-health-check | | Connection Monitor | @multisystemsuite/connection-monitor | | Query Cache | @multisystemsuite/query-cache | | Security Scanner | @multisystemsuite/security-scanner | | CLI | @multisystemsuite/cli | | Shared | @multisystemsuite/shared |

npm

• Package: @multisystemsuite/core
• Install: npm install @multisystemsuite/core