Stew - SQLクライアント

version 2.3


目次


Stewとは何ですか?

Stewは、JDBC接続を使ってデータベースにアクセスするツールです。Javaで書かれています。

2.0で変更された機能

2.0で主に変更された機能は以下のとおりです。

GUIモードで変更された機能は以下のとおりです。

また、ソースコードをすべて書き直しました。1.0との実装レベルでの互換性はほとんどありません。

使用上の注意

オンライン情報も確認してください。

パスワードの保存方式

パスワードは、デフォルトではそのまま保存します。生のパスワードを保存したくない場合は、暗号化を利用できます。

詳しくは、使い方-接続設定を参照してください。

コネクション切断時はrollbackしない

disconnectコマンドによりコネクションを切断するとき、rollbackを発行しません。DBMSによっては、トランザクションが自動的にコミットされてしまうことがありますので注意が必要です。

バージョン2.3より、「切断時に自動ロールバック」機能が利用可能になりました。

オンライン情報

Wikiにて追加説明を行っていますので、あわせてご利用ください。

http://argius.net/wiki/index.php?Stew%20tutorial


インストールするには

JRE(Java実行環境)1.4以上がインストールされている必要があります。(1.3で使いたい方は、古いバージョン(1.0)をお使い下さい。)

Stewを実行すると、".stew"ディレクトリが作成され、設定の保存に使用されます。".stew"ディレクトリは、デフォルトではHOMEディレクトリ(実装詳細:システムプロパティ"user.home"のパス)に作成されます。GUIの場合は、起動ディレクトリに作成されます。

UNIX系OSの場合

アーカイブを適当なディレクトリに展開します。ここでは"/opt/Stew"とします。

エイリアスを使う場合は、以下のコマンドを実行します。

alias stew="java -jar /opt/Stew/stew.jar"

エイリアスを使わない場合は、以下のスクリプトを記述したファイルを"stew"という名前でパスの通っているディレクトリに保存し、実行権限を与えてください。

#!/bin/sh
java -jar /opt/Stew/stew.jar $*

コマンドを実行してみましょう。"stew -v"でバージョン情報が表示されたらインストール完了です。

Windowsの場合

アーカイブを適当なディレクトリに展開します。ここでは"C:\Program Files\Stew"とします。

stew.exeを実行します。stew.exeを使用すると、自動的にGUIモードになります。

stew.exeを使用しない場合は、以下のコマンドを記述したファイルを"stew.bat"という名前でパスの通っているディレクトリに保存してください。("%*"はXP、2000、NTでしか使えないので注意。)

java -jar "C:\Program Files\Stew\stew.jar" %*

コマンドを実行してみましょう。"stew -v"でバージョン情報が表示されたらインストール完了です。

アンインストールするには

インストールで設定したもの全てと、".stew"ディレクトリを削除すればアンインストール完了です。


使い方

Stewを使用するには、JDBC接続が可能なデータベースと、JDBCドライバが必要です。JDBCドライバ自体の詳細については、各データベースの説明書などを参照してください。

接続設定

CUIの場合は、起動時に--editオプションを指定すると、編集プログラムが起動します。

GUIの場合は、メニューの"接続設定"を実行すると、編集ダイアログが開きます。

それぞれの設定項目の説明は次のとおりです。

コネクタID
connectコマンドなどに渡すIDです。英数字のみ指定できます。
コネクタ名
プロンプトに表示される接続名です。文字制限は特にありません。
クラスパス
JDBCドライバのクラスパスを指定します。Javaの-CLASSPATHオプションと同じ形式で指定します。
ドライバ
JDBCドライバのDriver実装クラスを指定します。GUIの場合、クラスパスが指定されていれば、"ドライバの検索"から選択できます。
接続先URL
JDBCのURL(DriverManager.getConnection(url)に指定するurlと同じもの)を指定します。
ユーザ
JDBCのURLと同時に指定するユーザIDを指定します。
パスワード
ユーザIDのパスワードを指定します。
暗号化処理
パスワードの保存方法を選択します。次項"パスワードの保存について"を参照してください。

これらの情報は、".stew/connectors.properties"に保存されます。手動で編集することもできますが、その際は注意して行ってください。

パスワードの保存について

パスワードは設定ファイルに保存されるため、そのまま保存すると都合が悪い場合があります。パスワードの保存方法は、暗号化処理を選択することができます。

PlainTextPassword
(デフォルト)パスワードをそのまま保存します。
PbePassword
PBE暗号を使用してパスワードを保存します。メニュー-暗号鍵設定で暗号鍵を設定した後、接続設定でパスワードを入力して保存すると、暗号化された状態で保存します。次回起動時、再度暗号鍵を設定しなければ、パスワードが復号できなくなります。

独自のパスワード暗号化を追加することもできます。(実装詳細:Passwordインタフェースの実装クラスを追加します。)

対話モード

通常の起動では、対話モードでの操作となります。

対話モードでは、コマンド入力待ち状態になった時にコマンドを入力し、処理が終わると再びコマンド入力待ちになります。

FTPコマンドのようなプログラムの操作に似ているかもしれません。

一行完結モード(One-Liner)

Stewの処理が一行の入力で完結します。"stew"コマンドを設定していると仮定すると、次のような形式で実行します。

$ stew <connector-id> <command>

実行すると、<connector-id>の接続設定で接続を開始し、その接続を使用してコマンドを実行します。コマンド実行後、接続を切断して終了します。

このモードでは、ご利用のshell環境の制約(例えば、ワイルドカード,リダイレクト など)を受けますのでご注意ください。


コマンド(Stew内部コマンド)

組み込みコマンドは、Stewから切り離すことができないコマンドです。(実装詳細:Commandクラスのサブクラスではなく、Command.invokeメソッドに直接書かれている処理です。)

それ以外は、追加コマンドとして実装されています。(実装詳細:Commandクラスのサブクラスによる処理です。)

connect - データベースに接続する (組み込みコマンド)

> connect <connector-id>

> -c <connector-id>

予め用意した接続設定を使用して、データベースに接続します。対話モードでは、disconnectまたは強制的に切断されるまで、接続が維持されます。

すでに接続中の場合は、その接続を切断してから接続を行います。

disconnect - データベースとの接続を切断する (組み込みコマンド)

> disconnect

> -d

データベースとの接続を切断します。

commit - トランザクションのコミット (組み込みコマンド)

現在のトランザクションでの変更をコミットします。

コミットする際は、誤って必要なデータを削除しないよう注意してください。

rollback - トランザクションのロールバック (組み込みコマンド)

現在のトランザクションでの変更をロールバックします。

exit -終了 (組み込みコマンド)

> exit

Stewを終了します。確認待ちは行いません。

select - SELECT文の実行

> <SQL-SELECT-STATEMENT>

update - UPDATE文の実行

> <SQL-UPDATE-STATEMENT>

insert - INSERT文の実行

> <SQL-INSERT-STATEMENT>

delete - DELETE文の実行

> <SQL-DELETE-STATEMENT>

count - 件数のみ表示

> count <テーブル名> [<WHERE句>]

指定したテーブルの件数を表示します。(実装詳細:このコマンドは SELECT COUNT(*) FROM <table-name> [<where-phrase>] と同じSQLを発行しますが、件数のみ表示します。)

> count test
12575 件 ヒットしました。
>

load - ファイルから実行

> load [<SQLファイル> | <データファイル> <テーブル名> [ HEADER ]]

指定されたファイルを読み込んで、SQLを実行します。

パラメータが1個の場合は、ファイルをSQL文と見なして実行します。

パラメータが2個以上の場合は、ファイルをデータファイルと見なして、インポートを実行します。ファイルの拡張子によって、ファイル形式が自動的に選択されます。

import - ファイルのインポート

> import [<データファイル> <テーブル名> [ HEADER ]]

ファイルをデータファイルと見なして、インポートを実行します。ファイルの拡張子によって、ファイル形式が自動的に選択されます。

(実装詳細:基本的には、loadのパラメータ2個以上指定した時と同じ動作ですが、Statement.addBatch()を使用します。)

export - 検索結果のエクスポート

> export <ファイル> [ HEADER ] [command(select|find|report)]

指定したファイルに、コマンドの検索結果を出力します。ファイルの拡張子によって、ファイル形式が自動的に選択されます。

time - 実行時間計測

> time [<回数>] <SQL文>

指定したSQL文を実行し、その実行時間を計測して表示します。回数が指定された場合は、回数分SQLを繰り返し実行して、「合計」「平均」「最大」「最小」を集計します。回数を指定しない場合は、1回の実行時間を表示します。

> time select * from test
  実行時間 : 0.050 秒
> time 100 select * from test
  合計 : 1.870 秒
  平均 : 0.018 秒
  最大 : 0.160 秒
  最小 : 0.000 秒
>

find - テーブル名検索

> find <テーブル名パターン> [<テーブル種別パターン> [<スキーマ名パターン> [<カタログ名パターン> [ FULL ]]]]

参照可能なテーブルの一覧を表示します。"パターン"というキーワードを含むパラメータは、ワイルドカード(*,?)が指定できます。

report - データベース情報表示

> report - | <テーブル名> [ PK | INDEX ]

接続中のコネクションに関する情報を表示します。

bind - バインド変数によるSQLの実行

> bind <SQL文>:<値のカンマ区切りリスト>

バインド変数を指定してSQLを実行します。(実装詳細:java.sql.PreparedStatementによる実行。)

":"以降のパラメータは、空白をパラメータと見なすので注意してください。

GUIモード・メニュー

GUIモードのメニューについての説明です。

ファイル(F) - 新しいウィンドウ(N) Ctrl-N

新しいウィンドウを開きます。新しいウィンドウは、元のウィンドウとは独立した接続で処理が行われます。

ファイル(F) - 閉じる(C) Ctrl-W

ウィンドウを閉じます。コネクションが接続中の場合は、確認ダイアログを表示します。

開いているウィンドウが1つの場合は、終了(X)と同じ動作となります。

ファイル(F) - ディレクトリ変更(D) Ctrl-D

現在の作業ディレクトリを変更します。この処理は、ファイルの読み込みや書き込みを行うコマンドに影響します。

ファイル(F) - エクスポート(E)

検索結果をファイルに出力します。exportコマンドとは独立した処理です。検索結果が表示されている場合のみ有効です。

ファイル(F) - 終了(X) Ctrl-Q

アプリケーションを終了します。確認ダイアログが表示され、"はい"を選択すると終了します。

編集(E) - 切り取り(T) Ctrl-X

選択範囲をクリップボードにコピーして、選択された部分を削除します。(基本的に、一般的なアプリケーションと同じ処理です。)

編集(E) - コピー(C) Ctrl + C

選択範囲をクリップボードにコピーします。(基本的に、一般的なアプリケーションと同じ処理です。)

編集(E) - 貼り付け(P) Ctrl-V

カーソル位置にクリップボードの内容を貼り付けます。(基本的に、一般的なアプリケーションと同じ処理です。)

編集(E) - すべて選択(A) Ctrl-A

選択している領域(テーブルまたは入出力欄)を全選択状態にします。

編集(E) - 入力欄に移動(G) Ctrl + G

コマンドを入力できるようにするため、入出力欄の末尾にカーソルを移動します。

編集(E) - メッセージのクリア

入出力欄のメッセージをクリアします。

表示(V) - ステータス バー(B)

選択された場合、ウィンドウの下部にステータスバーを表示します。

設定は保存されます。

表示(V) - 列番号を表示(C)

選択された場合、検索結果の列名に番号を付けます。

設定は保存されません。

表示(V) - 列幅を拡大(W) Ctrl + "."

検索結果の列幅をそれぞれ1.5倍に拡大します。

表示(V) - 列幅を縮小(N) Ctrl + ","

検索結果の列幅をそれぞれ2/3に縮小します。

表示(V) - 列幅を調整(A) Ctrl+/

検索結果の列幅を自動調整します。次項の「列幅自動調整」で選択されたモードで調整されます。

表示(V) - 列幅自動調整(M)

検索結果表示時に、検索結果の列幅を自動調整するモードを選択します。

設定は保存されます。

表示(V) - 最新状態に更新(R) F5

検索結果を表示した際のクエリを再発行して、最新状態を表示します。

表示(V) - 最大表示件数の設定(L)

検索結果欄に表示する件数の最大値を設定します。

設定は保存されます。

表示(V) - フォント(F) Ctrl + ";"

フォント変更ダイアログを表示します。

設定すると、検索結果欄とメッセージ欄のフォントが変更されます。

接続(C) - 接続の実行(C) Ctrl + " "(space)

接続リストを表示します。接続リストで接続したい接続IDを選択して"了解"を押すと、connectと同じ処理が実行されます。

接続(C) - 切断(D)

接続を切断します。disconnectコマンドと同じです。

接続(C) - 暗号鍵設定(K)

接続設定のパスワード暗号化に使用される秘密鍵を設定します。

接続(C) - 接続設定(E)

接続設定ダイアログを表示します。

コマンド(M) - 実行(X) (shortcut : Ctrl + "M")

コマンドを実行します。入出力欄でエンターキーを押したのと同じ効果があります。

コマンド(M) - 前の履歴(P) (shortcut : Ctrl + "K")

コマンド履歴を1つ遡ります。

コマンド(M) - 次の履歴(N) (shortcut : Ctrl + "J")

コマンド履歴を1つ進みます。

ヘルプ(H) - ヘルプを表示(H)

ヘルプを表示します。(実装詳細:カレントディレクトリにMANUAL_jaファイルが必要です。)

ヘルプ(H) - Stew について(A)

バージョン情報ダイアログを表示します。

GUIモード・その他

結果テーブル

検索コマンドを実行したときに、結果を表示します。最左列は行番号が表示されます。列幅自動調整が設定されていれば、列幅が自動的に調整されます。

セルを編集すると、テーブルに反映(UPDATE)されます。

行番号が"*"になっている行は保留行です。保留行については、コンテキストメニューを参照。

入出力欄

コマンドの入力とメッセージの出力が同居する、コマンドラインのようなインターフェイスです。

エンターキーを押すと、プロンプトから末尾までがコマンドとして解釈され実行されます。カーソルが末尾にない場合は、カーソルが末尾に移動します。プロンプトより前の部分は編集不可となっています。

ステータスバー

直前のコマンドとその実行時間が表示されます。実行時間は、timeコマンドとは異なり、コマンドの開始から終了までの所要時間となります。

コンテキストメニュー

マウスの右クリックにより、そのコントロールに即した機能のメニューが表示されます。表示されるメニュー内容は、入力部分ごとに異なります。

主なメニューは以下のとおりです。

この列をソート(S)
クリックした列(選択されている列では無く)をソートします。同じ列を続けてソートすると、逆順でソートします。
選択したセルの値をコピー(C)
選択しているセルを、タブ区切りテキスト形式でクリップボードに送ります。タブ文字や改行文字をエスケープしません。
選択したセルをエスケープ付でコピー(E)
選択しているセルを、エスケープ付のタブ区切りテキスト形式でクリップボードに送ります。値に改行文字が含まれている場合でも、直接スプレッドシートなどに貼り付けることができます。
列名をコピー(Y)
現在表示しているヘッダの値を、タブ区切りテキスト形式でクリップボードに送ります。(2.3で追加)
選択したセルに値を貼り付け(P)
選択したセルに、クリップボードのデータを貼り付け(UPDATE)ます。選択範囲外のデータは無視されます。データより選択範囲が大きい場合でも、貼り付けは繰返ししません。
選択したセルにNullを設定(V)
データ型にかかわらず、選択したセルにNullを設定(UPDATE)します。
行を新規追加(N)
表の最後に新しい行を追加します。この時点では、テーブルへの反映は行われません(保留行)。値を入力した後で「挿入を確定」を実行すると、テーブルへ反映されます。
選択行をコピー挿入(I)
表の最後に選択した行のコピーを追加します。この時点では、テーブルへの反映は行われません(保留行)。値を入力した後で「挿入を確定」を実行すると、テーブルへ反映されます。
クリップボードデータを挿入(O)
クリップボードのタブ区切りテキストを、テーブルに連続して挿入(INSERT)します。エラーの場合は、保留行となります。中断は強制終了以外できませんので注意。
挿入を確定(F)
保留行をテーブルへ反映(INSERT)します。
選択行を削除(D)
選択行を削除(DELETE)します。複数行を選択していても実行できます。保留行の場合はDELETEは行いません。

※COMMIT,ROLLBACKは手動です。

設定保存

以下の設定が、ウィンドウを閉じたとき(終了したときではない)に保存され、次回以降のウィンドウの設定として使用されます。

プロパティ

起動時に値を決定できるパラメータです。Javaのシステムプロパティ(Javaの-Dオプション)で指定するか、stew.propertiesファイルに記述します。

"設定値"は、設定する値についての説明です。設定値のカッコ内の値は既定値です。カッコがないものは既定値がありません。

net.argius.stew.properties - プロパティファイルの場所

設定値:ファイルまたはディレクトリのパス

stew.propertiesファイルを優先的に検索する場所を指定します。

指定されたパスがファイルの場合は、そのファイルをstew.propertiesの代わりにプロパティファイルとして読み込みます。指定されたパスがディレクトリの場合は、そこにstew.propertiesがあるものとみなされます。

指定されない場合は、クラスパス、システムディレクトリの順に検索されます。無い場合はプロパティファイルが無いものとみなされます。

net.argius.stew.directory - 作業ディレクトリ

設定値:ディレクトリパス(カレントディレクトリ)

コマンドで使用するディレクトリの開始時のパスを指定します。デフォルトシステムディレクトリとは異なります。

net.argius.stew.Launcher.class - Launcherの指定

設定値:完全修飾クラス名(net.argius.stew.StandardInputLauncher)

Launcherは、アプリケーションの起動、入力、コマンド実行、出力の管理を行う機能です。ここではそのクラス(実装詳細:net.argius.stew.Launcherインタフェースを実装している必要があります。)を指定します。デフォルトは、標準入出力Launcherです。

net.argius.stew.OutputProcessor.class - OutputProcessor

設定値:完全修飾クラス名(net.argius.stew.StandardOutputProcessor)

OutputProcessorは、出力制御を行う機能です。ここではそのクラス(実装詳細:net.argius.stew.OutputProcessorインタフェースを実装している必要があります)を指定します。デフォルトは、標準出力制御です。

net.argius.stew.query.timeout - クエリのタイムアウト値

設定値:整数秒(0)

コマンド内のクエリが発行時に設定するタイムアウト値を指定します。0以下はタイムアウト未指定とみなされます。

(実装詳細:java.sql.Statement#setQueryTimeoutに設定する値。)

net.argius.stew.gui.ResultSetTableMonitor.timeout - ResultSetTableMonitorのタイムアウト値

設定値:整数秒(10)

GUIの結果テーブルを編集した際に、バックグラウンドで発行されるクエリが使用するタイムアウト値です。

Logger用

デバッグ用のLoggerに関するプロパティです。プロパティファイルに直接は指定できません(-Dオプションで指定可能)。

標準のLoggingAPI(java.util.logging)を使用したい場合は、以下のシステムプロパティを設定してください。LoggingAPI自体の設定は、APIドキュメントを参照してください。

-Dnet.argius.logging=true
-Dnet.argius.logging.class=net.argius.logging.LoggingApiWrapper

2009 argius