LoginSignup
3
2

More than 1 year has passed since last update.

@nishikyon(Kyoko Nishito)

VS CodeでDb2 Connect Extensionを使ってみる

Last updated at Posted at 2021-04-07

「Db2 on Cloudを使ってみる」シリーズ

Db2 Connect for Visual Studio CodeはVS Code上でDb2に接続してSQL実行などのDB操作ができるExtensionです。もちろんDb2 on Cloudでも使用可能です。

ただ最近気がついたのですが、日本語が全く表示できません。Issueあげました。
とりあえずデータが英数字系の場合のみ今はお使いください。
2022/03/08追記: v2.3.0で確認したところ使用できるようになっていました!

Extentsionの説明には以下のように書かれています:

  • IBMデータベース・サーバーへの接続。
  • 各接続のツリービューで、すべてのデータベースオブジェクトを表示。
  • 接続プロファイルの作成と管理。
  • DDL および DML 操作を行う SQL文を記述し、 .sql、.spsql、.udfsql、.db2、.spdb2、.udfdb2 として保存。
  • SQLステートメントを実行し、結果をシンプルなグリッドで表示。
  • SQLファイルを実行。
  • 結果セットを JSON、CSV、XML 形式でエクスポート。
  • 単一または複数のSQL実行およびファイル実行のためのキーボードショートカット、エディタ・オプション。
  • テーブル、ビュー、エイリアス、ストアドプロシージャ、関数、トリガー、インデックスを作成するためのテンプレート。
  • 構文の強調表示。
  • コードスニペットのサポート。
  • Db2 Connect ExplorerからDb2 for iおよびDb2 for z/OSのライセンスのインストール。

当記事はDb2 Connect Extensionの導入と使い方を説明します。
尚、英語のでの使い方ガイドはこちらにあります(こっちの方が詳しく書いてあります)。

(2022/03/08更新)

0: 前提

前提は Visual Studio Codeが導入済みであることです。
未導入の方はこちらからダウンロードして導入してください。

1: Db2Connect Extensionの導入

特に他のExtensionの導入方法と違いはありません。
サイドバーからExtensionsのアイコンをクリックして、検索フィールドにDb2Connectと入力しします。
Db2 Connectが検索フィールドの下に表示されますので、クリックします。

image.png

クリックすると右側にDb2 Connectの説明が表示されますので、Installをクリックして導入します。
image.png

2. 使い方

早速つかってみましょう!

2.1 DB2 CONNECTメニューを出す

まずはサイドバーに出現したミツバチアイコンをクリックします。ちなみにこのミツバチマークはIBMのBeeなのです。

image.png

DB2 CONNECTメニューが表示されます。

Db2　Extensionの説明は必要なければ[X]をクリックして閉じで問題ありません。

2.2 Connection Profileの作成

Connection Profileの作成は必須ではありませんが、毎回入力するのも面倒なので、あらかじめ作成しておきます。

左から2番目の人の形(?)の丸のアイコンをクリックします。
image.png

Create Connection Profileをクリックします。
image.png

するとDB接続方法を入力する画面が表示されます。

Db2接続情報を入力します。見えてない部分は上にスクロールして表示させてください。
(Db2 on Cloudの接続情報の取得方法はこちら)

  • Profile Name: DB接続を識別できる任意の名前
  • Database: データペース名
  • Hostname: ホスト名
  • Port: ボート番号
  • Userid: ユーザーID
  • Password: パスワード
  • Enable SSL Security: SSL接続の場合はチェックを入れる
  • Enter Full Path Of SSL Server Certificate: 必要な場合はSSLサーバーのCertificateのFull Pathを記入(Db2 on Cloud + MacではブランクでもでOKでした）

（2021/07/13: SSL接続のオプション設定ができたようです）

image.png
image.png

入力が完了したら 「Save　& Close」をクリックしてConnection Profileを保存します。
複数接続先を登録したい場合は、同じ手順を繰り返してください。

2.3 DBへの接続

DB2 CONNECTメニュー、左から1番目の「+」のアイコンをクリックします。
image.png

Option 3をクリックします。
image.png

ちなみに、Option 1は接続パラメーターを一行で入力欄に記入する方式、Option 2は接続パラメーターを記入するフォームが表示されるのでそこに入力する方式となります。

作成したConnection Profileの名前が表示されますので、接続したいConnection Profileをクリックします。
image.png

接続が成功すると右下に「Successfully connected to database」と表示され、左側にConnection Profile名が表示されます。
image.png

接続がうまくいかない場合:　

接続設定を確認し修正しましょう。
左から2番目の人の形(?)の丸のアイコンをクリックします。
image.png

Edit Existing Database Connection Profileをクリックします。
image.png

Select Profileのドロップダウンをクリックして修正したい接続を選択します。
image.png

表示された接続設定を確認し、間違っていた場合は修正し、「Save & Close」をクリックして保存します。

##　2.4 ツリービューでの操作
左側のConnection Profile名の先頭の>をクリックすると、接続先のDB名が表示され、さらにDB名の先頭の>をクリックすると、DB内のスキーマが表示されます。
image.png

スキーマの先頭の>をクリックすると、スキーマ内のテーブルやビューなどデータベースオブジェクトの種類か表示されます。さらに>をクリックしていくことで、その詳細の内容、テーブルであればテーブル名や列名などを表示させていくことができます。
image.png

また各オブジェクトを選択した時、右側に表示される「＋」アイコンはクリックでそのオブジェクトの作成、「ゴミ箱」アイコンはクリックでそのオブジェクトの削除が可能です。
image.png

テーブル操作

ここでツリービューでのテーブル操作を説明します。
テーブル名を右クリックすると、メニューがでてきます。
image.png

  • Describe Table

表示に使用したSQLとテーブル定義が表示されます。
image.png

  • Select Top 1000

表示に使用したSQLと最初の1000行が表示されます。
表示に使用したSQLとimage.png

表示されたSQLの結果は右上のエクスポート(?)アイコンをクリックすると、ファイルのフォーマットが表示されるので、好きなフォーマットをクリックすると、そのフォーマットのデータの新規のタブが開きます。保存したい場合はこれをで保存します。
image.png

CSVを選択した例：
image.png

  • Select Top N
    こちらは最初のN行を表示できるSQLが表示されますので、Nの部分に表示したい行数を入れれば、指定した行数が表示されます。
    image.png

あとはSelect Top 1000と同じです。

2.5 SQLの実行

sqlを記入したファイルは、DB2 CONNECTメニュー、左から3番目のSQL(?)のアイコンをクリックし、ファイルを指定すると実行できます。
image.png

またVS Code上で記入したSQLも実行できます。
New File(Ctrl+n)で新しくファイルを開きます。
右下のPlan Textをクリックするとファイルタイプが指定できます。db2で検索して、使用するdb2のタイプを選びます。
image.png

SQLを入力します。ここでは3行入力しています。
image.png

入力したSQLを全部実行する場合は、エディタ画面で右クリックすると「Excute Current SQL File」というメニューが表示されますので、それをクリックします。
image.png

デリミター(行区切り)を聞くメッセージが表示されるので、デフォルトの;を使用していれば、そのままEnterキーを押します。別の文字を使用している場合は、入力してEnterキーを押します。実行を止める場合はEscキーを押してください。
image.png

しばらく待つと別タブで結果が表示されます。
image.png

入力したSQL一行または複数行を選択して実行したい場合は、実行したいSQL行を選択後、右クリックします。選択したSQLが（複数行に渡っても）1つのステートメントの場合は「Exceute Single SQL」、複数行の場合は「Exceute Multipul SQL」を選択して実行します。
image.png

「Exceute Multipul SQL」の場合は、デリミター(行区切り)を聞くメッセージが表示されるので、デフォルトの;を使用していれば、そのままEnterキーを押します。別の文字を使用している場合は、入力してEnterキーを押します。実行を止める場合はEscキーを押してください。
image.png

しばらく待つと別タブで結果が表示されます。
image.png

表示されたSQLの結果は右上のエクスポート(?)アイコンをクリックすると、ファイルのフォーマットが表示されるので、好きなフォーマットをクリックすると、そのフォーマットのデータの新規のタブが開きます。保存したい場合はこれをで保存します。
image.png
image.png

2.6 DB接続の切断

作業が終了したら DB接続を切断します。
右側に表示されているコネクションプロファイル名の右の「X」をクリックして切断します。

image.png

「Connection to Database terminated」とメッセージが表示されれば切断は完了です。
image.png

以上です。
その他にもいろいろ機能があるようなので、もっと知りたい方はVS Code extension for Db2 Connect(英語)で確認してみてください。

3
2
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
3
2