smallforce app db query

Execute parameterized SQLite against the selected application

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.7. Run smallforce app db query --help locally to view the same reference for your installed version.

Complete command help

Usage: smallforce app db query [options]

Execute parameterized SQLite against the selected application

Options:
  --sql <sql>                     SQL statement to execute
  --params-json <json>            JSON array of SQL parameters (default: "[]")
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment.
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command

Related reference

• smallforce app db: Parent command and related operations.
• CLI installation and authentication: Install the CLI and configure an API key.
• CLI JSON output: Use stable machine-readable output in scripts and agents.