|
| 1 | +name = "mongodb-shell" |
| 2 | +title = "mongosh" |
| 3 | + |
| 4 | +intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv" ] |
| 5 | + |
| 6 | +toc_landing_pages = ["/install", |
| 7 | + "/install/verify-signatures", |
| 8 | + "/run-commands", |
| 9 | + "/crud", |
| 10 | + "/field-level-encryption", |
| 11 | + "/write-scripts", |
| 12 | + "/snippets", |
| 13 | + "/configure-mongosh", |
| 14 | + "/reference/configure-shell-settings", |
| 15 | + "/reference/ejson", |
| 16 | + "/logs", |
| 17 | + "/logs/retention" |
| 18 | + ] |
| 19 | + |
| 20 | +[constants] |
| 21 | + |
| 22 | +version = "2.4.0" |
| 23 | +mdb-version = "8.0" |
| 24 | +pgp-version = "{+mdb-version+}" |
| 25 | +atlas = "MongoDB Atlas" |
| 26 | + |
| 27 | +[substitutions] |
| 28 | + |
| 29 | +2fa = ":abbr:`2FA (Two Factor Authentication)`" |
| 30 | +aki = ":abbr:`AKI (Azure Key Identifier)`" |
| 31 | +akv = ":abbr:`AKV (Azure Key Vault)`" |
| 32 | +api = ":abbr:`API (Application Programming Interface)`" |
| 33 | +arn = ":abbr:`ARN (Amazon Resource Name)`" |
| 34 | +aws = ":abbr:`AWS (Amazon Web Services)`" |
| 35 | +aws-pl = "AWS PrivateLink" |
| 36 | +aws-eni = ":abbr:`ENI (Elastic Network Interface)`" |
| 37 | +azure = ":abbr:`Azure (Microsoft Azure)`" |
| 38 | +bic-full = ":bic:`MongoDB Connector for BI </>`" |
| 39 | +bic-official = "MongoDB Connector for Business Intelligence for Atlas" |
| 40 | +bic-short = ":bic:`BI Connector </>`" |
| 41 | +bic-short-no-link = "BI Connector" |
| 42 | +bic = "BI Connector for Atlas" |
| 43 | +bson = ":abbr:`BSON (Binary Javascript Object Notation)`" |
| 44 | +certauth = "Certificate Authority" |
| 45 | +charts = "MongoDB Charts" |
| 46 | +charts-short = "Charts" |
| 47 | +cidr = ":abbr:`CIDR (Classless Inter-Domain Routing)`" |
| 48 | +cifs = ":abbr:`CIFS (Common Internet File System)`" |
| 49 | +cps = ":abbr:`CPS (Cloud Provider Snapshots)`" |
| 50 | +cmk = ":abbr:`CMK (customer master key)`" |
| 51 | +compass = "MongoDB Compass" |
| 52 | +data-lakes = "Data Lakes" |
| 53 | +data-lake = "Data Lake" |
| 54 | +datadog = "`Datadog <https://www.datadoghq.com/>`__" |
| 55 | +dns = ":abbr:`DNS (Domain Name System)`" |
| 56 | +Epoch-time-ms = "Timestamp in the number of milliseconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__" |
| 57 | +epoch-time-ms = "timestamp in the number of milliseconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__" |
| 58 | +Epoch-time = "Timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__" |
| 59 | +epoch-time = "timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__" |
| 60 | +fcv = ":abbr:`FCV (Feature Compatibility Version)`" |
| 61 | +fqdn = ":abbr:`FQDN (fully qualified domain name)`" |
| 62 | +fts = "Atlas Search" |
| 63 | +gcp = ":abbr:`GCP (Google Cloud Platform)`" |
| 64 | +global-write-clusters = "Global Clusters" |
| 65 | +global-write-cluster = "Global Cluster" |
| 66 | +global-write = "Global Writes" |
| 67 | +hmac = ":abbr:`HMAC (hash-based message authentication code)`" |
| 68 | +https = ":abbr:`HTTPS (Secure HyperText Transport Protocol)`" |
| 69 | +html = ":abbr:`HTML (Hypertext Markup Language)`" |
| 70 | +http = ":abbr:`HTTP (HyperText Transport Protocol)`" |
| 71 | +iam = ":abbr:`IAM (Identity and Access Management)`" |
| 72 | +iana = ":abbr:`IANA (Internet Assigned Numbers Authority)`" |
| 73 | +idp = ":abbr:`IdP (Identity Provider)`" |
| 74 | +idps = ":abbr:`IdPs (Identity Providers)`" |
| 75 | +iops = ":abbr:`IOPS (Input/Output Operations per Second)`" |
| 76 | +ipaddr = ":abbr:`IP (Internet Protocol)`" |
| 77 | +ipv4 = ":abbr:`IPv4 (Internet Protocol version 4)`" |
| 78 | +ipv6 = ":abbr:`IPv6 (Internet Protocol version 6)`" |
| 79 | +iso8601-duration = "Duration in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=851138376#Durations>`__ notation" |
| 80 | +iso8601-time = "Timestamp in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=793821205>`__ date and time format in |utc|" |
| 81 | +iso8601 = "`ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=793821205>`__" |
| 82 | +jira = "`Jira <https://jira.mongodb.org>`__" |
| 83 | +json = ":abbr:`JSON (Javascript Object Notation)`" |
| 84 | +kdc = ":abbr:`KDC (Key Distribution Center)`" |
| 85 | +kmip = ":abbr:`KMIP (Key Management Interoperability)`" |
| 86 | +kms = ":abbr:`KMS (Key Management Service)`" |
| 87 | +ldaps = ":abbr:`LDAPS (Secure Lightweight Directory Access Protocol)`" |
| 88 | +ldap = ":abbr:`LDAP (Lightweight Directory Access Protocol)`" |
| 89 | +mdb-shell= "MongoDB Shell" |
| 90 | +mms-full = "MongoDB Cloud Manager" |
| 91 | +mms = "Cloud Manager" |
| 92 | +mongo = ":binary:`~bin.mongo`" |
| 93 | +mongod = ":binary:`~bin.mongod`" |
| 94 | +mongos = ":binary:`~bin.mongos`" |
| 95 | +nfs = ":abbr:`NFS (Network File System)`" |
| 96 | +nvme = ":abbr:`NVMe (non-volatile memory express)`" |
| 97 | +nvme-clusters = "clusters with local NVMe SSDs" |
| 98 | +pa = "Performance Advisor" |
| 99 | +pem = ":abbr:`PEM (Privacy Enhanced Mail)`" |
| 100 | +pit = ":abbr:`PIT (Point in Time)`" |
| 101 | +piv = ":abbr:`PIV (Personal Identity Verification)`" |
| 102 | +rdp = ":abbr:`RDP (Remote Desktop Protocol)`" |
| 103 | +repl = ":abbr:`REPL (Read Eval Print Loop)`" |
| 104 | +restapi = ":abbr:`REST (Representational State Transfer)` :abbr:`API (Application Programming Interface)`" |
| 105 | +rest = ":abbr:`REST (Representational State Transfer)`" |
| 106 | +s3 = ":abbr:`S3 (Simple Storage Service)`" |
| 107 | +sak = ":abbr:`SAK (Service Account Key)`" |
| 108 | +saml = ":abbr:`SAML (Security Assertion Markup Language)`" |
| 109 | +sca = ":abbr:`SCA (Strong Customer Authentication)`" |
| 110 | +service-fullname = "MongoDB Atlas" |
| 111 | +service-pricing = "Atlas pricing page" |
| 112 | +service = "Atlas" |
| 113 | +sms = ":abbr:`SMS (short message service)`" |
| 114 | +smtp = ":abbr:`SMTP (Simple Mail Transport Protocol)`" |
| 115 | +sni = ":abbr:`SNI (Server Name Indication)`" |
| 116 | +snmp = ":abbr:`SNMP (Simple Network Management Protocol)`" |
| 117 | +spn = ":abbr:`SPN (Service Principal Name)`" |
| 118 | +ssd = ":abbr:`SSD (Solid State Disk)`" |
| 119 | +ssl = ":abbr:`SSL (Secure Sockets Layer)`" |
| 120 | +stitch-docs = "MongoDB Stitch" |
| 121 | +tcp = ":abbr:`TCP (Transmission Control Protocol)`" |
| 122 | +tls-ssl = ":abbr:`TLS (Transport Layer Security)` / :abbr:`SSL (Secure Sockets Layer)`" |
| 123 | +tls = ":abbr:`TLS (Transport Layer Security)`" |
| 124 | +totp = ":abbr:`TOTP (Time-based One-time Password Algorithm)`" |
| 125 | +udp = ":abbr:`UDP (User Datagram Protocol)`" |
| 126 | +upn = ":abbr:`UPN (User Principal Name)`" |
| 127 | +uri = ":abbr:`URI (Uniform Resource Identifier)`" |
| 128 | +url = ":abbr:`URL (Uniform Resource Locator)`" |
| 129 | +utc = ":abbr:`UTC (Coordinated Universal Time)`" |
| 130 | +vpc = ":abbr:`VPC (Virtual Private Cloud)`" |
| 131 | +yaml = ":abbr:`YAML (Yet Another Markup Language)`" |
| 132 | + |
| 133 | +[bundle] |
| 134 | +manpages = "manpages.tar.gz" |
| 135 | + |
| 136 | +[manpages.mongosh] |
| 137 | +file = "reference/options.txt" |
| 138 | +title = "mongosh" |
| 139 | +section = 1 |
0 commit comments