> ## 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 query

> Read a collection or named query

## bijection query

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Read a collection or public query as your business identity. Pages return a basis and cursor; keep both with the original target and predicates. Virtual collections retain one execution before starting source work. --page-size controls delivery, while --max-rows and --max-bytes bound source work. --watch follows named query updates, each at its own read basis.

Usage:
  bijection query <resource> [args...] [flags]
  bijection query [command]

Available Commands:
  cancel      Request cancellation of source work
  page        Read one page of an existing complete result
  release     Release retained source inputs and results
  reserve     Reserve and save a remote execution before source work
  resume      Observe an existing execution without submitting source work
  start       Start source work under an already saved reservation
  status      Read retained query status

Flags:
      --as string           Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
      --basis string        Use the original read basis returned by the collection page.
      --branch string       Use a branch under your current business identity.
      --cursor string       Continue a collection page; requires its --basis.
      --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.
      --explain             Explain virtual source work without executing it.
      --format string       Finite collection page rows in human or machine format; --json preserves the complete page and basis. (pretty, json, jsonl) (default "pretty")
      --from string         Read a bounded virtual query graph from a JSON file.
  -h, --help                help for query
      --help-all            Show all commands and options, including administrative controls.
      --json                Print exact query results and their read basis as JSON.
      --max-bytes int       Virtual result byte bound. (default 4194304)
      --max-rows int        Virtual source work bound; exceeding it refuses the complete result. (default 4096)
      --page-size int       Collection page size, from 1 to 50. (default 20)
      --prod                Inspect definitions in this project's default production deployment.
      --query string        Arguments in the collection reader's admitted query language.
      --select string       Comma-separated collection fields.
      --timeout string      Stop observing remote work after this duration; retain its execution for recovery. (default "30s")
      --watch               Follow a named query as JSON lines, each with its native read basis.

Use "bijection query [command] --help" for more information about a command.
```

## bijection query cancel

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Request cancellation of source work

Usage:
  bijection query cancel <execution-id> [flags]

Flags:
      --as string   Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
  -h, --help        help for cancel
      --json        Print the checked native result.

Global Flags:
      --basis string        Use the original read basis returned by the collection page.
      --branch string       Use a branch under your current business identity.
      --cursor string       Continue a collection page; requires its --basis.
      --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.
      --explain             Explain virtual source work without executing it.
      --format string       Finite collection page rows in human or machine format; --json preserves the complete page and basis. (pretty, json, jsonl) (default "pretty")
      --from string         Read a bounded virtual query graph from a JSON file.
      --help-all            Show all commands and options, including administrative controls.
      --max-bytes int       Virtual result byte bound. (default 4194304)
      --max-rows int        Virtual source work bound; exceeding it refuses the complete result. (default 4096)
      --page-size int       Collection page size, from 1 to 50. (default 20)
      --prod                Inspect definitions in this project's default production deployment.
      --query string        Arguments in the collection reader's admitted query language.
      --select string       Comma-separated collection fields.
      --timeout string      Stop observing remote work after this duration; retain its execution for recovery. (default "30s")
      --watch               Follow a named query as JSON lines, each with its native read basis.
```

## bijection query page

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Read one page of an existing complete result

Usage:
  bijection query page <execution-id> [flags]

Flags:
      --as string       Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
      --cursor string   Continue the exact retained result.
  -h, --help            help for page
      --json            Print the checked native result.
      --page-size int   Return one to one thousand rows. (default 20)

Global Flags:
      --basis string        Use the original read basis returned by the collection page.
      --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.
      --explain             Explain virtual source work without executing it.
      --format string       Finite collection page rows in human or machine format; --json preserves the complete page and basis. (pretty, json, jsonl) (default "pretty")
      --from string         Read a bounded virtual query graph from a JSON file.
      --help-all            Show all commands and options, including administrative controls.
      --max-bytes int       Virtual result byte bound. (default 4194304)
      --max-rows int        Virtual source work bound; exceeding it refuses the complete result. (default 4096)
      --prod                Inspect definitions in this project's default production deployment.
      --query string        Arguments in the collection reader's admitted query language.
      --select string       Comma-separated collection fields.
      --timeout string      Stop observing remote work after this duration; retain its execution for recovery. (default "30s")
      --watch               Follow a named query as JSON lines, each with its native read basis.
```

## bijection query release

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Release retained source inputs and results

Usage:
  bijection query release <execution-id> [flags]

Flags:
      --as string   Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
  -h, --help        help for release
      --json        Print the checked native result.

Global Flags:
      --basis string        Use the original read basis returned by the collection page.
      --branch string       Use a branch under your current business identity.
      --cursor string       Continue a collection page; requires its --basis.
      --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.
      --explain             Explain virtual source work without executing it.
      --format string       Finite collection page rows in human or machine format; --json preserves the complete page and basis. (pretty, json, jsonl) (default "pretty")
      --from string         Read a bounded virtual query graph from a JSON file.
      --help-all            Show all commands and options, including administrative controls.
      --max-bytes int       Virtual result byte bound. (default 4194304)
      --max-rows int        Virtual source work bound; exceeding it refuses the complete result. (default 4096)
      --page-size int       Collection page size, from 1 to 50. (default 20)
      --prod                Inspect definitions in this project's default production deployment.
      --query string        Arguments in the collection reader's admitted query language.
      --select string       Comma-separated collection fields.
      --timeout string      Stop observing remote work after this duration; retain its execution for recovery. (default "30s")
      --watch               Follow a named query as JSON lines, each with its native read basis.
```

## bijection query reserve

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Reserve and save a remote execution before source work

Usage:
  bijection query reserve [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.
  -h, --help                help for reserve
      --json                Print the complete public contract as JSON.
      --prod                Inspect definitions in this project's default production deployment.

Global Flags:
      --basis string     Use the original read basis returned by the collection page.
      --cursor string    Continue a collection page; requires its --basis.
      --explain          Explain virtual source work without executing it.
      --format string    Finite collection page rows in human or machine format; --json preserves the complete page and basis. (pretty, json, jsonl) (default "pretty")
      --from string      Read a bounded virtual query graph from a JSON file.
      --help-all         Show all commands and options, including administrative controls.
      --max-bytes int    Virtual result byte bound. (default 4194304)
      --max-rows int     Virtual source work bound; exceeding it refuses the complete result. (default 4096)
      --page-size int    Collection page size, from 1 to 50. (default 20)
      --query string     Arguments in the collection reader's admitted query language.
      --select string    Comma-separated collection fields.
      --timeout string   Stop observing remote work after this duration; retain its execution for recovery. (default "30s")
      --watch            Follow a named query as JSON lines, each with its native read basis.
```

## bijection query resume

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Observe an existing execution without submitting source work

Usage:
  bijection query resume <execution-id> [flags]

Flags:
      --as string        Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
      --cursor string    Continue the exact retained result.
  -h, --help             help for resume
      --json             Print the checked native result.
      --page-size int    Return one to one thousand rows. (default 20)
      --timeout string   Bound observation; keep the execution on timeout. (default "30s")

Global Flags:
      --basis string        Use the original read basis returned by the collection page.
      --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.
      --explain             Explain virtual source work without executing it.
      --format string       Finite collection page rows in human or machine format; --json preserves the complete page and basis. (pretty, json, jsonl) (default "pretty")
      --from string         Read a bounded virtual query graph from a JSON file.
      --help-all            Show all commands and options, including administrative controls.
      --max-bytes int       Virtual result byte bound. (default 4194304)
      --max-rows int        Virtual source work bound; exceeding it refuses the complete result. (default 4096)
      --prod                Inspect definitions in this project's default production deployment.
      --query string        Arguments in the collection reader's admitted query language.
      --select string       Comma-separated collection fields.
      --watch               Follow a named query as JSON lines, each with its native read basis.
```

## bijection query start

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Start source work under an already saved reservation

Usage:
  bijection query start <collection> [flags]

Flags:
      --as string             Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
      --execution-id string   Identity returned by query reserve.
  -h, --help                  help for start
      --json
      --query string          One admitted bounded source query; keep it unchanged when retrying an uncertain reply.

Global Flags:
      --basis string        Use the original read basis returned by the collection page.
      --branch string       Use a branch under your current business identity.
      --cursor string       Continue a collection page; requires its --basis.
      --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.
      --explain             Explain virtual source work without executing it.
      --format string       Finite collection page rows in human or machine format; --json preserves the complete page and basis. (pretty, json, jsonl) (default "pretty")
      --from string         Read a bounded virtual query graph from a JSON file.
      --help-all            Show all commands and options, including administrative controls.
      --max-bytes int       Virtual result byte bound. (default 4194304)
      --max-rows int        Virtual source work bound; exceeding it refuses the complete result. (default 4096)
      --page-size int       Collection page size, from 1 to 50. (default 20)
      --prod                Inspect definitions in this project's default production deployment.
      --select string       Comma-separated collection fields.
      --timeout string      Stop observing remote work after this duration; retain its execution for recovery. (default "30s")
      --watch               Follow a named query as JSON lines, each with its native read basis.
```

## bijection query status

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Read retained query status

Usage:
  bijection query status <execution-id> [flags]

Flags:
      --as string   Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
  -h, --help        help for status
      --json        Print the checked native result.

Global Flags:
      --basis string        Use the original read basis returned by the collection page.
      --branch string       Use a branch under your current business identity.
      --cursor string       Continue a collection page; requires its --basis.
      --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.
      --explain             Explain virtual source work without executing it.
      --format string       Finite collection page rows in human or machine format; --json preserves the complete page and basis. (pretty, json, jsonl) (default "pretty")
      --from string         Read a bounded virtual query graph from a JSON file.
      --help-all            Show all commands and options, including administrative controls.
      --max-bytes int       Virtual result byte bound. (default 4194304)
      --max-rows int        Virtual source work bound; exceeding it refuses the complete result. (default 4096)
      --page-size int       Collection page size, from 1 to 50. (default 20)
      --prod                Inspect definitions in this project's default production deployment.
      --query string        Arguments in the collection reader's admitted query language.
      --select string       Comma-separated collection fields.
      --timeout string      Stop observing remote work after this duration; retain its execution for recovery. (default "30s")
      --watch               Follow a named query as JSON lines, each with its native read basis.
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.