LinuxCommandLibrary

dolt-status

Show Dolt database status

TLDR

Display the status

$ dolt status
copy

SYNOPSIS

dolt status [options] [commit]

PARAMETERS

--summary, -s
    Show only a summary of changes

--branch, -b
    Include current branch name in output

--verbose, -v
    Enable verbose output (default)

--staged
    Show only staged changes

--not-staged
    Show only unstaged changes

commit
    Compare working set against specific commit

DESCRIPTION

The dolt status command provides a snapshot of the current state of a Dolt repository, similar to git status but tailored for database version control.

It reports the working set's status relative to the HEAD commit, highlighting:
Branch name (if enabled).
Untracked tables.
Modified tables (schema or data changes).
Staged changes ready for commit.

Changes are categorized by table diffs, including added, deleted, or modified rows, and schema alterations like column additions or type changes. Running it without arguments shows a default verbose view of both staged and unstaged changes.

Use options to filter output: --summary for a concise overview, --staged or --not-staged to focus on specific change sets. Specify a commit argument to compare against a different ref.

Ideal for quick checks during development workflows, ensuring no unintended data or schema drifts before committing. Must be executed within a Dolt database directory initialized via dolt init.

CAVEATS

Must run inside a Dolt repository directory; no output if working set matches HEAD.

TYPICAL OUTPUT

On branch main
# Untracked tables:
# new_table
# Changes not staged for commit:
# modified: existing_table (5 rows)

HISTORY

Introduced with Dolt v0.1.0 in 2019 by Heath Stewart and Tim Sehn as part of the DoltHub project, evolving alongside Git-like database versioning features.

SEE ALSO

git(1)

Copied to clipboard