PyCharm 2023.2 ヘルプ

MongoDB

データベースツールと SQL プラグインを有効にする

この機能は、PyCharm にバンドルされており、デフォルトで有効になっているデータベースツールと SQL プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。

  1. Control+Alt+S を押して IDE 設定を開き、プラグインを選択します。

  2. インストール済みタブを開き、データベースツールおよび SQL プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。

公式ドキュメントとソフトウェア

このトピックでは、PyCharm で MongoDB データベースに接続するためのデータソースを作成し、テスト接続を実行する方法に関する一般的な手順を示します。必要な前提条件がすでに満たされており、データベースが稼働していることを前提としています。例: マシン上でデータベースを実行し、そのデータベースに接続する場合は、対応する DBMS ソフトウェアを最初にマシンにインストールする必要があります。

MongoDB データベースに接続する

  1. データベースに接続するには、接続の詳細を保存するデータソースを作成します。これは、次のいずれかの方法で実行できます。

    • メインメニューからファイル | 新規 | データソースに移動し、MongoDB を選択します。

    • データベースツールウィンドウ ( 表示 | ツールウィンドウ | データベース ) で、ツールバーの新規アイコン (the New icon) をクリックします。データソースに移動し、MongoDB を選択します。

    Create a new data source
  2. データソースおよびドライバーダイアログの右ペインの一般タブで、ドライバーと接続タイプを指定します。

    1. 接続に別のドライバーが必要でない限り、ドライバーリストではデフォルトのドライバーオプションのままにしておきます。

    2. 接続タイプリストから、接続の詳細に応じて接続タイプを選択します。

      URL のみ接続タイプの場合、入力した JDBC URL がそのまま使用されます。

      他の接続タイプの場合、JDBC URL は接続の詳細に分割されます。個別に指定して自動生成された URL を使用することも、対応するフィールドに URL を直接入力することもできます。

    General tab of the Data Sources and Drivers dialog
  3. 接続設定領域の下部に「不足しているドライバーファイルをダウンロード」リンクがあるかどうかを確認します。このリンクをクリックして、データベースと対話するために必要なドライバーをダウンロードします。直接ダウンロードリンクについては、JetBrains JDBC ドライバーページを参照してください。

    ダウンロードした JDBC ドライバーは PyCharm 構成ディレクトリにあります。

    IDE には、インストールパッケージのサイズを小さくし、IDE バージョンごとにドライバーのバージョンを最新に保つために、バンドルされたドライバーは含まれていません。

    The Download missing driver files link

    提供されているドライバーの代わりにデータベース用のドライバーを使用することもできます。ドライバーを使用したデータベースへの接続の詳細については、「既存の接続にユーザードライバーを追加する」を参照してください。

    不足しているドライバーファイルをダウンロードリンクがない場合は、必要なドライバーがすでに存在します。

  4. データベース接続の詳細を指定します。あるいは、JDBC URL を URL フィールドに貼り付けます。

    1. ホストフィールドに、サーバーのアドレスを入力します。

    2. ポートフィールドに、MongoDB のポートを入力します。デフォルトのポートは 27017 です。

    3. 認証リストから、接続の認証に使用する認証方法を選択します。次のオプションが利用可能です。

      • ユーザーパスワード : ログインとパスワードを使用。

      • MongoDB 認証(英語)オプション:

        • SCRAM-SHA-1 : ユーザーパスワード認証データベースおよび SHA-256 ハッシュ関数を使用して認証します。

        • SCRAM-SHA-256 : ユーザーパスワード認証データベースおよび SHA-1 ハッシュ関数を使用して認証します。

        • AWS IAM : AWS アクセスキー IDAWS シークレットアクセスキーAWS セッショントークンを使用して認証します。

        • x.509 : 認証には x.509 証明書を使用します。

        • GSSAPI (Kerberos) : 認証に Kerberos を使用します。

        • 標準のテキスト形式 (LDAP) : 認証要求をライトウェイトディレクトリアクセスプロトコル (LDAP) サービスにプロキシすることによって認証します。

      • 認証なし : 認証は必要ありません。

    4. ユーザーおよびパスワードフィールドに、ユーザーの資格情報を入力します。

      パスワードを使用しない場合は、パスワードフィールドを空のままにします。

      一度入力したパスワードを削除するには、「パスワード」フィールドを右クリックし、「空にする」を選択します。

      the Set Empty context menu action
    5. データベースフィールドに、接続するデータベース名を入力します。

    6. URL フィールドでは、PyCharm は他の接続設定の値を使用して JDBC URL を自動的に生成します。

      特定の追加設定を含む JDBC URL を使用する必要がある場合は、それを URL フィールドに貼り付けます。使用する一般的な URL は次のとおりです。

      • フォーマット: mongodb://<host_address>:<port_number>/<database_name>

      • サンプル: mongodb://127.0.0.1:27017/myDatabase

      URL 形式の詳細については、「MongoDB 公式ドキュメント(英語)」を参照してください。

    Database connection details
    1. ホストフィールドに、サーバーのアドレスを入力します。

    2. ポートフィールドに、MongoDB のポートを入力します。デフォルトのポートは 27017 です。

    3. 認証リストから、接続の認証に使用する認証方法を選択します。次のオプションが利用可能です。

      • ユーザーパスワード : ログインとパスワードを使用。

      • MongoDB 認証(英語)オプション:

        • SCRAM-SHA-1 : ユーザーパスワード認証データベースおよび SHA-256 ハッシュ関数を使用して認証します。

        • SCRAM-SHA-256 : ユーザーパスワード認証データベースおよび SHA-1 ハッシュ関数を使用して認証します。

        • AWS IAM : AWS アクセスキー IDAWS シークレットアクセスキーAWS セッショントークンを使用して認証します。

        • x.509 : 認証には x.509 証明書を使用します。

        • GSSAPI (Kerberos) : 認証に Kerberos を使用します。

        • 標準のテキスト形式 (LDAP) : 認証要求をライトウェイトディレクトリアクセスプロトコル (LDAP) サービスにプロキシすることによって認証します。

      • 認証なし : 認証は必要ありません。

    4. ユーザーおよびパスワードフィールドに、ユーザーの資格情報を入力します。

      パスワードを使用しない場合は、パスワードフィールドを空のままにします。

      一度入力したパスワードを削除するには、「パスワード」フィールドを右クリックし、「空にする」を選択します。

      the Set Empty context menu action
    5. データベースフィールドに、接続するデータベース名を入力します。

    6. URL フィールドでは、PyCharm は他の接続設定の値を使用して JDBC URL を自動的に生成します。

      特定の追加設定を含む JDBC URL を使用する必要がある場合は、それを URL フィールドに貼り付けます。使用する一般的な URL は次のとおりです。

      • フォーマット: mongodb+srv://<host_address>/<database_name>

      • サンプル: mongodb+srv://127.0.0.1/myDatabase

      URL 形式の詳細については、「MongoDB 公式ドキュメント(英語)」を参照してください。

    Database connection details
    1. 認証リストから、接続の認証に使用する認証方法を選択します。次のオプションが利用可能です。

      • ユーザーパスワード : ログインとパスワードを使用。

      • MongoDB 認証(英語)オプション:

        • SCRAM-SHA-1 : ユーザーパスワード認証データベースおよび SHA-256 ハッシュ関数を使用して認証します。

        • SCRAM-SHA-256 : ユーザーパスワード認証データベースおよび SHA-1 ハッシュ関数を使用して認証します。

        • AWS IAM : AWS アクセスキー IDAWS シークレットアクセスキーAWS セッショントークンを使用して認証します。

        • x.509 : 認証には x.509 証明書を使用します。

        • GSSAPI (Kerberos) : 認証に Kerberos を使用します。

        • 標準のテキスト形式 (LDAP) : 認証要求をライトウェイトディレクトリアクセスプロトコル (LDAP) サービスにプロキシすることによって認証します。

      • 認証なし : 認証は必要ありません。

    2. ユーザーおよびパスワードフィールドに、ユーザーの資格情報を入力します。

      パスワードを使用しない場合は、パスワードフィールドを空のままにします。

      一度入力したパスワードを削除するには、「パスワード」フィールドを右クリックし、「空にする」を選択します。

      the Set Empty context menu action
    3. URL フィールドでは、PyCharm は他の接続設定の値を使用して JDBC URL を自動的に生成します。

      特定の追加設定を含む JDBC URL を使用する必要がある場合は、それを URL フィールドに貼り付けます。

      URL 形式の詳細については、「MongoDB 公式ドキュメント(英語)」を参照してください。

    Database connection details

    一般およびデータソースおよびドライバーダイアログ (Command I) の他のタブの接続設定とプロパティに関する参考情報については、「接続設定と DBMS 固有のプロパティ」を参照してください。

  5. 提供された詳細を使用してデータベースへの接続を確立できることを確認します。これを行うには、接続の詳細領域の下部にある接続のテストリンクをクリックします。

    Test Connection link

    接続に問題がある場合は、データベースに接続できませんページを参照してください。

  6. (オプション) デフォルトでは、デフォルトのデータベースのみがイントロスペクトされ、操作可能になります。他のデータベースも操作したい場合は、「スキーマ」タブで、イントロスペクションの対象としてそれらのデータベースを選択します。

    Schemas tab of the Data Sources and Drivers dialog
  7. OK をクリックして、データソースを作成します。

  8. データベースツールウィンドウ (Alt+1) で新しいデータソースを見つけます。

    • データベースツールウィンドウの詳細については、対応するリファレンストピックを参照してください。

    • PyCharm でのデータベースオブジェクトの操作の詳細については、「データベースオブジェクト」を参照してください。

    • クエリを作成して実行するには、データソースをクリックして F4 を押し、既定のクエリコンソールを開きます。

    • データベースオブジェクトのデータを表示および編集するには、オブジェクトをダブルクリックしてデータエディターとビューアーを開きます。

接続設定と DBMS 固有のプロパティ

接続設定

一般およびデータソースおよびドライバーダイアログ (Command I) の他のタブの接続設定 ( ホストポートなど) に関する参考情報については、「データソース設定」を参照してください。

DBMS 固有のプロパティ

一般タブ

項目

説明

認証データベース

ユーザー名に関連付けられている認証データベースの名前。認証データベースが接続先のデータベースと異なる場合は、URL の authSource パラメーターで認証データベースを指定します。認証データベースが指定されていない場合、MongoDB はデフォルトで admin データベースを使用します。

例: local データベースに接続したいが、認証データベースは admin です。この場合、接続 URL は mongodb://localhost:27017/local?authSource=admin のようになります。

このプロパティは、SCRAM-SHA-1 および SCRAM-SHA-256 認証方法に使用されます。

AWS アクセスキー ID

MongoDB AWS IAM 認証方法に使用される接続プロパティ。

AWS セッショントークン

AWS シークレットアクセスキー

基本

MongoDB GSSAPI (Kerberos) 認証方法に使用される接続プロパティ。

詳細は、このメソッドに関する MongoDB 公式ドキュメント(英語)を参照してください。

サービス名

サービス領域

ホスト名の正規化

関連ページ:

データベースへの接続

データベースツールと SQL プラグインを有効にするこの機能は、PyCharm にバンドルされており、デフォルトで有効になっているデータベースツールと SQL プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。を押して IDE 設定を開き、を選択します。インストール済みタブを開き、データベースツールおよび SQL プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。このトピックでは、PyCharm でのデータベー...

IDE で使用されるディレクトリ

デフォルトでは、PyCharm は、各 IDE インスタンスのユーザー固有のファイル(構成、キャッシュ、プラグイン、ログなど)をユーザーのホームディレクトリに保存します。ただし、必要に応じて、これらのファイルを保存する場所を変更できます。IDE ディレクトリの場所を変更するたとえば、ユーザープロファイルドライブの容量が不足している場合や低速ディスクにある場合、ホームディレクトリが暗号化されている(IDE の速度が低下している)場合、またはネットワークドライブにある場合は、デフォルトの IDE デ...

データベースに接続できません

ステップ 1. ネットワーク設定を確認してください:データベースは、ローカル、サーバー、クラウドで機能します。サーバーおよびクラウドデータベースの場合、ネットワーク接続が必要です。接続が使用可能であることを確認するには、ping および telnet コマンドを使用します。ping コマンドを使用すると、移行先コンピューターが移行元コンピューターから到達可能であることを確認できます。コマンドラインを開き、コマンドを入力します。は、アドレスをホスト名に解決するコマンドオプションです(可能な場合)。pin...

データベースツールウィンドウ

データベースツールと SQL プラグインを有効にするこの機能は、PyCharm にバンドルされており、デフォルトで有効になっているデータベースツールと SQL プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。を押して IDE 設定を開き、を選択します。インストール済みタブを開き、データベースツールおよび SQL プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。概要:データベースツールウィンドウ (表示 |...

クエリコンソール

データベースツールと SQL プラグインを有効にするこの機能は、PyCharm にバンドルされており、デフォルトで有効になっているデータベースツールと SQL プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。を押して IDE 設定を開き、を選択します。インストール済みタブを開き、データベースツールおよび SQL プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。概要:クエリまたはデータベースコンソールは、デ...

データエディターとビューアー

データベースツールと SQL プラグインを有効にするこの機能は、PyCharm にバンドルされており、デフォルトで有効になっているデータベースツールと SQL プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。を押して IDE 設定を開き、を選択します。インストール済みタブを開き、データベースツールおよび SQL プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。概要:データエディターとビューアー、またはデー...