From f3955c862668b35caa25e4d39541951404a7c902 Mon Sep 17 00:00:00 2001 From: argius Date: Sat, 18 Jan 2014 15:14:49 +0900 Subject: [PATCH] Update documents --- FEATURE.md | 25 ++++++++++++++++++++++++- FEATURE_ja.md | 24 ++++++++++++++++++++++++ MANUAL.html | 27 ++++++++++++++++++++++----- MANUAL.md | 28 ++++++++++++++++------------ README_ja.md | 7 +++---- 5 files changed, 89 insertions(+), 22 deletions(-) diff --git a/FEATURE.md b/FEATURE.md index 620857f..e5b688b 100644 --- a/FEATURE.md +++ b/FEATURE.md @@ -3,11 +3,15 @@ ## New Features +The new features in version 4.1 are nothing. + + The new features in version 4 are listed below: Special command "-s" - Executing file as script -: Execute a file as script (JavaScript). +: Execute a file as script. This feature can be used instead of a command class. + (On version 4.0, only JavaScript was supported.) Special command "?" - display environment info (not OS ENV) : Display System Properties. (System.getProperty) @@ -24,6 +28,25 @@ For more details, see MANUAL.html file. ## Changes +The major changes on version 4.1 are listed below: + +Enhance Scripting support +: On version 4.0, the scripting feature (command "-s") was limited, + such as only JavaScript, only by file, and stateless. + On version 4.1, it has been improved as follows: + + * Any Script Language (as long as its Script Engine exists) + * Parameters As Script + * Script Context (global scope bindings) + + +Change the layout of Text Search Panel +: In version 3.0, the information tree had been added, but the search panel + still had been left below the console window. + In version 4.1, the search panel has been moved below the status bar + of the window. + + The major changes since version 3 are listed below: Requires Java6 and later diff --git a/FEATURE_ja.md b/FEATURE_ja.md index 9cc15b5..c7f2893 100644 --- a/FEATURE_ja.md +++ b/FEATURE_ja.md @@ -3,6 +3,9 @@ ## 新機能 +バージョン4.1で追加された新機能はありません。 + + バージョン4の主な新機能は以下のとおりです。 各機能の詳細については、マニュアル(MANUAL_ja.html)をご覧ください。 @@ -22,6 +25,27 @@ ## 変更点 +バージョン4.1での主な変更は以下のとおりです。 + +スクリプト機能の強化 +: バージョン4.0では、スクリプト機能（"-s"コマンド）は、 + JavaScriptのみ使用可能、ファイルからだけ実行可能、ステートレス + のように限定的でした。 + バージョン4.1で、スクリプト機能は次のように強化されました。 + + * どのスクリプト言語でも使える (スクリプトエンジンに対応していれば) + * パラメータをスクリプトとして使える + * Script Context の導入 (グローバルスコープバインディング) + + +検索パネルの位置を変更 +: バージョン3.0から、情報ツリーが追加され、そのツリー内も検索が + できるようになっているのにも関わらず、検索パネルの位置は + テキスト入力欄の下になっていました。 + バージョン4.1で、検索パネルをステータスバーの上に表示するように + 変更しました。 + + バージョン3から4への主な変更点は以下のとおりです。 Java6以降のみサポート diff --git a/MANUAL.html b/MANUAL.html index 8b4af46..e15a8a0 100644 --- a/MANUAL.html +++ b/MANUAL.html @@ -147,6 +147,7 @@

In CUI mode, to start edit tool, specifies --edit option.

# command line
 $ stew --edit
+
 # running stew
 > --edit

In GUI mode, executes "Edit Connectors" to start edit dialog.

@@ -281,14 +282,30 @@ alias search=[select * from]

load - Executes file content as SQL

> load [<SQL-file> | <data-file> <table-name> [ HEADER ]]

This command executes the SQL read from specified file.

-

When If a parameter is specified, executes file content as SQL, otherwise, two or more parameters, imports the file as data file. The file format is automatically selected by file extension. *. .csv : CSV format *. .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd) *. otherwise: TSV format

+

When If a parameter is specified, executes file content as SQL, otherwise, two or more parameters, imports the file as data file. The file format is automatically selected by file extension.

+

(implementation detail: this is basically same as import command, executes as not batch but executes by record)

import - Imports from file

import <data-file> <table-name> [ HEADER ]
-

This command imports from file as data file. The file format is automatically selected by file extension. *. .csv : CSV format *. .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd) *. otherwise: TSV format

+

This command imports from file as data file. The file format is automatically selected by file extension.

+

(implementation detail: this is basically same as load command, but uses Statement#addBatch.)

export - Exports to file

-

This command exports result of command to the specified file. The file format is automatically selected by file extension. *. .htm,html : HTML format *. .csv : CSV format *. .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd) *. others: TSV format

+

This command exports result of command to the specified file. The file format is automatically selected by file extension.

+

time - Measures time to execute SQL

> time [<count>] <SQL>

This command executes specified SQL and measures its execution time.

@@ -337,8 +354,8 @@ Selected 42 records. 
> upload <file> <SQL(UPDATE|INSERT)>

This command registers a data file to the column that specified by place-holder.

wait - Waits for specified interval

-
> wait seconds()
-

This command waits for the interval that specified number of seconds. It may be useful for executing multiple commands.

+
> wait seconds
+

This command waits for the interval that specified number (mixed decimal) of seconds. It may be useful for executing multiple commands.

The GUI Mode

Common Behaviors

Standard commands, "undo", "redo", "cut", "copy", "paste", and "select all", can use in all text components via context menu or shortcut key.

diff --git a/MANUAL.md b/MANUAL.md index c598eaf..d58d3f1 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -76,6 +76,7 @@ In CUI mode, to start edit tool, specifies --edit option. # command line $ stew --edit + # running stew > --edit @@ -295,9 +296,10 @@ This command executes the SQL read from specified file. When If a parameter is specified, executes file content as SQL, otherwise, two or more parameters, imports the file as data file. The file format is automatically selected by file extension. - *. .csv : CSV format - *. .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd) - *. otherwise: TSV format + + * .csv : CSV format + * .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd) + * otherwise: TSV format (implementation detail: this is basically same as import command, executes as not batch but executes by record) @@ -309,9 +311,10 @@ The file format is automatically selected by file extension. This command imports from file as data file. The file format is automatically selected by file extension. - *. .csv : CSV format - *. .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd) - *. otherwise: TSV format + + * .csv : CSV format + * .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd) + * otherwise: TSV format (implementation detail: this is basically same as load command, but uses Statement#addBatch.) @@ -321,10 +324,11 @@ The file format is automatically selected by file extension. This command exports result of command to the specified file. The file format is automatically selected by file extension. - *. .htm,html : HTML format - *. .csv : CSV format - *. .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd) - *. others: TSV format + + * .htm,html : HTML format + * .csv : CSV format + * .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd) + * others: TSV format ### time - Measures time to execute SQL @@ -417,9 +421,9 @@ This command registers a data file to the column that specified by place-holder. ### wait - Waits for specified interval - > wait seconds() + > wait seconds -This command waits for the interval that specified number of seconds. +This command waits for the interval that specified number (mixed decimal) of seconds. It may be useful for executing multiple commands. diff --git a/README_ja.md b/README_ja.md index 4b97f3e..c3f350b 100644 --- a/README_ja.md +++ b/README_ja.md @@ -32,12 +32,11 @@ Stewは、JDBCを使ったSQLツール環境です。 インストール リリースパッケージのZIPファイルを適当なディレクトリに展開するだけです。 - 最小限にしたい場合は本体JARファイル(stew.jar)と起動スクリプト(stew.bat or stew.sh)です。 - 起動スクリプトも自前で用意していただくのであれば不要です。 + 最小限にしたい場合は本体JARファイル(stew.jar)だけ取り出してください。 バージョンアップ インストールしたファイルの最新版を上書きしてください。 - "connector.properties"はバージョン2以降は互換性がありますので、 + 接続設定ファイル"connector.properties"はバージョン2以降は互換性がありますので、 移行の際はそのままお使いいただけます。 アンインストール @@ -53,6 +52,6 @@ Apache License 2.0 を採用しています。 ## 4. 既知の問題 -更新権限のチェックは、更新権限の参照権限が無いと正しく判定できないという問題があります。 +更新権限のチェックは、権限設定自体の参照権限が無いと正しく判定できないという問題があります。 Look＆Feelの実装によっては上手く動作しない機能があるかもしれません。 -- 2.11.0