14.3.1.2 Oracle Graph Pythonクライアント

Pythonクライアントをインストールするには、Oracle Graph Server and Clientに付属しているoracle-graph-client-24.4.0.zipファイルをダウンロードするか、PyPIからダウンロードします。

あるいは、Pythonクライアントを埋込みモードでインストールすることもできます。

14.3.1.2.1 PyPIからのPythonクライアントのインストール

PyPIからプロパティ・グラフPythonクライアントを取得できます。

pipを使用して、PyPIリポジトリからoracle-graph-client-24.4.0.zipパッケージをインストールできます。
PyPIからPythonクライアントをインストールする前に、システムが次の要件を満たしていることを確認してください。
  • サポートされているオペレーティング・システム: Linux、WindowsまたはmacOS (M1またはM2プロセッサ)
  • サポートされているJDKバージョン:
    • Oracle JDK 11、JDK 17またはJDK 21
    • OpenJDK JDK 11、JDK 17またはJDK 21
  • Python 3.8以降
  • JAVA_HOME環境変数を設定していることを確認します。
  • プロキシがある場合は、https_proxy環境変数をプロキシ・サーバーに設定します。

次のように、Pythonクライアントのインストールをインストールおよび検証できます:

  1. pipを使用してクライアントをインストールします。
    たとえば、
    pip install --user oracle-graph-client

    これにより、必要なすべての依存関係とともにPythonクライアントがインストールされます。

  2. インストールが成功したことを確認します。
    $ python3
    Python 3.8.12 (default, Apr  5 2022, 08:07:47)
    [GCC 8.5.0 20210514 (Red Hat 8.5.0-10.0.1)] on linux
    Type "help", "copyright", "credits" or "license" for more information.
    >>> import opg4py
    >>> import pypgx

    関連項目:

    Python APIの詳細は、Python APIリファレンスを参照してください

14.3.1.2.2 Pythonクライアントのアップグレード

この項では、Pythonクライアントをアップグレードする方法について説明します。

  1. 使用可能なPythonクライアント・バージョンおよび現在インストールされているバージョンを確認します。
    pip3 index versions oracle-graph-client
    
    WARNING: pip index is currently an experimental command. It may be removed/changed in a future release without prior warning.
    oracle-graph-client (23.3.0)
    Available versions: 23.3.0, 23.2.0, 23.1.0
      INSTALLED: 23.1.0
      LATEST:    23.3.0
  2. 次のコマンドを実行して、Pythonクライアントをアップグレードします。
    pip3 install oracle-graph-client --upgrade

14.3.1.2.3 グラフ・サーバーおよびクライアント・ダウンロードからのPythonクライアントのインストール

Graph Server and Clientのダウンロードからoracle-graph-client-24.4.0のzipファイルをダウンロードして、Pythonクライアントをインストールできます。

Pythonクライアントをインストールする前に、次の前提条件を満たしていることを確認します。
  • システム要件:
    • サポートされているオペレーティング・システム: Linux
    • サポートされているJDKバージョン:
      • Oracle JDK 11、JDK 17またはJDK 21
      • OpenJDK JDK 11、JDK 17またはJDK 21
    • サポートされているPythonのバージョン: Python 3.8または3.9

      正しいバージョンのPythonクライアントを使用していることを確認するには、次のコマンドを実行します。

      python3 --version

      Oracle LinuxでのPython 3のインストールの詳細は、Python for Oracle Linuxを参照してください。

    ノート:

    他のオペレーティング・システムまたはPythonバージョンを使用している場合は、PyPIからPythonクライアントをインストールできます。詳細は、PyPIからのPythonクライアントのインストールを参照してください。
  • python3-develがシステムにインストールされていることを確認します。

    sudo yum install python3-devel

ノート:

Python APIの詳細は、Python APIリファレンスを参照してください。

次のステップを実行して、Pythonクライアントを使用してインストールおよび接続できます:

  1. Oracle Software CloudからOracle Graph Clientをダウンロードします。
    たとえば、oracle-graph-client-24.4.0.zipです。
  2. 選択したディレクトリに、このファイルを解凍します。

    解凍されたフォルダには、Pythonクライアントをインストールするためのoracle-graph-python-client-24.4.0.zipファイルが含まれています。

  3. 次のコマンドを実行してPythonクライアントをインストールします。
    python3 oracle-graph-python-client-24.4.0.zip --user
  4. 自己署名キーストアを信頼するようにクライアントを構成します。詳細は、「自己署名キーストアを信頼するためのクライアントの構成」を参照してください。
  5. 次のコマンドを実行することで、OPG4Pyシェルを起動してグラフ・サーバー(PGX)に接続します。
    cd <CLIENT_INSTALL_DIR>
    ./bin/opg4py --base_url https://<host>:7007

    前述のコードで:

    • <CLIENT_INSTALL_DIR>: シェル実行可能ファイルが置かれているディレクトリ。

      シェル実行可能ファイルは、クライアントのインストール後に<CLIENT_INSTALL_DIR>/binにあります。

    • <host>: サーバー・ホスト

      ノート:

      グラフ・サーバー(PGX)は、デフォルトでポート7007でリスニングします。必要に応じて、サーバー構成ファイル(server.conf)内のポート値を変更して、別のポートでリスニングするようにグラフ・サーバーを構成できます。詳細は、グラフ・サーバー(PGX)の構成を参照してください。

    ユーザー名とパスワードの入力を求められます。

    OPG4Pyシェルを起動できる様々な方法の詳細は、OPG4Pyシェルの起動を参照してください。

    OPG4Pyシェルが起動し、次に示すコマンドライン・プロンプトが表示されます。

    Oracle Graph Server Shell 24.4.0
    >>>

    ノート:

    Jupyter Notebookでpythonクライアント・ライブラリをインストールすることもできます。Python APIを使用すると、グラフ・サーバー(PGX)に接続してJupyter Notebook環境でPGQL問合せおよびグラフ・アルゴリズムを実行できます。詳細は、「Jupyter Notebookインタフェースの使用」を参照してください。

14.3.1.2.4 埋込みモードでのPythonクライアントのインストール

埋込みモードでPythonクライアントをインストールして操作できます。

埋込みPythonクライアントをインストールするには:

  1. 次のコマンドを実行します。
     python3 /opt/oracle/graph/client/oracle-graph-python-embedded-24.4.0.zip --user
  2. 次に示すように、OPG4Pyシェルを埋込みモードで起動します:
    cd /opt/oracle/graph
    ./bin/opg4py

    シェル実行可能ファイルは、サーバーのインストール後に/opt/oracle/graph/binにあります。

    OPG4Pyシェルが起動し、次に示すコマンドライン・プロンプトが表示されます。

    Oracle Graph Server Shell 24.4.0
    >>> instance
    ServerInstance(embedded: True, version: 24.4.1)
    >>>

14.3.1.2.5 Pythonクライアントのアンインストール

このセクションでは、Pythonクライアントをアンインストールする方法について説明します。

Pythonクライアントをアンインストールするには、次のコマンドを実行します。

pip uninstall oracle-graph-client