Comment on page
Commands
$ dolt
Valid commands for dolt are
init - Create an empty Dolt data repository.
status - Show the working tree status.
add - Add table changes to the list of staged table changes.
diff - Diff a table.
reset - Remove table changes from the list of staged table changes.
clean - Remove untracked tables from working set.
commit - Record changes to the repository.
sql - Run a SQL query against tables in repository.
sql-server - Start a MySQL-compatible server.
log - Show commit logs.
show - Show information about a specific commit.
branch - Create, list, edit, delete branches.
checkout - Checkout a branch or overwrite a table from HEAD.
merge - Merge a branch.
conflicts - Commands for viewing and resolving merge conflicts.
cherry-pick - Apply the changes introduced by an existing commit.
revert - Undo the changes introduced in a commit.
clone - Clone from a remote data repository.
fetch - Update the database from a remote data repository.
pull - Fetch from a dolt remote data repository and merge.
push - Push to a dolt remote.
config - Dolt configuration.
remote - Manage set of tracked repositories.
backup - Manage a set of server backups.
login - Login to a dolt remote host.
creds - Commands for managing credentials.
ls - List tables in the working set.
schema - Commands for showing and importing table schemas.
table - Commands for copying, renaming, deleting, and exporting tables.
tag - Create, list, delete tags.
blame - Show what revision and author last modified each row of a table.
constraints - Commands for handling constraints.
migrate - Executes a database migration to use the latest Dolt data format.
read-tables - Fetch table(s) at a specific commit into a new dolt repo
gc - Cleans up unreferenced data from the repository.
filter-branch - Edits the commit history using the provided query.
merge-base - Find the common ancestor of two commits.
version - Displays the current Dolt cli version.
dump - Export all tables in the working set into a file.
docs - Commands for working with Dolt documents.
stash - Stash the changes in a dirty working directory away.
profile - Manage dolt profiles for CLI global options.
query-diff - Shows table diff between two queries.
reflog - Show history of named refs.
Dolt subcommands are in transition to using the flags listed below as global flags. Not all subcommands use these flags. If your command accepts these flags without error, then they are supported.
dolt <--data-dir=<path>> subcommand <subcommand arguments>
Specific dolt options:
--profile=<profile>: The name of the profile to use when executing SQL queries. Run dolt profile --help for more information.-u <user>, --user=<user>: Defines the local superuser (defaults to root). If the specified user exists, will take on permissions of that user.-p <password>, --password=<password>: Defines the password for the user. Defaults to empty string when the user is root.--host=<host>: Defines the host to connect to.--port=<port>: Defines the port to connect to.--no-tls: Disables TLS for the connection to remote databases.--data-dir=<data-dir>: Defines a data directory whose subdirectories should all be dolt data repositories accessible as independent databases. Defaults to the current directory.--doltcfg-dir=<doltcfg-dir>: Defines a directory that contains configuration files for dolt. Defaults to $data-dir/.doltcfg. Will only be created if there is a change to configuration settings.--privilege-file=<privilege-file>: Path to a file to load and store users and grants. Defaults to $doltcfg-dir/privileges.db. Will only be created if there is a change to privileges.--branch-control-file=<branch-control-file>: Path to a file to load and store branch control permissions. Defaults to $doltcfg-dir/branch_control.db. Will only be created if there is a change to branch control permissions.--use-db=<use-db>: The name of the database to use when executing SQL queries. Defaults the database of the root directory, if it exists, and the first alphabetically if not.--branch=<branch>: Name of the branch to be selectedAdd table contents to the list of staged tables
Synopsis
dolt add [<table>...]
Description
This command updates the list of tables using the current content found in the working root, to prepare the content staged for the next commit. It adds the current content of existing tables as a whole or remove tables that do not exist in the working root anymore.
This command can be performed multiple times before a commit. It only adds the content of the specified table(s) at the time the add command is run; if you want subsequent changes included in the next commit, then you must run dolt add again to add the new content to the index.
The dolt status command can be used to obtain a summary of which tables have changes that are staged for the next commit.
Arguments and options
<table>: Working table(s) to add to the list tables staged to be committed. The abbreviation '.' can be used to add all tables.-A, --all: Stages any and all changes (adds, deletes, and modifications) except for ignored tables.-f, --force: Allow adding otherwise ignored tables.Manage server backups
Synopsis
dolt backup [-v | --verbose]
dolt backup add [--aws-region <region>] [--aws-creds-type <creds-type>] [--aws-creds-file <file>] [--aws-creds-profile <profile>] <name> <url>
dolt backup remove <name>
dolt backup restore <url> <name>
dolt backup sync <name>
dolt backup sync-url [--aws-region <region>] [--aws-creds-type <creds-type>] [--aws-creds-file <file>] [--aws-creds-profile <profile>] <url>
Description
With no arguments, shows a list of existing backups. Several subcommands are available to perform operations on backups, point in time snapshots of a database's contents.
add Adds a backup named <name> for the database at <url>. The <url> parameter supports url schemes of http, https, aws, gs, and file. The url prefix defaults to https. If the <url> parameter is in the format <organization>/<repository> then dolt will use the backups.default_host from your configuration file (Which will be dolthub.com unless changed). The URL address must be unique to existing remotes and backups.AWS cloud backup urls should be of the form
aws://[dynamo-table:s3-bucket]/database. You may configure your aws cloud backup using the optional parameters aws-region, aws-creds-type, aws-creds-file.aws-creds-type specifies the means by which credentials should be retrieved in order to access the specified cloud resources (specifically the dynamo table, and the s3 bucket). Valid values are 'role', 'env', or 'file'.
role: Use the credentials installed for the current user
env: Looks for environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
file: Uses the credentials file specified by the parameter aws-creds-file
GCP backup urls should be of the form gs://gcs-bucket/database and will use the credentials setup using the gcloud command line available from Google.
The local filesystem can be used as a backup by providing a repository url in the format file://absolute path. See https://en.wikipedia.org/wiki/File_URI_scheme
remove, rm Remove the backup named <name>. All configuration settings for the backup are removed. The contents of the backup are not affected.restore Restore a Dolt database from a given <url> into a specified directory <url>.sync Snapshot the database and upload to the backup <name>. This includes branches, tags, working sets, and remote tracking refs.sync-url Snapshot the database and upload the backup to <url>. Like sync, this includes branches, tags, working sets, and remote tracking refs, but it does not require you to create a named backupArguments and options
<region>: cloud provider region associated with this backup.<creds-type>: credential type. Valid options are role, env, and file. See the help section for additional details.<profile>: AWS profile to use.-v, --verbose: When printing the list of backups adds additional details.--aws-region--aws-creds-type--aws-creds-file: AWS credentials file--aws-creds-profile: AWS profile to useShow what revision and author last modified each row of a table
Synopsis
dolt blame [<rev>] <tablename>
Description
Annotates each row in the given table with information from the revision which last modified the row. Optionally, start annotating from the given revision.
Arguments and options
No options for this command.
List, create, or delete branches
Synopsis
dolt branch [--list] [-v] [-a] [-r]
dolt branch [-f] <branchname> [<start-point>]
dolt branch -m [-f] [<oldbranch>] <newbranch>
dolt branch -c [-f] [<oldbranch>] <newbranch>
dolt branch -d [-f] [-r] <branchname>...
Description
If
--list is given, or if there are no non-option arguments, existing branches are listed. The current branch will be highlighted with an asterisk. With no options, only local branches are listed. With -r, only remote branches are listed. With -a both local and remote branches are listed. -v causes the hash of the commit that the branches are at to be printed as well.The command's second form creates a new branch head named
<branchname> which points to the current HEAD, or <start-point> if given.Note that this will create the new branch, but it will not switch the working tree to it; use
dolt checkout <newbranch> to switch to the new branch.With a
-m, <oldbranch> will be renamed to <newbranch>. If <newbranch> exists, -f must be used to force the rename to happen.The
-c options have the exact same semantics as -m, except instead of the branch being renamed it will be copied to a new name.With a
-d, <branchname> will be deleted. You may specify more than one branch for deletion.Arguments and options
<start-point>: A commit that a new branch should point at.-f, --force: Reset <branchname> to <startpoint>, even if <branchname> exists already. Without -f, dolt branch refuses to change an existing branch. In combination with -d (or --delete), allow deleting the branch irrespective of its merged status. In combination with -m (or --move), allow renaming the branch even if the new branch name already exists, the same applies for -c (or --copy).-c, --copy: Create a copy of a branch.-m, --move: Move/rename a branch-d, --delete: Delete a branch. The branch must be fully merged in its upstream branch.--D: Shortcut for --delete --force.-t, --track: When creating a new branch, set up 'upstream' configuration.--list: List branches-v, --verbose: When in list mode, show the hash and commit subject line for each head-a, --all: When in list mode, shows remote tracked branches--datasets: List all datasets in the database-r, --remote: When in list mode, show only remote tracked branches. When with -d, delete a remote tracking branch.--show-current: Print the name of the current branchSwitch branches or restore working tree tables
Synopsis
dolt checkout <branch>
dolt checkout <table>...
dolt checkout -b <new-branch> [<start-point>]
dolt checkout --track <remote>/<branch>
Description
Updates tables in the working set to match the staged versions. If no paths are given, dolt checkout will also update HEAD to set the specified branch as the current branch.
dolt checkout
<branch> To prepare for working on <branch>, switch to it by updating the index and the tables in the working tree, and by pointing HEAD at the branch. Local modifications to the tables in the working tree are kept, so that they can be committed to the <branch>.dolt checkout -b
<new_branch> [<start_point>] Specifying -b causes a new branch to be created as if dolt branch were called and then checked out.dolt checkout
<table>... To update table(s) with their values in HEADArguments and options
--b: Create a new branch named <new_branch> and start it at <start_point>.-f, --force: If there is any changes in working set, the force flag will wipe out the current changes and checkout the new branch.-t, --track: When creating a new branch, set up 'upstream' configuration.Apply the changes introduced by an existing commit.
Synopsis
dolt cherry-pick <commit>
Description
Applies the changes from an existing commit and creates a new commit from the current HEAD. This requires your working tree to be clean (no modifications from the HEAD commit).
Cherry-picking merge commits or commits with table drops/renames is not currently supported.
If any data conflicts, schema conflicts, or constraint violations are detected during cherry-picking, you can use Dolt's conflict resolution features to resolve them. For more information on resolving conflicts, see: https://docs.dolthub.com/concepts/dolt/git/conflicts.
Arguments and options
--abort: Abort the current conflict resolution process, and revert all changes from the in-process cherry-pick operation.Deletes untracked working tables
Synopsis
dolt clean [--dry-run]
dolt clean [--dry-run] <tables>...
Description
dolt clean [--dry-run]The default (parameterless) form clears the values for all untracked working
<tables> .This command permanently deletes unstaged or uncommitted tables.The
--dry-run flag can be used to test whether the clean can succeed without deleting any tables from the current working set.dolt clean [--dry-run] ...If
<tables> is specified, only those table names are considered for deleting.Arguments and options
--dry-run: Tests removing untracked tables without modifying the working set.Clone a data repository into a new directory
Synopsis
dolt clone [-remote <remote>] [-branch <branch>] [--aws-region <region>] [--aws-creds-type <creds-type>] [--aws-creds-file <file>] [--aws-creds-profile <profile>] <remote-url> <new-dir>
Description
Clones a repository into a newly created directory, creates remote-tracking branches for each branch in the cloned repository (visible using
<dolt branch -a>), and creates and checks out an initial branch that is forked from the cloned repository's currently active branch.After the clone, a plain
dolt fetch without arguments will update all the remote-tracking branches, and a dolt pull without arguments will in addition merge the remote branch into the current branch.This default configuration is achieved by creating references to the remote branch heads under
<refs/remotes/origin> and by creating a remote named 'origin'.Arguments and options
--remote: Name of the remote to be added to the cloned database. The default is 'origin'.-b, --branch: The branch to be cloned. If not specified all branches will be cloned.--aws-region--aws-creds-type--aws-creds-file: AWS credentials file.--aws-creds-profile: AWS profile to use.--oss-creds-file: OSS credentials file.--oss-creds-profile: OSS profile to use.-u, --user: User name to use when authenticating with the remote. Gets password from the environment variable DOLT_REMOTE_PASSWORD.Record changes to the database
Synopsis
dolt commit [options]
Description
Stores the current contents of the staged tables in a new commit along with a log message from the user describing the changes.
The content to be added can be specified by using dolt add to incrementally "add" changes to the staged tables before using the commit command (Note: even modified tables must be "added").
The log message can be added with the parameter
-m <msg>. If the <-m> parameter is not provided an editor will be opened where you can review the commit and provide a log message.The commit timestamp can be modified using the --date parameter. Dates can be specified in the formats
<YYYY-MM-DD>, <YYYY-MM-DDTHH:MM:SS>, or <YYYY-MM-DDTHH:MM:SSZ07:00> (where <07:00> is the time zone offset)."Arguments and options
-m, --message: Use the given <msg> as the commit message.--allow-empty: Allow recording a commit that has the exact same data as its sole parent. This is usually a mistake, so it is disabled by default. This option bypasses that safety. Cannot be used with --skip-empty.--skip-empty: Only create a commit if there are staged changes. If no changes are staged, the call to commit is a no-op. Cannot be used with --allow-empty.--date: Specify the date used in the commit. If not specified the current system time is used.-f, --force: Ignores any foreign key warnings and proceeds with the commit.--author: Specify an explicit author using the standard A U Thor <[email protected]> format.-a, --all: Adds all existing, changed tables (but not new tables) in the working set to the staged set.-A, --ALL: Adds all tables (including new tables) in the working set to the staged set.--amend: Amend previous commitGet and set repository or global options
Synopsis
dolt config [--global|--local] --list
dolt config [--global|--local] --add <name> <value>
dolt config [--global|--local] --set <name> <value>
dolt config [--global|--local] --get <name>
dolt config [--global|--local] --unset <name>...
Description
You can query/set/replace/unset options with this command.
When reading, the values are read from the global and repository local configuration files, and options
<--global>, and <--local> can be used to tell the command to read from only that location.When writing, the new value is written to the repository local configuration file by default, and options
<--global>, can be used to tell the command to write to that location (you can say <--local> but that is the default).Valid configuration variables:
- core.editor - lets you edit 'commit' or 'tag' messages by launching the set editor.
​
- creds.add_url - sets the endpoint used to authenticate a client for 'dolt login'.
​
- doltlab.insecure - boolean flag used to authenticate a client against DoltLab.
​
- init.defaultbranch - allows overriding the default branch name e.g. when initializing a new repository.
​
- metrics.disabled - boolean flag disables sending metrics when true.
​
- user.creds - sets user keypairs for authenticating with doltremoteapi.
​
- user.email - sets name used in the author and committer field of commit objects.
​
- user.name - sets email used in the author and committer field of commit objects.
​
- remotes.default_host - sets default host for authenticating with doltremoteapi.
​
- remotes.default_port - sets default port for authenticating with doltremoteapi.
​
- push.autoSetupRemote - if set to "true" assume --set-upstream on default push when no upstream tracking exists for the current branch.
Arguments and options
--global: Use global config.--local: Use repository local config.--add: Set the value of one or more config parameters--set: Set the value of one or more config parameters--list: List the values of all config parameters.--get: Get the value of one or more config parameters.--unset: Unset the value of one or more config parameters.print conflicts
Synopsis
dolt conflicts cat <table>...
Description
The dolt conflicts cat command reads table conflicts from the working set and writes them to the standard output.
Arguments and options
<table>: List of tables to be printed. '.' can be used to print conflicts for all tables.Automatically resolves all conflicts taking either ours or theirs for the given tables
Synopsis
dolt conflicts resolve --ours|--theirs <table>...
Description
When a merge finds conflicting changes, it documents them in the dolt_conflicts table. A conflict is between two versions: ours (the rows at the destination branch head) and theirs (the rows at the source branch head).
​
dolt conflicts resolve will automatically resolve the conflicts by taking either the ours or theirs versions for each row.
Arguments and options
<table>: List of tables to be resolved. '.' can be used to resolve all tables.--ours: For all conflicts, take the version from our branch and resolve the conflict--theirs: For all conflicts, take the version from their branch and resolve the conflictVerifies that working set changes satisfy table constraints
Synopsis
dolt constraints verify [--all] [--output-only] [<table>...]
Description
Verifies that inserted or modified rows in the working set satisfy the defined table constraints. If any constraints are violated, they are documented in the dolt_constraint_violations system table. By default, this command does not consider row changes that have been previously committed.
Arguments and options
<table>: The table(s) to check constraints on. If omitted, checks all tables.-a, --all: Verifies that all rows in the database do not violate constraints instead of just rows modified or inserted in the working set.-o, --output-only: Disables writing violated constraints to the constraint violations table.Check authenticating with a credential keypair against a doltremoteapi.
Synopsis
dolt creds check [--endpoint doltremoteapi.dolthub.com:443] [--creds <eak95022q3vskvumn2fcrpibdnheq1dtr8t...>]
Description
Tests calling a doltremoteapi with dolt credentials and reports the authentication result.
Arguments and options
--endpoint: API endpoint, otherwise taken from config.--creds: Public Key ID or Public Key for credentials, otherwise taken from config.Import a dolt credential from an existing .jwk file.
Synopsis
dolt creds import [--no-profile] [<jwk_filename>]
Description
Imports a dolt credential from an existing .jwk file.
Dolt credentials are stored in the creds subdirectory of the global dolt config directory as files with one key per file in JWK format. This command can import a JWK from a file or stdin and places the imported key in the correct place for dolt to find it as a valid credential.
This command will set the newly imported credential as the used credential if there are currently not credentials. If this command does use the new credential, it will call doltremoteapi to update user.name and user.email with information from the remote user profile if those fields are not already available in the local dolt config.
Arguments and options
<jwk_filename>: The JWK file. If omitted, import operates on stdin.--no-profile: If provided, no attempt will be made to contact doltremoteapi and update user.name and user.email.List keypairs available for authenticating with doltremoteapi.
Synopsis
dolt creds ls [-v | --verbose]
Description
Lists known public keys from keypairs for authenticating with doltremoteapi.
The currently selected keypair appears with a
* next to it.Arguments and options
-v, --verbose: Verbose output, including key id.Create a new public/private keypair for authenticating with doltremoteapi.
Synopsis
Description
Creates a new keypair for authenticating with doltremoteapi.
Prints the public portion of the keypair, which can entered into the credentials settings page of dolthub.
Arguments and options
No options for this command.
Remove a stored public/private keypair.
Synopsis
dolt creds rm <public_key_as_appears_in_ls>
Description
Removes an existing keypair from dolt's credential storage.
Arguments and options
No options for this command.
Select an existing dolt credential for authenticating with doltremoteapi.
Synopsis
dolt creds use <public_key_as_appears_in_ls | public_key_id_as_appears_in_ls>
Description
Selects an existing dolt credential for authenticating with doltremoteapi.
Can be given a credential's public key or key id and will update global dolt config to use the credential when interacting with doltremoteapi.
You can see your available credentials with 'dolt creds ls'.
Arguments and options
No options for this command.
Show changes between commits, commit and working tree, etc
Synopsis
dolt diff [options] [<commit>] [<tables>...]
dolt diff [options] <commit> <commit> [<tables>...]
Description
Show changes between the working and staged tables, changes between the working tables and the tables within a commit, or changes between tables at two commits.
dolt diff [--options] [<tables>...] This form is to view the changes you made relative to the staging area for the next commit. In other words, the differences are what you could tell Dolt to further add but you still haven't. You can stage these changes by using dolt add.dolt diff [--options] [--merge-base] <commit> [<tables>...] This form is to view the changes you have in your working tables relative to the named <commit>. You can use HEAD to compare it with the latest commit, or a branch name to compare with the tip of a different branch. If --merge-base is given, instead of using <commit>, use the merge base of <commit> and HEAD. dolt diff --merge-base A is equivalent to dolt diff $(dolt merge-base A HEAD) and dolt diff A...HEAD.dolt diff [--options] [--merge-base] <commit> <commit> [<tables>...] This is to view the changes between two arbitrary commit. If --merge-base is given, use the merge base of the two commits for the "before" side. dolt diff --merge-base A B is equivalent to dolt diff $(dolt merge-base A B) B and dolt diff A...B.dolt diff [--options] <commit>..<commit> [<tables>...] This is synonymous to the above form (without the ..) to view the changes between two arbitrary commit.dolt diff [--options] <commit>...<commit> [<tables>...] This is to view the changes on the branch containing and up to the second <commit>, starting at a common ancestor of both <commit>. dolt diff A...B is equivalent to dolt diff $(dolt merge-base A B) B and dolt diff --merge-base A B. You can omit any one of <commit>, which has the same effect as using HEAD instead.The diffs displayed can be limited to show the first N by providing the parameter
--limit N where N is the number of diffs to display.To filter which data rows are displayed, use
--where <SQL expression>. Table column names in the filter expression must be prefixed with from_ or to_, e.g. to_COLUMN_NAME > 100 or from_COLUMN_NAME + to_COLUMN_NAME = 0.The
--diff-mode argument controls how modified rows are presented when the format output is set to tabular. When set to row, modified rows are presented as old and new rows. When set to line, modified rows are presented as a single row, and changes are presented using "+" and "-" within the column. When set to in-place, modified rows are presented as a single row, and changes are presented side-by-side with a color distinction (requires a color-enabled terminal). When set to context, rows that contain at least one column that spans multiple lines uses line, while all other rows use row. The default value is context.Arguments and options
-d, --data: Show only the data changes, do not show the schema changes (Both shown by default).-s, --schema: Show only the schema changes, do not show the data changes (Both shown by default).--stat: Show stats of data changes--summary: Show summary of data and schema changes-r, --result-format: How to format diff output. Valid values are tabular, sql, json. Defaults to tabular.--where: filters columns based on values in the diff. See dolt diff --help for details.--limit: limits to the first N diffs.-c, --cached: Show only the staged data changes.-sk, --skinny: Shows only primary key columns and any columns with data changes.--merge-base: Uses merge base of the first commit and second commit (or HEAD if not supplied) as the first commit--diff-mode: Determines how to display modified rows with tabular output. Valid values are row, line, in-place, context. Defaults to context.-R, --reverse: Reverses the direction of the diff.Diffs Dolt Docs
Synopsis
dolt docs diff <doc>
Description
Diffs Dolt Docs
Arguments and options
<doc>: Dolt doc to be diffed.Prints Dolt Docs to stdout
Synopsis
dolt docs print <doc>
Description
Prints Dolt Docs to stdout
Arguments and options
<doc>: Dolt doc to be read.Uploads Dolt Docs from the file system into the database
Synopsis
dolt docs upload <doc> <file>
Description
Uploads Dolt Docs from the file system into the database
Arguments and options
<doc>: Dolt doc name to be updated in the database.<file>: file to read Dolt doc from.Export all tables.
Synopsis
dolt dump [-f] [-r <result-format>] [-fn <file_name>] [-d <directory>] [--batch] [--no-batch] [--no-autocommit] [--no-create-db]
Description
dolt dump dumps all tables in the working set. If a dump file already exists then the operation will fail, unless the --force | -f flag is provided. The force flag forces the existing dump file to be overwritten. The -r flag is used to support different file formats of the dump. In the case of non .sql files each table is written to a separate csv,json or parquet file.Arguments and options
-r, --result-format: Define the type of the output file. Defaults to sql. Valid values are sql, csv, json and parquet.-fn, --file-name: Define file name for dump file. Defaults to doltdump.sql.-d, --directory: Define directory name to dump the files in. Defaults to doltdump/.-f, --force: If data already exists in the destination, the force flag will allow the target to be overwritten.--batch: Return batch insert statements wherever possible, enabled by default.--no-batch: Emit one row per statement, instead of batching multiple rows into each statement.-na, --no-autocommit: Turn off autocommit for each dumped table. Useful for speeding up loading of output SQL file.--schema-only: Dump a table's schema, without including any data, to the output SQL file.--no-create-db: Do not write CREATE DATABASE statements in SQL files.Download objects and refs from another repository
Synopsis
dolt fetch [<remote>] [<refspec> ...]
Description
Fetch refs, along with the objects necessary to complete their histories and update remote-tracking branches.
By default dolt will attempt to fetch from a remote named
origin. The <remote> parameter allows you to specify the name of a different remote you wish to pull from by the remote's name.When no refspec(s) are specified on the command line, the fetch_specs for the default remote are used.
Arguments and options
-u, --user: User name to use when authenticating with the remote. Gets password from the environment variable DOLT_REMOTE_PASSWORD.-p, --prune: After fetching, remove any remote-tracking references that don't exist on the remote.--silent: Suppress progress information.Edits the commit history using the provided query
Synopsis
dolt filter-branch [--all] -q <queries> [<commit>]
Description
Traverses the commit history to the initial commit starting at the current HEAD commit, or a commit you name. Replays all commits, rewriting the history using the provided SQL queries. Separate multiple queries with semicolons. Use the DELIMITER syntax to define stored procedures, triggers, etc.
If a
<commit-spec> is provided, the traversal will stop when the commit is reached and rewriting will begin at that commit, or will error if the commit is not found.If the
--branches flag is supplied, filter-branch traverses and rewrites commits for all branches.If the
--all flag is supplied, filter-branch traverses and rewrites commits for all branches and tags.Arguments and options
-v, --verbose: logs more information-b, --branches: filter all branches-a, --all: filter all branches and tags-c, --continue: log a warning and continue if any errors occur executing statements-q, --query: Queries to run, separated by semicolons. If not provided, queries are read from STDIN.Cleans up unreferenced data from the repository.
Synopsis
dolt gc [--shallow]
Description
Searches the repository for data that is no longer referenced and no longer needed.
If the
--shallow flag is supplied, a faster but less thorough garbage collection will be performed.dolt gc won't work if there is a running server. Use dolt sql -q 'call dolt_gc()' instead.Arguments and options
-s, --shallow: perform a fast, but incomplete garbage collection passCreate an empty Dolt data repository
Synopsis
dolt init
Description
This command creates an empty Dolt data repository in the current directory.
Running dolt init in an already initialized directory will fail.
Arguments and options
--name: The name used in commits to this repo. If not provided will be taken from user.name in the global config.--email: The email address used. If not provided will be taken from user.email in the global config.--date: Specify the date used in the initial commit. If not specified the current system time is used.-b, --initial-branch: The branch name used to initialize this database. If not provided will be taken from init.defaultbranch in the global config. If unset, the default initialized branch will be named 'main'.--new-format: Specify this flag to use the new storage format (DOLT).--old-format: Specify this flag to use the old storage format (LD_1).--funShow commit logs
Synopsis
dolt log [-n <num_commits>] [<revision-range>] [[--] <table>]
Description
Shows the commit logs
The command takes options to control what is shown and how.
dolt log Lists commit logs from current HEAD when no options provided.dolt log [<revisions>...] Lists commit logs starting from revision. If multiple revisions provided, lists logs reachable by all revisions.dolt log [<revisions>...] -- <table> Lists commit logs starting from revisions, only including commits with changes to table.dolt log <revisionB>..<revisionA> dolt log <revisionA> --not <revisionB> dolt log ^<revisionB> <revisionA> Different ways to list two dot logs. These will list commit logs for revisionA, while excluding commits from revisionB. The table option is not supported for two dot log.dolt log <revisionB>...<revisionA> dolt log <revisionA> <revisionB> --not $(dolt merge-base <revisionA> <revisionB>) Different ways to list three dot logs. These will list commit logs reachable by revisionA OR revisionB, while excluding commits reachable by BOTH revisionA AND revisionB.Arguments and options
-n, --number: Limit the number of commits to output.--min-parents: The minimum number of parents a commit must have to be included in the log.--merges: Equivalent to min-parents == 2, this will limit the log to commits with 2 or more parents.--parents: Shows all parents of each commit in the log.--decorate: Shows refs next to commits. Valid options are short, full, no, and auto--not: Excludes commits from revision.--oneline: Shows logs in a compact format.Login to DoltHub or DoltLab
Synopsis
dolt login [--auth-endpoint <endpoint>] [--login-url <url>] [-i | --insecure] [<creds>]
Description
Login into DoltHub or DoltLab using the email in your config so you can pull from private repos and push to those you have permission to.
Arguments and options
<creds>: A specific credential to use for login. If omitted, new credentials will be generated.-e, --auth-endpoint: Specify the endpoint used to authenticate this client. Must be used with --login-url OR set in the configuration file as creds.add_url-url, --login-url: Specify the login url where the browser will add credentials.-i, --insecure: If set, makes insecure connection to remote authentication serverList tables
Synopsis
dolt ls [--options] [<commit>]
Description
With no arguments lists the tables in the current working set but if a commit is specified it will list the tables in that commit. If the
--verbose flag is provided a row count of the table will also be displayed.If the
--system flag is supplied this will show the dolt system tables which are queryable with SQL.If the
--all flag is supplied both user and system tables will be printed.Arguments and options
-v, --verbose: show the hash of the table and row count-s, --system: show system tables-a, --all: show user and system tablesJoin two or more development histories together
Synopsis
dolt merge [--squash] <branch>
dolt merge --no-ff [-m message] <branch>
dolt merge --abort
Description
Incorporates changes from the named commits (since the time their histories diverged from the current branch) into the current branch.
The second syntax (
<dolt merge --abort>) can only be run after the merge has resulted in conflicts. dolt merge --abort will abort the merge process and try to reconstruct the pre-merge state. However, if there were uncommitted changes when the merge started (and especially if those changes were further modified after the merge was started), dolt merge --abort will in some cases be unable to reconstruct the original (pre-merge) changes. Therefore:<Warning>: Running dolt merge with non-trivial uncommitted changes is discouraged: while possible, it may leave you in a state that is hard to back out of in the case of a conflict.Arguments and options
--no-ff: Create a merge commit even when the merge resolves as a fast-forward.--squash: Merge changes to the working set without updating the commit history-m, --message: Use the given <msg> as the commit message.--abort: Abort the in-progress merge and return the working set to the state before the merge started.--commit: Perform the merge and commit the result. This is the default option, but can be overridden with the --no-commit flag. Note that this option does not affect fast-forward merges, which don't create a new merge commit, and if any merge conflicts or constraint violations are detected, no commit will be attempted.--no-commit: Perform the merge and stop just before creating a merge commit. Note this will not prevent a fast-forward merge; use the --no-ff arg together with the --no-commit arg to prevent both fast-forwards and merge commits.--no-edit: Use an auto-generated commit message when creating a merge commit. The default for interactive CLI sessions is to open an editor.--author: Specify an explicit author using the standard A U Thor <[email protected]> format.Find the common ancestor of two commits.
Synopsis
dolt merge-base <commit spec> <commit spec>
Description
Find the common ancestor of two commits, and return the ancestor's commit hash.'
Arguments and options
No options for this command.
Manage dolt profiles for CLI global options.
Synopsis
dolt profile [-v | --verbose]
dolt profile add [-u <user>] [-p <password>] [--host <host>] [--port <port>] [--no-tls] [--data-dir <directory>] [--doltcfg-dir <directory>] [--privilege-file <privilege file>] [--branch-control-file <branch control file>] [--use-db <database>] <name>
dolt profile remove <name>
Description
With no arguments, shows a list of existing profiles. Two subcommands are available to perform operations on the profiles.
add Adds a profile named <name>. Returns an error if the profile already exists.remove, rm Remove the profile named <name>.Arguments and options
<name>: Defines the name of the profile to add or remove.-u, --user: Defines the local superuser (defaults to root). If the specified user exists, will take on permissions of that user.-p, --password: Defines the password for the user. Defaults to empty string when the user is root.--host: Defines the host to connect to.--port: Defines the port to connect to.--no-tls: Disables TLS for the connection to remote databases.--data-dir: Defines a data directory whose subdirectories should all be dolt data repositories accessible as independent databases. Defaults to the current directory.--doltcfg-dir: Defines a directory that contains configuration files for dolt. Defaults to $data-dir/.doltcfg. Will only be created if there is a change to configuration settings.--privilege-file: Path to a file to load and store users and grants. Defaults to $doltcfg-dir/privileges.db. Will only be created if there is a change to privileges.--branch-control-file: Path to a file to load and store branch control permissions. Defaults to $doltcfg-dir/branch_control.db. Will only be created if there is a change to branch control permissions.--use-db: The name of the database to use when executing SQL queries. Defaults the database of the root directory, if it exists, and the first alphabetically if not.--branch: Name of the branch to be selected-v, --verbose: Includes full details when printing list of profiles.Fetch from and integrate with another repository or a local branch
Synopsis
dolt pull [<remote>, [<remoteBranch>]]
Description
Incorporates changes from a remote repository into the current branch. In its default mode,
dolt pull is shorthand for dolt fetch followed by dolt merge <remote>/<branch>.More precisely, dolt pull runs
dolt fetch with the given parameters and calls dolt merge to merge the retrieved branch HEAD into the current branch.Arguments and options
<remote>: The name of the remote to pull from.<remoteBranch>: The name of a branch on the specified remote to be merged into the current working set.--squash: Merge changes to the working set without updating the commit history--no-ff: Create a merge commit even when the merge resolves as a fast-forward.-f, --force: Update from the remote HEAD even if there are errors.--commit: Perform the merge and commit the result. This is the default option, but can be overridden with the --no-commit flag. Note that this option does not affect fast-forward merges, which don't create a new merge commit, and if any merge conflicts or constraint violations are detected, no commit will be attempted.--no-commit: Perform the merge and stop just before creating a merge commit. Note this will not prevent a fast-forward merge; use the --no-ff arg together with the --no-commit arg to prevent both fast-forwards and merge commits.--no-edit: Use an auto-generated commit message when creating a merge commit. The default for interactive CLI sessions is to open an editor.-u, --user: User name to use when authenticating with the remote. Gets password from the environment variable DOLT_REMOTE_PASSWORD.--silent: Suppress progress information.Update remote refs along with associated objects
Synopsis
dolt push [-u | --set-upstream] [<remote>] [<refspec>]
Description
Updates remote refs using local refs, while sending objects necessary to complete the given refs.
When the command line does not specify where to push with the
<remote> argument, an attempt is made to infer the remote. If only one remote exists it will be used, if multiple remotes exists, a remote named 'origin' will be attempted. If there is more than one remote, and none of them are named 'origin' then the command will fail and you will need to specify the correct remote explicitly.When the command line does not specify what to push with
<refspec>... then the current branch will be used.A remote's branch can be deleted by pushing an empty source ref:
dolt push origin :branchWhen neither the command-line does not specify what to push, the default behavior is used, which corresponds to the current branch being pushed to the corresponding upstream branch, but as a safety measure, the push is aborted if the upstream branch does not have the same name as the local one.
Arguments and options
-u, --set-upstream: For every branch that is up to date or successfully pushed, add upstream (tracking) reference, used by argument-less dolt pull and other commands.-f, --force: Update the remote with local history, overwriting any conflicting history in the remote.--all: Push all branches.--silent: Suppress progress information.Calculates table diff between two queries
Synopsis
dolt query-diff [options] [<query1>] [<query2>]
Description
Will execute two queries and compare the resulting table sets
<query1>: A SQL SELECT query to be executed.<query2>: A SQL SELECT query to be executed.Note
Query diff is performed brute force and thus, will be slow for large result sets. The algorithm is super linear (
n^2) on the size of the results sets. Over time, we will optimize this to use features of the storage engine to improve performance.Arguments and options
No options for this command.
Fetch table(s) at a specific commit into a new dolt repo
Synopsis