14.8 EXPORTファンクション

このファンクションは、指定した形式で問合せコンテキストをエクスポートします。

構文

FUNCTION EXPORT (
  p_context                 IN apex_exec.t_context,
  p_format                  IN t_format,
  p_as_clob                 IN BOOLEAN          DEFAULT false,
  p_columns                 IN t_columns        DEFAULT c_empty_columns,
  p_column_groups           IN t_column_groups  DEFAULT c_empty_column_groups,
  p_aggregates              IN t_aggregates     DEFAULT c_empty_aggregates,
  p_highlights              IN t_highlights     DEFAULT c_empty_highlights,
  --          
  p_file_name               IN VARCHAR2         DEFAULT NULL,
  p_print_config            IN t_print_config   DEFAULT c_empty_print_config,
  p_page_header             IN VARCHAR2         DEFAULT NULL,
  p_page_footer             IN VARCHAR2         DEFAULT NULL,
  p_supplemental_text       IN VARCHAR2         DEFAULT NULL,
  --          
  p_csv_enclosed_by         IN VARCHAR2         DEFAULT NULL,
  p_csv_separator           IN VARCHAR2         DEFAULT NULL,
  --          
  p_pdf_accessible          IN BOOLEAN          DEFAULT NULL,
  --
  p_xml_include_declaration IN BOOLEAN          DEFAULT false ) 
  RETURN t_export

パラメータ

パラメータ 説明
p_context EXECインフラストラクチャからのコンテキスト・オブジェクト。
p_format エクスポート形式。有効な値は、XLSX、PDF、HTML、CSV、XMLおよびJSONです。
p_as_clob BLOBではなくCLOBとしてエクスポートします(デフォルトはFALSE)。
p_columns 列区切りで始まり、表示順に続く列属性のコレクション。
p_column_groups レベルおよび表示順の列グループ属性のコレクション。
p_aggregates レポート集計のコレクション。
p_highlights レポート・ハイライトのコレクション。
p_file_name エクスポートのファイル名を定義します。
p_print_config EXCELおよびPDFで、印刷属性を設定するために使用します。
p_page_header ドキュメントのヘッダー・セクションに表示するテキスト。p_print_configからページ・ヘッダーを上書きします。
p_page_footer ドキュメントのフッター・セクションに表示するテキスト。p_print_configからページ・フッターを上書きします。
p_supplemental_text すべてのダウンロード形式の最上部に表示されるテキスト。
p_csv_enclosed_by CSVで、出力を囲むために使用します。
p_csv_separator CSVで、列の値を区切るために使用します。
p_pdf_accessible PDFで、アクセス可能なPDFを作成するために使用します。
p_xml_include_declaration XMLで、XML宣言を最初の行として生成するために使用します。

戻り値

このファンクションは、コンテンツ、MIMEタイプおよびファイル名を含むオブジェクトとしてエクスポート・ファイルを返します。

DECLARE
    l_context apex_exec.t_context; 
    l_export  apex_data_export.t_export;
BEGIN
    l_context := apex_exec.open_query_context(
        p_location    => apex_exec.c_location_local_db,
        p_sql_query   => 'select * from emp' );

    l_export := apex_data_export.export (
                        p_context   => l_context,
                        p_format    => apex_data_export.c_format_pdf );

    apex_exec.close( l_context );

    apex_data_export.download( p_export => l_export );

EXCEPTION
    when others THEN
        apex_exec.close( l_context );
        raise;
END;