Skip to content

en

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

en

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
model
model
 
 
README.md
README.md
 
 
admin.md
admin.md
 
 
aggregate.md
aggregate.md
 
 
api-index.md
api-index.md
 
 
basic-operations.md
basic-operations.md
 
 
bookmarks.md
bookmarks.md
 
 
business-lock.md
business-lock.md
 
 
cache-and-function-cache.md
cache-and-function-cache.md
 
 
cache-configuration.md
cache-configuration.md
 
 
cache-creation.md
cache-creation.md
 
 
cache-hub-migration.md
cache-hub-migration.md
 
 
cache-invalidation.md
cache-invalidation.md
 
 
cache.md
cache.md
 
 
capability-index.md
capability-index.md
 
 
capability-traceability.md
capability-traceability.md
 
 
chaining-api.md
chaining-api.md
 
 
chaining-methods.md
chaining-methods.md
 
 
collection-management.md
collection-management.md
 
 
configuration.md
configuration.md
 
 
connection.md
connection.md
 
 
count-queue.md
count-queue.md
 
 
count.md
count.md
 
 
create-index.md
create-index.md
 
 
create-indexes.md
create-indexes.md
 
 
data-tasks.md
data-tasks.md
 
 
database-ops.md
database-ops.md
 
 
delete-many.md
delete-many.md
 
 
delete-one.md
delete-one.md
 
 
deleteBatch.md
deleteBatch.md
 
 
distinct.md
distinct.md
 
 
distributed-deployment-quickref.md
distributed-deployment-quickref.md
 
 
distributed-deployment.md
distributed-deployment.md
 
 
drop-index.md
drop-index.md
 
 
error-codes.md
error-codes.md
 
 
esm-support.md
esm-support.md
 
 
events.md
events.md
 
 
examples.md
examples.md
 
 
explain.md
explain.md
 
 
expression-functions.md
expression-functions.md
 
 
failure-recovery-examples.md
failure-recovery-examples.md
 
 
file-dependency-governance.md
file-dependency-governance.md
 
 
find-and-count.md
find-and-count.md
 
 
find-by-ids.md
find-by-ids.md
 
 
find-one-and-delete.md
find-one-and-delete.md
 
 
find-one-and-replace.md
find-one-and-replace.md
 
 
find-one-and-update.md
find-one-and-update.md
 
 
find-one-by-id.md
find-one-by-id.md
 
 
find.md
find.md
 
 
findOne.md
findOne.md
 
 
findOneAnd-return-value-unified.md
findOneAnd-return-value-unified.md
 
 
findPage.md
findPage.md
 
 
function-cache.md
function-cache.md
 
 
getting-started.md
getting-started.md
 
 
hooks.md
hooks.md
 
 
increment-one.md
increment-one.md
 
 
index.md
index.md
 
 
insert-many.md
insert-many.md
 
 
insert-one.md
insert-one.md
 
 
insertBatch.md
insertBatch.md
 
 
list-indexes.md
list-indexes.md
 
 
model.md
model.md
 
 
mongodb-driver-compatibility.md
mongodb-driver-compatibility.md
 
 
mongodb-native-vs-extensions.md
mongodb-native-vs-extensions.md
 
 
multi-pool-health-check.md
multi-pool-health-check.md
 
 
multi-pool.md
multi-pool.md
 
 
objectid-auto-convert.md
objectid-auto-convert.md
 
 
objectid-conversion-scope.md
objectid-conversion-scope.md
 
 
objectid-cross-version-faq.md
objectid-cross-version-faq.md
 
 
objectid-cross-version.md
objectid-cross-version.md
 
 
objectid-logging-optimization.md
objectid-logging-optimization.md
 
 
performance-evidence.md
performance-evidence.md
 
 
pool-chain-api.md
pool-chain-api.md
 
 
populate.md
populate.md
 
 
production-data-migration.md
production-data-migration.md
 
 
production-rollout.md
production-rollout.md
 
 
quick-upsert.md
quick-upsert.md
 
 
readPreference.md
readPreference.md
 
 
recipes.md
recipes.md
 
 
relations.md
relations.md
 
 
release-preflight.md
release-preflight.md
 
 
replace-one.md
replace-one.md
 
 
roadmap-boundaries.md
roadmap-boundaries.md
 
 
runtime-architecture.md
runtime-architecture.md
 
 
saga-advanced.md
saga-advanced.md
 
 
saga-transaction.md
saga-transaction.md
 
 
slow-query-log.md
slow-query-log.md
 
 
ssh-tunnel.md
ssh-tunnel.md
 
 
support-matrix.md
support-matrix.md
 
 
sync-backup.md
sync-backup.md
 
 
transaction-optimizations.md
transaction-optimizations.md
 
 
transaction.md
transaction.md
 
 
update-aggregation.md
update-aggregation.md
 
 
update-many.md
update-many.md
 
 
update-one.md
update-one.md
 
 
update-operations.md
update-operations.md
 
 
updateBatch.md
updateBatch.md
 
 
upsert-guide.md
upsert-guide.md
 
 
upsert-one.md
upsert-one.md
 
 
utilities.md
utilities.md
 
 

README.md

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

Goal Start here Notes
Install, connect, and run the first query getting-started.md Installation and minimal connection validation
Learn basic usage for common collection operations basic-operations.md Daily CRUD, pagination, cache TTL, and Model entry-point guidance
Configure new MonSQLize(options) configuration.md Complete constructor options, defaults, cache, Redis, Model, sync, pools, and logging
Match docs to runnable source examples.md Links each topic to a GitHub example source
Add database caching cache.md Collection query cache, Redis L2 cache, and distributed invalidation
Control collection-vs-Model writes write-path-policy.md Optional guard when selected namespaces must go through Model writes
Prepare production rollout production-rollout.md Data task rollout, Change Stream CDC, index preflight, and traffic-switch checks
Migrate production data by scenario production-data-migration.md Filtered data, indexes, field edits, and restore from instance A to production
Look up data task parameters data-tasks.md One Job configuration, four methods, every parameter, and CLI commands
Follow scenario guides recipes.md Guides for connection, cache, Redis, SSH, pools, and Model usage
Browse the full API surface api-index.md Reference entry for lower-level and compatibility APIs
Check runtime boundaries capability-index.md Capability map with links to deeper reference pages

Recommended Reading Order

  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.