snooty.toml

name = "docs"
title = "MongoDB Manual"
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
intersphinx = [
    "https://pymongo.readthedocs.io/en/stable/objects.inv",
    "https://motor.readthedocs.io/en/stable/objects.inv",
    "https://www.mongodb.com/docs/atlas/objects.inv",
    "https://www.mongodb.com/docs/php-library/upcoming/objects.inv",
    "https://www.mongodb.com/docs/compass/current/objects.inv",
    "https://www.mongodb.com/docs/database-tools/objects.inv",
    "https://www.mongodb.com/docs/mongodb-shell/objects.inv",
    "https://www.mongodb.com/docs/cluster-to-cluster-sync/current/objects.inv",
]
# toc_landing_pages are pages that have pages nested beneath them
# and **should** open when a user clicks on that page in the TOC
# (i.e. they're not drawers)
toc_landing_pages = [
   "/administration",
   "/administration/analyzing-mongodb-performance",
   "/administration/backup-sharded-clusters",
   "/administration/configuration-and-maintenance",
   "/administration/connection-pool-overview",
   "/administration/health-managers",
   "/administration/install-community",
   "/administration/install-enterprise-linux",
   "/administration/install-enterprise",
   "/administration/install-on-linux/",
   "/administration/monitoring",
   "/administration/replica-set-deployment",
   "/administration/replica-set-maintenance",
   "/administration/replica-set-member-configuration",
   "/administration/sharded-cluster-administration",
   "/administration/sharded-cluster-config-servers",
   "/administration/upgrade-community-to-enterprise",
   "/aggregation",
   "/applications/indexes",
   "/applications/replication",
   "/changeStreams",
   "/core/2d",
   "/core/2dsphere",
   "/core/aggregation-pipeline",
   "/core/auditing",
   "/core/authentication-mechanisms-enterprise",
   "/core/authentication-mechanisms",
   "/core/authentication",
   "/core/authorization",
   "/core/backups",
   "/core/crud",
   "/core/csfle",
   "/core/csfle/fundamentals/",
   "/core/csfle/reference",
   "/core/csfle/tutorials",
   "/core/databases-and-collections",
   "/core/geohaystack",
   "/core/indexes/create-index",
   "/core/indexes/index-types",
   "/core/indexes/index-properties",
   "/core/indexes/index-types/index-single/",
   "/core/indexes/index-types/index-compound/",
   "/core/indexes/index-types/index-geospatial/",
   "/core/indexes/index-types/geospatial/2dsphere",
   "/core/indexes/index-types/geospatial/2dsphere/query",
   "/core/indexes/index-types/geospatial/2d",
   "/core/indexes/index-types/geospatial/2d/create",
   "/core/indexes/index-types/geospatial/2d/query",
   "/core/indexes/index-types/index-multikey/",
   "/core/indexes/index-types/index-text/",
   "/core/indexes/index-types/index-text/specify-text-index-language/",
   "/core/indexes/index-types/index-wildcard/",
   "/core/indexes/index-types/index-hashed/",
   "/core/index-creation",
   "/core/index-text",
   "/core/index-ttl",
   "/core/journaling",
   "/core/kerberos",
   "/core/map-reduce",
   "/core/query-optimization",
   "/core/read-isolation-consistency-recency",
   "/core/read-preference",
   "/core/replica-set-architectures",
   "/core/replica-set-high-availability",
   "/core/replica-set-members",
   "/core/replica-set-secondary",
   "/core/schema-validation",
   "/core/schema-validation/specify-json-schema",
   "/core/security-encryption-at-rest",
   "/core/queryable-encryption/",
   "/core/queryable-encryption/fundamentals/",
   "/core/queryable-encryption/tutorials/",
   "/core/queryable-encryption/reference/",
   "/core/security-hardening",
   "/core/security-internal-authentication",
   "/core/security-ldap",
   "/core/security-scram",
   "/core/security-oidc",
   "/core/security-transport-encryption",
   "/core/security-users",
   "/core/security-x.509",
   "/core/sharded-cluster-components",
   "/core/sharding-change-a-shard-key",
   "/core/sharding-balancer-administration",
   "/core/defragment-sharded-collections",
   "/core/sharding-data-partitioning",
   "/core/sharding-shard-key",
   "/core/storage-engines",
   "/core/timeseries-collections",
   "/core/timeseries-collections/timeseries-shard-collection",
   "/core/transactions",
   "/core/views",
   "/core/wiredtiger",
   "/core/zone-sharding",
   "/core/zone-sharding",
   "/crud",
   "/data-modeling",
   "/data-modeling/schema-design-process",
   "/data-modeling/data-consistency",
   "/data-modeling/design-patterns",
   "/data-modeling/design-patterns/group-data",
   "/geospatial-queries",
   "/indexes",
   "/installation",
   "/introduction",
   "/mongo",
   "/reference",
   "/reference/aggregation",
   "/reference/bson-types",
   "/reference/change-events",
   "/reference/cluster-parameters",
   "/reference/collation",
   "/reference/command",
   "/reference/command/nav-administration",
   "/reference/command/nav-aggregation",
   "/reference/command/nav-atlas-search",
   "/reference/command/nav-auditing",
   "/reference/command/nav-authentication",
   "/reference/command/nav-crud",
   "/reference/command/nav-diagnostic",
   "/reference/command/nav-free-monitoring",
   "/reference/command/nav-geospatial",
   "/reference/command/nav-plan-cache",
   "/reference/command/nav-replication",
   "/reference/command/nav-role-management",
   "/reference/command/nav-sessions",
   "/reference/command/nav-sharding",
   "/reference/command/nav-user-management",
   "/reference/configuration-options",
   "/reference/inconsistency-type",
   "/reference/method",
   "/reference/method/js-atlas-search",
   "/reference/method/js-bulk",
   "/reference/method/js-client-side-field-level-encryption",
   "/reference/method/js-collection",
   "/reference/method/js-connection",
   "/reference/method/js-constructor",
   "/reference/method/js-cursor",
   "/reference/method/js-database",
   "/reference/method/js-free-monitoring",
   "/reference/method/js-native",
   "/reference/method/js-native-legacy",
   "/reference/method/js-plan-cache",
   "/reference/method/js-replication",
   "/reference/method/js-role-management",
   "/reference/method/js-sharding",
   "/reference/method/js-user-management",
   "/reference/mongodb-wire-protocol/",
   "/reference/operator/aggregation-pipeline",
   "/reference/operator/aggregation",
   "/reference/operator/aggregation/queryStats",
   "/reference/operator/query-array",
   "/reference/operator/query-bitwise",
   "/reference/operator/query-comparison",
   "/reference/operator/query-element",
   "/reference/operator/query-evaluation",
   "/reference/operator/query-geospatial",
   "/reference/operator/query-logical",
   "/reference/operator/query-miscellaneous",
   "/reference/operator/query-modifiers",
   "/reference/operator/projection",
   "/reference/operator/query",
   "/reference/operator/update-array",
   "/reference/operator/update-bitwise",
   "/reference/operator/update-field",
   "/reference/operator/update",
   "/reference/read-concern",
   "/reference/replication",
   "/reference/security",
   "/reference/sharding",
   "/reference/stable-api",
   "/reference/write-concern",
   "/release-notes/2.4",
   "/release-notes/2.6",
   "/release-notes/3.0",
   "/release-notes/3.2-compatibility",
   "/release-notes/3.2",
   "/release-notes/3.4-downgrade",
   "/release-notes/3.4",
   "/release-notes/3.6",
   "/release-notes/4.0",
   "/release-notes/4.2-downgrade",
   "/release-notes/4.2",
   "/release-notes/4.4-downgrade",
   "/release-notes/4.4",
   "/release-notes/5.0",
   "/release-notes/5.0-downgrade",
   "/release-notes/5.1",
   "/release-notes/5.2",
   "/release-notes/5.3",
   "/release-notes/6.0",
   "/release-notes/6.0-downgrade",
   "/release-notes/6.1",
   "/release-notes/6.2",
   "/release-notes/6.3",
   "/release-notes/7.0",
   "/release-notes/7.0-downgrade",
   "/release-notes/7.1",
   "/release-notes/7.2",
   "/release-notes/7.3",
   "/replication",
   "/security",
   "/sharding",
   "/storage",
   "/text-search",
   "/tutorial/insert-documents",
   "/tutorial/install-mongodb-enterprise-on-amazon",
   "/tutorial/install-mongodb-enterprise-on-debian",
   "/tutorial/install-mongodb-enterprise-on-os-x",
   "/tutorial/install-mongodb-enterprise-on-red-hat",
   "/tutorial/install-mongodb-enterprise-on-suse",
   "/tutorial/install-mongodb-enterprise-on-ubuntu",
   "/tutorial/install-mongodb-enterprise-on-windows",
   "/tutorial/install-mongodb-on-amazon",
   "/tutorial/install-mongodb-on-debian",
   "/tutorial/install-mongodb-on-os-x",
   "/tutorial/install-mongodb-on-red-hat",
   "/tutorial/install-mongodb-on-suse",
   "/tutorial/install-mongodb-on-ubuntu",
   "/tutorial/install-mongodb-on-windows",
   "/tutorial/manage-the-database-profiler",
   "/tutorial/query-documents",
   "/tutorial/remove-documents",
   "/tutorial/update-documents",
]
[substitutions]
bi = "MongoDB Connector for BI"
compass = "MongoDB Compass"
copy = "©"
ent-build = "MongoDB Enterprise"
lts = "Major"
mdb-shell = "MongoDB Shell"
sbe = "slot-based query execution engine"
sbe-short = "slot-based execution engine"
sbe-title = "Slot-Based Query Execution Engine"
version = "{+version+}"
version-last = "{+version-last+}"
year = "2024"
ui-org-menu = ":icon-mms:`office` :guilabel:`Organizations` menu"

[constants]
atlas-admin-api = "Atlas Administration API"
atlas-cli = "Atlas CLI"
atlas-ui = "Atlas UI"
mongosh = ":binary:`~bin.mongosh`"
package-branch = "testing" # testing for dev rc releases
windows-dir-version = "6.0" # wizard
package-name-org = "mongodb-org"
package-name-enterprise = "mongodb-enterprise"
package-name = "mongodb"
version = "7.3"
current-rapid-release = "7.2"
latest-lts-version = "7.0"
last-supported-version = "5.0"
release = "7.2.0"
version-dev = "7.3"
version-last = "6.0"
pgp-version = "{+version+}"
rsa-key = "4B7C549A058F8B6B"
pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B"
pgp-fingerprint-fmt = "E162 F504 A20C DF15 827F  718D 4B7C 549A 058F 8B6B"
pgp-short-fingerprint = "0x4B7C549A058F8B6B"
windows-sha256 = "C777DF7816BB8C9A760FDEA782113949408B6F39D72BE29A2551FA51E2FE0473"
source-available = ":github:`source available and free to use <mongodb/mongo>`"
pb = ":abbr:`PB (petabyte)`"
pcre-abbr = ":abbr:`PCRE (Perl Compatible Regular Expressions)`"
pcre = "Perl Compatible Regular Expressions"
sbe = "slot-based query execution engine"
sbe-short = "slot-based execution engine"
sbe-title = "Slot-Based Query Execution Engine"
sbe-short-title = "Slot-Based Execution Engine"
fcv = ":abbr:`fCV (feature compatibility version)`"
fts = "Atlas Search"
atlas = "MongoDB Atlas"
# Automerger Constants
auto-merge-upper = "AutoMerger"
auto-merge-lower = "automerger"
auto-merge-lower-plural = "automerger"
auto-merge-action = "automerging"
auto-merge-action-upper = "Automerging"
# In Use Encryption Constants
csfle = "Client-Side Field Level Encryption"
csfle-abbrev = "CSFLE"
qe = "Queryable Encryption"
qe-abbr = ":abbr:`QE (Queryable Encryption)`"
qe-preview = "{+qe+} Public Preview"
qe-equality-ga = "{+qe+} with equality queries"
qe-equality-ga-title = "{+qe+} With Equality Queries"
in-use-doc = "document with encrypted fields"
in-use-doc-title = "Document with Encrypted Fields"
in-use-docs = "documents with encrypted fields"
kms-long = "Key Management System"
kms-abbr = ":abbr:`KMS ({+kms-long+})`"
km-service-long = "Key Management Service"
cmk-long = "Customer Master Key"
cmk-abbr = ":abbr:`CMK ({+cmk-long+})`"
dek-long = "Data Encryption Key"
dek-abbr = ":abbr:`DEK ({+dek-long+})`"
dek-abbr-no-hover = "DEK"
cmk-abbr-no-hover = "CMK"
key-vault-long = "Key Vault collection"
key-vault-long-title = "Key Vault Collection"
aws-abbr = ":abbr:`AWS (Amazon Web Services)`"
aws-iam-abbr = ":abbr:`IAM (Identity and Access Management)`"
aws-arn-abbr = ":abbr:`ARN (Amazon Resource Name)`"
aws-long = "Amazon Web Services"
azure-kv = "Azure Key Vault"
gcp-abbr = ":abbr:`GCP (Google Cloud Platform)`"
gcp-kms = "Google Cloud Key Management Service"
gcp-kms-abbr = "Google Cloud KMS"
manual-enc = "explicit encryption"
manual-enc-title = "Explicit Encryption"
manual-enc-first = "Explicit encryption"
kmip-hover = ":abbr:`KMIP (Key Management Interoperability Protocol)`"
kmip-kms-no-hover = "KMIP-compliant key provider"
kmip-kms = "{+kmip-hover+}-compliant key provider"
kmip-kms-title = "KMIP-Compliant Key Provider"
csfle-code-snippets-gen-keys = "https://github.com/mongodb/docs/tree/master/source/includes/quick-start/generate-master-key"
libmongocrypt-version = "1.9"
mongodb-crypt-version = "1.7.3"
sample-app-url-csfle = "https://github.com/mongodb-university/docs-in-use-encryption-examples/tree/main/csfle"
sample-app-url-qe = "https://github.com/mongodb/docs/tree/master/source/includes/qe-tutorials"
sample-app-url-qe-old = "https://github.com/mongodb-university/docs-in-use-encryption-examples/tree/main/queryable-encryption"
enc-schema = "encryption schema"
enc-schema-title = "Encryption Schema"
efm = "``encryptedFieldsMap``"
efm-title = "encryptedFieldsMap"
shared-library = "Automatic Encryption Shared Library"
shared-library-package = "``crypt_shared``"
shared-library-download-link = ""
auto-encrypt-options = "autoEncryptionOpts"
title-auto-encrypt-options = "AutoEncryptionOpts"
# Driver Constants
java-driver-full = "MongoDB Java driver"
node-driver-full = "MongoDB Node.js driver"
go-driver-full = "MongoDB Go driver"
pymongo = "PyMongo"
csharp-driver-full = "MongoDB C#/.NET driver"
java-driver-version = "4.6"
java-driver-api = "https://mongodb.github.io/mongo-java-driver/{+java-driver-version+}/apidocs"
pymongo-api-docs = "https://pymongo.readthedocs.io/en/stable/api"
node-libmongocrypt-binding-docs = "https://github.com/mongodb/libmongocrypt/tree/master/bindings"
csharp-api-docs = "https://mongodb.github.io/mongo-csharp-driver/2.18/apidocs/html"
java-api-docs = "https://mongodb.github.io/mongo-java-driver/4.11/apidocs"
go-api-docs = "https://pkg.go.dev/go.mongodb.org/mongo-driver@v1.10.3"
enterprise-download-link = "https://www.mongodb.com/try/download/enterprise"
# C2C Product
c2c-full-product-name = "MongoDB Cluster-to-Cluster Sync"
c2c-product-name = "Cluster-to-Cluster Sync"
c2c-docs = "https://www.mongodb.com/docs/cluster-to-cluster-sync/current"
[[banners]]
targets = [
    "core/queryable-encryption.txt",
    "core/queryable-encryption/*.txt",
    "core/queryable-encryption/*/*.txt",
]
variant = "warning"
value = """
    {+qe-equality-ga+} is generally available (GA) in MongoDB 7.0 and \
    later. The {+qe-preview+}, released in version 6.0, is no longer supported. \
    Data encrypted using the Public Preview is incompatible with the feature release. \
    For more information, see :ref:`7.0-compatibility`.
    """
[[banners]]
targets = ["core/csfle.txt", "core/csfle/*.txt", "core/csfle/*/*.txt"]
variant = "tip"
value = """
    MongoDB's {+qe+} feature is available (GA) in MongoDB 7.0 and later. \
    To learn more about {+qe+} and compare its benefits with {+csfle+}, \
    see :ref:`qe-manual-feature-qe`.
    """
[[banners]]
targets = [
    "core/security-oidc.txt",
    "tutorial/configure-oidc.txt"
]
variant = "danger"
value = """
    OpenID Connect is currently available in Public Preview and is only supported 
    on Linux binaries.
    """
[bundle]
manpages = "manpages.tar.gz"
[manpages.mongokerberos]
file = "reference/program/mongokerberos.txt"
title = "mongokerberos"
section = 1
[manpages.mongos]
file = "reference/program/mongos.txt"
title = "mongos"
section = 1
[manpages.mongod]
file = "reference/program/mongod.txt"
title = "mongod"
section = 1
[manpages.mongoldap]
file = "reference/program/mongoldap.txt"
title = "mongoldap"
section = 1
[manpages.mongodb-parameters]
file = "reference/parameters.txt"
title = "MongoDB setParameter Options"
section = 5