共通のフラグは --config <path>（既定はパッケージの config.toml）と -o, --output table|json です。全オプションは db-branch <command> --help で確かめられます。
| コマンド |
内容 |
db-branch init --pool <pool> |
ノードを初期化します（ZFS データセットの作成、管理者パスワードと TLS 証明書の生成など）。--storage <module> を指定すると、ZFS プールの代わりにモジュールのストレージを使います。 |
db-branch version |
バージョンを表示します。 |
db-branch admin reset-password |
クラスター全体の管理者パスワードをランダムな値に変え、コンソールのセッションをすべて終了します。 |
| コマンド |
内容 |
base create <name> --runtime <engine@version> [--dump file.sql.gz] [--node N] |
Base を作り、最初の Snapshot を作ります。 |
base snapshot <name> |
Base のサーバーを正常に止めて、新しい Snapshot を作ります。 |
base mask <target> --from <base> --masker <module> [--snapshot S] [--rules file] |
別の Base のデータをマスクして空の Base に書き出し、Snapshot を作ります。 |
base list、base show <name> |
Base の一覧、または Snapshot 付きの詳細を表示します。 |
base start <name>、base stop <name> |
Base のサーバーを起動、停止します。 |
base delete <name> |
Branch が使っていない Base を削除します。 |
base refresh set <base> --host H --port P --user U --databases a,b --every 24h |
元のデータベースから定期的に更新します。パスワードは --password-stdin か環境変数で渡します。 |
base refresh show|run|off <base> |
スケジュールと最後の実行を表示、今すぐ更新、定期更新の停止です。 |
branch は br と短く書けます。
| コマンド |
内容 |
branch create <name> --base <base> [--snapshot S] [--ttl 72h] [--init-sql SQL | --init-file F] [--node N] [--owner O] [--access private|open] |
Base をクローンして、新しい Branch を作ります。 |
branch list、branch show <name> |
Branch の一覧、または 1 つの詳細を表示します。 |
branch dsn <name> [--proxy] |
パスワード入りの接続 URL を表示します。--proxy は、このノードのプロキシ経由の URL です。 |
branch reset <name> |
作成後の変更をすべて捨てます。 |
branch recreate <name> [--node N] |
失われた Branch を、別のノードで作り直します。 |
branch delete <name> |
Branch を削除します（別名 rm）。 |
branch extend <name> <ttl> |
期限を、今から ttl 後に延ばします。 |
base create、base snapshot、base mask と、状態を変える branch のコマンドには --no-wait があり、オペレーション ID を表示してすぐに戻ります。
| コマンド |
内容 |
runtime available [mysql|postgres] |
インストールできるバージョンを表示します。 |
runtime list |
インストール済みのバージョンを表示します。 |
runtime install <engine@version> |
バージョンを入れます。クラスターでは全ノードに入ります。 |
runtime remove <engine@version> |
使われていない全ノードから、バージョンを外します。 |
Branch への接続をご覧ください。
| コマンド |
内容 |
route user add <user> --default <branch> |
全 Branch 共通のユーザーを追加、更新します。パスワードは標準入力から読みます。 |
route user list、route user remove <user> |
共通ユーザーの一覧、削除です。 |
クラスターをご覧ください。cluster init、cluster token、cluster join、cluster status があります。
| コマンド |
内容 |
token create <name> [--scope branches|full] [--ttl 720h] |
スクリプトや LLM エージェント（MCP）向けの API トークンを発行します。表示は一度だけです。 |
token list、token revoke <id> |
トークンの一覧、失効です。 |
module install <name>、module remove <name>、module list |
全ノードのモジュール（パッケージ db-branch-<name>）を管理します。 |
settings list、settings set <scope> <key>=<value>... |
クラスター全体の設定を表示、変更します。値を空にすると既定に戻ります。 |
backup now、backup list、backup restore <file> |
クラスターの状態のバックアップと復元です。 |
update check、update status、update apply <version>、update cancel |
クラスターを新しいマイナーバージョンに、1 ノードずつ更新します。 |