> ## Documentation Index > Fetch the complete documentation index at: https://docs.bijection.com/llms.txt > Use this file to discover all available pages before exploring further. # bijection sql > Plan SQL, see where it runs and serve SQL clients ## bijection sql ```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} Explain SQL without starting it, list the relations you can read and serve Flight SQL clients. Start SQL with bijection run sql; read what it produced with bijection result. Usage: bijection sql [flags] bijection sql [command] Examples: bijection sql explain --file report.sql bijection sql catalog bijection sql placements Available Commands: catalog List SQL relations visible to the signed-in caller client Export a Power BI or Tableau Flight SQL configuration explain Explain SQL, a declared definition or a collection relation without starting it placements Summarize where each declared SQL definition would run serve Serve Flight SQL over the application catalog Flags: -h, --help help for sql --help-all Show all commands and options, including administrative controls. --help-json Print command input and output schemas as JSON without executing it. Use "bijection sql [command] --help" for more information about a command. ``` ## bijection sql catalog ```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} List SQL relations visible to the signed-in caller Usage: bijection sql catalog [flags] Flags: --as string Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities. --branch string Use a branch under your current business identity. --deployment string Inspect definitions in a specific deployment. Accepts: • a deployment name (e.g. joyful-capybara-123) • a deployment reference (e.g. dev/james, staging) • dev (for your personal dev deployment) • prod (for your project’s default production deployment). You can also select deployments in other projects with project-slug:reference. --emulation string Use this explicitly selected reduced-authority preview and its original target. Omit deployment, branch and identity selectors. --features Show implementation contracts, availability requirements and verification evidence. --format string Output format; JSON preserves exact values. (pretty, json) (default "pretty") -h, --help help for catalog --help-all Show all commands and options, including administrative controls. --help-json Print command input and output schemas as JSON without executing it. --sign-in-client string Select the installed application client for business sign-in --url string Inspect definitions in a private deployment at this explicit origin. ``` ## bijection sql client ```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} Export a Power BI or Tableau Flight SQL configuration Usage: bijection sql client [flags] Flags: --client-version string Selected application version; configuration metadata, not an execution observation. --endpoint string Flight SQL HTTPS endpoint, without credentials or a path. -h, --help help for client --help-all Show all commands and options, including administrative controls. --help-json Print command input and output schemas as JSON without executing it. --output string New directory for the connector, connection configuration and source manifest. ``` ## bijection sql explain ```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} Plan the exact inputs under current access. Print the checked plan without reserving a result or executing source work. Usage: bijection sql explain [sql-or-definition] [args...] [flags] Flags: --args string The complete declared inputs as exact JSON or @path; omit assignments. --as string Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities. --branch string Use a branch under your current business identity. --deployment string Inspect definitions in a specific deployment. Accepts: • a deployment name (e.g. joyful-capybara-123) • a deployment reference (e.g. dev/james, staging) • dev (for your personal dev deployment) • prod (for your project’s default production deployment). You can also select deployments in other projects with project-slug:reference. --emulation string Use this explicitly selected reduced-authority preview and its original target. Omit deployment, branch and identity selectors. --execution string Execution policy as JSON, for example {"kind":"binding","binding":"analytics"}. --file string Read bounded SQL over the caller's exposed ontology catalog. --format string Output format; JSON preserves exact values. (pretty, json) (default "pretty") -h, --help help for explain --help-all Show all commands and options, including administrative controls. --help-json Print command input and output schemas as JSON without executing it. --max-bytes int Complete SQL result byte bound; excess refuses. (default 4194304) --max-rows int Complete SQL result row bound; excess refuses. (default 4096) --params string Named SQL parameter values as exact JSON or @path. --relation string An ad-hoc relation over one collection. --sign-in-client string Select the installed application client for business sign-in --table-providers string Named SQL table inputs as admitted object-query requests, from JSON or @path. --url string Inspect definitions in a private deployment at this explicit origin. ``` ## bijection sql placements ```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} Explain every declared SQL definition with placeholder arguments, one line each: its strategy, execution sites and the crossings it needs between them, or why no placement is admissible. Nothing executes and no data moves: planning reads source metadata only, and destination rules are asked for advice. A definition whose access depends on the caller or its arguments is decided when it runs. Deploy cannot print this itself, since planning needs the installed sources' metadata. Usage: bijection sql placements [flags] Flags: --as string Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities. --branch string Use a branch under your current business identity. --deployment string Inspect definitions in a specific deployment. Accepts: • a deployment name (e.g. joyful-capybara-123) • a deployment reference (e.g. dev/james, staging) • dev (for your personal dev deployment) • prod (for your project’s default production deployment). You can also select deployments in other projects with project-slug:reference. --emulation string Use this explicitly selected reduced-authority preview and its original target. Omit deployment, branch and identity selectors. --format string Output format; JSON preserves exact values. (pretty, json) (default "pretty") -h, --help help for placements --help-all Show all commands and options, including administrative controls. --help-json Print command input and output schemas as JSON without executing it. --sign-in-client string Select the installed application client for business sign-in --url string Inspect definitions in a private deployment at this explicit origin. ``` ## bijection sql serve ```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} Run an optional foreground Flight SQL gateway. Every RPC requires the client's business Bearer token, or the bearer returned when a JDBC or ODBC client connects with a service name and its credential as user and password. Each statement handle follows one run and its accepted result; reconnecting follows the same run and fetching another batch never submits SQL. Supply a distinct canonical UUIDv7 in x-bijection-request-id for each parameter row, and repeat it with identical SQL and parameters to recover the original ticket, schema and expiry. Without that header each execution starts a new run. Retired, spent, expired or changed submissions are refused. Usage: bijection sql serve [flags] Flags: --deployment string Serve SQL for a specific deployment. Accepts: • a deployment name (e.g. joyful-capybara-123) • a deployment reference (e.g. dev/james, staging) • dev (for your personal dev deployment) • prod (for your project’s default production deployment). You can also select deployments in other projects with project-slug:reference. --execution string Choose native, a source executor, one installed binding, or ordered automatic bindings as JSON. -h, --help help for serve --help-all Show all commands and options, including administrative controls. --help-json Print command input and output schemas as JSON without executing it. --idle-lease string Unused handle lifetime, up to 15m. --listen string Listener address (default 127.0.0.1:31337). --max-batch-bytes int Arrow page allowance, at most the result allowance. --max-handles int Gateway handle ceiling (default 256, maximum 4096). --max-prepared-per-principal int Prepared statements per caller (default 128). --max-requests-per-principal int Concurrent retained runs per caller (default 32). --max-result-bytes int Complete result byte allowance, up to 10737418240 on streaming compute (native: 16777216); deployment quotas also apply. --max-result-rows int Complete accepted result row ceiling, up to 10000000 on streaming compute (native: 65536). --max-runtime string Run lifetime ceiling, up to 15m. --max-transfer-bytes int Durable Flight payload allowance across reconnects (default 67108864, maximum 1099511627776). --preflight Print effective result limits, exact retained-storage requirements and default quotas without signing in, listening or reserving capacity. --sign-in-client string Select the installed application client for business sign-in --tls-cert string PEM server certificate; required for a network listener. --tls-key string PEM server private key. --url string Serve SQL for a private deployment at this explicit origin. --warehouse string Enable Dataset writes and transactions through an installed SQLWarehouse function module. ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.