DatabaseExportオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.19 |
since | 7.1 |
データベースの内容をファイルに出力します。
基本的な使い方は以下の通りです。
1.DatabaseExportインスタンスを生成 ... new DatabaseExport();
2.エクスポート対象テーブルを追加 ... add();
3.エクスポートの実行 ... execute();
以上の順で実行することで任意のテーブルをファイルに出力できます。
またエクスポート時の設定は、テーブルの情報も含めてXMLファイルで一括管理できます。
実装サンプル jssp/platform/src/tablemaintenance/ajax/export_run.js
基本的な使い方は以下の通りです。
1.DatabaseExportインスタンスを生成 ... new DatabaseExport();
2.エクスポート対象テーブルを追加 ... add();
3.エクスポートの実行 ... execute();
以上の順で実行することで任意のテーブルをファイルに出力できます。
またエクスポート時の設定は、テーブルの情報も含めてXMLファイルで一括管理できます。
実装サンプル jssp/platform/src/tablemaintenance/ajax/export_run.js
メソッドの概要
返却値の型 | メソッド名 |
---|---|
ResultObject | add (Array src ) エクスポート対象のテーブルを追加します。 |
ResultObject | add (String tableName ) エクスポート対象のテーブルを追加します。 |
ResultObject | execute (String jsconnectId , File jsfile ) エクスポートを実行して指定されたファイル/ストリームに出力します。 |
ResultObject | execute (String connectId ) 非推奨エクスポートを実行してデータを取得します。
エクスポートファイルのサイズが大きい場合、このメソッドはメモリ領域を圧迫する可能性があります。
|
ResultObject | execute (String connectId , String storagePath ) エクスポートを実行して指定されたストレージに出力します。 |
String | getDefaultExportFileName () 自動生成されたエクスポートファイルのファイル名を取得します。 |
Number | getDefaultFetchSize () static fetch-sizeのデフォルト値を取得します。 |
String | getExportOptionsXmlString () エクスポートオプションをXML形式の文字列で取得します。 |
Object | getMonitor (String jsuniqueKey ) staticエクスポートの実行状況を取得します。 |
ResultObject | includeImportOptions (String jsimportOptionsXml ) エクスポートファイル内に、インポート用の設定ファイルを含めます。 |
void | setExportConfig (String jsconfig ) エクスポート設定をセットします。 |
void | setExportFileEncordingSetting (Boolean jsflg ) エクスポートファイル内に、エクスポート時に利用したファイルエンコーディングの情報を含めるかどうかを設定します。 |
ResultObject | setExportOptionsXmlString (String jsoptionsXml ) エクスポートオプションをXML形式の文字列で設定します。 |
void | setMonitor (String jsuniqueKey ) 実行状況をモニタリングするためのキーをセットします。 |
メソッドの詳細
ResultObject add (Array src )
エクスポート対象のテーブルを追加します。
パラメータ
返却値
|
|||||||||||||||||||
ResultObject add (String tableName )
エクスポート対象のテーブルを追加します。
パラメータ
返却値
|
|||||||||||||||||||
ResultObject execute (String jsconnectId , File jsfile )
エクスポートを実行して指定されたファイル/ストリームに出力します。
第2引数で指定されたエクスポートターゲットに対してエクスポートデータが出力されます。 fetch sizeの設定を有効にする場合、トランザクション内で実行してください。
パラメータ
返却値
|
|||||||||||||||||||
ResultObject execute (String connectId )
非推奨
エクスポートファイルのサイズが大きい場合、このメソッドはメモリ領域を圧迫する可能性があります。
エクスポートを実行してデータを取得します。
パラメータ
返却値
|
|||||||||||||||||||
ResultObject execute (String connectId , String storagePath )
エクスポートを実行して指定されたストレージに出力します。
パスの最後を"/"にすると、指定されたパスはディレクトリとして解釈され 自動生成されたファイル名でエクスポートされます。
パラメータ
返却値
|
|||||||||||||||||||
String getDefaultExportFileName ()
自動生成されたエクスポートファイルのファイル名を取得します。
このメソッドは、execute()を呼び出した後に使用します。
返却値
|
|||||||||||||||||||
Number getDefaultFetchSize ()
static
fetch-sizeのデフォルト値を取得します。
fetch-sizeが未定義の場合にこの値を使用します。
返却値
|
|||||||||||||||||||
String getExportOptionsXmlString ()
エクスポートオプションをXML形式の文字列で取得します。
取得に失敗した場合は、 null を返却します。
返却値
|
|||||||||||||||||||
Object getMonitor (String jsuniqueKey )
static
エクスポートの実行状況を取得します。
エクスポートの実行とは別のスレッドからこのメソッドを使用することで 進捗状況を取得できます。
パラメータ
返却値
|
|||||||||||||||||||
ResultObject includeImportOptions (String jsimportOptionsXml )
エクスポートファイル内に、インポート用の設定ファイルを含めます。
パラメータ
返却値
|
|||||||||||||||||||
void setExportConfig (String jsconfig )
エクスポート設定をセットします。
パラメータ
返却値
|
|||||||||||||||||||
void setExportFileEncordingSetting (Boolean jsflg )
エクスポートファイル内に、エクスポート時に利用したファイルエンコーディングの情報を含めるかどうかを設定します。
パラメータ
返却値
|
|||||||||||||||||||
ResultObject setExportOptionsXmlString (String jsoptionsXml )
エクスポートオプションをXML形式の文字列で設定します。
XMLの構成については 「 テーブルメンテナンス管理者ガイド」 - 「エクスポート・インポートの設定をファイルで管理する」 を参照してください。
パラメータ
返却値
|
|||||||||||||||||||
void setMonitor (String jsuniqueKey )
実行状況をモニタリングするためのキーをセットします。
パラメータ
返却値
|