すべてのプロダクト
Search
ドキュメントセンター

PolarDB:PolarPlus

最終更新日:Nov 19, 2024

PolarPlusは、クライアントをPolarDBデータベースに接続するためのツールです。 PolarPlus は Oracle 構文との互換性を備えています。

PolarPlus クライアントのダウンロード

PolarPlusは、インストール不要のクライアントパッケージを提供します。 パッケージをダウンロードして解凍した後、Linuxで使用できます。 以下のコードに、展開後の PolarPlus ディレクトリの構造を示します。 polarplus ファイルは実行ファイルです。 polarplus_release/ ディレクトリのパスをシステム変数 PATH に追加すると、polarplus コマンドを実行できます。

polarplus_release
├── polarplus -> ./polarplus.sh
├── polarplus.sh
├── polarplus.jar
├── login.sql
├── etc
│   └── sysconfig
├── help
└── lib

PolarPlus の使用

概要

PolarPlusは、PolarDBのCLIを提供します。 SQL文、PolarPlusコマンド、PL/SQL匿名ブロック、関数、およびストアドプロシージャをサポートします。 PolarPlus では、以下の操作を実行できます。

  • 特定のデータベースオブジェクトを照会します。

  • ストアドプロシージャを実行します。

  • SQL 文の出力の整形。

  • バッチ処理スクリプトの実行。

  • OS コマンドの実行。

  • レコードの出力。

Oracleとの互換性

PolarPlusはPolarDBに適合しており、OracleのSQL * Plusツールの共通機能をサポートしています。

説明

PolarDB-Toolsを使用してPolarDBクラスターを管理することを推奨します。 このツールセットは、PolarDB for PostgreSQL (Oracle互換) に適合しています。 ツールセットのpsqlツールは、Oracle互換のPL/SQL匿名ブロック、関数、およびストアドプロシージャを提供します。

PolarPlusの設定

説明

PolarPlus には以下の依存関係が必要です。

  • Java Development Kit (JDK) 1.8 for 64-bit OSs

  • OpenSSL 1.1 for 64-bit OSs

  1. wgetコマンドを実行して、このトピックの「PolarPlusクライアントのダウンロード」セクションで指定されたリンクからPolarPlusクライアントパッケージをダウンロードします。 クライアントパッケージを解凍します。

  2. ビンディレクトリに移動します。

  3. polarplus.sh ファイルを開きます。

  4. export base="{pwd}/polarplus" ラインを変更する: {pwd}polarplus ファイルの絶対パスに変更します。

  5. PolarDB データベースに接続するサーバーで、以下のコマンドを実行して PolarPlus を起動します。

    polarplus [ -S[ILENT ] ] [ login | /NOLOG ] [ @scriptfile[.ext ] ]

    パラメーター

    説明

    -S[ILENT ]

    このパラメーターを設定すると、PolarPlus を使用してデータベースに接続する際、ログインバナーやログオン関連のメッセージは表示されません。

    login

    データベースサーバーとデータベースへの接続に使用されるログイン情報です。

    このパラメーターの値は、以下の形式で指定する必要があります。

    username[/password][@{connectstring | variable } ]

    詳細については、このトピックの「ログインパラメーター」表をご参照ください。

    変数パラメーターは、login.sql ファイルで定義されている変数です。 login.sql ファイルには、データベースの接続文字列が含まれています。

    /NOLOG

    /NOLOG を指定した場合、PolarPlus の起動時にデータベースへの接続が作成されません。 データベースに接続して SQL 文を実行したり、PolarPlus コマンドを実行したりする場合は、このオプションを指定しないでください。

    説明

    PolarPlus を起動する際にこのオプションを指定した場合は、CONNECT コマンドを実行してデータベースに接続します。

    scriptfile[.ext ]

    scriptfile パラメーターには、現在の作業ディレクトリに格納されているファイルの名前を指定します。 このファイルには、自動的に実行される SQL 文と、PolarPlus の起動後に自動的に実行される PolarPlus コマンドが含まれています。

    ファイル拡張子を指定します。 スクリプトファイルのファイル拡張子が. sql、スクリプトファイルを指定するときにファイル拡張子を省略できます。 スクリプトファイルを作成するときは、ファイル名を <file name>.<file extension> の形式で指定します。 この形式以外の場合、PolarPlus はファイルにアクセスできません。

    説明

    ファイル名にファイル拡張子サフィックスを含まないファイルの場合、PolarPlusはファイルを. sqlファイルとして作成します。

    表 1. ログインパラメーター

    パラメーター

    説明

    username

    データベースへの接続に使用されるデータベースアカウントの名前。

    password

    データベースへの接続に使用されるデータベースアカウントのパスワード。

    connectstring

    データベースの接続文字列です。 接続文字列は、以下の形式で指定する必要があります。

    host[:port][/dbname][?ssl={true | false}]
    • host パラメーターには、データベースサーバーのホスト名または IP アドレスを指定します。

      説明

      connectstringvariable、または /NOLOGパラメーターが設定されていない場合、デフォルトのホストはオンプレミスホストです。

    • Internet Protocol version 6 (IPv6) アドレスを使用してデータベースに接続する場合は、IP アドレスを角括弧 ([]) 内に配置する必要があります。

      以下の例で、IPv6 アドレスを使用してデータベースに接続する方法を示します。

      polarplus  polardb/password@[fe80::20c:29ff:fe7c:78b2]:5444/polardb
    • port パラメーターは、データベースサーバーが接続要求を受信するために使用するポートを指定します。

      説明

      このパラメーターが設定されなかった場合、デフォルトのポート 5444 が使用されます。

    • dbname パラメーターは、接続するデータベースの名前を指定します。

      説明

      このパラメーターが設定されなかった場合、デフォルト値 (polardb) が使用されます。

    • SSL 接続を作成する場合は、接続文字列に ?ssl = true および host:port を指定する必要があります。 指定されていない場合、SSL 接続は確立できません。

    以下の例に、PolarPlus を使用して PolarDB データベースに接続する方法を示します。

    polarplus  polardb/password@pc-bp1zxxxxxxxxxxx.o.polardb.rds.aliyuncs.com:1521/polardb
    説明

    PolarPlus は、PolarDB for PostgreSQL (Oracle 互換) 1.0 クラスターに接続するためにのみ使用されます。 PolarDB for PostgreSQL (Oracle 互換) 2.0 クラスターに接続するには、PolarPlus2 をダウンロードする必要があります。 PolarPlus2 のディレクトリ構造と使用法は、PolarPlus と同様です。 ディレクトリとコマンドのpolarpluspolarplus2に置き換えるだけです。