データ抽出

データ抽出は、エディター ( テキストエディター表示モード) でデータをコピーまたは表示する方法のルールを設定します。データのエクスポートアイコン () の近くにあるデータ抽出リストからデフォルトのエクストラクターを選択したり、既存のエクストラクターを構成したり、Groovy または JavaScript を使用してカスタムエクストラクターを作成したりできます。

Data extractor list on the data editor toolbar

最後に選択したエクストラクターが、新しく開いたエディタータブのデフォルトのエクストラクターになります。MongoDB の場合、デフォルトのエクストラクターは常に JSON です。

次のビデオでは、CSV データエクストラクターを使用してデータがコピーされ、SQL の UPDATE およびパイプ分離データエクストラクターを使用してテキストエディタービューモードで表示されます。

データ抽出機能を使用すると、データベースデータを SQL 文としてさまざまな形式でエクスポートできます。ファイルにエクスポートすると、テーブルまたはビューごとに個別のファイルが作成されます。エクスポートの詳細については、「エクスポート」セクションを参照してください。

サポートされているファイル形式

使用可能なスクリプトとサポートされているファイル形式のリストは次のとおりです。

定義済みスクリプト。これらを使用して、INSERT または UPDATE ステートメント、TSV と CSV(英語) ファイル、エクセル XLSX(英語) ファイル、Markdown(英語)、HTML テーブル、JSON(英語) 形式のセットとしてデータをエクスポートします。

ビルトイン
スクリプト
ファイルフォーマット
SQL の INSERT
.sql
SQL の UPDATE
Where 句
CSV
スクリプト
ファイルフォーマット
CSV
.csv
TSV
.tsv
パイプ区切り
.txt
CSV 形式の設定を使用して、CSV または任意の DSV 形式に基づいた独自の形式を作成します。

スクリプト	ファイルフォーマット
SQL の INSERT	.sql
SQL の UPDATE
Where 句

スクリプト

スクリプト	ファイルフォーマット
CSV	.csv
TSV	.tsv
Excel	.xlsx , .xls
HTML (groovy)	.html
HTML (js)	.html
JSON	.json
Markdown	.md
One-row	.sql
SQL-Insert-Multirow
SQL-Insert-Statements
Pretty	.txt
XML	.xml

カスタムデータエクストラクター。Groovy または JavaScript と提供された API を使用して作成します。

区切り文字で区切られた値のエクストラクターを構成する

デフォルトの機能を拡張し、CSV または任意の DSV 形式に基づいて独自の形式を作成できます。設定では、行とヘッダーの区切り文字を設定したり、NULL 値のテキストを定義したり、引用符を指定したり、区切り文字で区切られた値を持つ形式の新しい抽出子を作成したりできます。

データエクストラクターのリストから、CSV 形式の構成を選択します。
CSV フォーマットダイアログで、形式の追加アイコンをクリックします。
新しい形式の名前を指定します (たとえば、Confluence Wiki Markup)。
形式の設定を定義します。行とヘッダーのセパレーターの設定、NULL 値のテキストの定義、引用の指定。OK をクリックします。
フォーマットが作成されると、データのエクスポートアイコン () の近くのドロップダウンで選択できます。

CSV フォーマットダイアログの詳細については、リファレンスを参照してください。

カスタムエクストラクターを追加する

Groovy または JavaScript で記述できる独自の抽出プログラムを作成できます。

GitHub リポジトリ(英語)でスクリプト拡張機能開発用の事前構成済みプロジェクトを見つけます。

プロジェクトツールウィンドウで、Scratches and Consoles | Extensions | Database Tools and SQL | data | extractors に移動します。
抽出ノードを右クリックし、新規 | ファイルを選択します。
ファイル名を入力します (例: PHP.array.groovy)。
- PHP : 抽出メニューで使用される名前。
- array : エクストラクターの出力。
- groovy : スクリプトの拡張子。
抽出プログラムのコードを入力するか、新しいファイルに貼り付けます。extractors フォルダー内の他のエクストラクターのコードを使用して、エクストラクターを作成できます。また、次のエクストラクターを試すこともできます。
- GitHub の TSV-Icelandic-Groovy.tsv.groovy(英語) : タブ区切りのクエリ結果をコピーして、Excel にコンマ区切りで貼り付けます。
- GitHub 上の Groovy での Dbunit データセットのエクスポート (英語) : Dbunit エクスポート用のエクストラクター。
- Table-Text-Groovy.txt.groovy(英語) および Fixed-length-fields.txt.groovy(英語): 固定長の列を含む txt ファイルを生成するエクストラクター。
- PHP-Array.groovy(英語) : PHP 配列へのエクストラクター。
- Markdown-JavaScript.markdown.js(英語) : Markdown へのエクストラクター。
エクストラクターのリストからエクストラクターを選択します。
WebStorm に PHP 配列エクストラクターを追加する次の例について考えてみます。

カスタムデータエクストラクターの API

次の API を使用して、カスタムデータエクストラクターを作成します。

バインディング	メソッド (Groovy と JavaScript)	説明
`DIALECT`	`getDbms()` の後に、次のいずれかの方法が続きます。 `isOracle` `isMysql` `isPostgres` `isBigQuery` `isRedshift` `isGreenplum` `isVertica` `isMicrosoft` `isSybase` `isDb2` `isHsqldb` `isH2` `isDerby` `isSqlite` `isExasol` `isClickHouse` `isCassandra` `isHive` `isSpark` `isSnowflake` `isMongo` `isCouchbase` `isCockroach` `isTransactSql` `isDocumentOriented`	データベース方言
`TABLE`	`getName()` `getParent().getName()`	データベーステーブルのメタデータ
`ALL_COLUMNS`	`int columnNumber()` `String name()`	クエリ結果または現在開いているテーブルエディターのすべての列のリスト。
`COLUMNS`	`int columnNumber()` `String name()`	クエリ結果または現在開いているテーブルエディターで選択された列のリスト。
`FORMATTER`	`format(Row, Column)` `formatValue(Object, Column)` `getTypeName(Object, Column)` `isStringLiteral(Object, Column)`	デフォルトのフォーマット方法。
`OUT`	`append(String)`	エクストラクターの出力。
`ROWS`	`int rowNumber()` `boolean first()` `boolean last()` `java.util.List<java.lang.Object> data()` `Object value(Column)`	`Row data stream.`
TRANSPOSED		テーブルエディターが転置モードかどうかを示すブール値。

サンプル

以下のシンプルな CSV データ抽出ツールを、カスタムデータ抽出ツールのベースとして使用できます。このデータ抽出ツールのフルバージョンは WebStorm で入手できます。プロジェクトツールウィンドウで Scratches and Consoles | Extensions | Database Tools and SQL | data | extractors に移動してください。

                ROWS.each {
                    row -> COLUMNS.eachWithIndex { column, i ->
                        if (i > 0) OUT.append(",")
                        OUT.append(FORMATTER.format(row, column))
                    }
                        OUT.append("\n")
                }
            

リファレンス

CSV フォーマットダイアログ

このダイアログにアクセスするには、ツールバーのデータ抽出リストをクリックし、CSV 形式の構成を選択します。

このダイアログには、テーブルデータを区切り文字で区切られた値形式 (CSV、TSV など) に変換したり、その逆に変換したりするための設定が含まれています。

残りのデータが読み込まれないようにするため、プレビューは 10 件のレコードに制限されています。設定を変更すると、プレビューもそれに応じて変更されます。

項目	説明
フォーマット	ファイルデータをテーブルに正常に変換するテンプレートを選択します。事前定義されたテンプレートの設定を変更したり、新しいテンプレートを追加したりできます。テンプレートを追加するには、形式の追加ボタン（）をクリックします。形式の追加 ()、形式の除去 ()、アップ ()、およびダウン () ボタンを使用して、フォーマットを作成、削除、並べ替えます。形式のコピー () は、選択した形式のコピーを作成します。
値セパレーター	値の区切り記号として使用する文字を選択または入力します。
行セパレーター	行の区切り記号として使用する文字を選択または入力します。
null 値テキスト	セルに `NULL` 値が含まれている場合に使用するテキストを選択または入力します。
行接頭辞 / 接尾辞の追加	リンクをクリックして、行の接頭辞と接尾辞を入力します。接頭辞と接尾辞は文字シーケンスであり、改行コードに加えて行の開始と終了を示します。
引用符	引用符の領域の各行は、引用パターンです。見積もりパターンには次のものが含まれます。左 : 値の前に挿入される引用文字。右 : 値の後に挿入される引用文字。エスケープ : 引用文字が値の一部である場合のエスケープメソッドまたは文字。<重複> 値は、値内に引用符が含まれている場合、その値が 2 倍になることを意味します。独自のエスケープ文字を指定できます。複数のパターンがある場合は、最初のパターンが使用されます。追加 ()、除去 ()、アップ ()、ダウン () ボタンを使用して、パターンを作成、削除、並べ替えます。
値を引用符で囲む	値を引用符で囲む場合に選択します。なし : 値を引用しないでください。必要な場合 : 値または改行コード文字が含まれている場合は、値を引用符で囲みます。常時 : すべての値を引用します。
空白をトリム	空白文字を無視または削除します。このチェックボックスがオフの場合、空白文字は対応する値の一部として扱われます。
最初の行はヘッダー	最初の行を列名を含む行として扱います。
最初の列はヘッダー	最初の列を行名を含む列として扱います。