eval
Run an FQL query.
Syntax
fauna eval [DBNAME] [QUERY] [--url <value>] [--timeout <value>] [--secret <value>] [--endpoint <value>] [--environment <value>] [--stdin] [--output <value>] [--format json|json-tagged|shell] [--version 4|10] [--typecheck]
Description
The eval
command runs the QUERY against the optional DBNAME database.
The query is executed in the database. If you include a DBNAME, it must be the first argument.
The QUERY can be read from STDIN, a file, or the command line, and query results can be output to STDOUT or a file. You can also define the output format.
If the query returns an error, the Fauna CLI exits with a non-zero exit code.
You can’t use this command to execute a query in a parent or peer database. To access a database outside of the current database, log in to the Fauna Dashboard.
Arguments
Argument | Description |
---|---|
DBNAME |
Name of the database the query should be run against. |
QUERY |
Query you want to run. |
Options
Option | Description |
---|---|
|
Connection endpoint from |
|
Environment to use, from a Fauna project. |
|
Name of file with queries to run. |
|
Output format: |
|
Help for |
|
File to write output to. |
|
Secret key. Overrides the secret in |
|
Read file input from stdin. Write to stdout by default. |
|
Connection timeout (milliseconds). |
|
Enable typechecking. |
|
Database URL. Overrides the URL in |
|
FQL Version: |
Examples
The following examples illustrate the many ways to use the eval
command.
QUERY argument
fauna eval "Product.all()"
Response:
{
data: [
{
id: "402315569179656258",
coll: Product,
ts: Time("2099-07-02T16:14:35.500Z"),
name: "cups",
description: "Translucent 9 Oz, 100 ct",
price: 6.98,
quantity: 90,
store: Store("402315569175461954"),
backorderLimit: 5,
backordered: false
},
...
]
}
QUERY file
The query in the file is identical to the previous example:
fauna eval --file=./query.fql
Is this article helpful?
Tell Fauna how the article can be improved:
Visit Fauna's forums
or email docs@fauna.com
Thank you for your feedback!