35.2 EXPORT_DATAファンクション

このファンクションは、現在のリージョン・データをエクスポートします。

ノート:

APEX_REGION.EXPORT_DATAファンクションは、現時点ではネイティブ・リージョンのみをサポートしています。

構文

FUNCTION EXPORT_DATA(
    p_format                    IN apex_data_export.t_format,
    --
    p_page_id                   IN NUMBER,
    p_region_id                 IN NUMBER,
    p_component_id              IN NUMBER                                   DEFAULT NULL,
    p_view_mode                 IN VARCHAR2                                 DEFAULT NULL,
    --
    p_additional_filters        IN apex_exec.t_filters                      DEFAULT apex_exec.c_empty_filters,
    --
    p_max_rows                  IN NUMBER                                   DEFAULT NULL,
    p_parent_column_values      IN apex_exec.t_parameters                   DEFAULT apex_exec.c_empty_parameters,
    --
    p_as_clob                   IN BOOLEAN                                  DEFAULT FALSE,
    --
    p_file_name                 IN VARCHAR2                                 DEFAULT NULL,
    p_page_size                 IN apex_data_export.t_size                  DEFAULT apex_data_export.c_size_letter,
    p_orientation               IN apex_data_export.t_orientation           DEFAULT apex_data_export.c_orientation_portrait,
    p_data_only                 IN BOOLEAN                                  DEFAULT FALSE,
    --
    p_pdf_accessible            IN BOOLEAN                                  DEFAULT FALSE,
    --
    p_xml_include_declaration   IN BOOLEAN                                  DEFAULT TRUE ) 
    return apex_data_export.t_export;

パラメータ

パラメータ 説明
p_format エクスポート形式。定数apex_data_export.c_format_*を使用します
p_page_id リージョンが存在するページのID。
p_region_id この特定のリージョンIDの問合せコンテキストを開きます。
p_component_id

使用するリージョン・コンポーネントID。

対話モード・レポートおよび対話グリッドの場合、これはカレント・アプリケーション・ページ内の保存されたレポートIDです。JETチャートの場合は、チャート・シリーズIDを使用します。

p_view_mode

レポートで使用できるビュー・タイプ。値は次のとおりです。

  • APEX_IR.C_VIEW_REPORT
  • APEX_IR.C_VIEW_GROUPBY
  • APEX_IR.C_VIEW_PIVOT

p_viewがnullの場合、現在レポートで使用されているビューを取得します。現在のレポートに存在しないp_viewが渡された場合、エラーが発生します。

p_additional_filters コンテキストに適用する追加のフィルタ。
p_max_rows 取得する行の最大数。デフォルトは無制限です。
p_parent_column_values 対話グリッド・マスター/ディテール関係のディテール・グリッドの場合。このパラメータを使用して、マスター/ディテール親列の値を渡します。
p_as_clob エクスポートの内容をCLOBとして返します。PDFやXLSXなどのバイナリ・エクスポート形式では機能しません。デフォルトはfalseです。
p_file_name エクスポートのファイル名を定義します。
p_page_size レポートのページ・サイズ。定数apex_data_export.c_size_*を使用します
p_orientation レポート・ページの向き。定数apex_data_export.c_orientation_*を使用します
p_data_only 列グループ、コントロール・ブレーク、集計およびハイライトを含めるかどうか。
p_pdf_accessible PDFにアクセシビリティ・タグを含めるかどうか。デフォルトはfalseです。
p_xml_include_declaration XML宣言を含めるかどうか。デフォルトはtrueです。

戻り値

エクスポート・ファイルの内容、mime_typeおよびオプションでレポート・レイアウト。

ページ3に保存された特定の対話モード・レポートのエクスポート結果を取得し、HTMLとしてダウンロードします。

DECLARE
    l_export       apex_data_export.t_export;
    l_region_id    number;
BEGIN

   SELECT region_id into l_region_id
     FROM apex_application_page_regions
    WHERE application_id = 100
      and page_id = 3
      and static_id = 'classic_report';
    
    l_export := apex_region.export_data (
         p_format       => apex_data_export.c_format_html,
         p_page_id      => 3,
         p_region_id    => l_region_id );
         
    apex_data_export.download( l_export );
END;