# Eloquent ORM JS

> A Laravel Eloquent-inspired ORM and Artisan CLI for Node.js

## Docs

- [Models](https://alphaconsultings.mintlify.app/api/models.md): Working with SQL and Mongo models.
- [API Overview](https://alphaconsultings.mintlify.app/api/overview.md): High-level API surface and export entrypoints.
- [Querying](https://alphaconsultings.mintlify.app/api/querying.md): Safe finder patterns and query execution patterns.
- [API Reference](https://alphaconsultings.mintlify.app/api/reference.md): Public package and model exports with compatibility guarantees.
- [CLI Commands](https://alphaconsultings.mintlify.app/cli/commands.md): Reference for core ORM and scenario CLI commands.
- [Generators](https://alphaconsultings.mintlify.app/cli/generators.md): Scaffolding flow for models, services, controllers, migrations, and scenarios.
- [Production safety](https://alphaconsultings.mintlify.app/cli/production-safety.md)
- [CLI Test Matrix](https://alphaconsultings.mintlify.app/cli/test-matrix.md): Mapping between CLI behavior and owning test files.
- [Least-Privilege Environment Contract](https://alphaconsultings.mintlify.app/database/least-privilege-env-contract.md): Separate runtime and migration DB identities with explicit environment variables.
- [Common Scenarios](https://alphaconsultings.mintlify.app/getting-started/common-scenarios.md): Scenario-first documentation for real consumer use cases.
- [Controllers](https://alphaconsultings.mintlify.app/getting-started/controllers.md): Generated controller CRUD flow and mixin-aware runtime behavior.
- [Cookbook](https://alphaconsultings.mintlify.app/getting-started/cookbook.md): Copy-paste recipes for common consumer implementations.
- [Installation](https://alphaconsultings.mintlify.app/getting-started/installation.md)
- [Package Docs Index](https://alphaconsultings.mintlify.app/getting-started/package-docs.md): Primary entry points for install, usage, upgrades, and policy documents.
- [Quick start](https://alphaconsultings.mintlify.app/getting-started/quick-start.md)
- [Services](https://alphaconsultings.mintlify.app/getting-started/services.md): Generated service CRUD flow and mixin-aware runtime patterns.
- [Upgrade and Migration Guide](https://alphaconsultings.mintlify.app/getting-started/upgrade-guide.md): Version-by-version changes and required migration actions.
- [Usage Guides](https://alphaconsultings.mintlify.app/getting-started/usage-guides.md): End-to-end workflow patterns for runtime, migration, seeding, and tests.
- [Introduction](https://alphaconsultings.mintlify.app/introduction.md): What Eloquent ORM JS is and where to start.
- [Compatibility](https://alphaconsultings.mintlify.app/orm/compatibility.md)
- [Migration Rollback Recovery](https://alphaconsultings.mintlify.app/orm/migration-rollback.md): Recover from partial rollback failures safely and deterministically.
- [Migrations](https://alphaconsultings.mintlify.app/orm/migrations.md): Migration generation, execution, rollback, and status patterns.
- [Mixin Scenarios](https://alphaconsultings.mintlify.app/orm/mixin-scenarios.md): Practical runtime scenarios for mixin-backed model behavior.
- [Model Registry and Hooks](https://alphaconsultings.mintlify.app/orm/model-registry.md): Registry-based model bootstrap and lifecycle hook controls.
- [Multi-Connection Strategy](https://alphaconsultings.mintlify.app/orm/multi-connection-strategy.md): How to run SQL and Mongo connections together without breaking the env contract.
- [NoSQL (Mongo) Usage](https://alphaconsultings.mintlify.app/orm/nosql.md): Mongo runtime contract, supported commands, and explicit limits.
- [Relations](https://alphaconsultings.mintlify.app/orm/relations.md): Relationship helpers for models.
- [Soft Deletes and Restore](https://alphaconsultings.mintlify.app/orm/soft-deletes.md): When delete is soft vs hard, how restore works, and safe usage patterns.
- [Release Policy](https://alphaconsultings.mintlify.app/production-support/release-policy.md): LTS and release-posture overview.
- [Release Cadence](https://alphaconsultings.mintlify.app/release/cadence.md): Channels, eligibility rules, and promotion criteria.
- [History](https://alphaconsultings.mintlify.app/release/history.md)
- [Latest Release Summary / v1.3.0](https://alphaconsultings.mintlify.app/release/latest-release-summary.md): Exact current release headline and detailed package update summary for the latest published release.
- [Open Bugs](https://alphaconsultings.mintlify.app/release/open-bugs.md): Tracked unresolved ORM bugs that remain open after the current validated fix set.
- [Release Promotion Checklist](https://alphaconsultings.mintlify.app/release/promotion-checklist.md): Required checks before promoting stable or LTS.
- [Release Qualification Checklist](https://alphaconsultings.mintlify.app/release/qualification-checklist.md): Hard release gates for publish readiness.
- [Runtime Cache](https://alphaconsultings.mintlify.app/runtime/cache.md): Cache behavior at the service boundary, environment selection, and read-through invalidation patterns.
- [Runtime Controllers](https://alphaconsultings.mintlify.app/runtime/controllers.md): How generated controllers fit into the runtime contract, and how to keep HTTP handlers thin and service-driven.
- [Runtime CRUD](https://alphaconsultings.mintlify.app/runtime/crud.md): The recommended create, read, update, patch, delete, restore, and by-id helper contract for application runtime code.
- [Runtime Overview](https://alphaconsultings.mintlify.app/runtime/index.md): The runtime contract for model creation, querying, updates, deletes, restore flows, and cache-aware application design.
- [Runtime Models](https://alphaconsultings.mintlify.app/runtime/models.md): How to design runtime models for SQL and Mongo, when to choose each driver, and where relations fit into the model contract.
- [Runtime Querying](https://alphaconsultings.mintlify.app/runtime/querying.md): The Laravel-like runtime read contract for primary-key reads, safe-finder chains, scopes, eager loading, and service-level query composition.
- [Runtime Services](https://alphaconsultings.mintlify.app/runtime/services.md): The service-layer contract for CRUD, query composition, eager loading, soft deletes, hooks, and cache-aware runtime behavior.
- [Backward Compatibility Policy](https://alphaconsultings.mintlify.app/support/backward-compatibility.md): Compatibility boundaries and what changes are considered breaking.
- [Public API Freeze Policy](https://alphaconsultings.mintlify.app/support/public-api-freeze.md): Rules for what is considered public and how it is constrained.
- [Support Policy](https://alphaconsultings.mintlify.app/support/support-policy.md): Stable/LTS support, channels, and backport boundaries.
- [Troubleshooting](https://alphaconsultings.mintlify.app/support/troubleshooting.md): Resolve common build, runtime, CLI, and migration issues.
- [Versioning Policy](https://alphaconsultings.mintlify.app/support/versioning-policy.md): SemVer policy and release rules for this package.
- [CLI And Pack Smoke](https://alphaconsultings.mintlify.app/test/cli-pack-smoke.md): How the CLI, tarball smoke app, and release-level validation prove the shipped package behavior.
- [Factories And Seeds](https://alphaconsultings.mintlify.app/test/factories-seeds.md): How factories, seeders, and factory status fit into test and scenario validation.
- [Test Overview](https://alphaconsultings.mintlify.app/test/index.md): The full test surface for runtime validation, CLI validation, scenarios, factories, seeds, coverage, and release smoke checks.
- [Jest And Runtime Tests](https://alphaconsultings.mintlify.app/test/jest-runtime.md): How Jest is used for unit, contract, runtime, and integration validation across the ORM surface.
- [Advanced Integration / Real Backend Harness](https://alphaconsultings.mintlify.app/test/real-backend-harness.md): A documented consumer-project validation harness that exercises @alpha.consultings/eloquent-orm.js in a full Express backend with JWT auth, refresh tokens, PostgreSQL, Memcached, and Docker-backed tests.
- [Scenarios](https://alphaconsultings.mintlify.app/test/scenarios.md): How scenario generation, scenario seeders, and demo flows are tested for SQL, Mongo, and test-mode surfaces.

## OpenAPI Specs

- [openapi](https://alphaconsultings.mintlify.app/api-reference/openapi.json)