monSQLize
  • English

      • monSQLize Documentation

      This documentation starts with the common application path: connect to MongoDB, run collection operations, add Model validation when needed, then enable cache, transactions, pools, sync, and operations features deliberately.

      Main Documentation Paths

      GoalStart hereNotes
      Install, connect, and run the first querygetting-started.mdInstallation and minimal connection validation
      Learn basic usage for common collection operationsbasic-operations.mdDaily CRUD, pagination, cache TTL, and Model entry-point guidance
      Configure new MonSQLize(options)configuration.mdComplete constructor options, defaults, cache, Redis, Model, sync, pools, and logging
      Match docs to runnable sourceexamples.mdLinks each topic to a GitHub example source
      Add database cachingcache.mdCollection query cache, Redis L2 cache, and distributed invalidation
      Control collection-vs-Model writeswrite-path-policy.mdOptional guard when selected namespaces must go through Model writes
      Prepare production rolloutproduction-rollout.mdData task rollout, Change Stream CDC, index preflight, and traffic-switch checks
      Migrate production data by scenarioproduction-data-migration.mdFiltered data, indexes, field edits, and restore from instance A to production
      Look up data task parametersdata-tasks.mdOne Job configuration, four methods, every parameter, and CLI commands
      Follow scenario guidesrecipes.mdGuides for connection, cache, Redis, SSH, pools, and Model usage
      Browse the full API surfaceapi-index.mdReference entry for lower-level and compatibility APIs
      Check runtime boundariescapability-index.mdCapability map with links to deeper reference pages
      1. Package entry: repository README
      2. Installation: getting-started.md
      3. Basic usage: basic-operations.md
      4. Constructor configuration: configuration.md
      5. Examples:
      6. Cache guide: cache.md
      7. Write path policy: write-path-policy.md
      8. Production rollout: production-rollout.md
      9. Production data migration: production-data-migration.md
      10. Data tasks API: data-tasks.md
      11. Scenario guides: recipes.md
      12. API and runtime reference:

      Source and Verification

      • The website is generated from docs/en and docs/zh.
      • Runnable examples live in examples.
      • Public package behavior should match the package root exports, public types, and runnable examples.

      Running Examples

      Run these commands from the repository root:

      npm run build
npm run test:examples

      npm run test:examples starts temporary MongoDB test servers through the repository example runner, compiles the TypeScript examples, runs them, and cleans up the temporary data directories.