Skip to content
Esc
↑↓navigate↵open⌘Jpreview
On this page

tractorbeam dataset

The Tractorbeam API's dataset operations.

tractorbeam dataset <subcommand> [flags]

Shared flags

Every subcommand takes these flags.

Flag Description
--config <string> The Project’s tractorbeam.config.ts. Defaults to the one in the current directory or its nearest ancestor.
--workspace <string> Workspace name. Environment variable: TRACTORBEAM_WORKSPACE.
--origin <string> The Tractorbeam origin to call instead of the default, such as a proxy’s. Environment variable: TRACTORBEAM_ORIGIN.
--token <string> Access token. Defaults to the saved interactive session. Environment variable: TRACTORBEAM_TOKEN.

dataset list-rows

Returns one page of the Dataset’s rows at the Branch’s HEAD, or a retained Commit on it, ordered by the fields its key names, then by every other field. An external Dataset reads the snapshot of its table pinned by the Commit, and returns 409 when the Commit pins none, the catalog no longer keeps the pinned snapshot, a row has no value for a field the Dataset’s schema requires, or the table’s storage refuses the read. A page’s nextCursor resumes after its last row at the same Commit; a request with a cursor omits atCommitId. Needs Workspace authority with datasets:read; a Dataset requiring Markings can’t be read yet, and an App token can’t read a Dataset directly.

tractorbeam dataset list-rows [flags] <dataset>
Argument Description
<dataset> The name of the Dataset to read.
Flag Description
--limit <string> The most items the page returns, from 1 to 200. Defaults to 50.
--cursor <string> A cursor for use in pagination: the nextCursor of the previous page, whose read the page continues.
--at-commit-id <string> The ID of a retained Commit on the Branch to read at. Defaults to the Branch’s HEAD.
--branch <string> Branch name. Defaults to the Branch you last switched to, or main. Environment variable: TRACTORBEAM_BRANCH.
--all Read every page, following nextCursor, and print all their items together.