Package Docs Index

Primary entry points for install, usage, upgrades, and policy documents.

Package Documentation Index

Version: 1.1.4

Start here

• New consumer: Installation and Quick Start
• Upgrade path: Upgrade Guide
• If you evaluate stability: Support Policy, Versioning Policy, Release Cadence

Installation and setup

• Installation and Quick Start
• Usage guides
• Common scenarios
• Cookbook
• Controller usage guide
• Service usage guide
• Runtime overview
• Runtime CRUD
• Runtime querying
• Runtime models
• Runtime controllers
• Runtime services
• Runtime cache
• Test overview
• Jest and runtime tests
• Factories and seeds
• Scenarios
• CLI and pack smoke
• API reference

SQL and Mongo usage

• Usage guides
• Database metadata
• Multi-connection strategy
• NoSQL (Mongo) usage
• Mixin scenarios
• Soft deletes and restore

Operations and safety

• Production safety
• Least-privilege environment contract
• Migration rollback runbook
• Release Qualification checklist

Stability and compatibility

• Backward compatibility
• Public API freeze policy
• Versioning policy
• Support policy

Support and troubleshooting

• Troubleshooting guide
• SECURITY.md

Published npm package notes

• The published npm package intentionally excludes .map files to reduce package size.
• This does not change ORM runtime behavior, CLI behavior, or the public API. It only removes published debug metadata.
• Reverse mapping from published JavaScript back to TypeScript source is therefore not shipped in the npm tarball.
• Full TypeScript source remains available in the GitHub repository for collaboration, source review, and deeper debugging.
• The package may be flagged for network-access and eval-like behavior by supply-chain scanners because it legitimately talks to databases/cache servers and because mysql2 uses generated parser functions internally.
• The known mysql2 readCodeFor issue affected versions earlier than 3.9.7; this package’s supported range is ^3.15.2, which is above that fixed line.
• Hosted docs: https://alphaconsultings.mintlify.app/
• GitHub source: https://github.com/MetalDz/Eloquent-ORM.js
• npm docs command:
  • npm docs @alpha.consultings/eloquent-orm.js
• npm repository command:
  • npm repo @alpha.consultings/eloquent-orm.js
• npm issues command:
  • npm bugs @alpha.consultings/eloquent-orm.js