CLI コマンド：manage。

管理 コマンドは、アクションのリストを含む JSON 入力を受け入れ、順番に実行し、結果を含む JSON 配列を出力します。これはデータソースの作成、変更、削除、およびドライバーアーティファクトの管理に使われる主要なコマンドです。

構文: datagrip.exe dataSources manage -p <project_path> -i <input_path> -o <output_path>
サンプル: datagrip.exe dataSources manage -p C:\my_projects\cli_for_data_sources\ -i C:\data_source_jsons\input.json -o C:\data_source_jsons\output.json

構文: datagrip dataSources manage -p <project_path> -i <input_path> -o <output_path>
サンプル: datagrip dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/input.json -o ~/data_source_jsons/output.json

構文: datagrip.sh dataSources manage -p <project_path> -i <input_path> -o <output_path>
サンプル: datagrip.sh ataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/input.json -o ~/data_source_jsons/output.json

オプション

-p、--project

プロジェクトディレクトリへのパス。

必須：はい

-i、--input

入力ファイルパス。省略した場合、DataGrip は stdin から読み込みます。

必須：いいえ

-o、--output

出力ファイルパス。省略した場合、DataGrip は標準出力に書き込みます。

必須：いいえ

--input-schema

入力 JSON の検証に使用できる JSON スキーマを返します。

必須：いいえ

--output-schema

出力 JSON の検証に使用できる JSON スキーマを返します。

必須：いいえ

--input-schema および --input-schema オプションはデータソースを管理しないため、これらと一緒に使用した場合、 -p、 -i、 -o は無視されます。

入力形式

                {
                    "actions": [
                        { "actionName": { <parameters> } },
                        { "actionName": { <parameters> } }
                    ]
                }
            
  

actions 配列では、各要素はアクション名をキーとする 1 つのキーのみを持つ JSON オブジェクトです。このキーの値はアクションパラメーターのオブジェクトです。

出力形式

管理 コマンドの出力形式は、各要素が入力のアクションに対応する JSON 配列です。出力・入力では、要素とアクションが同じ順序で並びます。

                [
                    { "action": "actionName", "result": { <result_fields> } },
                    { "action": "actionName", "error": "<error_message>" }
                ]
            
  

成功した場合、エントリにはアクション固有の結果データを含む "result" が含まれます。失敗した場合、エントリにはエラーメッセージを含む "error" が含まれます。

サポートされているアクションの一覧については、アクションを参照してください。

共通タイプ

DataSourceFilter

DataGrip はこのフィルターを使用してデータソースを一致させます。データソースを一致させるには、指定されたすべてのフィールドが一致している必要があります。すべてのフィールドが null の場合、フィルターは何も一致しません。

フィールドにはデータソースに関する情報が含まれます：

id: 一意の識別子。
name: 表示名。
dbmsName: DBMS 名。例： "POSTGRES"、 "MYSQL" 、または "ORACLE"。大・小文字を区別します。

UpdatedDataSourceInfo

作成または変更の操作後に返されます。

フィールドにはデータソースに関する情報が含まれます：

id: 一意の識別子。
name: 表示名。
URL: JDBC URL。

アクション

createDataSource

プロジェクト内に新しいデータソースを作成します。

パラメーター

name

新しいデータソースの表示名。

driverId

明示的なドライバー ID。指定された場合、 dbmsName パラメーターは無視されます。

dbmsName

自動ドライバー検索で使用される DBMS 名。例： "POSTGRES"、 "MYSQL"。

URL

JDBC URL。

URL または connectionParams のいずれかを指定する必要があります。

connectionParams

ドライバーの URL テンプレートを使用して URL を作成する際に使われるキーと値の接続パラメーター。

ドライバーは driverId および dbmsName フィールドを使って解決されます。 driverId が指定された場合、 dbmsName は無視され、指定された ID でドライバーが検索されます。それ以外の場合は、 dbmsName または URL を登録済みのドライバーに対して照合してドライバーが解決されます。

URL は URL および connectionParams フィールドを使って解決されます。 URL が指定された場合は、そのまま使用されます。 connectionParams が指定され URL が指定されていない場合は、解決済みドライバーの URL テンプレートと指定されたパラメーターから URL が構築されます。いずれのパラメーターも指定されていない場合は、エラーが返されます。

このコマンドの結果は、次のような JSON 出力になります：

                {
                    "createdDataSource": {
                        "id": "<generated_unique_id>",
                        "name": "My PostgreSQL",
                        "url": "jdbc:postgresql://localhost:5432/mydb"
                    }
                }
                
    

サンプル

入力 JSON ファイル action_create_in.json ：
{ "actions": [ { "createDataSource": { "name": "My PostgreSQL", "dbmsName": "POSTGRES", "url": "jdbc:postgresql://localhost:5432/mydb" } } ] }
CLI コマンド：
datagrip.exe dataSources manage -p C:\my_projects\cli_for_data_sources\ -i C:\data_source_jsons\action_create_in.json -o C:\data_source_jsons\action_create_out.json
datagrip dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/action_create_in.json -o ~/data_source_jsons/action_create_out.json
datagrip.sh dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/action_create_in.json -o ~/data_source_jsons/action_create_out.json
出力 JSON ファイル action_create_out.json ：
[ { "action": "createDataSource", "result": { "createdDataSource": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "My PostgreSQL", "url": "jdbc:postgresql://localhost:5432/mydb" } } } ]

deleteDataSource

指定されたフィルターに一致するデータソースを削除します。各フィルターは個別に評価されます。いずれかのフィルターに一致したデータソースは削除されます。

パラメーター

フィルター: フィルターの一覧。いずれかの指定されたフィルターに一致するデータソースは削除されます。

サンプル

入力 JSON ファイル action_delete_in.json ：
{ "actions": [ { "deleteDataSource": { "filters": [ { "name": "Old Database" }, { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } ] } } ] }
CLI コマンド：
datagrip.exe dataSources manage -p C:\my_projects\cli_for_data_sources\ -i C:\data_source_jsons\action_delete_in.json -o C:\data_source_jsons\action_delete_out.json
datagrip dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/action_delete_in.json -o ~/data_source_jsons/action_delete_out.json
datagrip.sh dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/action_delete_in.json -o ~/data_source_jsons/action_delete_out.json
出力 JSON ファイル action_delete_out.json ：
[ { "action": "deleteDataSource", "result": { "deletedIds": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "b2c3d4e5-f6a7-8901-bcde-f12345678901" ] } } ]

modifyDataSource

パラメーター

modifyDataSource は既存のデータソースを変更します。フィルター条件は正確に 1 件のデータソースに一致する必要があります。どのデータソースにも一致しない、または複数一致する場合、エラーが返されます。

これらのフィールドのうち少なくとも 1 つを指定する必要があります： name、 URL、 driverId 、または connectionParams。

filter

データソースを特定するためのフィルター。条件は正確に 1 件のデータソースに一致する必要があります。

name

新しい表示名。

driverId

新しいドライバー ID。データソースに関連付けられているドライバーを変更します。

URL

新しい JDBC URL。

connectionParams

キーと値の接続パラメーター。これらのパラメーターは、現在のドライバーの URL テンプレートを使って新しい URL をビルドするのに役立ちます。

URL フィールドが指定されている場合、このフィールドは無視されます。も同時に指定された場合。

URL は URL または connectionParams フィールドを使って更新されます。 URL フィールドが指定されている場合は直ちに使用されます。 connectionParams だけが指定されている場合は、現在のドライバーの URL テンプレートを使ってパラメーターから新しい URL を作成します。 driverId も指定されている場合は、最初にドライバーが更新され、その後で connectionParams が新しいドライバーを使用します。

このコマンドの結果は、次のような JSON 出力になります：

                    {
                        "modifiedDataSource": {
                            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                            "name": "<updated_data_source_name>",
                            "url": "jdbc:postgresql://<new_host>:5432/mydb"
                        }
                    }
                
    

サンプル

入力 JSON ファイル action_modify_in.json ：
{ "actions": [ { "modifyDataSource": { "filter": { "name": "My PostgreSQL" }, "name": "Production PostgreSQL", "url": "jdbc:postgresql://prod-host:5432/mydb" } } ] }
CLI コマンド：
datagrip.exe dataSources manage -p C:\my_projects\cli_for_data_sources\ -i C:\data_source_jsons\action_modify_in.json -o C:\data_source_jsons\action_modify_out.json
datagrip dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/action_modify_in.json -o ~/data_source_jsons/action_modify_out.json
datagrip.sh dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/action_modify_in.json -o ~/data_source_jsons/action_modify_out.json
出力 JSON ファイル action_modify_out.json ：
[ { "action": "modifyDataSource", "result": { "modifiedDataSource": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Production PostgreSQL", "url": "jdbc:postgresql://prod-host:5432/mydb" } } } ]

updateArtifactList

リモートリポジトリから使用可能なデータベースアーティファクト（ドライバー）のリストを更新します。このアクションはパラメーターを取りません。通常はアーティファクトカタログを最新に保つために downloadArtifacts または setUpRecommendedArtifacts の前に呼び出してください。

パラメーター

なし空のオブジェクト {}。

このコマンドの結果は、次のような JSON 出力になります：

                    {
                        "status": "ok"
                    }
                
    

サンプル

入力 JSON ファイル action_updateArtifacts_in.json ：
{ "actions": [ { "updateArtifactList": {} } ] }
CLI コマンド：
datagrip.exe dataSources manage -p C:\my_projects\cli_for_data_sources\ -i C:\data_source_jsons\action_updateArtifacts_in.json -o C:\data_source_jsons\action_updateArtifacts_out.json
datagrip dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/action_updateArtifacts_in.json -o ~/data_source_jsons/action_updateArtifacts_out.json
datagrip.sh dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/action_updateArtifacts_in.json -o ~/data_source_jsons/action_updateArtifacts_out.json
出力 JSON ファイル action_updateArtifacts_out.json ：
[ { "action": "updateArtifactList", "result": { "status": "ok" } } ]

downloadArtifacts

指定したデータベースアーティファクト（例：JDBC ドライバー JAR）をアーティファクトトークンでダウンロードします。

パラメーター

artifactTokens

ダウンロードするアーティファクトトークンのリスト。

サポートされているアーティファクトトークンのフォーマットは次のとおりです：

<artifactId> ：最新の安定バージョンが解決されます。
<artifactId>:<version> ：特定のバージョンが解決されます。
<artifactId>:<channel> ：指定したチャンネル内の最新バージョンが解決されます。
<artifactId>:<version>/<channel> ：指定したチャンネル内の特定バージョンが解決されます。

このコマンドの結果は、次のような JSON 出力になります：

                {
                    "downloadedArtifacts": [
                        {
                            "artifactId": "com.mysql",
                            "version": "8.0.33",
                            "state": "Downloaded"
                        }
                    ]
                }
            
   

出力される JSON には、次のフィールドが含まれます：

artifactId: アーティファクト識別子。
version: ダウンロード済みバージョン。解決に失敗した場合、値は null です。
状態: 結果の状態： "Downloaded" または "Failed"。
error: エラーメッセージ。 状態 が "Failed" の場合のみ表示されます。

サンプル

入力 JSON ファイル action_downloadArtifacts_in.json ：
{ "actions": [ { "downloadArtifacts": { "artifactTokens": ["com.mysql:8.0.33", "org.postgresql"] } } ] }
CLI コマンド：
datagrip.exe dataSources manage -p C:\my_projects\cli_for_data_sources\ -i C:\data_source_jsons\action_downloadArtifacts_in.json -o C:\data_source_jsons\action_downloadArtifacts_out.json
datagrip dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/action_downloadArtifacts_in.json -o ~/data_source_jsons/action_downloadArtifacts_out.json
datagrip.sh dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/action_downloadArtifacts_in.json -o ~/data_source_jsons/action_downloadArtifacts_out.json
出力 JSON ファイル action_downloadArtifacts_out.json ：
[ { "action": "downloadArtifacts", "result": { "downloadedArtifacts": [ { "artifactId": "com.mysql", "version": "8.0.33", "state": "Downloaded" }, { "artifactId": "org.postgresql", "version": "42.7.1", "state": "Failed", "error": "Connection timeout" } ] } } ]

setUpRecommendedArtifacts

指定したデータベースドライバーの推奨（最新安定版）アーティファクトをダウンロードして設定します。初期ドライバーセットアップや、ドライバーを推奨バージョンに更新する際に便利です。

パラメーター

driverIds: セットアップするドライバー ID のリスト。

このコマンドの結果は、次のような JSON 出力になります：

                    {
                        "updatedDrivers": [
                            {
                                "id": "postgresql",
                                "name": "PostgreSQL",
                                "state": "Downloaded"
                            }
                        ]
                    }
                
    

出力される JSON には、次のフィールドが含まれます：

id

ドライバー ID。

name

ドライバー表示名。ドライバーが見つからなかった場合、値は null です。

状態

結果の状態：

"Downloaded" ：新しいアーティファクトがダウンロードされて設定されました。
"UpToDate" ：すでに推奨アーティファクトがドライバーに存在していました。
"Failed" ：操作に失敗しました。例えば、ドライバー ID が不明でした。

error

エラーメッセージ。 状態 が "Failed" の場合のみ表示されます。

サンプル

入力 JSON ファイル action_setupArtifacts_in.json ：
{ "actions": [ { "setUpRecommendedArtifacts": { "driverIds": ["postgresql", "mysql.8"] } } ] }
CLI コマンド：
datagrip.exe dataSources manage -p C:\my_projects\cli_for_data_sources\ -i C:\data_source_jsons\action_setupArtifacts_in.json -o C:\data_source_jsons\action_setupArtifacts_out.json
datagrip dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/action_setupArtifacts_in.json -o ~/data_source_jsons/action_setupArtifacts_out.json
datagrip.sh dataSources manage -p ~/my_projects/cli_for_data_sources/ -i ~/data_source_jsons/action_setupArtifacts_in.json -o ~/data_source_jsons/action_setupArtifacts_out.json
出力 JSON ファイル action_setupArtifacts_out.json ：
[ { "action": "setUpRecommendedArtifacts", "result": { "updatedDrivers": [ { "id": "postgresql", "name": "PostgreSQL", "state": "Downloaded" }, { "id": "mysql.8", "name": "MySQL 8", "state": "UpToDate" } ] } } ]

2026 年 7 月 14 日