DataGrip 2020.3 ヘルプ

DataGrip のクイックスタート

このクイックスタートガイドでは、主要な概念を紹介し、DataGrip での最初のステップを支援します。

ステップ 1: 初期設定を構成する

製品をインストールして初めて起動すると、初期構成ウィザードが表示されます。DataGrip をインストールするにインストールプロセスの詳細な説明があります。

  1. 最初のページで、DataGrip の配色を選択します。これは、明るい色でも暗い色でもかまいません。

  2. 2 番目のページでは、デフォルトのダイアレクトと SQL スクリプトを使用したディレクトリを構成できます。

    デフォルトの SQL ダイアレクト : SQL ファイルのコードは、選択したダイアレクトに従ってハイライトされます。例:Microsoft SQL Server を選択すると、SQL ファイルはデフォルトで SQL Server ファイルとしてハイライトされます。この設定は後で変更できます。ファイルまたはフォルダーのダイアレクトを設定するには、SQL ダイアレクトを参照してください。

    スクリプトディレクトリ : ファイルツールウィンドウ(表示 | ツールウィンドウ | ファイル)に接続されているディレクトリ。後で任意のディレクトリをアタッチできます。

    Configure initial settings

ステップ 2: Docker および Git プラグインを有効にする

PostgreSQL インスタンスを実行して git リポジトリのクローンを作成するには、Docker プラグインと Git プラグインが必要になります。これらのプラグインがインストールされ、有効になっていることを確認してください。DBMS とスクリプトを使用する場合は、この手順をスキップしてください。

JetBrains で Git プラグインを有効にする

  1. 設定 Ctrl+Alt+S を開き、プラグインに移動します。

  2. インストール済みをクリックします。

  3. 検索フィールドに Git と入力し、 Enter を押します。

  4. Git プラグイン名の近くにあるチェックボックスを選択します。GitHub との統合を追加するために、GitHub プラグインを有効にすることもできます。

  5. IDE を再起動します。

Install the Git plugin by JetBrains

JetBrains による Docker プラグインのインストール

DataGrip で Docker をサポートするには、JetBrains による Docker プラグインをインストールしてください。

  1. 設定 Ctrl+Alt+S を開き、プラグインに移動します。

  2. マーケットプレースをクリックします。

  3. 検索フィールドに Docker と入力し、 Enter を押します。

  4. プラグインをインストールするには、インストール クリックして DataGrip を再起動します。

Install the Docker plugin by JetBrains

ステップ 3: リポジトリのクローン

例として、次の 2 つのリポジトリを使用します。Sakila ダンプファイル(https://github.com/DataGrip/dumps(英語))と Docker-compose ファイル( https://github.com/DataGrip/datagrip-documentation(英語))です。Sakila リポジトリには、Sakila データベースの構造を生成するスクリプトと、データベースオブジェクトにデータを追加するスクリプトが含まれています。Docker リポジトリには、サービス、ネットワーク、ボリュームを定義する YAML ファイルが含まれています。

VCS 連携を有効にする

  1. VCS | VCS 連携を有効にするをクリックします。

  2. VCS 連携を有効にするダイアログで、ドロップダウンリストで Git が選択されていることを確認し、OK をクリックします。

    Enable version control integration

リポジトリのクローン

  1. Git | クローンをクリックします。

  2. URL フィールドに、次の Web URL をコピーして貼り付けます。

    • Sakila ダンプファイル:

      https://github.com/DataGrip/dumps.git

    • Docker-compose ファイル:

      https://github.com/DataGrip/datagrip-documentation.git

  3. ディレクトリフィールドで、フォルダーアイコン(The folder icon)をクリックして、リポジトリファイルのディレクトリを指定します。

    Clone repositories

ステップ 4: Docker データベースイメージを実行する

このチュートリアルでは、Docker 用の PostgreSQL コンテナーを実行します(datagrip-documentation リポジトリから)。リポジトリの Docker ディレクトリには、.env ファイルと docker-compose.yml ファイルがあります。 .env には、PostgreSQL サービスの資格情報が含まれています。 docker-compose.yml は、サービスの作成方法と構成方法を定義します。

サービス名は、サービス定義の最初の行(JDBC URL の前)です。この例では、サービス名は postgresql_12、JDBCURL は jdbc:postgresql://localhost:54333/guest?user=guest&password=guest です。

postgresql_12: # jdbc:postgresql://localhost:54333/guest?user=guest&password=guest container_name: postgresql_12 ports: - "54333:5432" image: postgres:12-alpine env_file: .env healthcheck: test: "exit 0"

次のコマンドを実行して、コマンドラインからコンテナーを実行できます。

docker-compose up -d postgresql_12
最初に docker-compose.yml ファイルのディレクトリに移動する必要があることに注意してください。

または、DataGrip で Docker プラグインを有効にして使用することもできます。

Docker サポートを有効にする

  1. Docker をインストールして実行します。

    詳しくは、Docker のドキュメント(英語)を参照してください。

  2. Docker デーモンの接続設定を構成します。

    • 設定 / 環境設定ダイアログ Ctrl+Alt+S で、ビルド、実行、デプロイ | Docker を選択します。

    • The Add button をクリックして Docker 構成を追加し、Docker デーモンへの接続方法を指定します。

      接続設定は、Docker のバージョンとオペレーティングシステムによって異なります。

      ダイアログの下部に接続完了メッセージが表示されます。

      The Docker connection settings
  3. Docker デーモンに接続します。

    構成された Docker 接続がサービスツールウィンドウ(表示 | ツールウィンドウ | サービスまたは Alt+8 )に表示されます。Docker ノードDocker nodeを選択してThe Connect buttonをクリックするか、コンテキストメニューから接続を選択します。

    The Docker tool window, connected to Docker

    Docker 接続設定を編集するには、Docker ノードを選択してツールバーのThe Edit Configuration buttonをクリックするか、コンテキストメニューから構成の編集を選択します。

Docker-compose デプロイ構成を作成する

  1. サービスツールウィンドウ(表示 | ツールウィンドウ | サービス)で、Docker ノードを右クリックしてデプロイを選択します。

  2. ポップアップウィンドウで、Docker-compose デプロイを作成を選択します。

  3. デプロイ構成の作成ダイアログで、構成ファイルフィールドの参照アイコンをクリックします。

  4. Docker Compose 構成ファイルダイアログで、追加ボタンをクリックして、作成ファイルに移動します。Compose YAML ファイルは、サービス、ネットワーク、ボリュームを定義します。私たちの場合、docker-compose.yml です

  5. Docker Compose 構成ファイルダイアログで、OK をクリックします。

  6. サービスフィールドに postgresql_12 と入力します。

  7. 実行をクリックします。

    その結果、サービスツールウィンドウに postgresql_12 実行中のコンテナーが表示されます。

    Create the Docker-compose deployment configuration

ステップ 5: データベースに接続する

データベースベンダー(MySQL、PostgreSQL、Oracle)に応じて、対応するデータソース接続を作成する必要があります。このチュートリアルでは、PostgreSQL 接続を作成します。

他のデータベース管理システム(DBMS)に接続する場合は、データベース接続を参照してください。接続できない場合

  1. データソースのプロパティを開きます。次のいずれかのオプションを使用して、データソースのプロパティを開くことができます。

    • ファイル | データソースにナビゲートします。

    • Ctrl+Alt+Shift+S を押します。

    • データベースツールウィンドウ(表示 | ツールウィンドウ | データベース)で、データソースのプロパティアイコンThe Data Source Properties iconをクリックします。

  2. データソースおよびドライバーダイアログで、追加アイコン(The Add icon)をクリックし、PostgreSQL を選択します。

  3. データソース設定領域の下部にある欠落しているドライバーファイルをダウンロードするリンクをクリックします。または、データソースのユーザードライバを指定することもできます。ユーザードライバの詳細については、既存の接続にユーザードライバーを追加するを参照してください。

  4. URL フィールドに、JDBC URL jdbc:postgresql://localhost:54333 / guest ? user = guest&password = guest をコピーして貼り付けます。他の DBMS の JDBC URL。docker-compose.yml を参照してください。テキストエディターで docker-compose.yml を開くことができます。

  5. (オプション)名前フィールドで、現在の名前を削除し、接続の新しい名前を入力します(たとえば、PostgreSQL)。

  6. データソースへの接続が正常に行われるようにするには、接続テストをクリックします。

Integration with PostgreSQL

ステップ 7: SQL スクリプトでディレクトリを添付する

SQL スクリプトを実行するには、データソースを右クリックして SQL スクリプトの実行を選択します。または、これらのスクリプトを含むフォルダーをファイルツールウィンドウにアタッチして、ここから実行することもできます。

  1. 表示 | ツールウィンドウ | ファイルにナビゲートします。

  2. ファイルツールウィンドウで、任意の領域を右クリックし、ディレクトリをプロジェクトに接続するを選択します。

  3. 接続するディレクトリに移動します。この例では、dumps ディレクトリです。

  4. OK をクリックします。

    Attach a directory with SQL files

ステップ 8: ダンプファイルを実行する

  1. ファイル(表示 | ツールウィンドウ | プロジェクト)ツールウィンドウで、postgres-sakila-db ツリーノードに移動します。

  2. postgres-sakila-db ツリーノードを展開します。

  3. Ctrl を押しながら postgres-sakila-schema.sql および postgres-sakila-insert-data.sql をクリックします。

  4. 選択を右クリックし、実行 '<file_names>' をクリックします。または、 Ctrl+Shift+F10 を押します。

  5. ターゲットデータソース / スキーマテーブルで、追加ボタン(The Add button)をクリックし、PostgreSQL を選択します。

  6. postgres-sakila-schema.sql ファイルが実行テーブルのリストの一番上にあることを確認します。それ以外の場合は、上(the Up button)ボタンと下(the Down button)ボタンを使用してファイルの順序を変更します。

    DataGrip は、リストの先頭からファイルを実行します。

  7. 実行を押します。

    Run dump files

ステップ 9: コードを書く

エディターで作業している間、DataGrip はあなたのコードを分析し、それを最適化する方法を探り、潜在的および実際の問題を検出します。次のリストには、コード作成に役立ち、生産性を向上させるのに役立つ可能性のある基本的な機能とツールが含まれています。

コード補完

  • コードを入力すると、コード補完の候補が表示されます。DataGrip には 2 種類のコード補完があります。

    基本コード補完 Ctrl+Space は、可視性スコープ内のタイプ、インターフェース、メソッド、キーワードの名前を完成させるのに役立ちます。コード補完を呼び出すと、DataGrip はコンテキストを分析し、現在のキャレット位置から到達可能な選択肢を提案します。デフォルトでは、DataGrip は入力時にコード補完ポップアップを自動的に表示します。

    スマートコード補完 Ctrl+Shift+Space は候補リストをフィルタリングし、現在のコンテキストに適用可能なタイプのみを表示します。

    次のアニメーションは、基本補完とスマート補完の違いを示しています。さまざまな補完タイプに推奨されるバリエーションの数に注意してください

コードの生成

  • DataGrip は、一般的なコード構造と繰り返し要素を生成する複数の方法を提供し、生産性の向上に役立ちます。これらは、新しいファイルを作成するときに使用されるファイルテンプレート、コンテキスト、さまざまなラッパー、または文字の自動ペアリングに基づいて異なる方法で適用されるカスタムまたは事前定義されたライブテンプレートのいずれかです。

    メインメニューからコード | 生成 Alt+Insert を選択して、生成可能な使用可能な構成体を含むポップアップメニューを開きます。

    関数、プロシージャ、ビュー、その他のデータベースオブジェクトを生成できます。

    オブジェクトを生成するには、 Alt+Insert を押して、生成するオブジェクトを選択します。

    Generating code

ライブテンプレート

  • ライブテンプレートを使用して、ステートメントやデータベースオブジェクトの定義などの一般的な構成をコードに挿入します。

    コードスニペットを展開するには、対応するテンプレートの省略形を入力して Tab を押します。 Tab を押し続けると、テンプレート内の 1 つの変数から次の変数にジャンプします。 Shift+Tab を押して、前の変数に移動します。

    ライブテンプレートのリストを表示するには、設定 Ctrl+Alt+S を開き、エディター | ライブテンプレートに移動します。

    Live templates

インスペクション

  • DataGrip には、コンパイル前にプロジェクト内の異常コードを検出して修正する一連のコードインスペクションがあります。IDE はさまざまな問題を見つけてハイライトし、デッドコードを見つけ、可能性のあるバグを見つけ、スペルの問題、コード構造全体を改善することができます。

    インスペクションは、すべてのプロジェクトファイル内のコード、または特定のスコープ内のみ(たとえば、本番コード内、または変更されたファイル内)のコードをスキャンできます。

    すべてのインスペクションには、問題がコードに影響を与える可能性がある程度の重大度レベルがあります。重大度はエディター内で異なる方法でハイライトされるため、重大な問題と重要性の低いものとをすばやく区別できます。DataGrip には事前定義された重大度のセットが付属しており、独自のものを作成できます。

    インスペクションのリストを表示するには、設定 Ctrl+Alt+S を開き、エディター | インスペクションにナビゲートします。それらの一部を無効にするか、他を有効にし、さらに各インスペクションの重大度を調整します。エラーと見なすか、単なる警告と見なすかを決定します。

    例:未使用のサブクエリアイテムインスペクションは、サブクエリ(フィールドなど)で未使用のアイテムを検出します。

    Unused subquery item

インテンションアクション

エディターで作業するときに、DataGrip はコードを分析し、コードを最適化する方法を検索し、潜在的な問題と実際の問題を検出します。

IDE がコードを変更する方法を見つけると、エディターの現在の行の横に黄色のバルブアイコンyellow bulb iconが表示されます。このアイコンをクリックすると、現在のコンテキストで使用可能なインテンションアクションを表示できます。インテンションアクションは、警告から最適化の提案まで、幅広い状況をカバーします。インテンションの完全なリストを表示し、設定 / 環境設定ダイアログ Ctrl+Alt+S カスタマイズできます

インテンションアクションのリストを表示するには、設定 Ctrl+Alt+S を開き、エディター | インテンションにナビゲートします。

  1. バルブのアイコンをクリックするか(または Alt+Enter を押してください)、提案のリストを開きます。

  2. リストからアクションを選択し、 Enter を押します。

    例:INSERT ステートメントでインテンションアクションを使用して、有効なフィールドタイプを持つテーブルを作成することができます。

    Inject a language with the intention action

関連ページ:

DataGrip をインストールする

DataGrip のユーザーインターフェースはデフォルトでは英語です。日本語化する場合は、言語パックのインストールを参照してください。DataGrip は、Windows、macOS、Linux オペレーティングシステムで一貫したエクスペリエンスを提供するクロスプラットフォーム IDE です。システ...

SQL ダイアレクト

このページでは、さまざまなスコープで使用される SQL ダイアレクト(SQL の DBMS 固有のバージョン)を指定できます。ファイル、プロジェクト、グローバルは、単一のファイル、プロジェクトにアタッチされた SQL ファイルを含むフォルダー、または IDE で開かれるすべての SQL ファイルのス...

ユーザーファイル

マシンまたはアクセス可能な他の場所からファイルを操作するには、ファイルツールウィンドウに必要なディレクトリをアタッチします。ディレクトリを管理する :SQL ファイルを含むディレクトリを添付するをクリックします。ファイルツールウィンドウで、任意の領域を右クリックし、ディレクトリをプロジェクトに接続す...

サービスツールウィンドウ

サービスツールウィンドウでは、データベースと Docker サービスを使用できます。Docker を使用するには、Docker プラグインをインストールします。Docker の詳細については、Dockerを参照してください。サービスツールウィンドウでは、Docker コンテナーとイメージ(1)、デー...

データベース接続

データベースにクエリを発行するには、データソース接続を作成する必要があります。データソースはデータの場所であり、サーバーまたは DDL ファイルにすることができます。データソースには、データソースの種類に依存する名前と接続設定が含まれます。DataGrip では、これらの接続をデータソースおよびドラ...

データベースの接続の構成

データベース接続を作成すると、DataGrip は自動的にデータベースに接続してデータベースオブジェクトを受信します。その後、接続が閉じます。データベースと相互作用するデータソースの名前は、データベースツールウィンドウに小さな緑色の円で表示されます。データベース接続を閉じる場合は、データソースを選択...