Command reference
=================

PGDコマンドラインインターフェイスのコマンド名は\ ``pgd`` です。

概要
----

EDB Postgres分散コマンドラインインターフェイスPGD CLIは、 EDB
Postgres分散クラスターを管理するツールです。 EDB
Postgres分散クラスターに対してコマンドを実行できます。これを使用して、クラスターリソースを検査および管理できます。

コマンド
--------

- :ref:`クラスター構成 <クラスター構成>`  クラスターを管理するためのクラスターレベルのコマンド

- :ref:`pgd cluster show <pgd cluster show>`  クラスターレベルの情報を表示します。

- :ref:`pgd cluster verify <pgd cluster verify>`  クラスターレベルの情報を確認します。

- :ref:`グループとレプリケーションセットの表示 <グループとレプリケーションセットの表示>`  グループを管理するためのグループレベルのコマンド

- :ref:`pgd cluster show <pgd cluster show>`  グループレベルの情報を表示します

- :ref:`pgd group set-option <pgd group set-option>`  グループレベルのオプションを設定します

- :ref:`pgd group get-option <pgd group get-option>`  グループレベルのオプションを取得します

- :ref:`pgd group set-leader <pgd group set-leader>` 
  グループの書き込みリーダーを設定しますスイッチオーバー)。

- :ref:`グループとレプリケーションセットの表示 <グループとレプリケーションセットの表示>`  グループをリストするためのグループ関連コマンド。 -
  :ref:`pgd commit-scopes list <pgd commit-scopes list>`  グループをリストします。

- :ref:`新しく参加したノードへのフェイルオーバー <新しく参加したノードへのフェイルオーバー>`  ノードを管理するためのノードレベルのコマンド。

- :ref:`pgdノードセットアップの実行 <pgdノードセットアップの実行>`  クラスター内のノードをセットアップします。

- :ref:`pgd cluster show <pgd cluster show>`  ノードレベルの情報を表示します。

- :ref:`pgd node part <pgd node part>`  アクティブなクラスターからPGDノードを分割します。

- :ref:`pgd group set-option <pgd group set-option>`  オプション設定ノードレベル.

- :ref:`pgd group get-option <pgd group get-option>`  ノードレベルのオプションを取得します。

- :ref:`pgd node set-config <pgd node set-config>`  ノードレベルの構成を設定します。

- :ref:`pgd node get-config <pgd node get-config>`  ノードレベルの構成を取得します。

- :ref:`pgd node upgrade <pgd node upgrade>`  PGD
  Postgresノードのメジャーバージョンのアップグレードを実行します。

- :ref:`Node management <Node management>`  ノードをリストするためのノード関連のコマンド。 -
  :ref:`pgd commit-scopes list <pgd commit-scopes list>`  ノードをリストします。

- :ref:`機能低下イベントの監視 <機能低下イベントの監視>`  イベントを表示するためのイベントログコマンド。 -
  :ref:`pgd cluster show <pgd cluster show>`  イベントを表示します。

- :ref:`EXPLAIN ANALYZEレプリケーション <EXPLAIN ANALYZEレプリケーション>` 
  レプリケーション関連、レプリケーションを管理するためのコマンド。 -
  :ref:`pgd cluster show <pgd cluster show>`  レプリケーション情報を表示します。

- :ref:`コミット決定にRaftを使用する <コミット決定にRaftを使用する>`  Raftコンセンサスを管理するためのRaft関連コマンド。

- :ref:`pgd cluster show <pgd cluster show>`  Raft state.

- に関する情報を表示します :ref:`pgd raft enable <pgd raft enable>` 
  1つ以上のノードでRaftコンセンサスワーカーを有効にします。

- :ref:`pgd raft disable <pgd raft disable>` 
  1つ以上のノードでRaftコンセンサスワーカーを無効にします。edb_0ran_3asis_29
  1つ以上のノードでRaftコンセンサスワーカーを無効にします。edb_0ran_3asis_28
  : Raftリーダーシップを指定されたノードに転送します。

- :ref:`pgd raft sync-snapshot <pgd raft sync-snapshot>`  すべてのノードでRaftの状態を同期します。

- :ref:`pgd commit-scope create <pgd commit-scope create>` 
  PGDコミットスコープを管理するためのコミットスコープ関連コマンド。

- :ref:`pgd cluster show <pgd cluster show>`  コミットスコープに関する情報を表示します。

- :ref:`pgd commit-scope create <pgd commit-scope create>`  コミットスコープを作成します。

- :ref:`pgd commit-scope update <pgd commit-scope update>`  コミットスコープを更新します。

- :ref:`pgd commit-scope drop <pgd commit-scope drop>`  コミットスコープをドロップします.

- :ref:`pgd commit-scopes list <pgd commit-scopes list>`  コミットスコープをリストします。

- :ref:`クラスターの状態の評価 <クラスターの状態の評価>`  PostgresサーバーのPGD互換性を評価します。

- :ref:`pgd completion <pgd completion>`  シェル完了スクリプトを生成します。

グローバルオプション
--------------------

すべてのコマンドは、次のグローバルオプションを受け入れます。

.. csv-table::
  :header: Short,Long,Description
  :widths: 12,10,25
  :align: left
  :class: longtable

  `-f`,`--config-file`,構成ファイルへの名前/パス。これは--dsnフラグが存在する場合は無視されますデフォルト「/etc/edb/pgd-cli/pgd-cli-config.yml」
  "",`--dsn`,"データベース接続文字列 例 ""host=bdr-a1 port=5432 dbname=pgddb user=postgres"" `PGD_CLI_DSN`環境変数によっても設定されます。"
  `-h`,`--help`,Help for pgd - 使用されるコマンドの特定のヘルプを表示します
  `-o`,`--output`,出力フォーマット `json`、`psql`、`modern`、`markdown`、`simple`  :ref:`出力フォーマット<出力フォーマット>` を参照してください。

追加オプション
--------------

``pgd -V`` を実行して、pgd CLIのバージョン情報を確認します。

出力フォーマット
----------------

``-o`` /``--output`` オプションとともに使用します。

.. csv-table::
  :header: Format,Description
  :widths: 10,30
  :align: left
  :class: longtable

  simple,単純なフォーマット-単純なASCIIテーブルとして出力しますデフォルト。
  json,JSON形式 - JSONドキュメントとして出力します、非表形式
  psql,PSQLフォーマット-PSQLのスタイルのASCIIテーブルとして出力
  modern,最新のフォーマット-ボックスキャラクターを使用して表として出力
  markdown,マークダウンテーブルフォーマット - マークダウン互換のASCIIテーブルとして出力

.. toctree::
  :maxdepth: 3

  Reference--reference--cli--command_ref--assess--index
  Reference--reference--cli--command_ref--cluster--index
  Reference--reference--cli--command_ref--commit-scope--index
  Reference--reference--cli--command_ref--completion--index
  Reference--reference--cli--command_ref--events--index
  Reference--reference--cli--command_ref--group--index
  Reference--reference--cli--command_ref--groups--index
  Reference--reference--cli--command_ref--node--index
  Reference--reference--cli--command_ref--nodes--index
  Reference--reference--cli--command_ref--raft--index
  Reference--reference--cli--command_ref--replication--index
