How do i export a mongodb database?

Docs HomeMongoDB Database Tools

mongoexport is a command-line tool that produces a JSON or CSV export of data stored in a MongoDB instance.

Run mongoexport from the system command line, not the mongo shell.

Tip

See also:

mongoimport which provides the corresponding structured data import capability.

Note

If you are archiving stale data to save on storage costs, consider Online Archive in MongoDB Atlas. Online Archive automatically archives infrequently accessed data to fully-managed S3 buckets for cost-effective data tiering.

Starting with MongoDB 4.4, mongoexport is now released separately from the MongoDB Server and uses its own versioning, with an initial version of 100.0.0. Previously, mongoexport was released alongside the MongoDB Server and used matching versioning.

For documentation on the MongoDB 4.2 or earlier versions of mongoexport, reference the MongoDB Server Documentation for that version of the tool:

Note

This documentation is for version 100.6.0 of mongoexport.

mongoexport version 100.6.0 supports the following versions of the MongoDB Server:

  • MongoDB 6.0

  • MongoDB 5.0

  • MongoDB 4.4

  • MongoDB 4.2

While mongoexport may work on earlier versions of MongoDB server, any such compatibility is not guaranteed.

mongoexport version 100.6.0 is supported on the following platforms:

x86_64

ARM64

PPC64LE

s390x

Amazon 2

Amazon 2013.03+

Debian 10

Debian 9

Debian 8

RHEL / CentOS 8

RHEL / CentOS 7

RHEL / CentOS 6

SUSE 15

SUSE 12

Ubuntu 20.04

Ubuntu 18.04

Ubuntu 16.04

Ubuntu 14.04

Windows 8 and later

Windows Server 2012 and later

macOS 10.12 or later

The mongoexport tool is part of the MongoDB Database Tools package:

➤ Follow the Database Tools Installation Guide to install mongoexport.

The mongoexport command has the following form:

mongoexport --collection=

Run mongoexport from the system command line, not the mongo shell.

You must specify the collection to export. If you do not specify an output file, mongoexport writes to the standard output [e.g. stdout].

To connect to a local MongoDB instance running on port 27017, you do not have to specify the host or port.

For example, to export the specified collection to the specified output file from a local MongoDB instance running on port 27017:

mongoexport --collection=events --db=reporting --out=events.json

To specify a host and/or port of the MongoDB instance, you can either:

  • Specify the hostname and port in the --uri connection string:

    mongoexport --uri="mongodb://mongodb0.example.com:27017/reporting" --collection=events --out=events.json [additional options]

    When using the --uri connection string, the database can be specified as part of the string.

  • Specify the hostname and port in the --host:

    mongoexport --host="mongodb0.example.com:27017" --collection=events --db=reporting --out=events.json [additional options]

  • Specify the hostname and port in the --host and --port:

    mongoexport --host="mongodb0.example.com" --port=27017 --collection=events --db=reporting --out=events.json [additional options]

For more information on the options available, see Options.

To connect to a replica set to export its data, you can either:

  • Specify the replica set name and members in the --uri connection string:

    mongoexport --uri="mongodb://mongodb0.example.com:27017,mongodb1.example.com:27017,mongodb2.example.com:27017/reporting?replicaSet=myReplicaSetName" --collection=events --out=events.json [additional options]

    When using the --uri connection string, the database can be specified as part of the string.

  • Specify the replica set name and members in the --host:

    mongoexport --host="myReplicaSetName/mongodb0.example.com:27017,mongodb1.example.com:27017,mongodb2.example.com" --collection=events --db=reporting --out=events.json [additional options]

By default, mongoexport reads from the primary of the replica set. To override the default, you can specify the read preference:

  • You can specify the read preference in the --uri connection string

    mongoexport --uri="mongodb://mongodb0.example.com:27017,mongodb1.example.com:27017,mongodb2.example.com:27017/reporting?replicaSet=myReplicaSetName&readPreference=secondary" --collection=events --out=events.json [additional options]

    If specifying the read preference tags, include the readPreferenceTags option:

    mongoexport --uri="mongodb://mongodb0.example.com:27017,mongodb1.example.com:27017,mongodb2.example.com:27017/reporting?replicaSet=myReplicaSetName&readPreference=secondary&readPreferenceTags=region:east" --collection=events --out=events.json [additional options]

    When using the --uri connection string, the database can be specified as part of the string.

  • You can specify the read preference using the --readPreference command-line option. The command-line option takes a string if specifying only the read preference mode:

    mongoexport --host="myReplicaSetName/mongodb0.example.com:27017,mongodb1.example.com:27017,mongodb2.example.com:27017" --readPreference=secondary --collection=events --db=reporting --out=events.json [additional options]

    Or, the command-line option can takes a quote-enclosed document '{ mode: , tagSets: [ , ... ], maxStalenessSeconds:}' to specify the mode, the optional read preference tag sets, and the optional maxStalenessSeconds:

    mongoexport --host="myReplicaSetName/mongodb0.example.com:27017,mongodb1.example.com:27017,mongodb2.example.com:27017" --readPreference='{mode: "secondary", tagSets: [ { "region": "east" } ]}' --collection=events --db=reporting --out=events.json [additional options]

For more information on the options available, see Options.

To connect to a sharded cluster to export its data, you can either:

  • Specify the hostname of the mongos instance in the --uri connection string

    mongoexport --uri="mongodb://mongos0.example.com:27017/reporting" --collection=events --out=events.json [additional options]

    When using the --uri connection string, the database can be specified as part of the string.

  • Specify the hostname and port of the mongos instance in the --host

    mongoexport --host="mongos0.example.com:27017" --collection=events --db=reporting --out=events.json[additional options]

By default, mongoexport reads from the primary of the shard replica set. To override the default, you can specify the read preference:

  • You can specify the read preference in the --uri connection string

    mongoexport --uri="mongodb://mongos0.example.com:27017/reporting?readPreference=secondary" --collection=events --out=events.json [additional options]

    If specifying the read preference tags, include the readPreferenceTags option:

    mongoexport --uri="mongodb://mongos0.example.com:27017/reporting?readPreference=secondary&readPreferenceTags=region:east" --collection=events --out=events.json [additional options]

    When using the --uri connection string, the database can be specified as part of the string.

  • You can specify the read preference using the --readPreference command-line option. The command-line option takes a string if specifying only the read preference mode:

    mongoexport --host="mongos0.example.com:27017" --readPreference=secondary --collection=events --db=reporting --out=events.json [additional options]

    Or, the command-line option can takes a quote-enclosed document '{ mode: , tagSets: [ , ... ], maxStalenessSeconds:}' to specify the mode, the optional read preference tag sets, and the optional maxStalenessSeconds:

    mongoexport --host="mongos0.example.com:27017" --readPreference='{mode: "secondary", tagSets: [ { "region": "east" } ]}' --collection=events --db=reporting --out=events.json [additional options]

For more information on the options available, see Options.

Tip

See also:

mongoexport requires read access on the target database.

Ensure that the connecting user possesses, at a minimum, the read role on the target database.

When connecting to a mongod or mongos that enforces Authentication, ensure you use the required security parameters based on the configured authentication mechanism.

If you need to preserve all rich BSON data types when using mongoexport to perform full instance backups, be sure to specify Extended JSON v2.0 [Canonical mode] to the --jsonFormat option to mongoexport, in the following fashion:

mongoexport --jsonFormat=canonical --collection=

If --jsonFormat is unspecified, mongoexport outputs data in Extended JSON v2.0 [Relaxed mode] by default.

mongoimport will automatically use the JSON format found in the specified target data file when restoring. For example, it will use Extended JSON v2.0 [Canonical mode] if the target data export file was created by mongoexport with --jsonFormat=canonical specified.

mongoexport automatically creates FIPS-compliant connections to a mongod/mongos that is configured to use FIPS mode.

By default, mongoexport uses read preference primary. To override the default, you can specify the read preference in the --readPreference command line option or in the --uri connection string.

If you specify read preference in the URI string and the --readPreference, the --readPreference value overrides the read preference specified in the URI string.

Warning

Data Import and Export Conflicts With [$] and [.]

Starting in MongoDB 5.0, document field names can be [$] prefixed and can contain a [.]. However, mongoimport and mongoexport should not be used with field names that make use of these characters.

MongoDB Extended JSON v2 cannot differentiate between type wrappers and fields that happen to have the same name as type wrappers. Do not use Extended JSON formats in contexts where the corresponding BSON representations might include [$] prefixed keys. The DBRef mechanism is an exception to this general rule.

There are also restrictions on using mongoimport and mongoexport with [.] in field names. Since CSV files use the [.] to represent data hierarchies, a [.] in a field name will be misinterpreted as a level of nesting.

--help

Returns information on the options and use of mongoexport.

--verbose, -v

Increases the amount of internal reporting returned on standard output or in log files. Increase the verbosity with the -v form by including the option multiple times, [e.g. -vvvvv.]

--quiet

Runs mongoexport in a quiet mode that attempts to limit the amount of output.

This option suppresses:

  • output from database commands

  • replication activity

  • connection accepted events

  • connection closed events

--version

Returns the mongoexport release number.

--config=

New in version 100.3.0.

Specifies the full path to a YAML configuration file containing sensitive values for the following options to mongoexport:

  • --password

  • --uri

  • --sslPEMKeyPassword

This is the recommended way to specify a password to mongoexport, aside from specifying it through a password prompt.

The configuration file takes the following form:

password:
uri: mongodb://mongodb0.example.com:27017
sslPEMKeyPassword:

Specifying a password to the password: field and providing a connection string in the uri: field which contains a conflicting password will result in an error.

Be sure to secure this file with appropriate filesystem permissions.

Note

--uri=

Specifies the resolvable URI connection string of the MongoDB deployment, enclosed in quotes:

--uri="mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]"

Starting with version 100.0 of mongoexport, the connection string may alternatively be provided as a positional parameter, without using the --uri option:

mongoexport mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]

As a positional parameter, the connection string may be specified at any point on the command line, as long as it begins with either mongodb:// or mongodb+srv://. For example:

mongoexport --username joe --password secret1 mongodb://mongodb0.example.com:27017 --ssl

Only one connection string can be provided. Attempting to include more than one, whether using the --uri option or as a positional argument, will result in an error.

For information on the components of the connection string, see the Connection String URI Format documentation.

Note

Some components in the connection string may alternatively be specified using their own explicit command-line options, such as --username and --password. Providing a connection string while also using an explicit option and specifying conflicting information will result in an error.

Note

Warning

On some systems, a password provided in a connection string with the --uri option may be visible to system status programs such as ps that may be invoked by other users. Consider instead:

  • omitting the password in the connection string to receive an interactive password prompt, or

  • using the --config option to specify a configuration file containing the password.

--host=, -h=

Default: localhost:27017

Specifies the resolvable hostname of the MongoDB deployment. By default, mongoexport attempts to connect to a MongoDB instance running on the localhost on port number 27017.

To connect to a replica set, specify the replSetName and a seed list of set members, as in the following:

--host=/,,

When specifying the replica set list format, mongoexport always connects to the primary.

You can also connect to any single member of the replica set by specifying the host and port of only that member:

--host=

If you use IPv6 and use the : format, you must enclose the portion of an address and port combination in brackets [e.g. []].

Alternatively, you can also specify the hostname directly in the URI connection string. Providing a connection string while also using --host and specifying conflicting information will result in an error.

--port=

Default: 27017

Specifies the TCP port on which the MongoDB instance listens for client connections.

Alternatively, you can also specify the port directly in the URI connection string. Providing a connection string while also using --port and specifying conflicting information will result in an error.

--ssl

Enables connection to a mongod or mongos that has TLS/SSL support enabled.

Alternatively, you can also configure TLS/SSL support directly in the URI connection string. Providing a connection string while also using --ssl and specifying conflicting information will result in an error.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients.

--sslCAFile=

Specifies the .pem file that contains the root certificate chain from the Certificate Authority. Specify the file name of the .pem file using relative or absolute paths.

Alternatively, you can also specify the .pem file directly in the URI connection string. Providing a connection string while also using --sslCAFile and specifying conflicting information will result in an error.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients.

--sslPEMKeyFile=

Specifies the .pem file that contains both the TLS/SSL certificate and key. Specify the file name of the .pem file using relative or absolute paths.

This option is required when using the --ssl option to connect to a mongod or mongos that has CAFile enabled without allowConnectionsWithoutCertificates.

Alternatively, you can also specify the .pem file directly in the URI connection string. Providing a connection string while also using --sslPEMKeyFile and specifying conflicting information will result in an error.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients.

--sslPEMKeyPassword=

Specifies the password to de-crypt the certificate-key file [i.e. --sslPEMKeyFile]. Use the --sslPEMKeyPassword option only if the certificate-key file is encrypted. In all cases, the mongoexport will redact the password from all logging and reporting output.

If the private key in the PEM file is encrypted and you do not specify the --sslPEMKeyPassword option, the mongoexport will prompt for a passphrase. See TLS/SSL Certificate Passphrase.

Alternatively, you can also specify the password directly in the URI connection string. Providing a connection string while also using --sslPEMKeyPassword and specifying conflicting information will result in an error.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients.

Warning

On some systems, a password provided directly using the --sslPEMKeyPassword option may be visible to system status programs such as ps that may be invoked by other users. Consider using the --config option to specify a configuration file containing the password instead.

--sslCRLFile=

Specifies the .pem file that contains the Certificate Revocation List. Specify the file name of the .pem file using relative or absolute paths.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients.

--sslAllowInvalidCertificates

Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the allowInvalidCertificates setting, MongoDB logs as a warning the use of the invalid certificate.

Warning

Although available, avoid using the --sslAllowInvalidCertificates option if possible. If the use of --sslAllowInvalidCertificates is necessary, only use the option on systems where intrusion is not possible.

Connecting to a mongod or mongos instance without validating server certificates is a potential security risk. If you only need to disable the validation of the hostname in the TLS/SSL certificates, see --sslAllowInvalidHostnames.

Alternatively, you can also disable certificate validation directly in the URI connection string. Providing a connection string while also using --sslAllowInvalidCertificates and specifying conflicting information will result in an error.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients.

--sslAllowInvalidHostnames

Disables the validation of the hostnames in TLS/SSL certificates. Allows mongoexport to connect to MongoDB instances even if the hostname in their certificates do not match the specified hostname.

Alternatively, you can also disable hostname validation directly in the URI connection string. Providing a connection string while also using --sslAllowInvalidHostnames and specifying conflicting information will result in an error.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients.

--username=, -u=

Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the --password and --authenticationDatabase options.

Alternatively, you can also specify the username directly in the URI connection string. Providing a connection string while also using --username and specifying conflicting information will result in an error.

If connecting to a MongoDB Atlas cluster using the MONGODB-AWS authentication mechanism, you can specify your AWS access key ID in:

  • this field,

  • the connection string, or

  • the AWS_ACCESS_KEY_ID environment variable.

See Connect to a MongoDB Atlas Cluster using AWS IAM Credentials for an example of each.

--password=, -p=

Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the --username and --authenticationDatabase options.

To prompt the user for the password, pass the --username option without --password or specify an empty string as the --password value, as in --password "" .

Alternatively, you can also specify the password directly in the URI connection string. Providing a connection string while also using --password and specifying conflicting information will result in an error.

If connecting to a MongoDB Atlas cluster using the MONGODB-AWS authentication mechanism, you can specify your AWS secret access key in:

  • this field,

  • the connection string, or

  • the AWS_SECRET_ACCESS_KEY environment variable.

See Connect to a MongoDB Atlas Cluster using AWS IAM Credentials for an example of each.

Warning

On some systems, a password provided directly using the --password option may be visible to system status programs such as ps that may be invoked by other users. Consider instead:

  • omitting the --password option to receive an interactive password prompt, or

  • using the --config option to specify a configuration file containing the password.

--awsSessionToken=

If connecting to a MongoDB Atlas cluster using the MONGODB-AWS authentication mechanism, and using session tokens in addition to your AWS access key ID and secret access key, you can specify your AWS session token in:

  • this field,

  • the AWS_SESSION_TOKEN authMechanismProperties parameter to the connection string, or

  • the AWS_SESSION_TOKEN environment variable.

See Connect to a MongoDB Atlas Cluster using AWS IAM Credentials for an example of each.

Only valid when using the MONGODB-AWS authentication mechanism.

--authenticationDatabase=

Specifies the authentication database where the specified --username has been created. See Authentication Database.

If you do not specify an authentication database, mongoexport assumes that the database specified to export holds the user's credentials.

If using the GSSAPI [Kerberos], PLAIN [LDAP SASL], or MONGODB-AWS authentication mechanisms, you must set --authenticationDatabase to $external.

Alternatively, you can also specify the authentication database directly in the URI connection string. Providing a connection string while also using --authenticationDatabase and specifying conflicting information will result in an error.

--authenticationMechanism=

Default: SCRAM-SHA-1

Specifies the authentication mechanism the mongoexport instance uses to authenticate to the mongod or mongos.

Changed in version 100.1.0: Starting in version 100.1.0, mongoexport adds support for the MONGODB-AWS authentication mechanism when connecting to a MongoDB Atlas

Chủ Đề