Parameters
This section describes the parameters that the FaunaDB Data Manager accepts. A typical command line invocation would look like:
./fdm -source <arg> -dest <arg>
You can display all of the available parameters by running:
./fdm --help
This page includes the following sections:
Parameter list
Parameter | Description |
---|---|
Specifies the path to the |
|
Creates a child database in the database associated with |
|
|
Specifies the source of the data. See the Source specification for the options
that can be included in |
|
Specifies the destination for the data. See the Destination specification for the
options that can be included in |
Specifies one or more format transformations as a comma-separated list. Example: See Format transformations for details. This is equivalent to the |
|
Specifies the number of documents per transaction. The default is 100. This is equivalent to the
|
|
|
Enable verbose output. |
|
Print the FaunaDB Data Manager’s version. |
Source specification
Option | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Use this option to import data from a file in JSON or CSV format, or to import data from a folder containing JSON or CSV format files. |
|||||||||||||||||
Use this option to import data from a FaunaDB database. The
When
|
|||||||||||||||||
Optional - Use this to import JSON or CSV files stored in an AWS S3 bucket. When
|
|||||||||||||||||
Specifies the path to a server-specific JDBC driver. You can download drivers for MySQL or PostgreSQL. Any JDBC driver should be usable, but you have to have a driver that is compatible with the database that you wish to use as a source. When
|
Destination specification
Option | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Specifies that no documents are written, either to the local filesystem or a FaunaDB database. This is useful for testing that the Source specification works. |
|||||||||||||||
Specifies the path to a folder that should receive all exported data. When data is exported, one JSON file per collection in the Source specification is
created, plus a |
|||||||||||||||
Specifies the admin key to a target FaunaDB database that should receive all exported data. When data is exported, all collections, indexes, functions, and roles in
the Source specification are automatically created, or used if they already exist,
in the target FaunaDB database associated with the Documents and their available history are created, or updated to match the Source specification equivalent. If the target database already contains a document with the same reference, its fields are overwritten with the fields from the Source specification. When
|
Schema policies
Schema policies affect the processing of collections, indexes, functions, and roles — collectively, schema documents. When the destination specified is FaunaDB database, one of the following policies can be specified per schema document type:
-
exists
: When the target schema document already exists, the FaunaDB Data Manager uses the existing schema document. No changes to the target schema document are made. -
replace
: When the target schema document already exists, the FaunaDB Data Manager deletes the existing schema document, then creates a new schema document using the configuration of the source schema document. -
ignore
: Function processing is ignored.
The default schema policy is exists
.
Document policy
The document policy affects the processing of data documents (not collections, indexes, functions, or roles). When the destination specified is a FaunaDB database, one of the following policies can be applied:
-
copy
: Copies a document from the source to the destination. -
ignore
: Document processing is ignored.
The default document policy is copy
.
When the source document does not have a FaunaDB reference or
timestamp, It is possible to use existing fields to establish a reference and/or timestamp via Format transformations. |
Document history is not copied. Only the most recent version of each document is processed. |
The document policy is applied to all documents in all collections. It is not possible to apply different document policies to different kinds of documents. |
Was this article helpful?
We're sorry to hear that.
Tell us how we can improve!
documentation@fauna.com
Thank you for your feedback!