Command reference ================= PGDコマンドラインインターフェイスのコマンド名は\ ``pgd`` です。概要 ---- EDB Postgres分散コマンドラインインターフェイスPGD CLIは、 EDB Postgres分散クラスターを管理するツールです。 EDB Postgres分散クラスターに対してコマンドを実行できます。これを使用して、クラスターリソースを検査および管理できます。コマンド -------- - :ref:`クラスター構成 <クラスター構成>` クラスターを管理するためのクラスターレベルのコマンド - :ref:`pgd cluster show ` クラスターレベルの情報を表示します。 - :ref:`pgd cluster verify ` クラスターレベルの情報を確認します。 - :ref:`グループとレプリケーションセットの表示 <グループとレプリケーションセットの表示>` グループを管理するためのグループレベルのコマンド - :ref:`pgd cluster show ` グループレベルの情報を表示します - :ref:`pgd group set-option ` グループレベルのオプションを設定します - :ref:`pgd group get-option ` グループレベルのオプションを取得します - :ref:`pgd group set-leader ` グループの書き込みリーダーを設定しますスイッチオーバー)。 - :ref:`グループとレプリケーションセットの表示 <グループとレプリケーションセットの表示>` グループをリストするためのグループ関連コマンド。 - :ref:`pgd commit-scopes list ` グループをリストします。 - :ref:`Nodes with differences ` ノードを管理するためのノードレベルのコマンド。 - :ref:`pgdノードセットアップの実行 ` クラスター内のノードをセットアップします。 - :ref:`pgd cluster show ` ノードレベルの情報を表示します。 - :ref:`pgd node part ` アクティブなクラスターからPGDノードを分割します。 - edb_15lk_a Setsis-level options . - :ref:`pgd group get-option ` ノードレベルのオプションを取得します。 - :ref:`pgd node set-config ` ノードレベルの構成を設定します。 - :ref:`pgd node get-config ` ノードレベルの構成を取得します。 - :ref:`pgd node upgrade ` : PGD Postgresノードのメジャーバージョンのアップグレードを実行します。edb_sis_edbgres_12インスタンスでPostgrestran_12開始a node. - :ref:`pgd node stop ` ノードでPostgresインスタンスを停止します。 - :ref:`pgd node restart ` ノードでPostgresインスタンスを再起動します。 - :ref:`Node management ` ノードをリストするためのノード関連のコマンド。 - :ref:`pgd commit-scopes list ` ノードをリストします。 - :ref:`機能低下イベントの監視 <機能低下イベントの監視>` イベントを表示するためのイベントログコマンド。 - :ref:`pgd cluster show ` イベントを表示します。 - :ref:`DML and DDL replication and nonreplication ` レプリケーション関連、レプリケーションを管理するためのコマンド。 - :ref:`pgd cluster show ` レプリケーション情報を表示します。 - :ref:`ノードの一部Raftプロトコルバージョン6003以降 <ノードの一部Raftプロトコルバージョン6003以降>` raftコンセンサスを管理ワーカーためのraft関連コマンド: Raftのリーダーシップを指定されたノードに転送します。 - :ref:`pgd raft restore ` 必要なノードの最小セットを削除することにより、Raftコンセンサスを復元します。 - :ref:`pgd raft sync-snapshot ` 全てのノードでRaftの状態を同期します。 - :ref:`pgd commit-scope create ` PGDコミットスコープを管理するためのコミットスコープ関連コマンド。 - :ref:`pgd cluster show ` コミットスコープに関する情報を表示します。 - :ref:`pgd commit-scope create ` コミットスコープを作成します。 - :ref:`pgd commit-scope update ` コミットスコープを更新します。 - :ref:`pgd commit-scope drop ` コミットスコープをドロップします. - :ref:`pgd commit-scopes list ` コミットスコープをリストします。 - :ref:`pgd promoteを使用する ` PostgresサーバーのPGD互換性を評価します。 - :ref:`pgd completion ` シェル完了スクリプトを生成します。ユーザーロール -------------- 各\ ``pgd`` コマンドは、特定のPostgresロールとして接続するか、いくつかのノード管理コマンドの場合、OSレベルのアクセスのみを必要とします。すべてのコマンドページには、必要なロールを記載したセクションが含まれています。これらのロールは、 BDR拡張機能のインストール時に自動的に作成されるため、自分で作成する必要はなく、CLIに接続しているユーザにのみ付与します。各権限の背後にある完全な特権リストについては、 :ref:`PGD predefined roles ` を参照してください。 .. csv-table:: :header: Role,Description :widths: 10,30 :align: left :class: longtable `bdr_superuser`,完全なPGD管理。 `bdr`スキーマおよび`pg_read_all_stats`のすべてのテーブルとファンクションに`ALL`特権を直接付与します。これは、正式なロール継承ではありませんが、他のすべてのロールが付与するもののスーパーセットです。 `bdr_monitor`,読み取り専用のクラスターモニタリング。 `bdr_read_all_stats`および`pg_read_all_stats`は`pg_read_all_settings`ではありませんを継承します。多くの`show`/`list`コマンドは、 `bdr_monitor`に付与されていない内部機能を使用するため、引き続き`bdr_superuser`が必要です。 `bdr_read_all_stats`,PGD統計とカタログビューを読み取ります。 `pg_read_all_stats`を継承します。 `bdr_application`,コミットスコープの読み取りなど、アプリケーションレベルのアクセス。別のロール。モニタリングチェーンの一部ではありません。 Postgres superuser,`ALTER SYSTEM`、`CREATE EXTENSION`、および`pg_upgrade`に必要です。 `bdr_superuser`とは別にします。 OS user (`pg_ctl`),OSレベルの操作である`pgd node start`/`stop`/`restart`で必要です。データベースロールはチェックされません。グローバルオプション -------------------- すべてのコマンドは、次のグローバルオプションを受け入れます。 .. 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 REFERENCE--reference--cli--command_ref--cluster--index REFERENCE--reference--cli--command_ref--commit-scope--index REFERENCE--reference--cli--command_ref--completion 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