Execute a SOQL query.
Description for data query
Specify the SOQL query at the command line with the --query flag or read the query from a file with the --file flag.
If your query returns more than 10,000 records, prefer to use the sf data export bulk command instead. It runs the query using Bulk API 2.0, which has higher limits than the default API used by the command.
Aliases for data query
force:data:soql:query
Flags
| Flag Name (Long) | Flag Name (Short) | Description |
|---|---|---|
| <code>‑‑all‑rows</code> | N/A | Type: Boolean<br><br>Include deleted records. By default, deleted records are not returned. |
| <code>‑‑api‑version</code> | N/A | Type: Value<br><br>Override the api version used for api requests made by this command |
| <code>‑‑file</code> | <code>‑f</code> | Type: Value<br><br>File that contains the SOQL query. |
| <code>‑‑flags‑dir</code> | N/A | Type: Value<br><br>Import flag values from a directory. |
| <code>‑‑json</code> | N/A | Type: Boolean<br><br>Format output as json. |
| <code>‑‑output‑file</code> | N/A | Type: Value<br><br>File where records are written; only CSV and JSON output formats are supported. |
| <code>‑‑query</code> | <code>‑q</code> | Type: Value<br><br>SOQL query to execute. |
| <code>‑‑result‑format</code> | <code>‑r</code> | Type: Value<br>Valid Values: human, csv, json<br>Default value: human<br><br>Format to display the results; the --json flag overrides this flag. |
| <code>‑‑target‑org</code> | <code>‑o</code> | Type: Value<br>Required<br><br>Username or alias of the target org. Not required if the target-org configuration variable is already set. |
| <code>‑‑use‑tooling‑api</code> | <code>‑t</code> | Type: Boolean<br><br>Use Tooling API so you can run queries on Tooling API objects. |
Examples for data query
Specify a SOQL query at the command line; the command uses your default org:
sf data query --query "SELECT Id, Name, Account.Name FROM Contact"
Read the SOQL query from a file called "query.txt" and write the CSV-formatted output to a file; the command uses the org with alias "my-scratch":
sf data query --file query.txt --output-file output.csv --result-format csv --target-org my-scratch
Use Tooling API to run a query on the ApexTrigger Tooling API object:
sf data query --query "SELECT Name FROM ApexTrigger" --use-tooling-api