diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..3f53200 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,17 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*] +trim_trailing_whitespace = true + +[*.{md}] +trim_trailing_whitespace = false + +[*.{sql,pks,pkb,json}] +indent_style = space +indent_size = 2 + +[*.{sql,pks,pkb,json,md,txt,bat}] +charset = utf-8 diff --git a/.gitignore b/.gitignore index dba8a59..b904bf3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,7 @@ node_modules temp +demo.sql +L_XE*.sql +*.zip +plex_install_SYS.bat +plex_install_APEX_190100.bat diff --git a/1_install.sql b/1_install.sql deleted file mode 100644 index a55615d..0000000 --- a/1_install.sql +++ /dev/null @@ -1,4 +0,0 @@ -prompt Installing PL/SQL Export Utilities -set define off -@PLEX.pks -@PLEX.pkb \ No newline at end of file diff --git a/2_uninstall.sql b/2_uninstall.sql deleted file mode 100644 index 93f95ee..0000000 --- a/2_uninstall.sql +++ /dev/null @@ -1,2 +0,0 @@ -prompt Uninstalling PL/SQL Export Utilities -drop package plex; diff --git a/PLEX.pkb b/PLEX.pkb index 05eb296..a481b1a 100755 --- a/PLEX.pkb +++ b/PLEX.pkb @@ -1,1411 +1,1295 @@ CREATE OR REPLACE PACKAGE BODY plex IS - -- CONSTANTS, TYPES - - c_tab CONSTANT VARCHAR2(1) := chr(9); - c_lf CONSTANT VARCHAR2(1) := chr(10); - c_cr CONSTANT VARCHAR2(1) := chr(13); - c_crlf CONSTANT VARCHAR2(2) := chr(13) || chr(10); - c_slash CONSTANT VARCHAR2(1) := '/'; -- We need it to be able to compile this package via SQL*Plus. SQL*Plus starts actions - c_at CONSTANT VARCHAR2(1) := '@'; -- on these characters regardsless if they encapsulated in strings or not :-( - c_vc2_max_size CONSTANT PLS_INTEGER := 32767; - - -- - TYPE rec_ilog_step IS RECORD ( -- - action app_info_text, - start_time TIMESTAMP(6), - stop_time TIMESTAMP(6), - elapsed NUMBER, - execution NUMBER ); - TYPE tab_ilog_step IS - TABLE OF rec_ilog_step INDEX BY BINARY_INTEGER; - - -- - TYPE rec_ilog IS RECORD ( -- - module app_info_text, - enabled BOOLEAN, - start_time TIMESTAMP(6), - stop_time TIMESTAMP(6), - run_time NUMBER, - measured_time NUMBER, - unmeasured_time NUMBER, - data tab_ilog_step ); - - -- - TYPE tab_vc1000 IS - TABLE OF VARCHAR2(1000) INDEX BY BINARY_INTEGER; - - -- - TYPE rec_ddl_files IS RECORD ( -- - sequences_ tab_vc1000, - tables_ tab_vc1000, - ref_constraints_ tab_vc1000, - indices_ tab_vc1000, - views_ tab_vc1000, - types_ tab_vc1000, - type_bodies_ tab_vc1000, - triggers_ tab_vc1000, - functions_ tab_vc1000, - procedures_ tab_vc1000, - packages_ tab_vc1000, - package_bodies_ tab_vc1000, - grants_ tab_vc1000, - other_objects_ tab_vc1000 ); - - -- - TYPE rec_queries IS RECORD (-- - query VARCHAR2(32767 CHAR), - file_name VARCHAR2(256 CHAR), - max_rows NUMBER DEFAULT 100000 ); - TYPE tab_queries IS - TABLE OF rec_queries INDEX BY PLS_INTEGER; - - -- GLOBAL VARIABLES - g_clob CLOB; - g_clob_varchar_cache VARCHAR2(32767char); - g_ilog rec_ilog; - g_queries tab_queries; - - - -- UTILITIES - - FUNCTION util_bool_to_string ( - p_bool IN BOOLEAN - ) RETURN VARCHAR2 - IS - BEGIN - RETURN - CASE - WHEN p_bool THEN 'TRUE' - ELSE 'FALSE' - END; - END util_bool_to_string; - - FUNCTION util_string_to_bool ( - p_bool_string IN VARCHAR2, - p_default IN BOOLEAN - ) RETURN BOOLEAN IS - l_bool_string VARCHAR2(1 CHAR); - l_return BOOLEAN; - BEGIN - l_bool_string := upper(substr( - p_bool_string, - 1, - 1 - ) ); - l_return := - CASE - WHEN l_bool_string IN ( - '1', - 'Y', - 'T' - ) THEN true - WHEN l_bool_string IN ( - '0', - 'N', - 'F' - ) THEN false - ELSE p_default - END; +-------------------------------------------------------------------------------------------------------------------------------- +-- CONSTANTS, TYPES +-------------------------------------------------------------------------------------------------------------------------------- + +c_tab CONSTANT VARCHAR2(1) := chr(9); +c_cr CONSTANT VARCHAR2(1) := chr(13); +c_lf CONSTANT VARCHAR2(1) := chr(10); +c_crlf CONSTANT VARCHAR2(2) := chr(13) || chr(10); +c_at CONSTANT VARCHAR2(1) := '@'; +c_hash CONSTANT VARCHAR2(1) := '#'; +c_slash CONSTANT VARCHAR2(1) := '/'; +c_vc2_max_size CONSTANT PLS_INTEGER := 32767; +c_zip_local_file_header CONSTANT RAW(4) := hextoraw('504B0304'); +c_zip_end_of_central_directory CONSTANT RAW(4) := hextoraw('504B0506'); + +TYPE tab_errlog IS TABLE OF rec_error_log INDEX BY BINARY_INTEGER; + +TYPE rec_runlog_step IS RECORD ( + action app_info_text, + start_time TIMESTAMP(6), + stop_time TIMESTAMP(6), + elapsed NUMBER, + execution NUMBER); +TYPE tab_runlog_step IS TABLE OF rec_runlog_step INDEX BY BINARY_INTEGER; + +TYPE rec_runlog IS RECORD ( + module app_info_text, + start_time TIMESTAMP(6), + stop_time TIMESTAMP(6), + run_time NUMBER, + measured_time NUMBER, + unmeasured_time NUMBER, + data tab_runlog_step); +TYPE rec_queries IS RECORD (-- + query VARCHAR2(32767 CHAR), + file_name VARCHAR2(256 CHAR), + max_rows NUMBER DEFAULT 100000); +TYPE tab_queries IS TABLE OF rec_queries INDEX BY BINARY_INTEGER; + +TYPE tab_file_list_lookup IS TABLE OF PLS_INTEGER INDEX BY VARCHAR2(256); + +TYPE rec_ddl_files IS RECORD ( + sequences_ tab_vc1k, + tables_ tab_vc1k, + ref_constraints_ tab_vc1k, + indices_ tab_vc1k, + views_ tab_vc1k, + types_ tab_vc1k, + type_bodies_ tab_vc1k, + triggers_ tab_vc1k, + functions_ tab_vc1k, + procedures_ tab_vc1k, + packages_ tab_vc1k, + package_bodies_ tab_vc1k, + grants_ tab_vc1k, + other_objects_ tab_vc1k); + + +-- GLOBAL VARIABLES +g_clob CLOB; +g_clob_vc_cache VARCHAR2(32767char); +g_errlog tab_errlog; +g_runlog rec_runlog; +g_queries tab_queries; + + + +-------------------------------------------------------------------------------------------------------------------------------- +-- UTILITIES (forward declarations, only compiled when not public) +-------------------------------------------------------------------------------------------------------------------------------- + +$if not $$utils_public $then +FUNCTION util_bool_to_string (p_bool IN BOOLEAN) RETURN VARCHAR2; + +FUNCTION util_string_to_bool ( + p_bool_string IN VARCHAR2, + p_default IN BOOLEAN) +RETURN BOOLEAN; + +FUNCTION util_split ( + p_string IN VARCHAR2, + p_delimiter IN VARCHAR2 DEFAULT ',') +RETURN tab_vc32k; + +FUNCTION util_join ( + p_array IN tab_vc32k, + p_delimiter IN VARCHAR2 DEFAULT ',') +RETURN VARCHAR2; + +FUNCTION util_clob_to_blob (p_clob CLOB) RETURN BLOB; + +/* +ZIP UTILS +- The following four zip utilities are copied from this article: + - Blog: https://technology.amis.nl/2010/03/13/utl_compress-gzip-and-zlib/ + - Source: https://technology.amis.nl/wp-content/uploads/2010/06/as_zip10.txt +- Copyright (c) 2010, 2011 by Anton Scheffer (MIT license) +- Thank you for sharing this Anton :-) +*/ +FUNCTION util_zip_blob_to_num ( + p_blob IN BLOB, + p_len IN INTEGER, + p_pos IN INTEGER) +RETURN NUMBER; - RETURN l_return; - END util_string_to_bool; +FUNCTION util_zip_little_endian ( + p_big IN NUMBER, + p_bytes IN PLS_INTEGER := 4) +RETURN RAW; - FUNCTION util_clob_to_blob ( - p_clob CLOB - ) RETURN BLOB IS +PROCEDURE util_zip_add_file ( + p_zipped_blob IN OUT BLOB, + p_name IN VARCHAR2, + p_content IN BLOB); - l_blob BLOB; - l_lang_context INTEGER := dbms_lob.default_lang_ctx; - l_warning INTEGER := dbms_lob.warn_inconvertible_char; - l_dest_offset INTEGER := 1; - l_src_offset INTEGER := 1; - BEGIN - IF - p_clob IS NOT NULL - THEN - dbms_lob.createtemporary( - l_blob, - true - ); - dbms_lob.converttoblob( - dest_lob => l_blob, - src_clob => p_clob, - amount => dbms_lob.lobmaxsize, - dest_offset => l_dest_offset, - src_offset => l_src_offset, - blob_csid => nls_charset_id('AL32UTF8'), - lang_context => l_lang_context, - warning => l_warning - ); +PROCEDURE util_zip_finish (p_zipped_blob IN OUT BLOB); - END IF; +FUNCTION util_multi_replace ( + p_source_string VARCHAR2, + p_01_find VARCHAR2 DEFAULT NULL, p_01_replace VARCHAR2 DEFAULT NULL, + p_02_find VARCHAR2 DEFAULT NULL, p_02_replace VARCHAR2 DEFAULT NULL, + p_03_find VARCHAR2 DEFAULT NULL, p_03_replace VARCHAR2 DEFAULT NULL, + p_04_find VARCHAR2 DEFAULT NULL, p_04_replace VARCHAR2 DEFAULT NULL, + p_05_find VARCHAR2 DEFAULT NULL, p_05_replace VARCHAR2 DEFAULT NULL, + p_06_find VARCHAR2 DEFAULT NULL, p_06_replace VARCHAR2 DEFAULT NULL, + p_07_find VARCHAR2 DEFAULT NULL, p_07_replace VARCHAR2 DEFAULT NULL, + p_08_find VARCHAR2 DEFAULT NULL, p_08_replace VARCHAR2 DEFAULT NULL, + p_09_find VARCHAR2 DEFAULT NULL, p_09_replace VARCHAR2 DEFAULT NULL, + p_10_find VARCHAR2 DEFAULT NULL, p_10_replace VARCHAR2 DEFAULT NULL, + p_11_find VARCHAR2 DEFAULT NULL, p_11_replace VARCHAR2 DEFAULT NULL, + p_12_find VARCHAR2 DEFAULT NULL, p_12_replace VARCHAR2 DEFAULT NULL) +RETURN VARCHAR2; - RETURN l_blob; - END util_clob_to_blob; - - FUNCTION util_multi_replace ( - p_source_string VARCHAR2, - p_1_find VARCHAR2 DEFAULT NULL, - p_1_replace VARCHAR2 DEFAULT NULL, - p_2_find VARCHAR2 DEFAULT NULL, - p_2_replace VARCHAR2 DEFAULT NULL, - p_3_find VARCHAR2 DEFAULT NULL, - p_3_replace VARCHAR2 DEFAULT NULL, - p_4_find VARCHAR2 DEFAULT NULL, - p_4_replace VARCHAR2 DEFAULT NULL, - p_5_find VARCHAR2 DEFAULT NULL, - p_5_replace VARCHAR2 DEFAULT NULL, - p_6_find VARCHAR2 DEFAULT NULL, - p_6_replace VARCHAR2 DEFAULT NULL, - p_7_find VARCHAR2 DEFAULT NULL, - p_7_replace VARCHAR2 DEFAULT NULL, - p_8_find VARCHAR2 DEFAULT NULL, - p_8_replace VARCHAR2 DEFAULT NULL, - p_9_find VARCHAR2 DEFAULT NULL, - p_9_replace VARCHAR2 DEFAULT NULL, - p_10_find VARCHAR2 DEFAULT NULL, - p_10_replace VARCHAR2 DEFAULT NULL, - p_11_find VARCHAR2 DEFAULT NULL, - p_11_replace VARCHAR2 DEFAULT NULL, - p_12_find VARCHAR2 DEFAULT NULL, - p_12_replace VARCHAR2 DEFAULT NULL - ) RETURN VARCHAR2 IS - l_return VARCHAR2(32767); - BEGIN - l_return := p_source_string; - IF - p_1_find IS NOT NULL - THEN - l_return := replace( - l_return, - p_1_find, - p_1_replace - ); - END IF; +FUNCTION util_set_build_status_run_only (p_app_export_sql IN CLOB) RETURN CLOB; - IF - p_2_find IS NOT NULL - THEN - l_return := replace( - l_return, - p_2_find, - p_2_replace - ); - END IF; +FUNCTION util_calc_data_timestamp (p_as_of_minutes_ago IN NUMBER) RETURN TIMESTAMP; - IF - p_3_find IS NOT NULL - THEN - l_return := replace( - l_return, - p_3_find, - p_3_replace - ); - END IF; +PROCEDURE util_setup_dbms_metadata ( + p_pretty IN BOOLEAN DEFAULT true, + p_constraints IN BOOLEAN DEFAULT true, + p_ref_constraints IN BOOLEAN DEFAULT false, + p_partitioning IN BOOLEAN DEFAULT true, + p_tablespace IN BOOLEAN DEFAULT false, + p_storage IN BOOLEAN DEFAULT false, + p_segment_attributes IN BOOLEAN DEFAULT false, + p_sqlterminator IN BOOLEAN DEFAULT true, + p_constraints_as_alter IN BOOLEAN DEFAULT false, + p_emit_schema IN BOOLEAN DEFAULT false); - IF - p_4_find IS NOT NULL - THEN - l_return := replace( - l_return, - p_4_find, - p_4_replace - ); - END IF; +-------------------------------------------------------------------------------------------------------------------------------- +-- The following tools are working on the global private package variables g_clob, g_clob_varchar_cache, g_runlog and g_queries +-------------------------------------------------------------------------------------------------------------------------------- - IF - p_5_find IS NOT NULL - THEN - l_return := replace( - l_return, - p_5_find, - p_5_replace - ); - END IF; +PROCEDURE util_clob_append (p_content IN VARCHAR2); - IF - p_6_find IS NOT NULL - THEN - l_return := replace( - l_return, - p_6_find, - p_6_replace - ); - END IF; +PROCEDURE util_clob_append (p_content IN CLOB); - IF - p_7_find IS NOT NULL - THEN - l_return := replace( - l_return, - p_7_find, - p_7_replace - ); - END IF; +PROCEDURE util_clob_flush_cache; - IF - p_8_find IS NOT NULL - THEN - l_return := replace( - l_return, - p_8_find, - p_8_replace - ); - END IF; +PROCEDURE util_clob_add_to_export_files ( + p_export_files IN OUT NOCOPY tab_export_files, + p_name IN VARCHAR2); - IF - p_9_find IS NOT NULL - THEN - l_return := replace( - l_return, - p_9_find, - p_9_replace - ); - END IF; +PROCEDURE util_clob_query_to_csv ( + p_query IN VARCHAR2, + p_max_rows IN NUMBER DEFAULT 1000, + p_delimiter IN VARCHAR2 DEFAULT ',', + p_quote_mark IN VARCHAR2 DEFAULT '"', + p_header_prefix IN VARCHAR2 DEFAULT NULL); - IF - p_10_find IS NOT NULL - THEN - l_return := replace( - l_return, - p_10_find, - p_10_replace - ); - END IF; +PROCEDURE util_clob_create_runtime_log (p_export_files IN OUT NOCOPY tab_export_files); - IF - p_11_find IS NOT NULL - THEN - l_return := replace( - l_return, - p_11_find, - p_11_replace - ); - END IF; +PROCEDURE util_clob_create_error_log (p_export_files IN OUT NOCOPY tab_export_files); - IF - p_12_find IS NOT NULL - THEN - l_return := replace( - l_return, - p_12_find, - p_12_replace - ); - END IF; +PROCEDURE util_ensure_unique_file_names (p_export_files IN OUT tab_export_files); - RETURN l_return; - END util_multi_replace; +PROCEDURE util_log_init (p_module IN VARCHAR2); - FUNCTION util_set_build_status_run_only ( - p_contents CLOB - ) RETURN CLOB IS - l_position PLS_INTEGER; - BEGIN - l_position := instr( - p_contents, - ',p_exact_substitutions_only' - ); - RETURN substr( - p_contents, - 1, - l_position - 1 - ) || ',p_build_status=>''RUN_ONLY''' || c_lf || substr( - p_contents, - l_position - ); - - END util_set_build_status_run_only; - - PROCEDURE util_export_files_append ( - p_export_files IN OUT NOCOPY apex_t_export_files, - p_name VARCHAR2, - p_contents CLOB - ) IS - l_index PLS_INTEGER; - BEGIN - l_index := p_export_files.count + 1; - p_export_files.extend; - p_export_files(l_index) := apex_t_export_file( - name => p_name, - contents => p_contents - ); - - END util_export_files_append; - - FUNCTION util_calc_data_timestamp ( - p_as_of_minutes_ago NUMBER - ) RETURN TIMESTAMP IS - l_return TIMESTAMP; - BEGIN - EXECUTE IMMEDIATE replace( - q'[SELECT systimestamp - INTERVAL '{{MINUTES}}' MINUTE FROM dual]', - '{{MINUTES}}', - TO_CHAR(p_as_of_minutes_ago) - ) - INTO l_return; - RETURN l_return; - END util_calc_data_timestamp; - - PROCEDURE util_setup_dbms_metadata ( - p_pretty IN BOOLEAN DEFAULT true, - p_constraints IN BOOLEAN DEFAULT true, - p_ref_constraints IN BOOLEAN DEFAULT false, - p_partitioning IN BOOLEAN DEFAULT true, - p_tablespace IN BOOLEAN DEFAULT false, - p_storage IN BOOLEAN DEFAULT false, - p_segment_attributes IN BOOLEAN DEFAULT false, - p_sqlterminator IN BOOLEAN DEFAULT true, - p_constraints_as_alter IN BOOLEAN DEFAULT false, - p_emit_schema IN BOOLEAN DEFAULT false - ) - IS - BEGIN - dbms_metadata.set_transform_param( - dbms_metadata.session_transform, - 'PRETTY', - p_pretty - ); - dbms_metadata.set_transform_param( - dbms_metadata.session_transform, - 'CONSTRAINTS', - p_constraints - ); - dbms_metadata.set_transform_param( - dbms_metadata.session_transform, - 'REF_CONSTRAINTS', - p_ref_constraints - ); - dbms_metadata.set_transform_param( - dbms_metadata.session_transform, - 'PARTITIONING', - p_partitioning - ); - dbms_metadata.set_transform_param( - dbms_metadata.session_transform, - 'TABLESPACE', - p_tablespace - ); - dbms_metadata.set_transform_param( - dbms_metadata.session_transform, - 'STORAGE', - p_storage - ); - dbms_metadata.set_transform_param( - dbms_metadata.session_transform, - 'SEGMENT_ATTRIBUTES', - p_segment_attributes - ); - dbms_metadata.set_transform_param( - dbms_metadata.session_transform, - 'SQLTERMINATOR', - p_sqlterminator - ); - dbms_metadata.set_transform_param( - dbms_metadata.session_transform, - 'CONSTRAINTS_AS_ALTER', - p_constraints_as_alter - ); - dbms_metadata.set_transform_param( - dbms_metadata.session_transform, - 'EMIT_SCHEMA', - p_emit_schema - ); - END util_setup_dbms_metadata; - - PROCEDURE util_g_clob_createtemporary - IS - BEGIN - g_clob := NULL; - dbms_lob.createtemporary( - g_clob, - true - ); - END util_g_clob_createtemporary; - - PROCEDURE util_g_clob_freetemporary - IS - BEGIN - dbms_lob.freetemporary(g_clob); - END util_g_clob_freetemporary; +PROCEDURE util_log_start (p_action IN VARCHAR2); - PROCEDURE util_g_clob_flush_cache - IS - BEGIN - IF - g_clob_varchar_cache IS NOT NULL - THEN - IF - g_clob IS NULL - THEN - g_clob := g_clob_varchar_cache; - ELSE - dbms_lob.append( - g_clob, - g_clob_varchar_cache - ); - END IF; +PROCEDURE util_log_error (p_name VARCHAR2); - g_clob_varchar_cache := NULL; - END IF; - END util_g_clob_flush_cache; +PROCEDURE util_log_stop; - PROCEDURE util_g_clob_append ( - p_content IN VARCHAR2 - ) - IS - BEGIN - g_clob_varchar_cache := g_clob_varchar_cache || p_content; - EXCEPTION - WHEN value_error THEN - IF - g_clob IS NULL - THEN - g_clob := g_clob_varchar_cache; - ELSE - dbms_lob.append( - g_clob, - g_clob_varchar_cache - ); - END IF; +FUNCTION util_log_get_runtime ( + p_start IN TIMESTAMP, + p_stop IN TIMESTAMP) +RETURN NUMBER; - g_clob_varchar_cache := p_content; - END util_g_clob_append; +PROCEDURE util_log_calc_runtimes; - PROCEDURE util_g_clob_append ( - p_content IN CLOB - ) - IS - BEGIN - util_g_clob_flush_cache; - IF - g_clob IS NULL - THEN - g_clob := p_content; - ELSE - dbms_lob.append( - g_clob, - p_content - ); - END IF; +$end - END util_g_clob_append; - PROCEDURE util_g_clob_query_to_csv ( - p_query VARCHAR2, - p_max_rows NUMBER DEFAULT 1000, - -- - p_delimiter VARCHAR2 DEFAULT ',', - p_quote_mark VARCHAR2 DEFAULT '"', - p_header_prefix VARCHAR2 DEFAULT NULL - ) IS - -- inspired by Tim Hall: https://oracle-base.com/dba/script?category=miscellaneous&file=csv.sql - - l_line_terminator VARCHAR2(2) := c_crlf; -- to be compatible with Excel we need to use crlf here (multiline text uses lf and is wrapped in quotes) - l_cursor PLS_INTEGER; - l_ignore PLS_INTEGER; - l_data_count PLS_INTEGER := 0; - l_col_cnt PLS_INTEGER; - l_desc_tab dbms_sql.desc_tab3; - l_buffer_varchar2 VARCHAR2(32767 CHAR); - l_buffer_clob CLOB; - l_buffer_xmltype XMLTYPE; - l_buffer_long LONG; - l_buffer_long_length PLS_INTEGER; - - -- numeric type identfiers - c_number CONSTANT PLS_INTEGER := 2; -- also FLOAT - c_binary_float CONSTANT PLS_INTEGER := 100; - c_binary_double CONSTANT PLS_INTEGER := 101; - -- string type identfiers - c_char CONSTANT PLS_INTEGER := 96; -- also NCHAR - c_varchar2 CONSTANT PLS_INTEGER := 1; -- also NVARCHAR2 - c_long CONSTANT PLS_INTEGER := 8; - c_clob CONSTANT PLS_INTEGER := 112; -- also NCLOB - c_xmltype CONSTANT PLS_INTEGER := 109; -- also ANYDATA, ANYDATASET, ANYTYPE, Object type, VARRAY, Nested table - c_rowid CONSTANT PLS_INTEGER := 11; - c_urowid CONSTANT PLS_INTEGER := 208; - -- binary type identfiers - c_raw CONSTANT PLS_INTEGER := 23; - c_long_raw CONSTANT PLS_INTEGER := 24; - c_blob CONSTANT PLS_INTEGER := 113; - c_bfile CONSTANT PLS_INTEGER := 114; - -- date type identfiers - c_date CONSTANT PLS_INTEGER := 12; - c_timestamp CONSTANT PLS_INTEGER := 180; - c_timestamp_with_time_zone CONSTANT PLS_INTEGER := 181; - c_timestamp_with_local_tz CONSTANT PLS_INTEGER := 231; - -- interval type identfiers - c_interval_year_to_month CONSTANT PLS_INTEGER := 182; - c_interval_day_to_second CONSTANT PLS_INTEGER := 183; - -- cursor type identfiers - c_ref CONSTANT PLS_INTEGER := 111; - c_ref_cursor CONSTANT PLS_INTEGER := 102; -- same identfiers for strong and weak ref cursor - - PROCEDURE escape_varchar2_buffer_for_csv - IS - BEGIN - IF - l_buffer_varchar2 IS NOT NULL - THEN - -- normalize line feeds for Excel - l_buffer_varchar2 := replace( - replace( - l_buffer_varchar2, - c_crlf, - c_lf - ), - c_cr, - c_lf - ); - - -- if we have the parameter p_force_quotes set to true or the delimiter character or - -- line feeds in the string then we have to wrap the text in quotes marks and escape - -- the quote marks inside the text by double them - - IF - instr( - l_buffer_varchar2, - p_delimiter - ) > 0 OR instr( - l_buffer_varchar2, - c_lf - ) > 0 - THEN - l_buffer_varchar2 := p_quote_mark || replace( - l_buffer_varchar2, - p_quote_mark, - p_quote_mark || p_quote_mark - ) || p_quote_mark; - END IF; +-------------------------------------------------------------------------------------------------------------------------------- +-- UTILITIES MAIN CODE +-------------------------------------------------------------------------------------------------------------------------------- - END IF; - EXCEPTION - WHEN value_error THEN - l_buffer_varchar2 := 'Value skipped - escaped text larger then ' || c_vc2_max_size || ' characters'; - END escape_varchar2_buffer_for_csv; +FUNCTION util_bool_to_string (p_bool IN BOOLEAN) RETURN VARCHAR2 IS +BEGIN + RETURN CASE WHEN p_bool THEN 'TRUE' ELSE 'FALSE' END; +END util_bool_to_string; - BEGIN - IF - p_query IS NOT NULL - THEN - l_cursor := dbms_sql.open_cursor; - dbms_sql.parse( - l_cursor, - regexp_replace( - p_query, - ';\s*$', - NULL - ), - dbms_sql.native - ); - -- https://support.esri.com/en/technical-article/000010110 - -- http://bluefrog-oracle.blogspot.com/2011/11/describing-ref-cursor-using-dbmssql-api.html - - dbms_sql.describe_columns3( - l_cursor, - l_col_cnt, - l_desc_tab - ); - FOR i IN 1..l_col_cnt LOOP - IF - l_desc_tab(i).col_type = c_clob - THEN - dbms_sql.define_column( - l_cursor, - i, - l_buffer_clob - ); - ELSIF l_desc_tab(i).col_type = c_xmltype THEN - dbms_sql.define_column( - l_cursor, - i, - l_buffer_xmltype - ); - ELSIF l_desc_tab(i).col_type = c_long THEN - dbms_sql.define_column_long( - l_cursor, - i - ); - ELSIF l_desc_tab(i).col_type in (c_raw, c_long_raw, c_blob, c_bfile) THEN - NULL; --> we ignore binary data types - ELSE - dbms_sql.define_column( - l_cursor, - i, - l_buffer_varchar2, - c_vc2_max_size - ); - END IF; - END LOOP; +-------------------------------------------------------------------------------------------------------------------------------- - l_ignore := dbms_sql.execute(l_cursor); - - -- create header - util_g_clob_append(p_header_prefix); - FOR i IN 1..l_col_cnt LOOP - IF - i > 1 - THEN - util_g_clob_append(p_delimiter); - END IF; - l_buffer_varchar2 := l_desc_tab(i).col_name; - escape_varchar2_buffer_for_csv; - util_g_clob_append(l_buffer_varchar2); - END LOOP; +FUNCTION util_string_to_bool ( + p_bool_string IN VARCHAR2, + p_default IN BOOLEAN) +RETURN BOOLEAN IS + v_bool_string VARCHAR2(1 CHAR); + v_return BOOLEAN; +BEGIN + v_bool_string := upper(substr(p_bool_string, 1, 1)); + v_return := + CASE + WHEN v_bool_string IN ('1', 'Y', 'T') THEN + true + WHEN v_bool_string IN ('0', 'N', 'F') THEN + false + ELSE p_default + END; + RETURN v_return; +END util_string_to_bool; + +-------------------------------------------------------------------------------------------------------------------------------- + +FUNCTION util_split ( + p_string IN VARCHAR2, + p_delimiter IN VARCHAR2 DEFAULT ',') +RETURN tab_vc32k IS + v_return tab_vc32k := tab_vc32k(); + v_offset PLS_INTEGER := 1; + v_index PLS_INTEGER := instr(p_string, p_delimiter, v_offset); + v_delimiter_length PLS_INTEGER := length(p_delimiter); + v_string_length CONSTANT PLS_INTEGER := length(p_string); + v_count PLS_INTEGER := 1; + + PROCEDURE add_value (p_value VARCHAR2) IS + BEGIN + v_return.extend; + v_return(v_count) := p_value; + v_count := v_count + 1; + END add_value; - util_g_clob_append(l_line_terminator); - - -- create data - LOOP - EXIT WHEN dbms_sql.fetch_rows(l_cursor) = 0 OR l_data_count = p_max_rows; - FOR i IN 1..l_col_cnt LOOP - IF - i > 1 - THEN - util_g_clob_append(p_delimiter); - END IF; - -- - IF - l_desc_tab(i).col_type = c_clob - THEN - dbms_sql.column_value( - l_cursor, - i, - l_buffer_clob - ); - IF - length(l_buffer_clob) <= c_vc2_max_size - THEN - l_buffer_varchar2 := substr( - l_buffer_clob, - 1, - c_vc2_max_size - ); - escape_varchar2_buffer_for_csv; - util_g_clob_append(l_buffer_varchar2); - ELSE - l_buffer_varchar2 := 'CLOB value skipped - larger then ' || c_vc2_max_size || ' characters'; - util_g_clob_append(l_buffer_varchar2); - END IF; - - ELSIF l_desc_tab(i).col_type = c_xmltype THEN - dbms_sql.column_value( - l_cursor, - i, - l_buffer_xmltype - ); - l_buffer_clob := l_buffer_xmltype.getclobval (); - IF - length(l_buffer_clob) <= c_vc2_max_size - THEN - l_buffer_varchar2 := substr( - l_buffer_clob, - 1, - c_vc2_max_size - ); - escape_varchar2_buffer_for_csv; - util_g_clob_append(l_buffer_varchar2); - ELSE - l_buffer_varchar2 := 'XML value skipped - larger then ' || c_vc2_max_size || ' characters'; - util_g_clob_append(l_buffer_varchar2); - END IF; - - ELSIF l_desc_tab(i).col_type = c_long THEN - dbms_sql.column_value_long( - l_cursor, - i, - c_vc2_max_size, - 0, - l_buffer_varchar2, - l_buffer_long_length - ); - IF - l_buffer_long_length <= c_vc2_max_size - THEN - escape_varchar2_buffer_for_csv; - util_g_clob_append(l_buffer_varchar2); - ELSE - util_g_clob_append('LONG value skipped - larger then ' || c_vc2_max_size || ' characters'); - END IF; - - ELSIF l_desc_tab(i).col_type in (c_raw, c_long_raw, c_blob, c_bfile) THEN - util_g_clob_append('Binary data type skipped - not supported for CSV'); - ELSE - dbms_sql.column_value( - l_cursor, - i, - l_buffer_varchar2 - ); - escape_varchar2_buffer_for_csv; - util_g_clob_append(l_buffer_varchar2); - END IF; +BEGIN + WHILE v_index > 0 LOOP + add_value(trim(substr(p_string, v_offset, v_index - v_offset))); + v_offset := v_index + v_delimiter_length; + v_index := instr(p_string, p_delimiter, v_offset); + END LOOP; + IF v_string_length - v_offset + 1 > 0 THEN + add_value(trim(substr(p_string, v_offset, v_string_length - v_offset + 1))); + END IF; + RETURN v_return; +END util_split; - END LOOP; +-------------------------------------------------------------------------------------------------------------------------------- - util_g_clob_append(l_line_terminator); - l_data_count := l_data_count + 1; - END LOOP; +FUNCTION util_join ( + p_array IN tab_vc32k, + p_delimiter IN VARCHAR2 DEFAULT ',') +RETURN VARCHAR2 IS + v_return VARCHAR2(32767); +BEGIN + IF p_array IS NOT NULL AND p_array.count > 0 THEN + v_return := p_array(1); + FOR i IN 2 ..p_array.count LOOP + v_return := v_return || p_delimiter || p_array(i); + END LOOP; + END IF; + RETURN v_return; +EXCEPTION + WHEN value_error THEN + RETURN v_return; +END util_join; + +-------------------------------------------------------------------------------------------------------------------------------- + +FUNCTION util_clob_to_blob (p_clob CLOB) RETURN BLOB IS + v_blob BLOB; + v_lang_context INTEGER := dbms_lob.default_lang_ctx; + v_warning INTEGER := dbms_lob.warn_inconvertible_char; + v_dest_offset INTEGER := 1; + v_src_offset INTEGER := 1; +BEGIN + IF p_clob IS NOT NULL THEN + dbms_lob.createtemporary(v_blob, true); + dbms_lob.converttoblob( + dest_lob => v_blob, + src_clob => p_clob, + amount => dbms_lob.lobmaxsize, + dest_offset => v_dest_offset, + src_offset => v_src_offset, + blob_csid => nls_charset_id('AL32UTF8'), + lang_context => v_lang_context, + warning => v_warning); + END IF; + RETURN v_blob; +END util_clob_to_blob; + +-------------------------------------------------------------------------------------------------------------------------------- + +-- copyright by Anton Scheffer (MIT license, see https://technology.amis.nl/2010/03/13/utl_compress-gzip-and-zlib/) +FUNCTION util_zip_blob_to_num ( + p_blob IN BLOB, + p_len IN INTEGER, + p_pos IN INTEGER) +RETURN NUMBER IS + rv NUMBER; +BEGIN + rv := utl_raw.cast_to_binary_integer( + dbms_lob.substr(p_blob, p_len, p_pos), + utl_raw.little_endian); + IF rv < 0 THEN + rv := rv + 4294967296; + END IF; + RETURN rv; +END util_zip_blob_to_num; - dbms_sql.close_cursor(l_cursor); - END IF; - END util_g_clob_query_to_csv; +-------------------------------------------------------------------------------------------------------------------------------- - PROCEDURE util_g_clob_create_runtime_log - IS - BEGIN - util_g_clob_append(util_multi_replace( - ' -{{MAIN_FUNCTION}} - Runtime Log -============================================================ +-- copyright by Anton Scheffer (MIT license, see https://technology.amis.nl/2010/03/13/utl_compress-gzip-and-zlib/) +FUNCTION util_zip_little_endian ( + p_big IN NUMBER, + p_bytes IN PLS_INTEGER := 4) +RETURN RAW IS + t_big NUMBER := p_big; +BEGIN + IF t_big > 2147483647 THEN + t_big := t_big - 4294967296; + END IF; + RETURN utl_raw.substr(utl_raw.cast_from_binary_integer(t_big, utl_raw.little_endian), 1, p_bytes); +END util_zip_little_endian; + +-------------------------------------------------------------------------------------------------------------------------------- + +-- copyright by Anton Scheffer (MIT license, see https://technology.amis.nl/2010/03/13/utl_compress-gzip-and-zlib/) +PROCEDURE util_zip_add_file ( + p_zipped_blob IN OUT BLOB, + p_name IN VARCHAR2, + p_content IN BLOB) +IS + t_now DATE; + t_blob BLOB; + t_len INTEGER; + t_clen INTEGER; + t_crc32 RAW(4) := hextoraw('00000000'); + t_compressed BOOLEAN := false; + t_name RAW(32767); +BEGIN + t_now := SYSDATE; + t_len := nvl(dbms_lob.getlength(p_content), 0); + IF t_len > 0 THEN + t_blob := utl_compress.lz_compress(p_content); + t_clen := dbms_lob.getlength(t_blob) - 18; + t_compressed := t_clen < t_len; + t_crc32 := dbms_lob.substr(t_blob, 4, t_clen + 11); + END IF; + IF NOT t_compressed THEN + t_clen := t_len; + t_blob := p_content; + END IF; + t_name := utl_i18n.string_to_raw(p_name, 'AL32UTF8'); + dbms_lob.append( + p_zipped_blob, + utl_raw.concat( + c_zip_local_file_header, -- local file header signature + hextoraw('1400'), -- version 2.0 + CASE WHEN t_name = utl_i18n.string_to_raw(p_name, 'US8PC437') + THEN hextoraw('0000') -- no General purpose bits + ELSE hextoraw('0008') -- set Language encoding flag (EFS) + END, + CASE WHEN t_compressed + THEN hextoraw('0800') -- deflate + ELSE hextoraw('0000') -- stored + END, + util_zip_little_endian( + to_number(TO_CHAR(t_now, 'ss')) / 2 + + to_number(TO_CHAR(t_now, 'mi')) * 32 + + to_number(TO_CHAR(t_now, 'hh24')) * 2048, + 2), -- file last modification time + util_zip_little_endian( + to_number(TO_CHAR(t_now, 'dd')) + + to_number(TO_CHAR(t_now, 'mm')) * 32 + + (to_number(TO_CHAR(t_now, 'yyyy')) - 1980) * 512, + 2), -- file last modification date + t_crc32, -- CRC-32 + util_zip_little_endian(t_clen), -- compressed size + util_zip_little_endian(t_len), -- uncompressed size + util_zip_little_endian(utl_raw.length(t_name), 2), -- file name length + hextoraw('0000'), -- extra field length + t_name)); -- file name + IF t_compressed THEN + dbms_lob.copy(p_zipped_blob, t_blob, t_clen, dbms_lob.getlength(p_zipped_blob) + 1, 11); -- compressed content + ELSIF t_clen > 0 THEN + dbms_lob.copy(p_zipped_blob, t_blob, t_clen, dbms_lob.getlength(p_zipped_blob) + 1, 1); -- content + END IF; + IF dbms_lob.istemporary(t_blob) = 1 THEN + dbms_lob.freetemporary(t_blob); + END IF; +END util_zip_add_file; -- Export started at {{START_TIME}} and took {{RUN_TIME}} seconds to finish -- Unmeasured execution time because of system waits, missing log calls or log overhead was {{UNMEASURED_TIME}} seconds -- The used PLEX version was {{PLEX_VERSION}} -- More infos here: [PLEX on GitHub]({{PLEX_URL}}) +-------------------------------------------------------------------------------------------------------------------------------- -' - , - '{{MAIN_FUNCTION}}', - upper(g_ilog.module), - '{{START_TIME}}', - TO_CHAR( - g_ilog.start_time, - 'yyyy-mm-dd hh24:mi:ss' - ), - '{{RUN_TIME}}', - trim(TO_CHAR( - g_ilog.run_time, - '999G990D000' - ) ), - '{{UNMEASURED_TIME}}', - trim(TO_CHAR( - g_ilog.unmeasured_time, - '999G990D000000' - ) ), - '{{PLEX_VERSION}}', - c_plex_version, - '{{PLEX_URL}}', - c_plex_url - ) ); - - util_g_clob_append(' -| Step | Elapsed | Execution | Action | -|-----:|----------:|------------:|:-----------------------------------------------------------------| -' - - ); - FOR i IN 1..g_ilog.data.count LOOP - util_g_clob_append(util_multi_replace( - '| {{STEP}} | {{ELAPSED}} | {{EXECUTION}} | {{ACTION}} |' || c_lf, - '{{STEP}}', - lpad( - TO_CHAR(i), - 4 - ), - '{{ELAPSED}}', - lpad( - trim(TO_CHAR( - g_ilog.data(i).elapsed, - '99990D000' - ) ), - 9 - ), - '{{EXECUTION}}', - lpad( - trim(TO_CHAR( - g_ilog.data(i).execution, - '9990D000000' - ) ), - 11 - ), - '{{ACTION}}', - rpad( - g_ilog.data(i).action, - 64 - ) - ) ); - END LOOP; +-- copyright by Anton Scheffer (MIT license, see https://technology.amis.nl/2010/03/13/utl_compress-gzip-and-zlib/) +PROCEDURE util_zip_finish (p_zipped_blob IN OUT BLOB) IS + t_cnt PLS_INTEGER := 0; + t_offs INTEGER; + t_offs_dir_header INTEGER; + t_offs_end_header INTEGER; + t_comment RAW(32767) := utl_raw.cast_to_raw('Implementation by Anton Scheffer'); +BEGIN + t_offs_dir_header := dbms_lob.getlength(p_zipped_blob); + t_offs := 1; + WHILE dbms_lob.substr(p_zipped_blob, utl_raw.length(c_zip_local_file_header), t_offs) = c_zip_local_file_header + LOOP + t_cnt := t_cnt + 1; + dbms_lob.append( + p_zipped_blob, + utl_raw.concat( + hextoraw('504B0102'), -- central directory file header signature + hextoraw('1400'), -- version 2.0 + dbms_lob.substr(p_zipped_blob, 26, t_offs + 4), + hextoraw('0000'), -- file comment length + hextoraw('0000'), -- disk number where file starts + hextoraw('0000'), -- internal file attributes: 0000 = binary file, 0100 = (ascii)text file + CASE + WHEN dbms_lob.substr( + p_zipped_blob, + 1, + t_offs + 30 + util_zip_blob_to_num(p_zipped_blob, 2, t_offs + 26) - 1) + IN (hextoraw('2F')/*slash*/, hextoraw('5C')/*backslash*/) + THEN hextoraw('10000000') -- a directory/folder + ELSE hextoraw('2000B681') -- a file + END, -- external file attributes + util_zip_little_endian(t_offs - 1), -- relative offset of local file header + dbms_lob.substr( + p_zipped_blob, + util_zip_blob_to_num(p_zipped_blob, 2, t_offs + 26), + t_offs + 30))); -- File name + t_offs := t_offs + 30 + + util_zip_blob_to_num(p_zipped_blob, 4, t_offs + 18) -- compressed size + + util_zip_blob_to_num(p_zipped_blob, 2, t_offs + 26) -- file name length + + util_zip_blob_to_num(p_zipped_blob, 2, t_offs + 28); -- extra field length + END LOOP; + t_offs_end_header := dbms_lob.getlength(p_zipped_blob); + dbms_lob.append( + p_zipped_blob, + utl_raw.concat( + c_zip_end_of_central_directory, -- end of central directory signature + hextoraw('0000'), -- number of this disk + hextoraw('0000'), -- disk where central directory starts + util_zip_little_endian(t_cnt, 2), -- number of central directory records on this disk + util_zip_little_endian(t_cnt, 2), -- total number of central directory records + util_zip_little_endian(t_offs_end_header - t_offs_dir_header), -- size of central directory + util_zip_little_endian(t_offs_dir_header), -- offset of start of central directory, relative to start of archive + util_zip_little_endian(nvl(utl_raw.length(t_comment), 0), 2), -- ZIP file comment length + t_comment)); +END util_zip_finish; + +-------------------------------------------------------------------------------------------------------------------------------- + +FUNCTION util_multi_replace ( + p_source_string VARCHAR2, + p_01_find VARCHAR2 DEFAULT NULL, p_01_replace VARCHAR2 DEFAULT NULL, + p_02_find VARCHAR2 DEFAULT NULL, p_02_replace VARCHAR2 DEFAULT NULL, + p_03_find VARCHAR2 DEFAULT NULL, p_03_replace VARCHAR2 DEFAULT NULL, + p_04_find VARCHAR2 DEFAULT NULL, p_04_replace VARCHAR2 DEFAULT NULL, + p_05_find VARCHAR2 DEFAULT NULL, p_05_replace VARCHAR2 DEFAULT NULL, + p_06_find VARCHAR2 DEFAULT NULL, p_06_replace VARCHAR2 DEFAULT NULL, + p_07_find VARCHAR2 DEFAULT NULL, p_07_replace VARCHAR2 DEFAULT NULL, + p_08_find VARCHAR2 DEFAULT NULL, p_08_replace VARCHAR2 DEFAULT NULL, + p_09_find VARCHAR2 DEFAULT NULL, p_09_replace VARCHAR2 DEFAULT NULL, + p_10_find VARCHAR2 DEFAULT NULL, p_10_replace VARCHAR2 DEFAULT NULL, + p_11_find VARCHAR2 DEFAULT NULL, p_11_replace VARCHAR2 DEFAULT NULL, + p_12_find VARCHAR2 DEFAULT NULL, p_12_replace VARCHAR2 DEFAULT NULL) +RETURN VARCHAR2 IS + v_return VARCHAR2(32767); +BEGIN + v_return := p_source_string; + IF p_01_find IS NOT NULL THEN v_return := replace(v_return, p_01_find, p_01_replace); END IF; + IF p_02_find IS NOT NULL THEN v_return := replace(v_return, p_02_find, p_02_replace); END IF; + IF p_03_find IS NOT NULL THEN v_return := replace(v_return, p_03_find, p_03_replace); END IF; + IF p_04_find IS NOT NULL THEN v_return := replace(v_return, p_04_find, p_04_replace); END IF; + IF p_05_find IS NOT NULL THEN v_return := replace(v_return, p_05_find, p_05_replace); END IF; + IF p_06_find IS NOT NULL THEN v_return := replace(v_return, p_06_find, p_06_replace); END IF; + IF p_07_find IS NOT NULL THEN v_return := replace(v_return, p_07_find, p_07_replace); END IF; + IF p_08_find IS NOT NULL THEN v_return := replace(v_return, p_08_find, p_08_replace); END IF; + IF p_09_find IS NOT NULL THEN v_return := replace(v_return, p_09_find, p_09_replace); END IF; + IF p_10_find IS NOT NULL THEN v_return := replace(v_return, p_10_find, p_10_replace); END IF; + IF p_11_find IS NOT NULL THEN v_return := replace(v_return, p_11_find, p_11_replace); END IF; + IF p_12_find IS NOT NULL THEN v_return := replace(v_return, p_12_find, p_12_replace); END IF; + RETURN v_return; +END util_multi_replace; + +-------------------------------------------------------------------------------------------------------------------------------- + +FUNCTION util_set_build_status_run_only (p_app_export_sql CLOB) RETURN CLOB IS + v_position PLS_INTEGER; +BEGIN + v_position := instr(p_app_export_sql, ',p_exact_substitutions_only'); + RETURN substr(p_app_export_sql, 1, v_position - 1) + || ',p_build_status=>''RUN_ONLY''' + || c_lf + || substr(p_app_export_sql, v_position); +END util_set_build_status_run_only; - END util_g_clob_create_runtime_log; +-------------------------------------------------------------------------------------------------------------------------------- - FUNCTION util_ilog_get_runtime ( - p_start TIMESTAMP, - p_stop TIMESTAMP - ) RETURN NUMBER - IS - BEGIN - RETURN SYSDATE + ( ( p_stop - p_start ) * 86400 ) - SYSDATE; - --sysdate + (interval_difference * 86400) - sysdate - --https://stackoverflow.com/questions/10092032/extracting-the-total-number-of-seconds-from-an-interval-data-type - END util_ilog_get_runtime; - - PROCEDURE util_ilog_init ( - p_module VARCHAR2, - p_include_runtime_log BOOLEAN - ) - IS - BEGIN - g_ilog.module := substr( - p_module, - 1, - c_app_info_length - ); - IF - p_include_runtime_log - THEN - g_ilog.enabled := true; +FUNCTION util_calc_data_timestamp (p_as_of_minutes_ago IN NUMBER) RETURN TIMESTAMP IS + v_return TIMESTAMP; +BEGIN + EXECUTE IMMEDIATE + replace( + q'[SELECT systimestamp - INTERVAL '{{MINUTES}}' MINUTE FROM dual]', + '{{MINUTES}}', + TO_CHAR(p_as_of_minutes_ago)) + INTO v_return; + RETURN v_return; +END util_calc_data_timestamp; + +-------------------------------------------------------------------------------------------------------------------------------- + +PROCEDURE util_setup_dbms_metadata ( + p_pretty IN BOOLEAN DEFAULT true, + p_constraints IN BOOLEAN DEFAULT true, + p_ref_constraints IN BOOLEAN DEFAULT false, + p_partitioning IN BOOLEAN DEFAULT true, + p_tablespace IN BOOLEAN DEFAULT false, + p_storage IN BOOLEAN DEFAULT false, + p_segment_attributes IN BOOLEAN DEFAULT false, + p_sqlterminator IN BOOLEAN DEFAULT true, + p_constraints_as_alter IN BOOLEAN DEFAULT false, + p_emit_schema IN BOOLEAN DEFAULT false) +IS +BEGIN + dbms_metadata.set_transform_param(dbms_metadata.session_transform, 'PRETTY', p_pretty); + dbms_metadata.set_transform_param(dbms_metadata.session_transform, 'CONSTRAINTS', p_constraints); + dbms_metadata.set_transform_param(dbms_metadata.session_transform, 'REF_CONSTRAINTS', p_ref_constraints); + dbms_metadata.set_transform_param(dbms_metadata.session_transform, 'PARTITIONING', p_partitioning); + dbms_metadata.set_transform_param(dbms_metadata.session_transform, 'TABLESPACE', p_tablespace); + dbms_metadata.set_transform_param(dbms_metadata.session_transform, 'STORAGE', p_storage); + dbms_metadata.set_transform_param(dbms_metadata.session_transform, 'SEGMENT_ATTRIBUTES', p_segment_attributes); + dbms_metadata.set_transform_param(dbms_metadata.session_transform, 'SQLTERMINATOR', p_sqlterminator); + dbms_metadata.set_transform_param(dbms_metadata.session_transform, 'CONSTRAINTS_AS_ALTER', p_constraints_as_alter); + dbms_metadata.set_transform_param(dbms_metadata.session_transform, 'EMIT_SCHEMA', p_emit_schema); +END util_setup_dbms_metadata; + +-------------------------------------------------------------------------------------------------------------------------------- + +PROCEDURE util_ensure_unique_file_names (p_export_files IN OUT tab_export_files) IS + v_file_list_lookup tab_file_list_lookup; + v_apex_install_file_id PLS_INTEGER; + v_file_name VARCHAR2(256); + v_extension VARCHAR2(256); + v_base_name VARCHAR2(256); + v_count PLS_INTEGER; +BEGIN + util_log_start('ensure unique file names in collection'); + $if $$apex_installed $then + -- find apex install file + FOR i IN 1..p_export_files.count LOOP + IF p_export_files(i).name = 'scripts/install_frontend_generated_by_apex.sql' THEN + v_apex_install_file_id := i; END IF; - g_ilog.start_time := systimestamp; - g_ilog.stop_time := NULL; - g_ilog.run_time := 0; - g_ilog.measured_time := 0; - g_ilog.unmeasured_time := 0; - g_ilog.data.DELETE; - END util_ilog_init; - - PROCEDURE util_ilog_exit - IS - BEGIN - IF - g_ilog.enabled - THEN - g_ilog.stop_time := systimestamp; - g_ilog.run_time := util_ilog_get_runtime( - g_ilog.start_time, - g_ilog.stop_time - ); - g_ilog.unmeasured_time := g_ilog.run_time - g_ilog.measured_time; - g_ilog.enabled := false; + END LOOP; + $end + FOR i IN 1..p_export_files.count LOOP + v_file_name := p_export_files(i).name; + v_count := 1; + IF instr(v_file_name, '.') > 0 THEN + v_base_name := substr(v_file_name, 1, instr(v_file_name, '.', -1) - 1); + v_extension := substr(v_file_name, instr(v_file_name, '.', -1)); + ELSE + v_base_name := v_file_name; + v_extension := NULL; END IF; - END util_ilog_exit; - - PROCEDURE util_ilog_start ( - p_action VARCHAR2 - ) IS - l_index PLS_INTEGER; - BEGIN - dbms_application_info.set_module( - module_name => g_ilog.module, - action_name => p_action - ); - IF - g_ilog.enabled - THEN - l_index := g_ilog.data.count + 1; - g_ilog.data(l_index).action := substr( - p_action, - 1, - plex.c_app_info_length - ); - - g_ilog.data(l_index).start_time := systimestamp; + WHILE v_file_list_lookup.EXISTS(v_file_name) LOOP + v_count := v_count + 1; + v_file_name := v_base_name || '_' || v_count || v_extension; + END LOOP; + v_file_list_lookup(v_file_name) := i; + -- correct data if needed + IF p_export_files(i).name != v_file_name THEN + -- correct the prompt statement + p_export_files(i).contents := replace( + p_export_files(i).contents, + v_base_name, + v_base_name || '_' || v_count); + -- correct the apex install file + IF v_apex_install_file_id IS NOT NULL THEN + p_export_files(v_apex_install_file_id).contents := regexp_replace( + p_export_files(v_apex_install_file_id).contents, + p_export_files(i).name || '$', + v_file_name, + 1, 2, 'm'); + END IF; + -- correct the file name itself + p_export_files(i).name := v_file_name; END IF; + END LOOP; + util_log_stop; +END util_ensure_unique_file_names; - END util_ilog_start; +-------------------------------------------------------------------------------------------------------------------------------- - PROCEDURE util_ilog_append_action_text ( - p_text VARCHAR2 - ) IS - l_index PLS_INTEGER; +PROCEDURE util_log_init (p_module IN VARCHAR2) IS +BEGIN + g_runlog.module := substr(p_module, 1, c_app_info_length); + g_runlog.start_time := systimestamp; + g_runlog.stop_time := NULL; + g_runlog.run_time := 0; + g_runlog.measured_time := 0; + g_runlog.unmeasured_time := 0; + g_runlog.data.DELETE; + g_errlog.DELETE; +END util_log_init; + +-------------------------------------------------------------------------------------------------------------------------------- + +PROCEDURE util_log_start (p_action IN VARCHAR2) IS + v_index PLS_INTEGER; +BEGIN + dbms_application_info.set_module( + module_name => g_runlog.module, + action_name => p_action); + v_index := g_runlog.data.count + 1; + g_runlog.data(v_index).action := substr(p_action, 1, plex.c_app_info_length); + g_runlog.data(v_index).start_time := systimestamp; +END util_log_start; + +-------------------------------------------------------------------------------------------------------------------------------- + +PROCEDURE util_log_error (p_name VARCHAR2) IS + v_index PLS_INTEGER; + PROCEDURE add_error_to_action IS + v_index PLS_INTEGER; BEGIN - IF - g_ilog.enabled - THEN - l_index := g_ilog.data.count; - g_ilog.data(l_index).action := substr( - g_ilog.data(l_index).action || p_text, - 1, - plex.c_app_info_length - ); + v_index := g_runlog.data.count; + g_runlog.data(v_index).action := substr('ERROR: ' || g_runlog.data(v_index).action, 1, plex.c_app_info_length); + END add_error_to_action; +BEGIN + v_index := g_errlog.count + 1; + g_errlog(v_index).time_stamp := systimestamp; + g_errlog(v_index).file_name := substr(p_name, 1, 255); + g_errlog(v_index).error_text := substr(sqlerrm, 1, 200); + g_errlog(v_index).call_stack := substr(dbms_utility.format_error_backtrace, 1, 500); + add_error_to_action; + util_log_stop; + g_clob := null; +END util_log_error; + +-------------------------------------------------------------------------------------------------------------------------------- + +PROCEDURE util_log_stop IS + v_index PLS_INTEGER; +BEGIN + v_index := g_runlog.data.count; + dbms_application_info.set_module( + module_name => NULL, + action_name => NULL); + g_runlog.data(v_index).stop_time := systimestamp; + g_runlog.data(v_index).elapsed := util_log_get_runtime(g_runlog.start_time, g_runlog.data(v_index).stop_time); + g_runlog.data(v_index).execution := util_log_get_runtime(g_runlog.data(v_index).start_time, g_runlog.data(v_index).stop_time); + g_runlog.measured_time := g_runlog.measured_time + g_runlog.data(v_index).execution; +END util_log_stop; + +-------------------------------------------------------------------------------------------------------------------------------- + +FUNCTION util_log_get_runtime ( + p_start IN TIMESTAMP, + p_stop IN TIMESTAMP) +RETURN NUMBER IS +BEGIN + RETURN SYSDATE + ((p_stop - p_start) * 86400) - SYSDATE; + --sysdate + (interval_difference * 86400) - sysdate + --https://stackoverflow.com/questions/10092032/extracting-the-total-number-of-seconds-from-an-interval-data-type +END util_log_get_runtime; - END IF; - END util_ilog_append_action_text; +-------------------------------------------------------------------------------------------------------------------------------- - PROCEDURE util_ilog_stop IS - l_index PLS_INTEGER; - BEGIN - l_index := g_ilog.data.count; - dbms_application_info.set_module( - module_name => NULL, - action_name => NULL - ); - IF - g_ilog.enabled - THEN - g_ilog.data(l_index).stop_time := systimestamp; - g_ilog.data(l_index).elapsed := util_ilog_get_runtime( - g_ilog.start_time, - g_ilog.data(l_index).stop_time - ); - - g_ilog.data(l_index).execution := util_ilog_get_runtime( - g_ilog.data(l_index).start_time, - g_ilog.data(l_index).stop_time - ); - - g_ilog.measured_time := g_ilog.measured_time + g_ilog.data(l_index).execution; - END IF; +PROCEDURE util_log_calc_runtimes IS +BEGIN + g_runlog.stop_time := systimestamp; + g_runlog.run_time := util_log_get_runtime(g_runlog.start_time, g_runlog.stop_time); + g_runlog.unmeasured_time := g_runlog.run_time - g_runlog.measured_time; +END util_log_calc_runtimes; - END util_ilog_stop; - - - - -- MAIN CODE - - FUNCTION backapp ( - p_app_id IN NUMBER DEFAULT NULL, - p_app_date IN BOOLEAN DEFAULT true, - p_app_public_reports IN BOOLEAN DEFAULT true, - p_app_private_reports IN BOOLEAN DEFAULT false, - p_app_notifications IN BOOLEAN DEFAULT false, - p_app_translations IN BOOLEAN DEFAULT true, - p_app_pkg_app_mapping IN BOOLEAN DEFAULT false, - p_app_original_ids IN BOOLEAN DEFAULT false, - p_app_subscriptions IN BOOLEAN DEFAULT true, - p_app_comments IN BOOLEAN DEFAULT true, - p_app_supporting_objects IN VARCHAR2 DEFAULT NULL, - p_app_include_single_file IN BOOLEAN DEFAULT false, - p_app_build_status_run_only IN BOOLEAN DEFAULT false, - p_include_object_ddl IN BOOLEAN DEFAULT false, - p_object_name_like IN VARCHAR2 DEFAULT NULL, - p_object_name_not_like IN VARCHAR2 DEFAULT NULL, - p_include_data IN BOOLEAN DEFAULT false, - p_data_as_of_minutes_ago IN NUMBER DEFAULT 0, - p_data_max_rows IN NUMBER DEFAULT 1000, - p_data_table_name_like IN VARCHAR2 DEFAULT NULL, - p_data_table_name_not_like IN VARCHAR2 DEFAULT NULL, - p_include_templates IN BOOLEAN DEFAULT true, - p_include_runtime_log IN BOOLEAN DEFAULT true - ) RETURN apex_t_export_files IS - - l_apex_version NUMBER; - l_data_timestamp TIMESTAMP; - l_data_scn NUMBER; - l_file_path VARCHAR2(255); - l_current_user user_objects.object_name%TYPE; - l_app_workspace user_objects.object_name%TYPE; - l_app_owner user_objects.object_name%TYPE; - l_app_alias user_objects.object_name%TYPE; - -- - l_ddl_files rec_ddl_files; - l_contents CLOB; - l_export_files apex_t_export_files; - -- - TYPE obj_cur_typ IS REF CURSOR; - l_cur obj_cur_typ; - l_query VARCHAR2(32767); +-------------------------------------------------------------------------------------------------------------------------------- - PROCEDURE init - IS - BEGIN - util_ilog_init( - p_module => 'plex.backapp' || CASE - WHEN p_app_id IS NOT NULL THEN '(' || TO_CHAR(p_app_id) || ')' - END, - p_include_runtime_log => p_include_runtime_log - ); - END init; - - PROCEDURE check_owner IS - CURSOR cur_owner IS SELECT workspace, - owner, - alias - FROM apex_applications t - WHERE t.application_id = p_app_id; +PROCEDURE util_clob_append (p_content IN VARCHAR2) IS +BEGIN + g_clob_vc_cache := g_clob_vc_cache || p_content; +EXCEPTION + WHEN value_error THEN + IF g_clob IS NULL THEN + g_clob := g_clob_vc_cache; + ELSE + dbms_lob.writeappend(g_clob, length(g_clob_vc_cache), g_clob_vc_cache); + END IF; + g_clob_vc_cache := p_content; +END util_clob_append; - BEGIN - util_ilog_start('check_owner'); - l_current_user := sys_context( - 'USERENV', - 'CURRENT_USER' - ); - IF - p_app_id IS NOT NULL - THEN - OPEN cur_owner; - FETCH cur_owner INTO - l_app_workspace, - l_app_owner, - l_app_alias; - CLOSE cur_owner; - END IF; +-------------------------------------------------------------------------------------------------------------------------------- - IF - p_app_id IS NOT NULL AND l_app_owner IS NULL - THEN - raise_application_error( - -20101, - 'Could not find owner for application - are you sure you provided the right app_id?' - ); - ELSIF p_app_id IS NOT NULL AND l_app_owner != l_current_user THEN - raise_application_error( - -20102, - 'You are not the owner of the app - please login as the owner.' - ); - END IF; +PROCEDURE util_clob_append (p_content IN CLOB) IS +BEGIN + IF p_content IS NOT NULL THEN + util_clob_flush_cache; + IF g_clob IS NULL THEN + g_clob := p_content; + ELSE + dbms_lob.writeappend(g_clob, length(p_content), p_content); + END IF; + END IF; +END util_clob_append; - util_ilog_stop; - END check_owner; +-------------------------------------------------------------------------------------------------------------------------------- - PROCEDURE process_apex_app IS - l_single_file apex_t_export_files; - BEGIN +PROCEDURE util_clob_flush_cache IS +BEGIN + IF g_clob_vc_cache IS NOT NULL THEN + IF g_clob IS NULL THEN + g_clob := g_clob_vc_cache; + ELSE + dbms_lob.writeappend(g_clob, length(g_clob_vc_cache), g_clob_vc_cache); + END IF; + g_clob_vc_cache := NULL; + END IF; +END util_clob_flush_cache; - -- save as individual files - util_ilog_start('app_frontend/APEX_EXPORT:individual_files'); - l_export_files := apex_export.get_application( - p_application_id => p_app_id, - p_split => true, - p_with_date => p_app_date, - p_with_ir_public_reports => p_app_public_reports, - p_with_ir_private_reports => p_app_private_reports, - p_with_ir_notifications => p_app_notifications, - p_with_translations => p_app_translations, - p_with_pkg_app_mapping => p_app_pkg_app_mapping, - p_with_original_ids => p_app_original_ids, - p_with_no_subscriptions => - CASE - WHEN p_app_subscriptions THEN false - ELSE true - END, - p_with_comments => p_app_comments, - p_with_supporting_objects => p_app_supporting_objects - ); - - FOR i IN 1..l_export_files.count LOOP - -- relocate files to own project structure - l_export_files(i).name := replace( - l_export_files(i).name, - 'f' || p_app_id || '/application/', - 'app_frontend/' - ); - -- correct prompts for relocation - - l_export_files(i).contents := replace( - l_export_files(i).contents, - 'prompt --application/', - 'prompt --app_frontend/' - ); - -- special handling for install file - - IF - l_export_files(i).name = 'f' || p_app_id || '/install.sql' - THEN - l_export_files(i).name := 'scripts/install_frontend_generated_by_apex.sql'; - l_export_files(i).contents := '-- DO NOT TOUCH THIS FILE - IT WILL BE OVERWRITTEN ON NEXT PLEX BACKAPP CALL' || c_lf || c_lf - || replace( - replace( - l_export_files(i).contents, - '@application/', - '@../app_frontend/' - ), - 'prompt --install', - 'prompt --install_frontend_generated_by_apex' - ); +-------------------------------------------------------------------------------------------------------------------------------- - END IF; - - -- handle build status RUN_ONLY +PROCEDURE util_clob_add_to_export_files ( + p_export_files IN OUT NOCOPY tab_export_files, + p_name IN VARCHAR2) +IS + v_index PLS_INTEGER; +BEGIN + util_clob_flush_cache; + v_index := p_export_files.count + 1; + p_export_files.extend; + p_export_files(v_index) := rec_export_file( + name => p_name, + contents => g_clob); + g_clob := null; +END util_clob_add_to_export_files; + +-------------------------------------------------------------------------------------------------------------------------------- + +PROCEDURE util_clob_query_to_csv ( + p_query IN VARCHAR2, + p_max_rows IN NUMBER DEFAULT 1000, + p_delimiter IN VARCHAR2 DEFAULT ',', + p_quote_mark IN VARCHAR2 DEFAULT '"', + p_header_prefix IN VARCHAR2 DEFAULT NULL) +IS + -- inspired by Tim Hall: https://oracle-base.com/dba/script?category=miscellaneous&file=csv.sql + v_line_terminator VARCHAR2(2) := c_crlf; -- to be compatible with Excel we need to use crlf here (multiline text uses lf and is wrapped in quotes) + v_cursor PLS_INTEGER; + v_ignore_me PLS_INTEGER; + v_data_count PLS_INTEGER := 0; + v_col_cnt PLS_INTEGER; + v_desc_tab dbms_sql.desc_tab3; + v_buffer_varchar2 VARCHAR2(32767 CHAR); + v_buffer_clob CLOB; + v_buffer_xmltype XMLTYPE; + v_buffer_long LONG; + v_buffer_long_length PLS_INTEGER; + -- numeric type identfiers + c_number CONSTANT PLS_INTEGER := 2; -- FLOAT + c_binary_float CONSTANT PLS_INTEGER := 100; + c_binary_double CONSTANT PLS_INTEGER := 101; + -- string type identfiers + c_char CONSTANT PLS_INTEGER := 96; -- NCHAR + c_varchar2 CONSTANT PLS_INTEGER := 1; -- NVARCHAR2 + c_long CONSTANT PLS_INTEGER := 8; + c_clob CONSTANT PLS_INTEGER := 112; -- NCLOB + c_xmltype CONSTANT PLS_INTEGER := 109; -- ANYDATA, ANYDATASET, ANYTYPE, Object type, VARRAY, Nested table + c_rowid CONSTANT PLS_INTEGER := 11; + c_urowid CONSTANT PLS_INTEGER := 208; + -- binary type identfiers + c_raw CONSTANT PLS_INTEGER := 23; + c_long_raw CONSTANT PLS_INTEGER := 24; + c_blob CONSTANT PLS_INTEGER := 113; + c_bfile CONSTANT PLS_INTEGER := 114; + -- date type identfiers + c_date CONSTANT PLS_INTEGER := 12; + c_timestamp CONSTANT PLS_INTEGER := 180; + c_timestamp_with_time_zone CONSTANT PLS_INTEGER := 181; + c_timestamp_with_local_tz CONSTANT PLS_INTEGER := 231; + -- interval type identfiers + c_interval_year_to_month CONSTANT PLS_INTEGER := 182; + c_interval_day_to_second CONSTANT PLS_INTEGER := 183; + -- cursor type identfiers + c_ref CONSTANT PLS_INTEGER := 111; + c_ref_cursor CONSTANT PLS_INTEGER := 102; -- same identfiers for strong and weak ref cursor + + PROCEDURE escape_varchar2_buffer_for_csv IS + BEGIN + IF v_buffer_varchar2 IS NOT NULL THEN + -- normalize line feeds for Excel + v_buffer_varchar2 := replace( + replace(v_buffer_varchar2, c_crlf, c_lf), + c_cr, + c_lf); + -- if we have the parameter p_force_quotes set to true or the delimiter character or + -- line feeds in the string then we have to wrap the text in quotes marks and escape + -- the quote marks inside the text by double them + IF instr(v_buffer_varchar2, p_delimiter) > 0 OR instr(v_buffer_varchar2, c_lf) > 0 THEN + v_buffer_varchar2 := p_quote_mark + || replace(v_buffer_varchar2, p_quote_mark, p_quote_mark || p_quote_mark) + || p_quote_mark; + END IF; + END IF; + EXCEPTION + WHEN value_error THEN + v_buffer_varchar2 := 'Value skipped - escaped text larger then ' || c_vc2_max_size || ' characters'; + END escape_varchar2_buffer_for_csv; - IF - l_export_files(i).name = 'app_frontend/create_application.sql' AND p_app_build_status_run_only - THEN - l_export_files(i).contents := util_set_build_status_run_only(l_export_files(i).contents); +BEGIN + IF p_query IS NOT NULL THEN + v_cursor := dbms_sql.open_cursor; + dbms_sql.parse( + v_cursor, + regexp_replace(p_query, ';\s*$', NULL), + dbms_sql.native); + -- https://support.esri.com/en/technical-article/000010110 + -- http://bluefrog-oracle.blogspot.com/2011/11/describing-ref-cursor-using-dbmssql-api.html + dbms_sql.describe_columns3(v_cursor, v_col_cnt, v_desc_tab); + FOR i IN 1..v_col_cnt LOOP + IF v_desc_tab(i).col_type = c_clob THEN + dbms_sql.define_column(v_cursor, i, v_buffer_clob); + ELSIF v_desc_tab(i).col_type = c_xmltype THEN + dbms_sql.define_column(v_cursor, i, v_buffer_xmltype); + ELSIF v_desc_tab(i).col_type = c_long THEN + dbms_sql.define_column_long(v_cursor, i); + ELSIF v_desc_tab(i).col_type IN (c_raw, c_long_raw, c_blob, c_bfile) THEN + NULL; --> we ignore binary data types + ELSE + dbms_sql.define_column(v_cursor, i, v_buffer_varchar2, c_vc2_max_size); + END IF; + END LOOP; + v_ignore_me := dbms_sql.execute(v_cursor); + util_clob_append(p_header_prefix); + FOR i IN 1..v_col_cnt LOOP + IF i > 1 THEN + util_clob_append(p_delimiter); + END IF; + v_buffer_varchar2 := v_desc_tab(i).col_name; + escape_varchar2_buffer_for_csv; + util_clob_append(v_buffer_varchar2); + END LOOP; + util_clob_append(v_line_terminator); + -- create data + LOOP + EXIT WHEN dbms_sql.fetch_rows(v_cursor) = 0 OR v_data_count = p_max_rows; + FOR i IN 1..v_col_cnt LOOP + IF i > 1 THEN + util_clob_append(p_delimiter); END IF; - - END LOOP; - - util_ilog_stop; - IF - p_app_include_single_file - THEN - -- save as single file - util_ilog_start('app_frontend/APEX_EXPORT:single_file'); - l_single_file := apex_export.get_application( - p_application_id => p_app_id, - p_split => false, - p_with_date => p_app_date, - p_with_ir_public_reports => p_app_public_reports, - p_with_ir_private_reports => p_app_private_reports, - p_with_ir_notifications => p_app_notifications, - p_with_translations => p_app_translations, - p_with_pkg_app_mapping => p_app_pkg_app_mapping, - p_with_original_ids => p_app_original_ids, - p_with_no_subscriptions => - CASE - WHEN p_app_subscriptions THEN false - ELSE true - END, - p_with_comments => p_app_comments, - p_with_supporting_objects => p_app_supporting_objects - ); - - IF - p_app_build_status_run_only - THEN - l_single_file(1).contents := util_set_build_status_run_only(l_single_file(1).contents); + IF v_desc_tab(i).col_type = c_clob THEN + dbms_sql.column_value(v_cursor, i, v_buffer_clob); + IF length(v_buffer_clob) <= c_vc2_max_size THEN + v_buffer_varchar2 := substr(v_buffer_clob, 1, c_vc2_max_size); + escape_varchar2_buffer_for_csv; + util_clob_append(v_buffer_varchar2); + ELSE + v_buffer_varchar2 := 'CLOB value skipped - larger then ' || c_vc2_max_size || ' characters'; + util_clob_append(v_buffer_varchar2); + END IF; + ELSIF v_desc_tab(i).col_type = c_xmltype THEN + dbms_sql.column_value(v_cursor, i, v_buffer_xmltype); + v_buffer_clob := v_buffer_xmltype.getclobval(); + IF length(v_buffer_clob) <= c_vc2_max_size THEN + v_buffer_varchar2 := substr(v_buffer_clob, 1, c_vc2_max_size); + escape_varchar2_buffer_for_csv; + util_clob_append(v_buffer_varchar2); + ELSE + v_buffer_varchar2 := 'XML value skipped - larger then ' || c_vc2_max_size || ' characters'; + util_clob_append(v_buffer_varchar2); + END IF; + ELSIF v_desc_tab(i).col_type = c_long THEN + dbms_sql.column_value_long(v_cursor, i, c_vc2_max_size, 0, v_buffer_varchar2, v_buffer_long_length); + IF v_buffer_long_length <= c_vc2_max_size THEN + escape_varchar2_buffer_for_csv; + util_clob_append(v_buffer_varchar2); + ELSE + util_clob_append('LONG value skipped - larger then ' || c_vc2_max_size || ' characters'); + END IF; + ELSIF v_desc_tab(i).col_type IN (c_raw, c_long_raw, c_blob, c_bfile) THEN + util_clob_append('Binary data type skipped - not supported for CSV'); + ELSE + dbms_sql.column_value(v_cursor, i, v_buffer_varchar2); + escape_varchar2_buffer_for_csv; + util_clob_append(v_buffer_varchar2); END IF; - - util_export_files_append( - p_export_files => l_export_files, - p_name => 'app_frontend/' || l_single_file(1).name, - p_contents => l_single_file(1).contents - ); - - l_single_file.DELETE; - util_ilog_stop; - END IF; - - END process_apex_app; - - PROCEDURE replace_query_like_expressions ( - p_like_list VARCHAR2, - p_not_like_list VARCHAR2, - p_column_name VARCHAR2 - ) IS - l_expression_table apex_t_varchar2; - BEGIN - -- process filter "like" - l_expression_table := apex_string.split( - p_like_list, - ',' - ); - FOR i IN 1..l_expression_table.count LOOP - l_expression_table(i) := p_column_name || ' like ''' || trim(l_expression_table(i) ) || ''' escape ''\'''; END LOOP; + util_clob_append(v_line_terminator); + v_data_count := v_data_count + 1; + END LOOP; + dbms_sql.close_cursor(v_cursor); + END IF; +END util_clob_query_to_csv; - l_query := replace( - l_query, - '#LIKE_EXPRESSIONS#', - nvl( - apex_string.join( - l_expression_table, - ' or ' - ), - '1 = 1' - ) - ); +-------------------------------------------------------------------------------------------------------------------------------- - -- process filter "not like" +PROCEDURE util_clob_create_error_log (p_export_files IN OUT NOCOPY tab_export_files) IS +BEGIN + IF g_errlog.count > 0 THEN + util_log_start(g_errlog.count || ' error' || CASE WHEN g_errlog.count != 1 THEN 's' END || ' occurred: create error log'); + util_clob_append( + replace('# {{MAIN_FUNCTION}} - Error Log', '{{MAIN_FUNCTION}}', upper(g_runlog.module)) + || c_crlf || c_crlf || c_crlf); + FOR i IN 1..g_errlog.count LOOP + util_clob_append('## ' || g_errlog(i).file_name || c_crlf || c_crlf); + util_clob_append(to_char(g_errlog(i).time_stamp, 'yyyy-mm-dd hh24:mi:ss.ffffff') || ': ' || g_errlog(i).error_text || c_crlf || c_crlf); + util_clob_append('```sql' || c_crlf || g_errlog(i).call_stack || '```' || c_crlf || c_crlf || c_crlf); + END LOOP; + util_clob_add_to_export_files( + p_export_files => p_export_files, + p_name => 'plex_error_log.md'); + util_log_stop; + END IF; +END util_clob_create_error_log; - l_expression_table := apex_string.split( - p_not_like_list, - ',' - ); - FOR i IN 1..l_expression_table.count LOOP - l_expression_table(i) := p_column_name || ' not like ''' || trim(l_expression_table(i) ) || ''' escape ''\'''; - END LOOP; +-------------------------------------------------------------------------------------------------------------------------------- - l_query := replace( - l_query, - '#NOT_LIKE_EXPRESSIONS#', - nvl( - apex_string.join( - l_expression_table, - ' and ' - ), - '1 = 1' - ) - ); +PROCEDURE util_clob_create_runtime_log (p_export_files IN OUT NOCOPY tab_export_files) IS +BEGIN + util_log_calc_runtimes; + util_clob_append(util_multi_replace('# {{MAIN_FUNCTION}} - Runtime Log - --dbms_output.put_line(l_query); +- Export started at {{START_TIME}} and took {{RUN_TIME}} seconds to finish with {{ERRORS}} +- Unmeasured execution time because of system waits, missing log calls or log overhead was {{UNMEASURED_TIME}} seconds +- The used PLEX version was {{PLEX_VERSION}} +- More infos here: [PLEX on GitHub]({{PLEX_URL}}) - END replace_query_like_expressions; +' , + '{{MAIN_FUNCTION}}', upper(g_runlog.module), + '{{START_TIME}}', TO_CHAR(g_runlog.start_time, 'yyyy-mm-dd hh24:mi:ss'), + '{{RUN_TIME}}', trim(TO_CHAR(g_runlog.run_time, '999G990D000')), + '{{UNMEASURED_TIME}}', trim(TO_CHAR(g_runlog.unmeasured_time, '999G990D000')), + '{{PLEX_VERSION}}', c_plex_version, + '{{PLEX_URL}}', c_plex_url, + '{{ERRORS}}', g_errlog.count || ' error' || CASE WHEN g_errlog.count != 1 THEN 's' END)); + util_clob_append(' +| Step | Elapsed | Execution | Action | +|------:|----------:|------------:|:-----------------------------------------------------------------| +' ); + FOR i IN 1..g_runlog.data.count LOOP + util_clob_append(util_multi_replace( + '| {{STEP}} | {{ELAPSED}} | {{EXECUTION}} | {{ACTION}} |' || c_lf, + '{{STEP}}', lpad(TO_CHAR(i), 5), + '{{ELAPSED}}', lpad(trim(TO_CHAR(g_runlog.data(i).elapsed, '99990D000')), 9), + '{{EXECUTION}}', lpad(trim(TO_CHAR(g_runlog.data(i).execution, '9990D000000')), 11), + '{{ACTION}}', rpad(g_runlog.data(i).action, 64))); + END LOOP; + util_clob_add_to_export_files( + p_export_files => p_export_files, + p_name => 'plex_runtime_log.md'); +END util_clob_create_runtime_log; + + + +------------------------------------------------------------------------------------------------------------------------------ +-- MAIN CODE +------------------------------------------------------------------------------------------------------------------------------ + +FUNCTION backapp ( + $if $$apex_installed $then + p_app_id IN NUMBER DEFAULT NULL, + p_app_date IN BOOLEAN DEFAULT true, + p_app_public_reports IN BOOLEAN DEFAULT true, + p_app_private_reports IN BOOLEAN DEFAULT false, + p_app_notifications IN BOOLEAN DEFAULT false, + p_app_translations IN BOOLEAN DEFAULT true, + p_app_pkg_app_mapping IN BOOLEAN DEFAULT false, + p_app_original_ids IN BOOLEAN DEFAULT false, + p_app_subscriptions IN BOOLEAN DEFAULT true, + p_app_comments IN BOOLEAN DEFAULT true, + p_app_supporting_objects IN VARCHAR2 DEFAULT NULL, + p_app_include_single_file IN BOOLEAN DEFAULT false, + p_app_build_status_run_only IN BOOLEAN DEFAULT false, + $end + p_include_object_ddl IN BOOLEAN DEFAULT false, + p_object_type_like IN VARCHAR2 DEFAULT NULL, + p_object_type_not_like IN VARCHAR2 DEFAULT NULL, + p_object_name_like IN VARCHAR2 DEFAULT NULL, + p_object_name_not_like IN VARCHAR2 DEFAULT NULL, + p_include_data IN BOOLEAN DEFAULT false, + p_data_as_of_minutes_ago IN NUMBER DEFAULT 0, + p_data_max_rows IN NUMBER DEFAULT 1000, + p_data_table_name_like IN VARCHAR2 DEFAULT NULL, + p_data_table_name_not_like IN VARCHAR2 DEFAULT NULL, + p_include_templates IN BOOLEAN DEFAULT true, + p_include_runtime_log IN BOOLEAN DEFAULT true, + p_include_error_log IN BOOLEAN DEFAULT true, + p_base_path_backend IN VARCHAR2 DEFAULT 'app_backend', + p_base_path_frontend IN VARCHAR2 DEFAULT 'app_frontend', + p_base_path_data IN VARCHAR2 DEFAULT 'app_data') +RETURN tab_export_files IS + v_apex_version NUMBER; + v_data_timestamp TIMESTAMP; + v_data_scn NUMBER; + v_file_path VARCHAR2(255); + v_current_user user_objects.object_name%TYPE; + v_app_workspace user_objects.object_name%TYPE; + v_app_owner user_objects.object_name%TYPE; + v_app_alias user_objects.object_name%TYPE; + v_ddl_files rec_ddl_files; + v_contents CLOB; + v_export_files tab_export_files; + v_file_list_lookup tab_file_list_lookup; + TYPE obj_cur_typ IS REF CURSOR; + v_cur obj_cur_typ; + v_query VARCHAR2(32767); + + PROCEDURE init IS + BEGIN + util_log_init( + p_module => 'plex.backapp' + $if $$apex_installed $then + || CASE WHEN p_app_id IS NOT NULL THEN '(' || TO_CHAR(p_app_id) || ')' END + $end); + util_log_start('init'); + v_export_files := NEW tab_export_files(); + v_current_user := sys_context('USERENV', 'CURRENT_USER'); + util_log_stop; + END init; + + $if $$apex_installed $then + PROCEDURE check_owner IS + CURSOR cur_owner IS + SELECT workspace, + owner, + alias + FROM apex_applications t + WHERE t.application_id = p_app_id; + BEGIN + util_log_start('check_owner'); + IF p_app_id IS NOT NULL THEN + OPEN cur_owner; + FETCH cur_owner INTO + v_app_workspace, + v_app_owner, + v_app_alias; + CLOSE cur_owner; + END IF; + IF p_app_id IS NOT NULL AND v_app_owner IS NULL THEN + raise_application_error( + -20101, + 'Could not find owner for application - are you sure you provided the right app_id?'); + ELSIF p_app_id IS NOT NULL AND v_app_owner != v_current_user THEN + raise_application_error( + -20102, + 'You are not the owner of the app - please login as the owner.'); + END IF; + util_log_stop; + END check_owner; + $end - PROCEDURE process_user_ddl IS - exception_occured BOOLEAN := false; + $if $$apex_installed $then + PROCEDURE process_apex_app IS + v_apex_files apex_t_export_files; + BEGIN + -- save as individual files + util_log_start(p_base_path_frontend || '/APEX_EXPORT:individual_files'); + v_apex_files := apex_export.get_application( + p_application_id => p_app_id, + p_split => true, + p_with_date => p_app_date, + p_with_ir_public_reports => p_app_public_reports, + p_with_ir_private_reports => p_app_private_reports, + p_with_ir_notifications => p_app_notifications, + p_with_translations => p_app_translations, + p_with_pkg_app_mapping => p_app_pkg_app_mapping, + p_with_original_ids => p_app_original_ids, + p_with_no_subscriptions => CASE WHEN p_app_subscriptions THEN false ELSE true END, + p_with_comments => p_app_comments, + p_with_supporting_objects => p_app_supporting_objects); + FOR i IN 1..v_apex_files.count LOOP + v_export_files.extend; + -- relocate files to own project structure + v_export_files(i).name := replace( + v_apex_files(i).name, + 'f' || p_app_id || '/application/', + p_base_path_frontend || '/'); + -- correct prompts for relocation + v_export_files(i).contents := replace( + v_apex_files(i).contents, + 'prompt --application/', + 'prompt --' || p_base_path_frontend || '/'); + -- special handling for install file + IF v_export_files(i).name = 'f' || p_app_id || '/install.sql' THEN + v_export_files(i).name := 'scripts/install_frontend_generated_by_apex.sql'; + v_export_files(i).contents := '-- DO NOT TOUCH THIS FILE - IT WILL BE OVERWRITTEN ON NEXT PLEX BACKAPP CALL' + || c_lf || c_lf + || util_multi_replace( + v_export_files(i).contents, + '@application/', '@../' || p_base_path_frontend || '/', + 'prompt --install', 'prompt --install_frontend_generated_by_apex'); + END IF; + -- handle build status RUN_ONLY + IF v_export_files(i).name = p_base_path_frontend || '/create_application.sql' AND p_app_build_status_run_only THEN + v_export_files(i).contents := util_set_build_status_run_only(v_export_files(i).contents); + END IF; + v_apex_files.DELETE(i); + END LOOP; + util_log_stop; + -- + IF p_app_include_single_file THEN + -- save as single file + v_apex_files.DELETE; + util_log_start(p_base_path_frontend || '/APEX_EXPORT:single_file'); + v_apex_files := apex_export.get_application( + p_application_id => p_app_id, + p_split => false, + p_with_date => p_app_date, + p_with_ir_public_reports => p_app_public_reports, + p_with_ir_private_reports => p_app_private_reports, + p_with_ir_notifications => p_app_notifications, + p_with_translations => p_app_translations, + p_with_pkg_app_mapping => p_app_pkg_app_mapping, + p_with_original_ids => p_app_original_ids, + p_with_no_subscriptions => CASE WHEN p_app_subscriptions THEN false ELSE true END, + p_with_comments => p_app_comments, + p_with_supporting_objects => p_app_supporting_objects); + IF p_app_build_status_run_only THEN + v_apex_files(1).contents := util_set_build_status_run_only(v_apex_files(1).contents); + END IF; + util_clob_append(v_apex_files(1).contents); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => p_base_path_frontend || '/' || v_apex_files(1).name); + v_apex_files.DELETE; + util_log_stop; + END IF; + END process_apex_app; + $end + + PROCEDURE replace_query_like_expressions ( + p_like_list VARCHAR2, + p_not_like_list VARCHAR2, + p_placeholder_prefix VARCHAR2, + p_column_name VARCHAR2) + IS + v_expression_table tab_vc32k; + BEGIN + -- process filter "like" + v_expression_table := util_split(p_like_list, ','); + FOR i IN 1..v_expression_table.count LOOP + v_expression_table(i) := p_column_name + || ' like ''' + || trim(v_expression_table(i)) + || ''' escape ''\'''; + END LOOP; + v_query := replace( + v_query, + '#' || p_placeholder_prefix || '_LIKE_EXPRESSIONS#', + nvl(util_join(v_expression_table, ' or '), '1 = 1')); + -- process filter "not like" + v_expression_table := util_split(p_not_like_list, ','); + FOR i IN 1..v_expression_table.count LOOP + v_expression_table(i) := p_column_name + || ' not like ''' + || trim(v_expression_table (i)) + || ''' escape ''\'''; + END LOOP; + v_query := replace( + v_query, + '#' || p_placeholder_prefix || '_NOT_LIKE_EXPRESSIONS#', + nvl(util_join(v_expression_table, ' and '), '1 = 1')); + $if $$debug_on $then + dbms_output.put_line(v_query); + $end + END replace_query_like_expressions; + + PROCEDURE process_user_ddl IS + + PROCEDURE process_user IS BEGIN - -- user itself - BEGIN - l_file_path := 'app_backend/_user/' || l_current_user || '.sql'; - util_ilog_start(l_file_path); - l_contents := replace( - q'^ -BEGIN - FOR i IN (SELECT '{{CURRENT_USER}}' AS username FROM dual MINUS SELECT username FROM dba_users) LOOP + v_file_path := p_base_path_backend || '/_user/' || v_current_user || '.sql'; + util_log_start(v_file_path); + util_setup_dbms_metadata(p_sqlterminator => false); + util_clob_append(util_multi_replace(q'^ +BEGIN + FOR i IN (SELECT '{{CURRENT_USER}}' AS username FROM dual + MINUS + SELECT username FROM dba_users) LOOP EXECUTE IMMEDIATE q'[ -------------------------------------------------------------------------------- -^' - , - '{{CURRENT_USER}}', - l_current_user - ); - -- - util_setup_dbms_metadata(p_sqlterminator => false); - BEGIN - l_contents := l_contents || dbms_metadata.get_ddl( - 'USER', - l_current_user - ); - EXCEPTION - WHEN OTHERS THEN - exception_occured := true; - util_ilog_append_action_text(' ' || sqlerrm); - l_contents := l_contents || sqlerrm; - END; - - util_setup_dbms_metadata; - -- - l_contents := l_contents || replace( - q'^ +{{DDL}} -------------------------------------------------------------------------------- ]' END LOOP; END; -{{SLASH}} -^' - , - '{{SLASH}}', - c_slash - ); - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => l_contents - ); - util_ilog_stop; - END; - - -- roles - - BEGIN - l_contents := NULL; - l_file_path := 'app_backend/_user/' || l_current_user || '_roles.sql'; - util_ilog_start(l_file_path); - FOR i IN ( - -- ensure we get no dbms_metadata error when no role privs exists - SELECT DISTINCT username - FROM user_role_privs - ) LOOP - BEGIN - l_contents := l_contents || dbms_metadata.get_granted_ddl( - 'ROLE_GRANT', - l_current_user - ); - EXCEPTION - WHEN OTHERS THEN - exception_occured := true; - util_ilog_append_action_text(' ' || sqlerrm); - l_contents := l_contents || sqlerrm; - END; - END LOOP; - - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => l_contents - ); - util_ilog_stop; - END; - - -- system privileges - - BEGIN - l_contents := NULL; - l_file_path := 'app_backend/_user/' || l_current_user || '_system_privileges.sql'; - util_ilog_start(l_file_path); - FOR i IN ( - -- ensure we get no dbms_metadata error when no sys privs exists - SELECT DISTINCT username - FROM user_sys_privs - ) LOOP - BEGIN - l_contents := l_contents || dbms_metadata.get_granted_ddl( - 'SYSTEM_GRANT', - l_current_user - ); - EXCEPTION - WHEN OTHERS THEN - exception_occured := true; - util_ilog_append_action_text(' ' || sqlerrm); - l_contents := l_contents || sqlerrm; - END; - END LOOP; - - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => l_contents - ); - util_ilog_stop; - END; - - -- object privileges - - BEGIN - l_contents := NULL; - l_file_path := 'app_backend/_user/' || l_current_user || '_object_privileges.sql'; - util_ilog_start(l_file_path); - FOR i IN ( - -- ensure we get no dbms_metadata error when no object grants exists - SELECT DISTINCT grantee - FROM user_tab_privs - WHERE grantee = l_current_user - ) LOOP - BEGIN - l_contents := l_contents || dbms_metadata.get_granted_ddl( - 'OBJECT_GRANT', - l_current_user - ); - EXCEPTION - WHEN OTHERS THEN - exception_occured := true; - util_ilog_append_action_text(' ' || sqlerrm); - l_contents := l_contents || sqlerrm; - END; - END LOOP; - - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => l_contents - ); - util_ilog_stop; - END; +{{/}} +^' , + '{{CURRENT_USER}}', v_current_user, + '{{DDL}}', dbms_metadata.get_ddl('USER', v_current_user), + '{{/}}', c_slash)); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_setup_dbms_metadata; + util_log_stop; + EXCEPTION + WHEN OTHERS THEN + util_setup_dbms_metadata; + util_log_error(v_file_path); + END process_user; - IF - exception_occured - THEN - l_file_path := 'app_backend/_user/_ERROR_on_DDL_creation_occured.md'; - util_ilog_start(l_file_path); - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => ' -ERRORS on User DDL Creation -=========================== - -There were errors during the creation of one or more user DDL files. This -could happen without sufficient rights. Normally these files are created: - -- USERNAME.sql -- USERNAME_roles.sql -- USERNAME_system_privileges.sql -- USERNAME_object_privileges.sql - -Please have a look in these files and check for errors. -' - ); - util_ilog_stop; - END IF; + PROCEDURE process_roles IS + BEGIN + v_file_path := p_base_path_backend || '/_user/' || v_current_user || '_roles.sql'; + util_log_start(v_file_path); + FOR i IN (SELECT DISTINCT username FROM user_role_privs) LOOP + util_clob_append(dbms_metadata.get_granted_ddl( + 'ROLE_GRANT', + v_current_user)); + END LOOP; + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; + EXCEPTION + WHEN OTHERS THEN + util_log_error(v_file_path); + END process_roles; - END process_user_ddl; + PROCEDURE process_system_privileges IS + BEGIN + v_file_path := p_base_path_backend || '/_user/' || v_current_user || '_system_privileges.sql'; + util_log_start(v_file_path); + FOR i IN (SELECT DISTINCT username FROM user_sys_privs) LOOP + util_clob_append(dbms_metadata.get_granted_ddl( + 'SYSTEM_GRANT', + v_current_user)); + END LOOP; + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; + EXCEPTION + WHEN OTHERS THEN + util_log_error(v_file_path); + END process_system_privileges; - PROCEDURE process_object_ddl IS + PROCEDURE process_object_privileges IS + BEGIN + v_file_path := p_base_path_backend || '/_user/' || v_current_user || '_object_privileges.sql'; + util_log_start(v_file_path); + FOR i IN (SELECT DISTINCT grantee FROM user_tab_privs WHERE grantee = v_current_user) LOOP + util_clob_append(dbms_metadata.get_granted_ddl( + 'OBJECT_GRANT', + v_current_user)); + END LOOP; + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; + EXCEPTION + WHEN OTHERS THEN + util_log_error(v_file_path); + END process_object_privileges; - l_contents CLOB; - TYPE obj_rec_typ IS RECORD ( object_type VARCHAR2(128), + BEGIN + process_user; + process_roles; + process_system_privileges; + process_object_privileges; + END process_user_ddl; + + PROCEDURE process_object_ddl IS + TYPE obj_rec_typ IS RECORD ( + object_type VARCHAR2(128), object_name VARCHAR2(256), - file_path VARCHAR2(512) ); - l_rec obj_rec_typ; - BEGIN - util_ilog_start('app_backend/open_objects_cursor'); - l_query := q'^ + file_path VARCHAR2(512)); + v_rec obj_rec_typ; + BEGIN + util_log_start(p_base_path_backend || '/open_objects_cursor'); + v_query := q'^ --https://stackoverflow.com/questions/10886450/how-to-generate-entire-ddl-of-an-oracle-schema-scriptable --https://stackoverflow.com/questions/3235300/oracles-dbms-metadata-get-ddl-for-object-type-job SELECT CASE object_type + --http://psoug.org/reference/dbms_metadata.html + WHEN 'UNIFIED AUDIT POLICY' THEN 'AUDIT_OBJ' + WHEN 'CONSUMER GROUP' THEN 'RMGR_CONSUMER_GROUP' WHEN 'DATABASE LINK' THEN 'DB_LINK' WHEN 'EVALUATION CONTEXT' THEN 'PROCOBJ' WHEN 'JAVA CLASS' THEN 'JAVA_CLASS' @@ -1413,353 +1297,317 @@ SELECT CASE object_type WHEN 'JAVA SOURCE' THEN 'JAVA_SOURCE' WHEN 'JAVA TYPE' THEN 'JAVA_TYPE' WHEN 'JOB' THEN 'PROCOBJ' + WHEN 'JOB CLASS' THEN 'PROCOBJ' WHEN 'MATERIALIZED VIEW' THEN 'MATERIALIZED_VIEW' WHEN 'PACKAGE BODY' THEN 'PACKAGE_BODY' WHEN 'PACKAGE' THEN 'PACKAGE_SPEC' WHEN 'PROGRAM' THEN 'PROCOBJ' WHEN 'QUEUE' THEN 'AQ_QUEUE' + WHEN 'RESOURCE PLAN' THEN 'RMGR_PLAN' WHEN 'RULE SET' THEN 'PROCOBJ' WHEN 'RULE' THEN 'PROCOBJ' WHEN 'SCHEDULE' THEN 'PROCOBJ' + WHEN 'SCHEDULER GROUP' THEN 'PROCOBJ' WHEN 'TYPE BODY' THEN 'TYPE_BODY' WHEN 'TYPE' THEN 'TYPE_SPEC' ELSE object_type END AS object_type, object_name, - 'app_backend/' || - replace( - lower( - CASE - WHEN object_type LIKE '%S' THEN object_type || 'ES' - WHEN object_type LIKE '%EX' THEN regexp_replace(object_type, 'EX$', 'ICES', 1, 0, 'i') - WHEN object_type LIKE '%Y' THEN regexp_replace(object_type, 'Y$', 'IES', 1, 0, 'i') - ELSE object_type || 'S' - END - ), - ' ', - '_' - ) || '/' || object_name || - CASE object_type - WHEN 'FUNCTION' THEN '.fnc' - WHEN 'PACKAGE BODY' THEN '.pkb' - WHEN 'PACKAGE' THEN '.pks' - WHEN 'PROCEDURE' THEN '.prc' - WHEN 'TRIGGER' THEN '.trg' - WHEN 'TYPE BODY' THEN '.tpb' - WHEN 'TYPE' THEN '.tps' - ELSE '.sql' - END AS file_path - FROM user_objects - WHERE 1 = 1 + '{{BASE_PATH_APP_BACKEND}}/' + || replace(lower( + CASE + WHEN object_type LIKE '%S' THEN object_type || 'ES' + WHEN object_type LIKE '%EX' THEN regexp_replace(object_type, 'EX$', 'ICES', 1, 0, 'i') + WHEN object_type LIKE '%Y' THEN regexp_replace(object_type, 'Y$', 'IES', 1, 0, 'i') + ELSE object_type || 'S' + END), ' ', '_') + || '/' || object_name + || CASE object_type + WHEN 'FUNCTION' THEN '.fnc' + WHEN 'PACKAGE BODY' THEN '.pkb' + WHEN 'PACKAGE' THEN '.pks' + WHEN 'PROCEDURE' THEN '.prc' + WHEN 'TRIGGER' THEN '.trg' + WHEN 'TYPE BODY' THEN '.tpb' + WHEN 'TYPE' THEN '.tps' + ELSE '.sql' + END AS file_path + FROM ^' +$if NOT $$debug_on +$then || 'user_objects' +$else || '(SELECT MIN(object_name) AS object_name, object_type FROM user_objects GROUP BY object_type)' +$end || q'^ + WHERE -- ignore invalid object types + object_type NOT IN ('UNDEFINED','DESTINATION','EDITION','JAVA DATA','WINDOW') --These objects are included within other object types: AND object_type NOT IN ('INDEX PARTITION','INDEX SUBPARTITION','LOB','LOB PARTITION','TABLE PARTITION','TABLE SUBPARTITION') --Ignore system-generated types for collection processing: AND NOT (object_type = 'TYPE' AND object_name LIKE 'SYS_PLSQL_%') --Ignore system-generated sequences for identity columns: - AND NOT (object_type = 'SEQUENCE' AND object_name LIKE 'ISEQ$$_%') + AND NOT (object_type = 'SEQUENCE' AND object_name LIKE 'ISEQ$$_%') --Ignore LOB indices, their DDL is part of the table: AND object_name NOT IN (SELECT index_name FROM user_lobs) --Ignore nested tables, their DDL is part of their parent table: AND object_name NOT IN (SELECT table_name FROM user_nested_tables) --Set user specific like filters: - AND (#LIKE_EXPRESSIONS#) - AND (#NOT_LIKE_EXPRESSIONS#) + AND (#TYPE_LIKE_EXPRESSIONS#) + AND (#TYPE_NOT_LIKE_EXPRESSIONS#) + AND (#NAME_LIKE_EXPRESSIONS#) + AND (#NAME_NOT_LIKE_EXPRESSIONS#) ORDER BY object_type, object_name -^' - ; - replace_query_like_expressions( - p_like_list => p_object_name_like, - p_not_like_list => p_object_name_not_like, - p_column_name => 'object_name' - ); - util_setup_dbms_metadata; - OPEN l_cur FOR l_query; - - util_ilog_stop; - LOOP - FETCH l_cur INTO l_rec; - EXIT WHEN l_cur%notfound; - util_ilog_start(l_rec.file_path); - CASE - l_rec.object_type +^' ; + v_query := replace( + v_query, + '{{BASE_PATH_APP_BACKEND}}', + p_base_path_backend); + replace_query_like_expressions( + p_like_list => p_object_type_like, + p_not_like_list => p_object_type_not_like, + p_placeholder_prefix => 'TYPE', + p_column_name => 'object_type'); + replace_query_like_expressions( + p_like_list => p_object_name_like, + p_not_like_list => p_object_name_not_like, + p_placeholder_prefix => 'NAME', + p_column_name => 'object_name'); + util_setup_dbms_metadata; + OPEN v_cur FOR v_query; + util_log_stop; + LOOP + FETCH v_cur INTO v_rec; + EXIT WHEN v_cur%notfound; + BEGIN + util_log_start(v_rec.file_path); + CASE v_rec.object_type WHEN 'SEQUENCE' THEN - l_ddl_files.sequences_(l_ddl_files.sequences_.count + 1) := l_rec.file_path; + v_ddl_files.sequences_(v_ddl_files.sequences_.count + 1) := v_rec.file_path; WHEN 'TABLE' THEN - l_ddl_files.tables_(l_ddl_files.tables_.count + 1) := l_rec.file_path; + v_ddl_files.tables_(v_ddl_files.tables_.count + 1) := v_rec.file_path; WHEN 'INDEX' THEN - l_ddl_files.indices_(l_ddl_files.indices_.count + 1) := l_rec.file_path; + v_ddl_files.indices_(v_ddl_files.indices_.count + 1) := v_rec.file_path; WHEN 'VIEW' THEN - l_ddl_files.views_(l_ddl_files.views_.count + 1) := l_rec.file_path; + v_ddl_files.views_(v_ddl_files.views_.count + 1) := v_rec.file_path; WHEN 'TYPE_SPEC' THEN - l_ddl_files.types_(l_ddl_files.types_.count + 1) := l_rec.file_path; + v_ddl_files.types_(v_ddl_files.types_.count + 1) := v_rec.file_path; WHEN 'TYPE_BODY' THEN - l_ddl_files.type_bodies_(l_ddl_files.type_bodies_.count + 1) := l_rec.file_path; + v_ddl_files.type_bodies_(v_ddl_files.type_bodies_.count + 1) := v_rec.file_path; WHEN 'TRIGGER' THEN - l_ddl_files.triggers_(l_ddl_files.triggers_.count + 1) := l_rec.file_path; + v_ddl_files.triggers_(v_ddl_files.triggers_.count + 1) := v_rec.file_path; WHEN 'FUNCTION' THEN - l_ddl_files.functions_(l_ddl_files.functions_.count + 1) := l_rec.file_path; + v_ddl_files.functions_(v_ddl_files.functions_.count + 1) := v_rec.file_path; WHEN 'PROCEDURE' THEN - l_ddl_files.procedures_(l_ddl_files.procedures_.count + 1) := l_rec.file_path; + v_ddl_files.procedures_(v_ddl_files.procedures_.count + 1) := v_rec.file_path; WHEN 'PACKAGE_SPEC' THEN - l_ddl_files.packages_(l_ddl_files.packages_.count + 1) := l_rec.file_path; + v_ddl_files.packages_(v_ddl_files.packages_.count + 1) := v_rec.file_path; WHEN 'PACKAGE_BODY' THEN - l_ddl_files.package_bodies_(l_ddl_files.package_bodies_.count + 1) := l_rec.file_path; + v_ddl_files.package_bodies_(v_ddl_files.package_bodies_.count + 1) := v_rec.file_path; ELSE - l_ddl_files.other_objects_(l_ddl_files.other_objects_.count + 1) := l_rec.file_path; + v_ddl_files.other_objects_(v_ddl_files.other_objects_.count + 1) := v_rec.file_path; END CASE; - CASE - WHEN l_rec.object_type = 'VIEW' THEN - l_contents := ltrim( - regexp_replace( - regexp_replace( - dbms_metadata.get_ddl( - object_type => l_rec.object_type, - name => l_rec.object_name, - schema => l_current_user - ), - '\(.*\) ', - -- remove additional column list from the compiler - NULL, - 1, - 1 - ), - '^\s*SELECT', - -- remove additional whitespace from the compiler - 'SELECT', - 1, - 1, - 'im' - ), - ' ' || c_lf - ); - - util_export_files_append( - p_export_files => l_export_files, - p_name => l_rec.file_path, - p_contents => l_contents - ); - - WHEN l_rec.object_type IN ( - 'TABLE', - 'INDEX', - 'SEQUENCE' - ) THEN - util_setup_dbms_metadata(p_sqlterminator => false); - l_contents := replace( - q'^ + WHEN v_rec.object_type = 'VIEW' THEN + util_clob_append(ltrim(regexp_replace(regexp_replace( + -- source string + dbms_metadata.get_ddl( + object_type => v_rec.object_type, + name => v_rec.object_name, + schema => v_current_user), + -- regex replace: remove additional column list from the compiler + '\(.*\) ', NULL, 1, 1), + -- regex replace: remove additional whitespace from the compiler + '^\s*SELECT', 'SELECT', 1, 1, 'im'), + -- ltrim: remove leading whitspace + ' ' || c_lf)); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_rec.file_path); + WHEN v_rec.object_type IN ('TABLE', 'INDEX', 'SEQUENCE') THEN + util_setup_dbms_metadata(p_sqlterminator => false); + util_clob_append(replace(q'^ BEGIN - FOR i IN (SELECT '{{OBJECT_NAME}}' AS object_name FROM dual - MINUS + FOR i IN (SELECT '{{OBJECT_NAME}}' AS object_name FROM dual + MINUS SELECT object_name FROM user_objects) LOOP EXECUTE IMMEDIATE q'[ -------------------------------------------------------------------------------- -^' - , +^' , '{{OBJECT_NAME}}', - l_rec.object_name - ) || dbms_metadata.get_ddl( - object_type => l_rec.object_type, - name => l_rec.object_name, - schema => l_current_user - ) || replace( - q'^ + v_rec.object_name) + || dbms_metadata.get_ddl(v_rec.object_type, v_rec.object_name, v_current_user) + || replace(q'^ -------------------------------------------------------------------------------- ]'; END LOOP; END; -{{SLASH}} +{{/}} -- Put your ALTER statements below in the same style as before to ensure that -- the script is restartable. -^' - , - '{{SLASH}}', - c_slash - ); - - util_export_files_append( - p_export_files => l_export_files, - p_name => l_rec.file_path, - p_contents => l_contents - ); - - util_setup_dbms_metadata(p_sqlterminator => true); +^' , + '{{/}}', + c_slash)); + util_setup_dbms_metadata; ELSE - l_contents := dbms_metadata.get_ddl( - object_type => l_rec.object_type, - name => l_rec.object_name, - schema => l_current_user - ); - - util_export_files_append( - p_export_files => l_export_files, - p_name => l_rec.file_path, - p_contents => l_contents - ); - + util_clob_append(dbms_metadata.get_ddl( + object_type => v_rec.object_type, + name => v_rec.object_name, + schema => v_current_user)); END CASE; - - util_ilog_stop; - END LOOP; - - CLOSE l_cur; - END process_object_ddl; - - PROCEDURE process_object_grants IS - - TYPE obj_rec_typ IS RECORD ( grantor VARCHAR2(128), - privilege VARCHAR2(128), - object_name VARCHAR2(256), - file_path VARCHAR2(512) ); - l_rec obj_rec_typ; - BEGIN - util_ilog_start('app_backend/grants:open_cursor'); - l_query := q'^ -SELECT DISTINCT - p.grantor, - p.privilege, - p.table_name as object_name, - 'app_backend/grants/' || p.privilege || '_on_' || p.table_name || '.sql' AS file_path - FROM user_tab_privs p - JOIN user_objects o ON p.table_name = o.object_name - WHERE (#LIKE_EXPRESSIONS#) - AND (#NOT_LIKE_EXPRESSIONS#) - ORDER BY - privilege, - object_name -^' - ; - replace_query_like_expressions( - p_like_list => p_object_name_like, - p_not_like_list => p_object_name_not_like, - p_column_name => 'o.object_name' - ); - OPEN l_cur FOR l_query; - - util_ilog_stop; - LOOP - FETCH l_cur INTO l_rec; - EXIT WHEN l_cur%notfound; - util_ilog_start(l_rec.file_path); - l_contents := dbms_metadata.get_dependent_ddl( + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_rec.file_path); + util_log_stop; + EXCEPTION + WHEN OTHERS THEN + util_setup_dbms_metadata; + util_log_error(v_rec.file_path); + END; + END LOOP; + CLOSE v_cur; + END process_object_ddl; + + PROCEDURE process_object_grants IS + TYPE obj_rec_typ IS RECORD ( + grantor VARCHAR2(128), + privilege VARCHAR2(128), + object_name VARCHAR2(256), + file_path VARCHAR2(512)); + v_rec obj_rec_typ; + BEGIN + util_log_start(p_base_path_backend || '/grants:open_cursor'); + v_query := q'^ +SELECT DISTINCT + p.grantor, + p.privilege, + p.table_name as object_name, + '{{BASE_PATH_APP_BACKEND}}/grants/' || p.privilege || '_on_' || p.table_name || '.sql' AS file_path +FROM user_tab_privs p +JOIN user_objects o ON p.table_name = o.object_name +WHERE (#NAME_LIKE_EXPRESSIONS#) + AND (#NAME_NOT_LIKE_EXPRESSIONS#) +ORDER BY + privilege, + object_name +^' ; + v_query := replace( + v_query, + '{{BASE_PATH_APP_BACKEND}}', + p_base_path_backend); + replace_query_like_expressions( + p_like_list => p_object_name_like, + p_not_like_list => p_object_name_not_like, + p_placeholder_prefix => 'NAME', + p_column_name => 'o.object_name'); + OPEN v_cur FOR v_query; + util_log_stop; + LOOP + FETCH v_cur INTO v_rec; + EXIT WHEN v_cur%notfound; + BEGIN + util_log_start(v_rec.file_path); + util_clob_append(dbms_metadata.get_dependent_ddl( 'OBJECT_GRANT', - l_rec.object_name, - l_rec.grantor - ); - l_ddl_files.grants_(l_ddl_files.grants_.count + 1) := l_rec.file_path; - util_export_files_append( - p_export_files => l_export_files, - p_name => l_rec.file_path, - p_contents => l_contents - ); - - util_ilog_stop; - END LOOP; - - CLOSE l_cur; - END process_object_grants; - - PROCEDURE process_ref_constraints IS + v_rec.object_name, + v_rec.grantor)); + v_ddl_files.grants_(v_ddl_files.grants_.count + 1) := v_rec.file_path; + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_rec.file_path); + util_log_stop; + EXCEPTION + WHEN OTHERS THEN + util_log_error(v_rec.file_path); + END; + END LOOP; + CLOSE v_cur; + END process_object_grants; - TYPE obj_rec_typ IS RECORD ( table_name VARCHAR2(256), + PROCEDURE process_ref_constraints IS + TYPE obj_rec_typ IS RECORD ( + table_name VARCHAR2(256), constraint_name VARCHAR2(256), - file_path VARCHAR2(512) ); - l_rec obj_rec_typ; - BEGIN - util_ilog_start('app_backend/ref_constraints:open_cursor'); - l_query := q'^ + file_path VARCHAR2(512)); + v_rec obj_rec_typ; + BEGIN + util_log_start(p_base_path_backend || '/ref_constraints:open_cursor'); + v_query := q'^ SELECT table_name, - constraint_name, - 'app_backend/ref_constraints/' || constraint_name || '.sql' AS file_path - FROM user_constraints - WHERE constraint_type = 'R' - AND (#LIKE_EXPRESSIONS#) - AND (#NOT_LIKE_EXPRESSIONS#) - ORDER BY - table_name, - constraint_name -^' - ; - replace_query_like_expressions( - p_like_list => p_object_name_like, - p_not_like_list => p_object_name_not_like, - p_column_name => 'table_name' - ); - OPEN l_cur FOR l_query; - - util_ilog_stop; - LOOP - FETCH l_cur INTO l_rec; - EXIT WHEN l_cur%notfound; - util_ilog_start(l_rec.file_path); - util_setup_dbms_metadata(p_sqlterminator => false); - l_contents := replace( - q'^ + constraint_name, + '{{BASE_PATH_APP_BACKEND}}/ref_constraints/' || constraint_name || '.sql' AS file_path +FROM user_constraints +WHERE constraint_type = 'R' + AND (#NAME_LIKE_EXPRESSIONS#) + AND (#NAME_NOT_LIKE_EXPRESSIONS#) +ORDER BY + table_name, + constraint_name +^' ; + v_query := replace( + v_query, + '{{BASE_PATH_APP_BACKEND}}', + p_base_path_backend); + replace_query_like_expressions( + p_like_list => p_object_name_like, + p_not_like_list => p_object_name_not_like, + p_placeholder_prefix => 'NAME', + p_column_name => 'table_name'); + OPEN v_cur FOR v_query; + util_log_stop; + LOOP + FETCH v_cur INTO v_rec; + EXIT WHEN v_cur%notfound; + BEGIN + util_log_start(v_rec.file_path); + util_setup_dbms_metadata(p_sqlterminator => false); + util_clob_append(replace(q'^ BEGIN - FOR i IN (SELECT '{{CONSTRAINT_NAME}}' AS constraint_name FROM dual - MINUS - SELECT constraint_name FROM user_constraints) LOOP - EXECUTE IMMEDIATE q'[ +FOR i IN (SELECT '{{CONSTRAINT_NAME}}' AS constraint_name FROM dual + MINUS + SELECT constraint_name FROM user_constraints) LOOP + EXECUTE IMMEDIATE q'[ -------------------------------------------------------------------------------- -^' - , +^' , '{{CONSTRAINT_NAME}}', - l_rec.constraint_name - ) || dbms_metadata.get_ddl( - 'REF_CONSTRAINT', - l_rec.constraint_name - ) || replace( - q'^ + v_rec.constraint_name) + || dbms_metadata.get_ddl('REF_CONSTRAINT', v_rec.constraint_name) + || replace(q'^ -------------------------------------------------------------------------------- - ]'; - END LOOP; + ]'; +END LOOP; END; -{{SLASH}} -^' - , - '{{SLASH}}', - c_slash - ); - - util_setup_dbms_metadata(p_sqlterminator => true); - l_ddl_files.ref_constraints_(l_ddl_files.ref_constraints_.count + 1) := l_rec.file_path; - util_export_files_append( - p_export_files => l_export_files, - p_name => l_rec.file_path, - p_contents => l_contents - ); - - util_ilog_stop; - END LOOP; - - CLOSE l_cur; - END process_ref_constraints; - - PROCEDURE create_backend_install_file IS +{{/}} +^' , + '{{/}}', + c_slash)); + util_setup_dbms_metadata; + v_ddl_files.ref_constraints_(v_ddl_files.ref_constraints_.count + 1) := v_rec.file_path; + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_rec.file_path); + util_log_stop; + EXCEPTION + WHEN OTHERS THEN + util_setup_dbms_metadata; + util_log_error(v_rec.file_path); + END; + END LOOP; + CLOSE v_cur; + END process_ref_constraints; - FUNCTION get_script_line ( - p_file_path VARCHAR2 - ) RETURN VARCHAR2 - IS - BEGIN - RETURN 'prompt --' || replace( - p_file_path, - '.sql', - NULL - ) || c_lf || '@' || '../' || p_file_path || c_lf || c_lf; - END get_script_line; + PROCEDURE create_backend_install_file IS + FUNCTION get_script_line (p_file_path VARCHAR2) RETURN VARCHAR2 IS BEGIN + RETURN 'prompt --' || replace(p_file_path, '.sql', NULL) + || c_lf || '@' || '../' || p_file_path || c_lf || c_lf; + END get_script_line; - - -- file one - l_file_path := 'scripts/install_backend_generated_by_plex.sql'; - util_ilog_start(l_file_path); - util_g_clob_createtemporary; - util_g_clob_append('/* A T T E N T I O N + BEGIN + v_file_path := 'scripts/install_backend_generated_by_plex.sql'; + util_log_start(v_file_path); + util_clob_append('/* A T T E N T I O N DO NOT TOUCH THIS FILE or set the PLEX.BackApp parameter p_include_object_ddl to false - otherwise your changes would be overwritten on next PLEX.BackApp call. It is recommended to export your object ddl only ones on initial @@ -1771,82 +1619,63 @@ whenever sqlerror exit sql.sqlcode rollback prompt --install_backend_generated_by_plex -'); - - FOR i IN 1..l_ddl_files.sequences_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.sequences_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.tables_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.tables_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.ref_constraints_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.ref_constraints_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.indices_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.indices_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.views_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.views_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.types_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.types_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.type_bodies_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.type_bodies_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.triggers_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.triggers_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.functions_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.functions_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.procedures_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.procedures_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.packages_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.packages_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.package_bodies_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.package_bodies_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.grants_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.grants_(i) ) ); - END LOOP; - - FOR i IN 1..l_ddl_files.other_objects_.count LOOP - util_g_clob_append(get_script_line(l_ddl_files.other_objects_(i) ) ); - END LOOP; - - util_g_clob_flush_cache; - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => g_clob - ); - util_g_clob_freetemporary; - util_ilog_stop; - END create_backend_install_file; - - PROCEDURE process_data IS - - TYPE obj_rec_typ IS RECORD ( table_name VARCHAR2(256), - pk_columns VARCHAR2(4000) ); - l_rec obj_rec_typ; - BEGIN - util_ilog_start('app_data/open_tables_cursor'); - l_query := q'^ +' ); + FOR i IN 1..v_ddl_files.sequences_.count LOOP + util_clob_append(get_script_line(v_ddl_files.sequences_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.tables_.count LOOP + util_clob_append(get_script_line(v_ddl_files.tables_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.ref_constraints_.count LOOP + util_clob_append(get_script_line(v_ddl_files.ref_constraints_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.indices_.count LOOP + util_clob_append(get_script_line(v_ddl_files.indices_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.views_.count LOOP + util_clob_append(get_script_line(v_ddl_files.views_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.types_.count LOOP + util_clob_append(get_script_line(v_ddl_files.types_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.type_bodies_.count LOOP + util_clob_append(get_script_line(v_ddl_files.type_bodies_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.triggers_.count LOOP + util_clob_append(get_script_line(v_ddl_files.triggers_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.functions_.count LOOP + util_clob_append(get_script_line(v_ddl_files.functions_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.procedures_.count LOOP + util_clob_append(get_script_line(v_ddl_files.procedures_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.packages_.count LOOP + util_clob_append(get_script_line(v_ddl_files.packages_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.package_bodies_.count LOOP + util_clob_append(get_script_line(v_ddl_files.package_bodies_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.grants_.count LOOP + util_clob_append(get_script_line(v_ddl_files.grants_(i))); + END LOOP; + FOR i IN 1..v_ddl_files.other_objects_.count LOOP + util_clob_append(get_script_line(v_ddl_files.other_objects_(i))); + END LOOP; + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; + END create_backend_install_file; + + PROCEDURE process_data IS + TYPE obj_rec_typ IS RECORD ( + table_name VARCHAR2(256), + pk_columns VARCHAR2(4000)); + v_rec obj_rec_typ; + BEGIN + util_log_start(p_base_path_data || '/open_tables_cursor'); + v_query := q'^ SELECT table_name, (SELECT LISTAGG(column_name, ', ') WITHIN GROUP(ORDER BY position) FROM user_cons_columns @@ -1857,65 +1686,59 @@ SELECT table_name, ) AS pk_columns FROM user_tables t WHERE table_name IN (SELECT table_name FROM user_tables - MINUS - SELECT table_name FROM user_external_tables) - AND (#LIKE_EXPRESSIONS#) - AND (#NOT_LIKE_EXPRESSIONS#) - ORDER BY + MINUS + SELECT table_name FROM user_external_tables) + AND (#NAME_LIKE_EXPRESSIONS#) + AND (#NAME_NOT_LIKE_EXPRESSIONS#) + ORDER BY table_name -^' - ; - replace_query_like_expressions( - p_like_list => p_data_table_name_like, - p_not_like_list => p_data_table_name_not_like, - p_column_name => 'table_name' - ); - OPEN l_cur FOR l_query; - - util_ilog_stop; - util_ilog_start('app_data/get_scn'); - l_data_timestamp := util_calc_data_timestamp(nvl( - p_data_as_of_minutes_ago, - 0 - ) ); - l_data_scn := timestamp_to_scn(l_data_timestamp); - util_ilog_stop; - LOOP - FETCH l_cur INTO l_rec; - EXIT WHEN l_cur%notfound; - l_file_path := 'app_data/' || l_rec.table_name || '.csv'; - util_ilog_start(l_file_path); - util_g_clob_createtemporary; - util_g_clob_query_to_csv( - p_query => 'SELECT * FROM ' || l_rec.table_name || ' AS OF SCN ' || l_data_scn || CASE - WHEN l_rec.pk_columns IS NOT NULL THEN ' ORDER BY ' || l_rec.pk_columns - ELSE NULL - END, - p_max_rows => p_data_max_rows - ); - - util_g_clob_flush_cache; - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => g_clob - ); - util_g_clob_freetemporary; - util_ilog_stop; - END LOOP; - - CLOSE l_cur; - END process_data; +^' ; + replace_query_like_expressions( + p_like_list => p_data_table_name_like, + p_not_like_list => p_data_table_name_not_like, + p_placeholder_prefix => 'NAME', + p_column_name => 'table_name'); + OPEN v_cur FOR v_query; + util_log_stop; + -- + util_log_start(p_base_path_data || '/get_scn'); + v_data_timestamp := util_calc_data_timestamp(nvl(p_data_as_of_minutes_ago, 0)); + v_data_scn := timestamp_to_scn(v_data_timestamp); + util_log_stop; + LOOP + FETCH v_cur INTO v_rec; + EXIT WHEN v_cur%notfound; + BEGIN + v_file_path := p_base_path_data || '/' || v_rec.table_name || '.csv'; + util_log_start(v_file_path); + util_clob_query_to_csv( + p_query => 'SELECT * FROM ' || v_rec.table_name || ' AS OF SCN ' || v_data_scn || + CASE + WHEN v_rec.pk_columns IS NOT NULL + THEN ' ORDER BY ' || v_rec.pk_columns + ELSE NULL + END, + p_max_rows => p_data_max_rows); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; + EXCEPTION + WHEN OTHERS THEN + util_log_error(v_file_path); + END; + END LOOP; + CLOSE v_cur; + END process_data; - PROCEDURE create_template_files IS - l_file_template VARCHAR2(32767 CHAR); - BEGIN - l_file_template := q'^ -Your Global README File + PROCEDURE create_template_files IS + v_file_template VARCHAR2(32767 CHAR); + BEGIN + v_file_template := q'^Your Global README File ======================= - + It is a good practice to have a README file in the root of your project with -a high level overview of your application. Put the more detailed docs in the +a high level overview of your application. Put the more detailed docs in the docs folder. You can start with a copy of this file. Rename it to README.md and try to use @@ -1929,9 +1752,9 @@ for you: - scripts/install_backend_generated_by_plex.sql - scripts/install_frontend_generated_by_apex.sql -Do not touch these generated install files. They will be overwritten on each +Do not touch these generated install files. They will be overwritten on each plex call. Depending on your call parameters it would be ok to modify the file -install_backend_generated_by_plex - especially when you follow the files first +install_backend_generated_by_plex - especially when you follow the files first approach and export your schema DDL only ones to have a starting point for you repository. @@ -1949,26 +1772,21 @@ If you want to use these files please make a copy into the scripts directory and modify it to your needs. Doing it this way your changes are overwrite save. [Feedback is welcome]({{PLEX_URL}}/issues/new) -^' - ; - l_file_path := 'plex_README.md'; - util_ilog_start(l_file_path); - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => replace( - l_file_template, - '{{PLEX_URL}}', - c_plex_url - ) - ); - - util_ilog_stop; - l_file_template := q'^ -rem Template generated by PLEX version {{PLEX_VERSION}} +^' ; + v_file_path := 'plex_README.md'; + util_log_start(v_file_path); + util_clob_append(replace( + v_file_template, + '{{PLEX_URL}}', + c_plex_url)); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; + v_file_template := q'^rem Template generated by PLEX version {{PLEX_VERSION}} rem More infos here: {{PLEX_URL}} -{{AT}}echo off +{{@}}echo off setlocal set "areyousure=N" @@ -1995,12 +1813,12 @@ set NLS_LANG=AMERICAN_AMERICA.UTF8 set /p "password=Please enter password for %app_schema% [default = oracle]: " || set "password=oracle" echo This is the runlog for %scriptfile% on %app_schema%@%systemrole%(%connection%) > %logfile% echo exit | sqlplus -S %app_schema%/%password%@%connection% ^ - {{AT}}%scriptfile% ^ - %logfile% ^ - %app_id% ^ - %app_alias% ^ - %app_schema% ^ - %app_workspace% +{{@}}%scriptfile% ^ +%logfile% ^ +%app_id% ^ +%app_alias% ^ +%app_schema% ^ +%app_workspace% if %errorlevel% neq 0 echo ERROR: SQL script finished with return code %errorlevel% :-( >> %logfile% if %errorlevel% neq 0 echo ERROR: SQL script finished with return code %errorlevel% :-( @@ -2009,112 +1827,74 @@ if %errorlevel% neq 0 echo ERROR: SQL script finished with return code %errorlev rem Remove "pause" for fully automated setup: pause if %errorlevel% neq 0 exit /b %errorlevel% -^' - ; - l_file_path := 'scripts/templates/1_export_app_from_DEV.bat'; - util_ilog_start(l_file_path); - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => util_multi_replace( - l_file_template, - '{{PLEX_VERSION}}', - c_plex_version, - '{{PLEX_URL}}', - c_plex_url, - '{{SYSTEMROLE}}', - 'DEV', - '{{APP_ID}}', - p_app_id, - '{{APP_ALIAS}}', - l_app_alias, - '{{APP_OWNER}}', - l_app_owner, - '{{APP_WORKSPACE}}', - l_app_workspace, - '{{SCRIPTFILE}}', - 'export_app_custom_code.sql', - '{{LOGFILE}}', - 'logs/export_app_%app_id%_from_%app_schema%_at_%systemrole%_%mydate%_%mytime%.log', - '{{AT}}', - c_at - ) - ); - - util_ilog_stop; - - -- - l_file_path := 'scripts/templates/2_install_app_into_TEST.bat'; - util_ilog_start(l_file_path); - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => util_multi_replace( - l_file_template, - '{{PLEX_VERSION}}', - c_plex_version, - '{{PLEX_URL}}', - c_plex_url, - '{{SYSTEMROLE}}', - 'TEST', - '{{APP_ID}}', - p_app_id, - '{{APP_ALIAS}}', - l_app_alias, - '{{APP_OWNER}}', - l_app_owner, - '{{APP_WORKSPACE}}', - l_app_workspace, - '{{SCRIPTFILE}}', - 'install_app_custom_code.sql', - '{{LOGFILE}}', - 'logs/install_app_%app_id%_into_%app_schema%_at_%systemrole%_%mydate%_%mytime%.log', - '{{AT}}', - c_at - ) - ); - - util_ilog_stop; - - -- - l_file_path := 'scripts/templates/3_install_app_into_PROD.bat'; - util_ilog_start(l_file_path); - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => util_multi_replace( - l_file_template, - '{{PLEX_VERSION}}', - c_plex_version, - '{{PLEX_URL}}', - c_plex_url, - '{{SYSTEMROLE}}', - 'PROD', - '{{APP_ID}}', - p_app_id, - '{{APP_ALIAS}}', - l_app_alias, - '{{APP_OWNER}}', - l_app_owner, - '{{APP_WORKSPACE}}', - l_app_workspace, - '{{SCRIPTFILE}}', - 'install_app_custom_code.sql', - '{{LOGFILE}}', - 'logs/install_app_%app_id%_into_%app_schema%_at_%systemrole%_%mydate%_%mytime%.log', - '{{AT}}', - c_at - ) - ); - - util_ilog_stop; - - -- - l_file_template := q'^ --- Template generated by PLEX version {{PLEX_VERSION}} +^' ; + v_file_path := 'scripts/templates/1_export_app_from_DEV.bat'; + util_log_start(v_file_path); + util_clob_append(util_multi_replace( + v_file_template, + '{{PLEX_VERSION}}', c_plex_version, + '{{PLEX_URL}}', c_plex_url, + '{{SYSTEMROLE}}', 'DEV', + $if $$apex_installed $then + '{{APP_ID}}', p_app_id, + '{{APP_ALIAS}}', v_app_alias, + '{{APP_OWNER}}', v_app_owner, + '{{APP_WORKSPACE}}', v_app_workspace, + $end + '{{SCRIPTFILE}}', 'export_app_custom_code.sql', + '{{LOGFILE}}', 'logs/export_app_%app_id%_from_%app_schema%_at_%systemrole%_%mydate%_%mytime%.log', + '{{@}}', c_at)); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; + + v_file_path := 'scripts/templates/2_install_app_into_TEST.bat'; + util_log_start(v_file_path); + util_clob_append(util_multi_replace( + v_file_template, + '{{PLEX_VERSION}}', c_plex_version, + '{{PLEX_URL}}', c_plex_url, + '{{SYSTEMROLE}}', 'TEST', + $if $$apex_installed $then + '{{APP_ID}}', p_app_id, + '{{APP_ALIAS}}', v_app_alias, + '{{APP_OWNER}}', v_app_owner, + '{{APP_WORKSPACE}}', v_app_workspace, + $end + '{{SCRIPTFILE}}', 'install_app_custom_code.sql', + '{{LOGFILE}}', 'logs/install_app_%app_id%_into_%app_schema%_at_%systemrole%_%mydate%_%mytime%.log', + '{{@}}', c_at)); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; + + v_file_path := 'scripts/templates/3_install_app_into_PROD.bat'; + util_log_start(v_file_path); + util_clob_append(util_multi_replace( + v_file_template, + '{{PLEX_VERSION}}', c_plex_version, + '{{PLEX_URL}}', c_plex_url, + '{{SYSTEMROLE}}', 'PROD', + $if $$apex_installed $then + '{{APP_ID}}', p_app_id, + '{{APP_ALIAS}}', v_app_alias, + '{{APP_OWNER}}', v_app_owner, + '{{APP_WORKSPACE}}', v_app_workspace, + $end + '{{SCRIPTFILE}}', 'install_app_custom_code.sql', + '{{LOGFILE}}', 'logs/install_app_%app_id%_into_%app_schema%_at_%systemrole%_%mydate%_%mytime%.log', + '{{@}}', c_at)); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; + + v_file_template := q'^-- Template generated by PLEX version {{PLEX_VERSION}} -- More infos here: {{PLEX_URL}} -set verify off feedback off heading off +set verify off feedback off heading off set trimout on trimspool on pagesize 0 linesize 5000 long 100000000 longchunksize 32767 whenever sqlerror exit sql.sqlcode rollback -- whenever oserror exit failure rollback @@ -2124,13 +1904,13 @@ variable app_id varchar2(100) variable app_alias varchar2(100) variable app_schema varchar2(100) variable app_workspace varchar2(100) -begin +BEGIN :app_id := &2; :app_alias := '&3'; :app_schema := '&4'; :app_workspace := '&5'; -end; -{{SLASH}} +END; +{{/}} prompt @@ -2138,68 +1918,76 @@ prompt Start Export prompt ========================================================================= prompt Create global temporary table temp_export_files if not exist BEGIN - FOR i IN (SELECT 'TEMP_EXPORT_FILES' AS object_name FROM dual - MINUS + FOR i IN (SELECT 'TEMP_EXPORT_FILES' AS object_name FROM dual + MINUS SELECT object_name FROM user_objects) LOOP EXECUTE IMMEDIATE ' -------------------------------------------------------------------------------- CREATE GLOBAL TEMPORARY TABLE temp_export_files ( - name VARCHAR2(255), - contents CLOB -) ON COMMIT DELETE ROWS + name VARCHAR2(255), + contents CLOB) +ON COMMIT DELETE ROWS -------------------------------------------------------------------------------- '; END LOOP; END; -{{SLASH}} +{{/}} prompt Do the app export, relocate files and save to temporary table prompt ATTENTION: Depending on your options this could take some time ... DECLARE - l_files apex_t_export_files; + v_files tab_export_files; BEGIN - l_files := plex.backapp ( - -- These are the defaults - align it to your needs: - p_app_id => :app_id, - p_app_date => true, - p_app_public_reports => true, - p_app_private_reports => false, - p_app_notifications => false, - p_app_translations => true, - p_app_pkg_app_mapping => false, - p_app_original_ids => true, - p_app_subscriptions => true, - p_app_comments => true, - p_app_supporting_objects => null, - p_app_include_single_file => false, - p_app_build_status_run_only => false, - - p_include_object_ddl => true, - p_object_name_like => null, - p_object_name_not_like => null, - - p_include_data => false, - p_data_as_of_minutes_ago => 0, - p_data_max_rows => 1000, - p_data_table_name_like => null, - p_data_table_name_not_like => null, - - p_include_templates => true, - p_include_runtime_log => true ); + v_files := plex.backapp( + -- These are the defaults - align it to your needs:^'; + $if $$apex_installed $then + v_file_template := v_file_template || q'^ + p_app_id => :app_id, + p_app_date => true, + p_app_public_reports => true, + p_app_private_reports => false, + p_app_notifications => false, + p_app_translations => true, + p_app_pkg_app_mapping => false, + p_app_original_ids => false, + p_app_subscriptions => true, + p_app_comments => true, + p_app_supporting_objects => null, + p_app_include_single_file => false, + p_app_build_status_run_only => false,^'; + $end + v_file_template := v_file_template || q'^ + p_include_object_ddl => true, + p_object_type_like => null, + p_object_type_not_like => null, + p_object_name_like => null, + p_object_name_not_like => null, + + p_include_data => false, + p_data_as_of_minutes_ago => 0, + p_data_max_rows => 1000, + p_data_table_name_like => null, + p_data_table_name_not_like => null, + + p_include_templates => true, + p_include_runtime_log => true, + p_include_error_log => true, + p_base_path_backend => 'app_backend', + p_base_path_frontend => 'app_frontend', + p_base_path_data => 'app_data'); -- relocate files to own project structure, we are inside the scripts folder - FOR i IN 1..l_files.count LOOP - l_files(i).name := '../' || l_files(i).name; + FOR i IN 1..v_files.count LOOP + v_files(i).name := '../' || v_files(i).name; END LOOP; - - FORALL i IN 1..l_files.count + + FORALL i IN 1..v_files.count INSERT INTO temp_export_files VALUES ( - l_files(i).name, - l_files(i).contents - ); + v_files(i).name, + v_files(i).contents); END; -{{SLASH}} +{{/}} prompt Create intermediate script file to unload the table contents into files @@ -2208,19 +1996,17 @@ set termout off serveroutput on spool "logs/temp_export_files.sql" BEGIN -- create host commands for the needed directories (spool does not create missing directories) - FOR i IN ( - WITH t AS ( - SELECT regexp_substr(name, '^((\w|\.)+\/)+' /*path without file name*/) AS dir - FROM temp_export_files - ) - SELECT DISTINCT - dir, - -- This is for Windows to create a directory and suppress warning if it exist. - -- Align the command to your operating system: - 'host mkdir "' || replace(dir,'/','\') || '" 2>NUL' AS mkdir - FROM t - WHERE dir IS NOT NULL - ) LOOP + FOR i IN (WITH t AS (SELECT regexp_substr( + name, + '^((\w|\.)+\/)+' /*path without file name*/) AS dir + FROM temp_export_files) + SELECT DISTINCT + dir, + -- This is for Windows to create a directory and suppress warning if it exist. + -- Align the command to your operating system: + 'host mkdir "' || replace(dir,'/','\') || '" 2>NUL' AS mkdir + FROM t + WHERE dir IS NOT NULL) LOOP dbms_output.put_line('set termout on'); dbms_output.put_line('spool "&logfile." append'); dbms_output.put_line('prompt --create directory if not exist: ' || i.dir); @@ -2229,7 +2015,6 @@ BEGIN dbms_output.put_line(i.mkdir); dbms_output.put_line('-----'); END LOOP; - -- create the spool calls for unload the files FOR i IN (SELECT * FROM temp_export_files) LOOP dbms_output.put_line('set termout on'); @@ -2242,9 +2027,8 @@ BEGIN dbms_output.put_line('spool off'); dbms_output.put_line('-----'); END LOOP; - END; -{{SLASH}} +{{/}} spool off set termout on serveroutput off spool "&logfile." append @@ -2252,42 +2036,33 @@ spool "&logfile." append prompt Call the intermediate script file to save the files spool off -{{AT}}logs/temp_export_files.sql +{{@}}logs/temp_export_files.sql set termout on serveroutput off spool "&logfile." append + prompt Delete files from the global temporary table COMMIT; prompt ========================================================================= -prompt Export DONE :-) +prompt Export DONE :-) prompt -^' - ; - l_file_path := 'scripts/templates/export_app_custom_code.sql'; - util_ilog_start(l_file_path); - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => util_multi_replace( - l_file_template, - '{{PLEX_VERSION}}', - c_plex_version, - '{{PLEX_URL}}', - c_plex_url, - '{{SLASH}}', - '/', - '{{AT}}', - c_at - ) - ); - - util_ilog_stop; - - -- - l_file_template := q'^ --- Template generated by PLEX version {{PLEX_VERSION}} +^' ; + v_file_path := 'scripts/templates/export_app_custom_code.sql'; + util_log_start(v_file_path); + util_clob_append(util_multi_replace( + v_file_template, + '{{PLEX_VERSION}}', c_plex_version, + '{{PLEX_URL}}', c_plex_url, + '{{/}}', c_slash, + '{{@}}', c_at)); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; + -- + v_file_template := q'^-- Template generated by PLEX version {{PLEX_VERSION}} -- More infos here: {{PLEX_URL}} set define on verify off feedback off @@ -2299,344 +2074,283 @@ variable app_id varchar2(100) variable app_alias varchar2(100) variable app_schema varchar2(100) variable app_workspace varchar2(100) -begin +BEGIN :app_id := &2; :app_alias := '&3'; :app_schema := '&4'; :app_workspace := '&5'; -end; -{{SLASH}} +END; +{{/}} set define off -prompt +prompt prompt Start Installation prompt ========================================================================= prompt Start backend installation - prompt Call PLEX backend install script -{{AT}}install_backend_generated_by_plex.sql - +{{@}}install_backend_generated_by_plex.sql prompt Compile invalid objects BEGIN dbms_utility.compile_schema( - schema => user, - compile_all => false, - reuse_settings => true - ); + schema => user, + compile_all => false, + reuse_settings => true); END; -{{SLASH}} - +{{/}} prompt Check invalid objects DECLARE v_count PLS_INTEGER; v_objects VARCHAR2(4000); BEGIN - SELECT COUNT(*), - listagg(object_name, - ', ') within GROUP(ORDER BY object_name) - INTO v_count, - v_objects + SELECT COUNT(*), chr(10) || + listagg('- ' || object_name || ' (' || object_type || ')', chr(10)) within GROUP(ORDER BY object_name) + INTO v_count, v_objects FROM user_objects WHERE status = 'INVALID'; - IF v_count > 0 - THEN - raise_application_error(-20000, - 'Found ' || v_count || ' invalid object' || CASE - WHEN v_count > 1 THEN - 's' - END || ' :-( ' || v_objects); + IF v_count > 0 THEN + raise_application_error(-20000, chr(10) || chr(10) || + 'Found ' || v_count || ' invalid object' || CASE WHEN v_count > 1 THEN 's' END || + ' :-( ' || chr(10) || '=============================' || v_objects || chr(10) || chr(10) ); END IF; END; -{{SLASH}} - +{{/}} prompt Start frontend installation BEGIN - apex_application_install.set_workspace_id( APEX_UTIL.find_security_group_id( :app_workspace ) ); - apex_application_install.set_application_alias( :app_alias ); - apex_application_install.set_application_id( :app_id ); - apex_application_install.set_schema( :app_schema ); - apex_application_install.generate_offset; + apex_application_install.set_workspace_id(APEX_UTIL.find_security_group_id(:app_workspace)); + apex_application_install.set_application_alias(:app_alias); + apex_application_install.set_application_id(:app_id); + apex_application_install.set_schema(:app_schema); + apex_application_install.generate_offset; END; -{{SLASH}} - +{{/}} prompt Call APEX frontend install script -{{AT}}install_frontend_generated_by_APEX.sql - +{{@}}install_frontend_generated_by_APEX.sql prompt ========================================================================= prompt Installation DONE :-) prompt -^' - ; - l_file_path := 'scripts/templates/install_app_custom_code.sql'; - util_ilog_start(l_file_path); - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => util_multi_replace( - l_file_template, - '{{PLEX_VERSION}}', - c_plex_version, - '{{PLEX_URL}}', - c_plex_url, - '{{SLASH}}', - '/', - '{{AT}}', - c_at - ) - ); - - util_ilog_stop; - END create_template_files; - - -- - - PROCEDURE create_directory_keepers IS - l_the_point VARCHAR2(30) := '. < this is the point ;-)'; - BEGIN - l_file_path := 'docs/_save_your_docs_here.txt'; - util_ilog_start(l_file_path); - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => l_the_point - ); - util_ilog_stop; - - -- - l_file_path := 'scripts/logs/_spool_your_script_logs_here.txt'; - util_ilog_start(l_file_path); - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => l_the_point - ); - util_ilog_stop; - - -- - l_file_path := 'tests/_save_your_tests_here.txt'; - util_ilog_start(l_file_path); - util_export_files_append( - p_export_files => l_export_files, - p_name => l_file_path, - p_contents => l_the_point - ); - util_ilog_stop; - END create_directory_keepers; - - PROCEDURE finish - IS - BEGIN - util_ilog_exit; - -- - IF - p_include_runtime_log - THEN - util_g_clob_createtemporary; - util_g_clob_create_runtime_log; - util_g_clob_flush_cache; - util_export_files_append( - p_export_files => l_export_files, - p_name => 'plex_backapp_log.md', - p_contents => g_clob - ); - util_g_clob_freetemporary; - END IF; - - END; - +^' ; + v_file_path := 'scripts/templates/install_app_custom_code.sql'; + util_log_start(v_file_path); + util_clob_append(util_multi_replace( + v_file_template, + '{{PLEX_VERSION}}', c_plex_version, + '{{PLEX_URL}}', c_plex_url, + '{{/}}', c_slash, + '{{@}}', c_at)); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; + END create_template_files; + + PROCEDURE create_directory_keepers IS + v_the_point VARCHAR2(30) := '. < this is the point ;-)'; BEGIN - init; - check_owner; + v_file_path := 'docs/_save_your_docs_here.txt'; + util_log_start(v_file_path); + util_clob_append(v_the_point); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; -- - IF - p_app_id IS NOT NULL - THEN - process_apex_app; - ELSE - l_export_files := NEW apex_t_export_files (); - END IF; + v_file_path := 'scripts/logs/_spool_your_script_logs_here.txt'; + util_log_start(v_file_path); + util_clob_append(v_the_point); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; -- - - IF - p_include_object_ddl - THEN - process_user_ddl; - process_object_ddl; - process_object_grants; - process_ref_constraints; - create_backend_install_file; + v_file_path := 'tests/_save_your_tests_here.txt'; + util_log_start(v_file_path); + util_clob_append(v_the_point); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => v_file_path); + util_log_stop; + END create_directory_keepers; + + PROCEDURE finish IS + BEGIN + util_ensure_unique_file_names(v_export_files); + IF p_include_error_log THEN + util_clob_create_error_log(v_export_files); END IF; - -- - IF - p_include_data - THEN - process_data; + IF p_include_runtime_log THEN + util_clob_create_runtime_log(v_export_files); END IF; - -- - IF - p_include_templates - THEN - create_template_files; - END IF; - -- + END finish; + +BEGIN + init; + $if $$apex_installed $then + check_owner; + IF p_app_id IS NOT NULL THEN + process_apex_app; + END IF; + $end + IF p_include_object_ddl THEN + process_user_ddl; + process_object_ddl; + $if NOT $$debug_on $then + -- excluded in debug mode (potential long running object types) + process_object_grants; + process_ref_constraints; + $end + create_backend_install_file; + END IF; + IF p_include_data THEN + process_data; + END IF; + IF p_include_templates THEN + create_template_files; create_directory_keepers; - -- - finish; - -- - RETURN l_export_files; - END backapp; - - PROCEDURE add_query ( - p_query VARCHAR2, - p_file_name VARCHAR2, - p_max_rows NUMBER DEFAULT 1000 - ) IS - l_index PLS_INTEGER; + END IF; + finish; + RETURN v_export_files; +END backapp; + +-------------------------------------------------------------------------------------------------------------------------------- + +PROCEDURE add_query ( + p_query VARCHAR2, + p_file_name VARCHAR2, + p_max_rows NUMBER DEFAULT 1000) +IS + v_index PLS_INTEGER; +BEGIN + v_index := g_queries.count + 1; + g_queries(v_index).query := p_query; + g_queries(v_index).file_name := p_file_name; + g_queries(v_index).max_rows := p_max_rows; +END add_query; + +-------------------------------------------------------------------------------------------------------------------------------- + +FUNCTION queries_to_csv ( + p_delimiter IN VARCHAR2 DEFAULT ',', + p_quote_mark IN VARCHAR2 DEFAULT '"', + p_header_prefix IN VARCHAR2 DEFAULT NULL, + p_include_runtime_log IN BOOLEAN DEFAULT true, + p_include_error_log IN BOOLEAN DEFAULT true) +RETURN tab_export_files IS + v_export_files tab_export_files; + + PROCEDURE init IS BEGIN - l_index := g_queries.count + 1; - g_queries(l_index).query := p_query; - g_queries(l_index).file_name := p_file_name; - g_queries(l_index).max_rows := p_max_rows; - END add_query; - - FUNCTION queries_to_csv ( - p_delimiter IN VARCHAR2 DEFAULT ',', - p_quote_mark IN VARCHAR2 DEFAULT '"', - p_header_prefix IN VARCHAR2 DEFAULT NULL, - p_include_runtime_log IN BOOLEAN DEFAULT true - ) RETURN apex_t_export_files IS - - l_export_files apex_t_export_files; - - PROCEDURE init - IS - BEGIN - l_export_files := NEW apex_t_export_files (); - IF - g_queries.count = 0 - THEN - raise_application_error( - -20201, - 'You need first to add queries by using plex.add_query. Calling plex.queries_to_csv clears the global queries array for subsequent processing.' - ); - END IF; - util_ilog_init( - p_module => 'plex.queries_to_csv', - p_include_runtime_log => p_include_runtime_log - ); - END init; - - PROCEDURE process_queries - IS - BEGIN - FOR i IN g_queries.first..g_queries.last LOOP - util_ilog_start('process_query:' || TO_CHAR(i) || ':' || g_queries(i).file_name); - - util_g_clob_createtemporary; - util_g_clob_query_to_csv( - p_query => g_queries(i).query, - p_max_rows => g_queries(i).max_rows, - p_delimiter => p_delimiter, - p_quote_mark => p_quote_mark, - p_header_prefix => p_header_prefix - ); - - util_g_clob_flush_cache; - util_export_files_append( - p_export_files => l_export_files, - p_name => g_queries(i).file_name || '.csv', - p_contents => g_clob - ); - - util_g_clob_freetemporary; - util_ilog_stop; - END LOOP; - END process_queries; - - PROCEDURE finish - IS - BEGIN - g_queries.DELETE; - util_ilog_exit; - IF - p_include_runtime_log - THEN - util_g_clob_createtemporary; - util_g_clob_create_runtime_log; - util_g_clob_flush_cache; - util_export_files_append( - p_export_files => l_export_files, - p_name => 'plex_queries_to_csv_log.md', - p_contents => g_clob - ); - util_g_clob_freetemporary; - END IF; - - END finish; + IF g_queries.count = 0 THEN + raise_application_error( + -20201, + 'You need first to add queries by using plex.add_query. Calling plex.queries_to_csv clears the global queries array for subsequent processing.'); + END IF; + util_log_init(p_module => 'plex.queries_to_csv'); + util_log_start('init'); + v_export_files := NEW tab_export_files(); + util_log_stop; + END init; + PROCEDURE process_queries IS BEGIN - init; - process_queries; - finish; - RETURN l_export_files; - END queries_to_csv; - - FUNCTION to_zip ( - p_file_collection IN apex_t_export_files - ) RETURN BLOB IS - l_zip BLOB; - BEGIN - dbms_lob.createtemporary( - l_zip, - true - ); - FOR i IN 1..p_file_collection.count LOOP - apex_zip.add_file( - p_zipped_blob => l_zip, - p_file_name => p_file_collection(i).name, - p_content => util_clob_to_blob(p_file_collection(i).contents) - ); + FOR i IN g_queries.first..g_queries.last LOOP + BEGIN + util_log_start('process_query ' || TO_CHAR(i) || ': ' || g_queries(i).file_name); + util_clob_query_to_csv( + p_query => g_queries(i).query, + p_max_rows => g_queries(i).max_rows, + p_delimiter => p_delimiter, + p_quote_mark => p_quote_mark, + p_header_prefix => p_header_prefix); + util_clob_add_to_export_files( + p_export_files => v_export_files, + p_name => g_queries(i).file_name || '.csv'); + util_log_stop; + EXCEPTION + WHEN OTHERS THEN + util_log_error(g_queries(i).file_name); + END; END LOOP; + END process_queries; - apex_zip.finish(l_zip); - RETURN l_zip; - END to_zip; - - FUNCTION view_runtime_log RETURN tab_runtime_log - PIPELINED - IS - v_return rec_runtime_log; + PROCEDURE finish IS BEGIN - v_return.overall_start_time := g_ilog.start_time; - v_return.overall_run_time := round( - g_ilog.run_time, - 3 - ); - FOR i IN 1..g_ilog.data.count LOOP - v_return.step := i; - v_return.elapsed := round( - g_ilog.data(i).elapsed, - 3 - ); - - v_return.execution := round( - g_ilog.data(i).execution, - 6 - ); - - v_return.module := g_ilog.module; - v_return.action := g_ilog.data(i).action; - PIPE ROW ( v_return ); - END LOOP; + g_queries.DELETE; + util_ensure_unique_file_names(v_export_files); + IF p_include_error_log THEN + util_clob_create_error_log(v_export_files); + END IF; + IF p_include_runtime_log THEN + util_clob_create_runtime_log(v_export_files); + END IF; + END finish; + +BEGIN + init; + process_queries; + finish; + RETURN v_export_files; +EXCEPTION + WHEN others THEN + g_queries.DELETE; +END queries_to_csv; + +-------------------------------------------------------------------------------------------------------------------------------- + +FUNCTION to_zip (p_file_collection IN tab_export_files) RETURN BLOB IS + v_zip BLOB; +BEGIN + dbms_lob.createtemporary(v_zip, true); + util_log_start('post processing with to_zip: ' || p_file_collection.count || ' files'); + FOR i IN 1..p_file_collection.count LOOP + util_zip_add_file( + p_zipped_blob => v_zip, + p_name => p_file_collection(i).name, + p_content => util_clob_to_blob(p_file_collection(i).contents)); + END LOOP; + util_zip_finish(v_zip); + util_log_stop; + util_log_calc_runtimes; + RETURN v_zip; +END to_zip; + +-------------------------------------------------------------------------------------------------------------------------------- + +FUNCTION view_error_log RETURN tab_error_log PIPELINED IS +BEGIN + FOR i IN 1..g_errlog.count LOOP + PIPE ROW (g_errlog(i)); + END LOOP; +END view_error_log; - END view_runtime_log; +-------------------------------------------------------------------------------------------------------------------------------- +FUNCTION view_runtime_log RETURN tab_runtime_log PIPELINED IS + v_return rec_runtime_log; +BEGIN + v_return.overall_start_time := g_runlog.start_time; + v_return.overall_run_time := round(g_runlog.run_time, 3); + FOR i IN 1..g_runlog.data.count LOOP + v_return.step := i; + v_return.elapsed := round(g_runlog.data(i).elapsed, 3); + v_return.execution := round(g_runlog.data(i).execution, 6); + v_return.module := g_runlog.module; + v_return.action := g_runlog.data(i).action; + PIPE ROW (v_return); + END LOOP; +END view_runtime_log; + +-------------------------------------------------------------------------------------------------------------------------------- + +BEGIN + IF dbms_lob.istemporary(g_clob) = 0 THEN + dbms_lob.createtemporary(g_clob, true); + END IF; END plex; / \ No newline at end of file diff --git a/PLEX.pks b/PLEX.pks index 435cc3f..74236bd 100755 --- a/PLEX.pks +++ b/PLEX.pks @@ -1,55 +1,99 @@ CREATE OR REPLACE PACKAGE PLEX AUTHID current_user IS c_plex_name CONSTANT VARCHAR2(30 CHAR) := 'PLEX - PL/SQL Export Utilities'; -c_plex_version CONSTANT VARCHAR2(10 CHAR) := '1.2.1'; +c_plex_version CONSTANT VARCHAR2(10 CHAR) := '2.0.0'; c_plex_url CONSTANT VARCHAR2(40 CHAR) := 'https://github.com/ogobrecht/plex'; c_plex_license CONSTANT VARCHAR2(10 CHAR) := 'MIT'; c_plex_license_url CONSTANT VARCHAR2(60 CHAR) := 'https://github.com/ogobrecht/plex/blob/master/LICENSE.txt'; c_plex_author CONSTANT VARCHAR2(20 CHAR) := 'Ottmar Gobrecht'; /** PL/SQL Export Utilities +======================= -PLEX was created to be able to quickstart version control for existing (APEX) apps and has currently two main functions called __BackApp__ and __Queries_to_CSV__. Queries_to_CSV is used by BackApp as a helper function, but its functionality is also useful standalone. +PLEX was created to be able to quickstart version control for existing (APEX) apps and has currently two main functions called **BackApp** and **Queries_to_CSV**. Queries_to_CSV is used by BackApp as a helper function, but its functionality is also useful standalone. See also this resources for more information: -- PLEX project page on [GitHub](https://github.com/ogobrecht/plex) -- Blog post on how to [getting started](https://ogobrecht.github.io/posts/2018-08-26-plex-plsql-export-utilities) +- [Blog post on how to getting started](https://ogobrecht.github.io/posts/2018-08-26-plex-plsql-export-utilities) +- [PLEX project page on GitHub](https://github.com/ogobrecht/plex) +- [Give feedback on GitHub](https://github.com/ogobrecht/plex/issues/new). -[Feedback is welcome](https://github.com/ogobrecht/plex/issues/new). +DEPENDENCIES -STANDARDS +The package itself is independend, but functionality varies on the following conditions: -- All main functions returning a file collection of type apex_t_export_files -- All main functions setting the session module and action infos while processing their work +- For APEX app export: APEX >= 5.1.4 installed +- NOT YET IMPLEMENTED: For ORDS REST service export: ORDS >= FIXME installed -DEPENDENCIES +INSTALLATION + +- Download the [latest version](https://github.com/ogobrecht/plex/releases/latest) +- Unzip it, open a shell and go into the root directory +- Start SQL*Plus (or another tool which can run SQL scripts) +- To install PLEX run the provided install script `plex_install.sql` (script provides compiler flags) +- To uninstall PLEX run the provided script `plex_uninstall.sql` or drop the package manually + -- APEX 5.1.4 because we use the packages APEX_EXPORT and APEX_ZIP +CHANGELOG + +- 2.0.0 (2019-06-20) + - Package is now independend from APEX to be able to export schema object DDL and table data without an APEX installation + - ATTENTION: The return type of functions BackApp and Queries_to_CSV has changed from `apex_t_export_files` to `plex.tab_export_files` + - New parameters to filter for object types + - New parameters to change base paths for backend, frontend and data +- 1.2.1 (2019-03-13) + - Fix script templates: Change old parameters in plex.backapp call + - Add install and uninstall scripts for PLEX itself +- 1.2.0 (2018-10-31) + - New: All like/not like parameters are now translated internally with the escape character set to backslash like so `... like 'YourExpression' escape '\'` + - Fixed: Binary data type columns (raw, long_raw, blob, bfile) should no longer break the export data to CSV functionality +- 1.1.0 (2018-09-23) + - Change filter parameter from regular expression to list of like expressions for easier handling +- 1.0.0 (2018-08-26) + - First public release **/ +-------------------------------------------------------------------------------------------------------------------------------- -- CONSTANTS, TYPES +-------------------------------------------------------------------------------------------------------------------------------- -c_app_info_length CONSTANT PLS_INTEGER := 64; - +c_app_info_length CONSTANT PLS_INTEGER := 64; SUBTYPE app_info_text IS VARCHAR2(64 CHAR); -TYPE rec_runtime_log IS RECORD ( - overall_start_time DATE, - overall_run_time NUMBER, - step INTEGER, - elapsed NUMBER, - execution NUMBER, - module app_info_text, - action app_info_text ); - +TYPE rec_error_log IS RECORD ( + time_stamp TIMESTAMP, + file_name VARCHAR2(255), + error_text VARCHAR2(200), + call_stack VARCHAR2(500)); +TYPE tab_error_log IS TABLE OF rec_error_log; + +TYPE rec_runtime_log IS RECORD ( + overall_start_time TIMESTAMP, + overall_run_time NUMBER, + step INTEGER, + elapsed NUMBER, + execution NUMBER, + module app_info_text, + action app_info_text); TYPE tab_runtime_log IS TABLE OF rec_runtime_log; +TYPE rec_export_file IS RECORD ( + name VARCHAR2(255), + contents CLOB); +TYPE tab_export_files IS TABLE OF rec_export_file; +TYPE tab_vc32k IS TABLE OF varchar2(32767); +TYPE tab_vc1k IS TABLE OF VARCHAR2(1024) INDEX BY BINARY_INTEGER; + + +-------------------------------------------------------------------------------------------------------------------------------- +-- MAIN METHODS +-------------------------------------------------------------------------------------------------------------------------------- FUNCTION backapp ( + $if $$apex_installed $then -- App related options: p_app_id IN NUMBER DEFAULT null, -- If null, we simply skip the APEX app export. p_app_date IN BOOLEAN DEFAULT true, -- If true, include export date and time in the result. @@ -64,10 +108,13 @@ FUNCTION backapp ( p_app_supporting_objects IN VARCHAR2 DEFAULT null, -- If 'Y', export supporting objects. If 'I', automatically install on import. If 'N', do not export supporting objects. If null, the application's include in export deployment value is used. p_app_include_single_file IN BOOLEAN DEFAULT false, -- If true, the single sql install file is also included beside the splitted files. p_app_build_status_run_only IN BOOLEAN DEFAULT false, -- If true, the build status of the app will be overwritten to RUN_ONLY. + $end -- Object related options: p_include_object_ddl IN BOOLEAN DEFAULT false, -- If true, include DDL of current user/schema and all its objects. - p_object_name_like IN VARCHAR2 DEFAULT null, -- A comma separated list of like expressions to filter the objects - example: 'EMP%,DEPT%' will be translated to: where ... and (object_name like 'EMP%' escape '\' or object_name like 'DEPT%' escape '\'). - p_object_name_not_like IN VARCHAR2 DEFAULT null, -- A comma separated list of not like expressions to filter the objects - example: 'EMP%,DEPT%' will be translated to: where ... and (object_name not like 'EMP%' escape '\' and object_name not like 'DEPT%' escape '\'). + p_object_type_like IN VARCHAR2 DEFAULT null, -- A comma separated list of like expressions to filter the objects - example: '%BODY,JAVA%' will be translated to: ... from user_objects where ... and (object_type like '%BODY' escape '\' or object_type like 'JAVA%' escape '\'). + p_object_type_not_like IN VARCHAR2 DEFAULT null, -- A comma separated list of not like expressions to filter the objects - example: '%BODY,JAVA%' will be translated to: ... from user_objects where ... and (object_type not like '%BODY' escape '\' and object_type not like 'JAVA%' escape '\'). + p_object_name_like IN VARCHAR2 DEFAULT null, -- A comma separated list of like expressions to filter the objects - example: 'EMP%,DEPT%' will be translated to: ... from user_objects where ... and (object_name like 'EMP%' escape '\' or object_name like 'DEPT%' escape '\'). + p_object_name_not_like IN VARCHAR2 DEFAULT null, -- A comma separated list of not like expressions to filter the objects - example: 'EMP%,DEPT%' will be translated to: ... from user_objects where ... and (object_name not like 'EMP%' escape '\' and object_name not like 'DEPT%' escape '\'). -- Data related options: p_include_data IN BOOLEAN DEFAULT false, -- If true, include CSV data of each table. p_data_as_of_minutes_ago IN NUMBER DEFAULT 0, -- Read consistent data with the resulting timestamp(SCN). @@ -76,8 +123,12 @@ FUNCTION backapp ( p_data_table_name_not_like IN VARCHAR2 DEFAULT null, -- A comma separated list of not like expressions to filter the tables - example: 'EMP%,DEPT%' will be translated to: where ... and (table_name not like 'EMP%' escape '\' and table_name not like 'DEPT%' escape '\'). -- Miscellaneous options: p_include_templates IN BOOLEAN DEFAULT true, -- If true, include templates for README.md, export and install scripts. - p_include_runtime_log IN BOOLEAN DEFAULT true -- If true, generate file plex_backapp_log.md with runtime statistics. -) RETURN apex_t_export_files; + p_include_runtime_log IN BOOLEAN DEFAULT true, -- If true, generate file plex_runtime_log.md with detailed runtime infos. + p_include_error_log IN BOOLEAN DEFAULT true, -- If true, generate file plex_error_log.md with detailed error messages. + p_base_path_backend IN VARCHAR2 DEFAULT 'app_backend', -- The base path in the project root for the database DDL files. + p_base_path_frontend IN VARCHAR2 DEFAULT 'app_frontend', -- The base path in the project root for the APEX UI install files. + p_base_path_data IN VARCHAR2 DEFAULT 'app_data') -- The base path in the project root for the data files. +RETURN tab_export_files; /** Get a file collection of an APEX application (or the current user/schema only) including: @@ -86,39 +137,97 @@ Get a file collection of an APEX application (or the current user/schema only) i - Optional the data in CSV files (this option was implemented to track catalog tables, can be used as logical backup, has the typical CSV limitations...) - Everything in a (hopefully) nice directory structure -EXAMPLE +EXAMPLE BASIC USAGE ```sql DECLARE - l_file_collection apex_t_export_files; + l_file_collection plex.tab_export_files; BEGIN l_file_collection := plex.backapp( - p_app_id => 100, + p_app_id => 100, -- parameter only available when APEX installed p_include_object_ddl => false, - p_include_data => false - ); + p_include_data => false); -- do something with the file collection FOR i IN 1..l_file_collection.count LOOP - dbms_output.put_line( - i - || ' | ' - || lpad(round(length(l_file_collection(i).contents) / 1024), 3) || ' kB' - || ' | ' - || l_file_collection(i).name - ); + dbms_output.put_line(i || ' | ' + || lpad(round(length(l_file_collection(i).contents) / 1024), 3) || ' kB' || ' | ' + || l_file_collection(i).name); END LOOP; END; +{{/}} +``` + +EXAMPLE ZIP FILE PL/SQL + +```sql +DECLARE + l_zip_file BLOB; +BEGIN + l_zip_file := plex.to_zip(plex.backapp( + p_app_id => 100, -- parameter only available when APEX installed + p_include_object_ddl => true, + p_include_data => false)); + -- do something with the zip file + -- Your code here... +END; +{{/}} +``` + +EXAMPLE ZIP FILE SQL + +```sql +-- Inline function because of boolean parameters (needs Oracle 12c or higher). +-- Alternative create a helper function and call that in a SQL context. +WITH + FUNCTION backapp RETURN BLOB IS + BEGIN + RETURN plex.to_zip(plex.backapp( + -- All parameters are optional and shown with their defaults + -- App related options (only available, when APEX is installed): + p_app_id => NULL, + p_app_date => true, + p_app_public_reports => true, + p_app_private_reports => false, + p_app_notifications => false, + p_app_translations => true, + p_app_pkg_app_mapping => false, + p_app_original_ids => false, + p_app_subscriptions => true, + p_app_comments => true, + p_app_supporting_objects => NULL, + p_app_include_single_file => false, + p_app_build_status_run_only => false, + -- Object related options: + p_include_object_ddl => false, + p_object_type_like => NULL, + p_object_type_not_like => NULL, + p_object_name_like => NULL, + p_object_name_not_like => NULL, + -- Data related options: + p_include_data => false, + p_data_as_of_minutes_ago => 0, + p_data_max_rows => 1000, + p_data_table_name_like => NULL, + p_data_table_name_not_like => NULL, + -- Miscellaneous options: + p_include_templates => true, + p_include_runtime_log => true, + p_include_error_log => true, + p_base_path_backend => 'app_backend', + p_base_path_frontend => 'app_frontend', + p_base_path_data => 'app_data')); + END backapp; +SELECT backapp FROM dual; ``` **/ PROCEDURE add_query ( - p_query IN VARCHAR2, -- The query itself - p_file_name IN VARCHAR2, -- File name like 'Path/to/your/file-name-without-extension'. - p_max_rows IN NUMBER DEFAULT 1000 -- The maximum number of rows to be included in your file. -); + p_query IN VARCHAR2, -- The query itself + p_file_name IN VARCHAR2, -- File name like 'Path/to/your/file-without-extension'. + p_max_rows IN NUMBER DEFAULT 1000); -- The maximum number of rows to be included in your file. /** Add a query to be processed by the method queries_to_csv. You can add as many queries as you like. @@ -128,9 +237,9 @@ EXAMPLE BEGIN plex.add_query( p_query => 'select * from user_tables', - p_file_name => 'user_tables' - ); + p_file_name => 'user_tables'); END; +{{/}} ``` **/ @@ -140,51 +249,86 @@ FUNCTION queries_to_csv ( p_delimiter IN VARCHAR2 DEFAULT ',', -- The column delimiter. p_quote_mark IN VARCHAR2 DEFAULT '"', -- Used when the data contains the delimiter character. p_header_prefix IN VARCHAR2 DEFAULT NULL, -- Prefix the header line with this text. - p_include_runtime_log IN BOOLEAN DEFAULT true -- If true, generate file plex_queries_to_csv_log.md with runtime statistics. -) RETURN apex_t_export_files; + p_include_runtime_log IN BOOLEAN DEFAULT true, -- If true, generate file plex_runtime_log.md with runtime statistics. + p_include_error_log IN BOOLEAN DEFAULT true) -- If true, generate file plex_error_log.md with detailed error messages. +RETURN tab_export_files; /** Export one or more queries as CSV data within a file collection. -EXAMPLE +EXAMPLE BASIC USAGE ```sql DECLARE - l_file_collection apex_t_export_files; + l_file_collection plex.tab_export_files; BEGIN - --fill the queries array plex.add_query( p_query => 'select * from user_tables', - p_file_name => 'user_tables' - ); + p_file_name => 'user_tables'); plex.add_query( p_query => 'select * from user_tab_columns', p_file_name => 'user_tab_columns', - p_max_rows => 10000 - ); - + p_max_rows => 10000); -- process the queries l_file_collection := plex.queries_to_csv; - -- do something with the file collection FOR i IN 1..l_file_collection.count LOOP - dbms_output.put_line( - i - || ' | ' - || lpad(round(length(l_file_collection(i).contents) / 1024), 3) || ' kB' - || ' | ' - || l_file_collection(i).name - ); + dbms_output.put_line(i || ' | ' + || lpad(round(length(l_file_collection(i).contents) / 1024), 3) || ' kB' || ' | ' + || l_file_collection(i).name); END LOOP; END; +{{/}} +``` + +EXPORT EXPORT ZIP FILE PL/SQL + +```sql +DECLARE + l_zip_file BLOB; +BEGIN + --fill the queries array + plex.add_query( + p_query => 'select * from user_tables', + p_file_name => 'user_tables'); + plex.add_query( + p_query => 'select * from user_tab_columns', + p_file_name => 'user_tab_columns', + p_max_rows => 10000); + -- process the queries + l_zip_file := plex.to_zip(plex.queries_to_csv); + -- do something with the zip file + -- Your code here... +END; +{{/}} +``` + +EXAMPLE EXPORT ZIP FILE SQL + +```sql +WITH + FUNCTION queries_to_csv_zip RETURN BLOB IS + v_return BLOB; + BEGIN + plex.add_query( + p_query => 'select * from user_tables', + p_file_name => 'user_tables'); + plex.add_query( + p_query => 'select * from user_tab_columns', + p_file_name => 'user_tab_columns', + p_max_rows => 10000); + v_return := plex.to_zip(plex.queries_to_csv); + RETURN v_return; + END queries_to_csv_zip; +SELECT queries_to_csv_zip FROM dual; ``` **/ FUNCTION to_zip ( - p_file_collection IN apex_t_export_files -- The file collection to process with APEX_ZIP. -) RETURN BLOB; + p_file_collection IN tab_export_files) -- The file collection to zip. +RETURN BLOB; /** Convert a file collection to a zip file. @@ -194,21 +338,28 @@ EXAMPLE DECLARE l_zip BLOB; BEGIN - l_zip := plex.to_zip(plex.backapp( - p_app_id => 100, - p_include_object_ddl => true - )); - + l_zip := plex.to_zip(plex.backapp( + p_app_id => 100, + p_include_object_ddl => true)); -- do something with the zip file... END; ``` ***/ +FUNCTION view_error_log RETURN tab_error_log PIPELINED; +/** +View the error log from the last plex run. The internal array for the error log is cleared on each call of BackApp or Queries_to_CSV. + +EXAMPLE +```sql +SELECT * FROM TABLE(plex.view_error_log); +``` +**/ FUNCTION view_runtime_log RETURN tab_runtime_log PIPELINED; /** -View the log from the last plex run. The internal array for the runtime log is cleared after each call of BackApp or Queries_to_CSV. +View the runtime log from the last plex run. The internal array for the runtime log is cleared on each call of BackApp or Queries_to_CSV. EXAMPLE @@ -218,6 +369,130 @@ SELECT * FROM TABLE(plex.view_runtime_log); **/ +-------------------------------------------------------------------------------------------------------------------------------- +-- UTILITIES (only available when v_utils_public is set to 'true' in install script plex_install.sql) +-------------------------------------------------------------------------------------------------------------------------------- + +$if $$utils_public $then + +FUNCTION util_bool_to_string (p_bool IN BOOLEAN) RETURN VARCHAR2; + +FUNCTION util_string_to_bool ( + p_bool_string IN VARCHAR2, + p_default IN BOOLEAN) +RETURN BOOLEAN; + +FUNCTION util_split ( + p_string IN VARCHAR2, + p_delimiter IN VARCHAR2 DEFAULT ',') +RETURN tab_vc32k; + +FUNCTION util_join ( + p_array IN tab_vc32k, + p_delimiter IN VARCHAR2 DEFAULT ',') +RETURN VARCHAR2; + +FUNCTION util_clob_to_blob (p_clob CLOB) RETURN BLOB; + +/* +ZIP UTILS +- The following four zip utilities are copied from this article: + - Blog: https://technology.amis.nl/2010/03/13/utl_compress-gzip-and-zlib/ + - Source: https://technology.amis.nl/wp-content/uploads/2010/06/as_zip10.txt +- Copyright (c) 2010, 2011 by Anton Scheffer (MIT license) +- Thank you for sharing this Anton :-) +*/ +FUNCTION util_zip_blob_to_num ( + p_blob IN BLOB, + p_len IN INTEGER, + p_pos IN INTEGER) +RETURN NUMBER; +FUNCTION util_zip_little_endian ( + p_big IN NUMBER, + p_bytes IN PLS_INTEGER := 4) +RETURN RAW; +PROCEDURE util_zip_add_file ( + p_zipped_blob IN OUT BLOB, + p_name IN VARCHAR2, + p_content IN BLOB); + +PROCEDURE util_zip_finish (p_zipped_blob IN OUT BLOB); + +FUNCTION util_multi_replace ( + p_source_string VARCHAR2, + p_01_find VARCHAR2 DEFAULT NULL, p_01_replace VARCHAR2 DEFAULT NULL, + p_02_find VARCHAR2 DEFAULT NULL, p_02_replace VARCHAR2 DEFAULT NULL, + p_03_find VARCHAR2 DEFAULT NULL, p_03_replace VARCHAR2 DEFAULT NULL, + p_04_find VARCHAR2 DEFAULT NULL, p_04_replace VARCHAR2 DEFAULT NULL, + p_05_find VARCHAR2 DEFAULT NULL, p_05_replace VARCHAR2 DEFAULT NULL, + p_06_find VARCHAR2 DEFAULT NULL, p_06_replace VARCHAR2 DEFAULT NULL, + p_07_find VARCHAR2 DEFAULT NULL, p_07_replace VARCHAR2 DEFAULT NULL, + p_08_find VARCHAR2 DEFAULT NULL, p_08_replace VARCHAR2 DEFAULT NULL, + p_09_find VARCHAR2 DEFAULT NULL, p_09_replace VARCHAR2 DEFAULT NULL, + p_10_find VARCHAR2 DEFAULT NULL, p_10_replace VARCHAR2 DEFAULT NULL, + p_11_find VARCHAR2 DEFAULT NULL, p_11_replace VARCHAR2 DEFAULT NULL, + p_12_find VARCHAR2 DEFAULT NULL, p_12_replace VARCHAR2 DEFAULT NULL) +RETURN VARCHAR2; + +FUNCTION util_set_build_status_run_only (p_app_export_sql IN CLOB) RETURN CLOB; + +FUNCTION util_calc_data_timestamp (p_as_of_minutes_ago IN NUMBER) RETURN TIMESTAMP; + +PROCEDURE util_setup_dbms_metadata ( + p_pretty IN BOOLEAN DEFAULT true, + p_constraints IN BOOLEAN DEFAULT true, + p_ref_constraints IN BOOLEAN DEFAULT false, + p_partitioning IN BOOLEAN DEFAULT true, + p_tablespace IN BOOLEAN DEFAULT false, + p_storage IN BOOLEAN DEFAULT false, + p_segment_attributes IN BOOLEAN DEFAULT false, + p_sqlterminator IN BOOLEAN DEFAULT true, + p_constraints_as_alter IN BOOLEAN DEFAULT false, + p_emit_schema IN BOOLEAN DEFAULT false); + +PROCEDURE util_ensure_unique_file_names (p_export_files IN OUT tab_export_files); + +-------------------------------------------------------------------------------------------------------------------------------- +-- The following tools are working on global private package variables +-------------------------------------------------------------------------------------------------------------------------------- + +PROCEDURE util_log_init (p_module IN VARCHAR2); + +PROCEDURE util_log_start (p_action IN VARCHAR2); + +PROCEDURE util_log_error (p_name VARCHAR2); + +PROCEDURE util_log_stop; + +FUNCTION util_log_get_runtime ( + p_start IN TIMESTAMP, + p_stop IN TIMESTAMP) +RETURN NUMBER; + +PROCEDURE util_log_calc_runtimes; + +PROCEDURE util_clob_append (p_content IN VARCHAR2); + +PROCEDURE util_clob_append (p_content IN CLOB); + +PROCEDURE util_clob_flush_cache; + +PROCEDURE util_clob_add_to_export_files ( + p_export_files IN OUT NOCOPY tab_export_files, + p_name IN VARCHAR2); + +PROCEDURE util_clob_query_to_csv ( + p_query IN VARCHAR2, + p_max_rows IN NUMBER DEFAULT 1000, + p_delimiter IN VARCHAR2 DEFAULT ',', + p_quote_mark IN VARCHAR2 DEFAULT '"', + p_header_prefix IN VARCHAR2 DEFAULT NULL); + +PROCEDURE util_clob_create_error_log (p_export_files IN OUT NOCOPY tab_export_files); + +PROCEDURE util_clob_create_runtime_log (p_export_files IN OUT NOCOPY tab_export_files); + +$end END plex; / \ No newline at end of file diff --git a/README.md b/README.md index 67217a7..c601397 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,70 @@ +PL/SQL Export Utilities +======================= - [Package PLEX](#plex) - [Function backapp](#backapp) - [Procedure add_query](#add_query) - [Function queries_to_csv](#queries_to_csv) - [Function to_zip](#to_zip) +- [Function view_error_log](#view_error_log) - [Function view_runtime_log](#view_runtime_log) -

Package PLEX

- +

Package PLEX

+ -PL/SQL Export Utilities - -PLEX was created to be able to quickstart version control for existing (APEX) apps and has currently two main functions called __BackApp__ and __Queries_to_CSV__. Queries_to_CSV is used by BackApp as a helper function, but its functionality is also useful standalone. +PLEX was created to be able to quickstart version control for existing (APEX) apps and has currently two main functions called **BackApp** and **Queries_to_CSV**. Queries_to_CSV is used by BackApp as a helper function, but its functionality is also useful standalone. See also this resources for more information: -- PLEX project page on [GitHub](https://github.com/ogobrecht/plex) -- Blog post on how to [getting started](https://ogobrecht.github.io/posts/2018-08-26-plex-plsql-export-utilities) +- [Blog post on how to getting started](https://ogobrecht.github.io/posts/2018-08-26-plex-plsql-export-utilities) +- [PLEX project page on GitHub](https://github.com/ogobrecht/plex) +- [Give feedback on GitHub](https://github.com/ogobrecht/plex/issues/new). -[Feedback is welcome](https://github.com/ogobrecht/plex/issues/new). +DEPENDENCIES -STANDARDS +The package itself is independend, but functionality varies on the following conditions: -- All main functions returning a file collection of type apex_t_export_files -- All main functions setting the session module and action infos while processing their work +- For APEX app export: APEX >= 5.1.4 installed +- NOT YET IMPLEMENTED: For ORDS REST service export: ORDS >= FIXME installed -DEPENDENCIES +INSTALLATION + +- Download the [latest version](https://github.com/ogobrecht/plex/releases/latest) +- Unzip it, open a shell and go into the root directory +- Start SQL*Plus (or another tool which can run SQL scripts) +- To install PLEX run the provided install script `plex_install.sql` (script provides compiler flags) +- To uninstall PLEX run the provided script `plex_uninstall.sql` or drop the package manually + -- APEX 5.1.4 because we use the packages APEX_EXPORT and APEX_ZIP +CHANGELOG + +- 2.0.0 (2019-06-20) + - Package is now independend from APEX to be able to export schema object DDL and table data without an APEX installation + - ATTENTION: The return type of functions BackApp and Queries_to_CSV has changed from `apex_t_export_files` to `plex.tab_export_files` + - New parameters to filter for object types + - New parameters to change base paths for backend, frontend and data +- 1.2.1 (2019-03-13) + - Fix script templates: Change old parameters in plex.backapp call + - Add install and uninstall scripts for PLEX itself +- 1.2.0 (2018-10-31) + - New: All like/not like parameters are now translated internally with the escape character set to backslash like so `... like 'YourExpression' escape '\'` + - Fixed: Binary data type columns (raw, long_raw, blob, bfile) should no longer break the export data to CSV functionality +- 1.1.0 (2018-09-23) + - Change filter parameter from regular expression to list of like expressions for easier handling +- 1.0.0 (2018-08-26) + - First public release SIGNATURE ```sql PACKAGE PLEX AUTHID current_user IS c_plex_name CONSTANT VARCHAR2(30 CHAR) := 'PLEX - PL/SQL Export Utilities'; -c_plex_version CONSTANT VARCHAR2(10 CHAR) := '1.2.1'; +c_plex_version CONSTANT VARCHAR2(10 CHAR) := '2.0.0'; c_plex_url CONSTANT VARCHAR2(40 CHAR) := 'https://github.com/ogobrecht/plex'; c_plex_license CONSTANT VARCHAR2(10 CHAR) := 'MIT'; c_plex_license_url CONSTANT VARCHAR2(60 CHAR) := 'https://github.com/ogobrecht/plex/blob/master/LICENSE.txt'; @@ -57,35 +82,95 @@ Get a file collection of an APEX application (or the current user/schema only) i - Optional the data in CSV files (this option was implemented to track catalog tables, can be used as logical backup, has the typical CSV limitations...) - Everything in a (hopefully) nice directory structure -EXAMPLE +EXAMPLE BASIC USAGE ```sql DECLARE - l_file_collection apex_t_export_files; + l_file_collection plex.tab_export_files; BEGIN l_file_collection := plex.backapp( - p_app_id => 100, + p_app_id => 100, -- parameter only available when APEX installed p_include_object_ddl => false, - p_include_data => false - ); + p_include_data => false); -- do something with the file collection FOR i IN 1..l_file_collection.count LOOP - dbms_output.put_line( - i - || ' | ' - || lpad(round(length(l_file_collection(i).contents) / 1024), 3) || ' kB' - || ' | ' - || l_file_collection(i).name - ); + dbms_output.put_line(i || ' | ' + || lpad(round(length(l_file_collection(i).contents) / 1024), 3) || ' kB' || ' | ' + || l_file_collection(i).name); END LOOP; END; +/ +``` + +EXAMPLE ZIP FILE PL/SQL + +```sql +DECLARE + l_zip_file BLOB; +BEGIN + l_zip_file := plex.to_zip(plex.backapp( + p_app_id => 100, -- parameter only available when APEX installed + p_include_object_ddl => true, + p_include_data => false)); + -- do something with the zip file + -- Your code here... +END; +/ +``` + +EXAMPLE ZIP FILE SQL + +```sql +-- Inline function because of boolean parameters (needs Oracle 12c or higher). +-- Alternative create a helper function and call that in a SQL context. +WITH + FUNCTION backapp RETURN BLOB IS + BEGIN + RETURN plex.to_zip(plex.backapp( + -- All parameters are optional and shown with their defaults + -- App related options (only available, when APEX is installed): + p_app_id => NULL, + p_app_date => true, + p_app_public_reports => true, + p_app_private_reports => false, + p_app_notifications => false, + p_app_translations => true, + p_app_pkg_app_mapping => false, + p_app_original_ids => false, + p_app_subscriptions => true, + p_app_comments => true, + p_app_supporting_objects => NULL, + p_app_include_single_file => false, + p_app_build_status_run_only => false, + -- Object related options: + p_include_object_ddl => false, + p_object_type_like => NULL, + p_object_type_not_like => NULL, + p_object_name_like => NULL, + p_object_name_not_like => NULL, + -- Data related options: + p_include_data => false, + p_data_as_of_minutes_ago => 0, + p_data_max_rows => 1000, + p_data_table_name_like => NULL, + p_data_table_name_not_like => NULL, + -- Miscellaneous options: + p_include_templates => true, + p_include_runtime_log => true, + p_include_error_log => true, + p_base_path_backend => 'app_backend', + p_base_path_frontend => 'app_frontend', + p_base_path_data => 'app_data')); + END backapp; +SELECT backapp FROM dual; ``` SIGNATURE ```sql FUNCTION backapp ( + $if $$apex_installed $then -- App related options: p_app_id IN NUMBER DEFAULT null, -- If null, we simply skip the APEX app export. p_app_date IN BOOLEAN DEFAULT true, -- If true, include export date and time in the result. @@ -100,10 +185,13 @@ FUNCTION backapp ( p_app_supporting_objects IN VARCHAR2 DEFAULT null, -- If 'Y', export supporting objects. If 'I', automatically install on import. If 'N', do not export supporting objects. If null, the application's include in export deployment value is used. p_app_include_single_file IN BOOLEAN DEFAULT false, -- If true, the single sql install file is also included beside the splitted files. p_app_build_status_run_only IN BOOLEAN DEFAULT false, -- If true, the build status of the app will be overwritten to RUN_ONLY. + $end -- Object related options: p_include_object_ddl IN BOOLEAN DEFAULT false, -- If true, include DDL of current user/schema and all its objects. - p_object_name_like IN VARCHAR2 DEFAULT null, -- A comma separated list of like expressions to filter the objects - example: 'EMP%,DEPT%' will be translated to: where ... and (object_name like 'EMP%' escape '\' or object_name like 'DEPT%' escape '\'). - p_object_name_not_like IN VARCHAR2 DEFAULT null, -- A comma separated list of not like expressions to filter the objects - example: 'EMP%,DEPT%' will be translated to: where ... and (object_name not like 'EMP%' escape '\' and object_name not like 'DEPT%' escape '\'). + p_object_type_like IN VARCHAR2 DEFAULT null, -- A comma separated list of like expressions to filter the objects - example: '%BODY,JAVA%' will be translated to: ... from user_objects where ... and (object_type like '%BODY' escape '\' or object_type like 'JAVA%' escape '\'). + p_object_type_not_like IN VARCHAR2 DEFAULT null, -- A comma separated list of not like expressions to filter the objects - example: '%BODY,JAVA%' will be translated to: ... from user_objects where ... and (object_type not like '%BODY' escape '\' and object_type not like 'JAVA%' escape '\'). + p_object_name_like IN VARCHAR2 DEFAULT null, -- A comma separated list of like expressions to filter the objects - example: 'EMP%,DEPT%' will be translated to: ... from user_objects where ... and (object_name like 'EMP%' escape '\' or object_name like 'DEPT%' escape '\'). + p_object_name_not_like IN VARCHAR2 DEFAULT null, -- A comma separated list of not like expressions to filter the objects - example: 'EMP%,DEPT%' will be translated to: ... from user_objects where ... and (object_name not like 'EMP%' escape '\' and object_name not like 'DEPT%' escape '\'). -- Data related options: p_include_data IN BOOLEAN DEFAULT false, -- If true, include CSV data of each table. p_data_as_of_minutes_ago IN NUMBER DEFAULT 0, -- Read consistent data with the resulting timestamp(SCN). @@ -112,8 +200,12 @@ FUNCTION backapp ( p_data_table_name_not_like IN VARCHAR2 DEFAULT null, -- A comma separated list of not like expressions to filter the tables - example: 'EMP%,DEPT%' will be translated to: where ... and (table_name not like 'EMP%' escape '\' and table_name not like 'DEPT%' escape '\'). -- Miscellaneous options: p_include_templates IN BOOLEAN DEFAULT true, -- If true, include templates for README.md, export and install scripts. - p_include_runtime_log IN BOOLEAN DEFAULT true -- If true, generate file plex_backapp_log.md with runtime statistics. -) RETURN apex_t_export_files; + p_include_runtime_log IN BOOLEAN DEFAULT true, -- If true, generate file plex_runtime_log.md with detailed runtime infos. + p_include_error_log IN BOOLEAN DEFAULT true, -- If true, generate file plex_error_log.md with detailed error messages. + p_base_path_backend IN VARCHAR2 DEFAULT 'app_backend', -- The base path in the project root for the database DDL files. + p_base_path_frontend IN VARCHAR2 DEFAULT 'app_frontend', -- The base path in the project root for the APEX UI install files. + p_base_path_data IN VARCHAR2 DEFAULT 'app_data') -- The base path in the project root for the data files. +RETURN tab_export_files; ``` @@ -128,19 +220,18 @@ EXAMPLE BEGIN plex.add_query( p_query => 'select * from user_tables', - p_file_name => 'user_tables' - ); + p_file_name => 'user_tables'); END; +/ ``` SIGNATURE ```sql PROCEDURE add_query ( - p_query IN VARCHAR2, -- The query itself - p_file_name IN VARCHAR2, -- File name like 'Path/to/your/file-name-without-extension'. - p_max_rows IN NUMBER DEFAULT 1000 -- The maximum number of rows to be included in your file. -); + p_query IN VARCHAR2, -- The query itself + p_file_name IN VARCHAR2, -- File name like 'Path/to/your/file-without-extension'. + p_max_rows IN NUMBER DEFAULT 1000); -- The maximum number of rows to be included in your file. ``` @@ -149,38 +240,72 @@ PROCEDURE add_query ( Export one or more queries as CSV data within a file collection. -EXAMPLE +EXAMPLE BASIC USAGE ```sql DECLARE - l_file_collection apex_t_export_files; + l_file_collection plex.tab_export_files; BEGIN - --fill the queries array plex.add_query( p_query => 'select * from user_tables', - p_file_name => 'user_tables' - ); + p_file_name => 'user_tables'); plex.add_query( p_query => 'select * from user_tab_columns', p_file_name => 'user_tab_columns', - p_max_rows => 10000 - ); - + p_max_rows => 10000); -- process the queries l_file_collection := plex.queries_to_csv; - -- do something with the file collection FOR i IN 1..l_file_collection.count LOOP - dbms_output.put_line( - i - || ' | ' - || lpad(round(length(l_file_collection(i).contents) / 1024), 3) || ' kB' - || ' | ' - || l_file_collection(i).name - ); + dbms_output.put_line(i || ' | ' + || lpad(round(length(l_file_collection(i).contents) / 1024), 3) || ' kB' || ' | ' + || l_file_collection(i).name); END LOOP; END; +/ +``` + +EXPORT EXPORT ZIP FILE PL/SQL + +```sql +DECLARE + l_zip_file BLOB; +BEGIN + --fill the queries array + plex.add_query( + p_query => 'select * from user_tables', + p_file_name => 'user_tables'); + plex.add_query( + p_query => 'select * from user_tab_columns', + p_file_name => 'user_tab_columns', + p_max_rows => 10000); + -- process the queries + l_zip_file := plex.to_zip(plex.queries_to_csv); + -- do something with the zip file + -- Your code here... +END; +/ +``` + +EXAMPLE EXPORT ZIP FILE SQL + +```sql +WITH + FUNCTION queries_to_csv_zip RETURN BLOB IS + v_return BLOB; + BEGIN + plex.add_query( + p_query => 'select * from user_tables', + p_file_name => 'user_tables'); + plex.add_query( + p_query => 'select * from user_tab_columns', + p_file_name => 'user_tab_columns', + p_max_rows => 10000); + v_return := plex.to_zip(plex.queries_to_csv); + RETURN v_return; + END queries_to_csv_zip; +SELECT queries_to_csv_zip FROM dual; ``` SIGNATURE @@ -190,8 +315,9 @@ FUNCTION queries_to_csv ( p_delimiter IN VARCHAR2 DEFAULT ',', -- The column delimiter. p_quote_mark IN VARCHAR2 DEFAULT '"', -- Used when the data contains the delimiter character. p_header_prefix IN VARCHAR2 DEFAULT NULL, -- Prefix the header line with this text. - p_include_runtime_log IN BOOLEAN DEFAULT true -- If true, generate file plex_queries_to_csv_log.md with runtime statistics. -) RETURN apex_t_export_files; + p_include_runtime_log IN BOOLEAN DEFAULT true, -- If true, generate file plex_runtime_log.md with runtime statistics. + p_include_error_log IN BOOLEAN DEFAULT true) -- If true, generate file plex_error_log.md with detailed error messages. +RETURN tab_export_files; ``` @@ -206,11 +332,9 @@ EXAMPLE DECLARE l_zip BLOB; BEGIN - l_zip := plex.to_zip(plex.backapp( - p_app_id => 100, - p_include_object_ddl => true - )); - + l_zip := plex.to_zip(plex.backapp( + p_app_id => 100, + p_include_object_ddl => true)); -- do something with the zip file... END; ``` @@ -219,15 +343,33 @@ SIGNATURE ```sql FUNCTION to_zip ( - p_file_collection IN apex_t_export_files -- The file collection to process with APEX_ZIP. -) RETURN BLOB; + p_file_collection IN tab_export_files) -- The file collection to zip. +RETURN BLOB; +``` + + +

Function view_error_log

+ + +View the error log from the last plex run. The internal array for the error log is cleared on each call of BackApp or Queries_to_CSV. + +EXAMPLE + +```sql +SELECT * FROM TABLE(plex.view_error_log); +``` + +SIGNATURE + +```sql +FUNCTION view_error_log RETURN tab_error_log PIPELINED; ```

Function view_runtime_log

-View the log from the last plex run. The internal array for the runtime log is cleared after each call of BackApp or Queries_to_CSV. +View the runtime log from the last plex run. The internal array for the runtime log is cleared on each call of BackApp or Queries_to_CSV. EXAMPLE diff --git a/formatter_styles_sql_developer.xml b/formatter_styles_sql_developer.xml deleted file mode 100644 index 830a496..0000000 --- a/formatter_styles_sql_developer.xml +++ /dev/null @@ -1,36 +0,0 @@ -false -true -false -false -CommentsUnchanged -false -128 -true -true -true -After -Before -false -true -/C:/Users/decaf4/AppData/Roaming/SQL Developer/system18.2.0.183.1748/o.sqldeveloper/format.arbori -1 -true -false -lower -X2 -None -false -false -NoSpace -1 -false -false -true -false -2 -false -false -false -true -UPPER - \ No newline at end of file diff --git a/lib/as_zip.sql b/lib/as_zip.sql new file mode 100644 index 0000000..8a7a530 --- /dev/null +++ b/lib/as_zip.sql @@ -0,0 +1,528 @@ +CREATE OR REPLACE package as_zip +is +/********************************************** +** +** Author: Anton Scheffer +** Date: 25-01-2012 +** Website: http://technology.amis.nl/blog +** +** Changelog: +** Date: 04-08-2016 +** fixed endless loop for empty/null zip file +** Date: 28-07-2016 +** added support for defate64 (this only works for zip-files created with 7Zip) +** Date: 31-01-2014 +** file limit increased to 4GB +** Date: 29-04-2012 +** fixed bug for large uncompressed files, thanks Morten Braten +** Date: 21-03-2012 +** Take CRC32, compressed length and uncompressed length from +** Central file header instead of Local file header +** Date: 17-02-2012 +** Added more support for non-ascii filenames +** Date: 25-01-2012 +** Added MIT-license +** Some minor improvements +****************************************************************************** +****************************************************************************** +Copyright (C) 2010,2011 by Anton Scheffer + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +****************************************************************************** +******************************************** */ + type file_list is table of clob; +-- + function file2blob + ( p_dir varchar2 + , p_file_name varchar2 + ) + return blob; +-- + function get_file_list + ( p_dir varchar2 + , p_zip_file varchar2 + , p_encoding varchar2 := null + ) + return file_list; +-- + function get_file_list + ( p_zipped_blob blob + , p_encoding varchar2 := null + ) + return file_list; +-- + function get_file + ( p_dir varchar2 + , p_zip_file varchar2 + , p_file_name varchar2 + , p_encoding varchar2 := null + ) + return blob; +-- + function get_file + ( p_zipped_blob blob + , p_file_name varchar2 + , p_encoding varchar2 := null + ) + return blob; +-- + procedure add1file + ( p_zipped_blob in out blob + , p_name varchar2 + , p_content blob + ); +-- + procedure finish_zip( p_zipped_blob in out blob ); +-- + procedure save_zip + ( p_zipped_blob blob + , p_dir varchar2 := 'MY_DIR' + , p_filename varchar2 := 'my.zip' + ); +-- +/* +declare + g_zipped_blob blob; +begin + as_zip.add1file( g_zipped_blob, 'test4.txt', null ); -- a empty file + as_zip.add1file( g_zipped_blob, 'dir1/test1.txt', utl_raw.cast_to_raw( q'' ) ); + as_zip.add1file( g_zipped_blob, 'test1234.txt', utl_raw.cast_to_raw( 'A small file' ) ); + as_zip.add1file( g_zipped_blob, 'dir2/', null ); -- a folder + as_zip.add1file( g_zipped_blob, 'dir3/', null ); -- a folder + as_zip.add1file( g_zipped_blob, 'dir3/test2.txt', utl_raw.cast_to_raw( 'A small filein a previous created folder' ) ); + as_zip.finish_zip( g_zipped_blob ); + as_zip.save_zip( g_zipped_blob, 'MY_DIR', 'my.zip' ); + dbms_lob.freetemporary( g_zipped_blob ); +end; +-- +declare + zip_files as_zip.file_list; +begin + zip_files := as_zip.get_file_list( 'MY_DIR', 'my.zip' ); + for i in zip_files.first() .. zip_files.last + loop + dbms_output.put_line( zip_files( i ) ); + dbms_output.put_line( utl_raw.cast_to_varchar2( as_zip.get_file( 'MY_DIR', 'my.zip', zip_files( i ) ) ) ); + end loop; +end; +*/ +end; +/ + +CREATE OR REPLACE package body as_zip +is +-- + c_LOCAL_FILE_HEADER constant raw(4) := hextoraw( '504B0304' ); -- Local file header signature + c_END_OF_CENTRAL_DIRECTORY constant raw(4) := hextoraw( '504B0506' ); -- End of central directory signature +-- + function blob2num( p_blob blob, p_len integer, p_pos integer ) + return number + is + rv number; + begin + rv := utl_raw.cast_to_binary_integer( dbms_lob.substr( p_blob, p_len, p_pos ), utl_raw.little_endian ); + if rv < 0 + then + rv := rv + 4294967296; + end if; + return rv; + end; +-- + function raw2varchar2( p_raw raw, p_encoding varchar2 ) + return varchar2 + is + begin + return coalesce( utl_i18n.raw_to_char( p_raw, p_encoding ) + , utl_i18n.raw_to_char( p_raw, utl_i18n.map_charset( p_encoding, utl_i18n.GENERIC_CONTEXT, utl_i18n.IANA_TO_ORACLE ) ) + ); + end; +-- + function little_endian( p_big number, p_bytes pls_integer := 4 ) + return raw + is + t_big number := p_big; + begin + if t_big > 2147483647 + then + t_big := t_big - 4294967296; + end if; + return utl_raw.substr( utl_raw.cast_from_binary_integer( t_big, utl_raw.little_endian ), 1, p_bytes ); + end; +-- + function file2blob + ( p_dir varchar2 + , p_file_name varchar2 + ) + return blob + is + file_lob bfile; + file_blob blob; + begin + file_lob := bfilename( p_dir, p_file_name ); + dbms_lob.open( file_lob, dbms_lob.file_readonly ); + dbms_lob.createtemporary( file_blob, true ); + dbms_lob.loadfromfile( file_blob, file_lob, dbms_lob.lobmaxsize ); + dbms_lob.close( file_lob ); + return file_blob; + exception + when others then + if dbms_lob.isopen( file_lob ) = 1 + then + dbms_lob.close( file_lob ); + end if; + if dbms_lob.istemporary( file_blob ) = 1 + then + dbms_lob.freetemporary( file_blob ); + end if; + raise; + end; +-- + function get_file_list + ( p_zipped_blob blob + , p_encoding varchar2 := null + ) + return file_list + is + t_ind integer; + t_hd_ind integer; + t_rv file_list; + t_encoding varchar2(32767); + begin + t_ind := nvl( dbms_lob.getlength( p_zipped_blob ), 0 ) - 21; + loop + exit when t_ind < 1 or dbms_lob.substr( p_zipped_blob, 4, t_ind ) = c_END_OF_CENTRAL_DIRECTORY; + t_ind := t_ind - 1; + end loop; +-- + if t_ind <= 0 + then + return null; + end if; +-- + t_hd_ind := blob2num( p_zipped_blob, 4, t_ind + 16 ) + 1; + t_rv := file_list(); + t_rv.extend( blob2num( p_zipped_blob, 2, t_ind + 10 ) ); + for i in 1 .. blob2num( p_zipped_blob, 2, t_ind + 8 ) + loop + if p_encoding is null + then + if utl_raw.bit_and( dbms_lob.substr( p_zipped_blob, 1, t_hd_ind + 9 ), hextoraw( '08' ) ) = hextoraw( '08' ) + then + t_encoding := 'AL32UTF8'; -- utf8 + else + t_encoding := 'US8PC437'; -- IBM codepage 437 + end if; + else + t_encoding := p_encoding; + end if; + t_rv( i ) := raw2varchar2 + ( dbms_lob.substr( p_zipped_blob + , blob2num( p_zipped_blob, 2, t_hd_ind + 28 ) + , t_hd_ind + 46 + ) + , t_encoding + ); + t_hd_ind := t_hd_ind + 46 + + blob2num( p_zipped_blob, 2, t_hd_ind + 28 ) -- File name length + + blob2num( p_zipped_blob, 2, t_hd_ind + 30 ) -- Extra field length + + blob2num( p_zipped_blob, 2, t_hd_ind + 32 ); -- File comment length + end loop; +-- + return t_rv; + end; +-- + function get_file_list + ( p_dir varchar2 + , p_zip_file varchar2 + , p_encoding varchar2 := null + ) + return file_list + is + begin + return get_file_list( file2blob( p_dir, p_zip_file ), p_encoding ); + end; +-- + function get_file + ( p_zipped_blob blob + , p_file_name varchar2 + , p_encoding varchar2 := null + ) + return blob + is + t_tmp blob; + t_ind integer; + t_hd_ind integer; + t_fl_ind integer; + t_encoding varchar2(32767); + t_len integer; + begin + t_ind := nvl( dbms_lob.getlength( p_zipped_blob ), 0 ) - 21; + loop + exit when t_ind < 1 or dbms_lob.substr( p_zipped_blob, 4, t_ind ) = c_END_OF_CENTRAL_DIRECTORY; + t_ind := t_ind - 1; + end loop; +-- + if t_ind <= 0 + then + return null; + end if; +-- + t_hd_ind := blob2num( p_zipped_blob, 4, t_ind + 16 ) + 1; + for i in 1 .. blob2num( p_zipped_blob, 2, t_ind + 8 ) + loop + if p_encoding is null + then + if utl_raw.bit_and( dbms_lob.substr( p_zipped_blob, 1, t_hd_ind + 9 ), hextoraw( '08' ) ) = hextoraw( '08' ) + then + t_encoding := 'AL32UTF8'; -- utf8 + else + t_encoding := 'US8PC437'; -- IBM codepage 437 + end if; + else + t_encoding := p_encoding; + end if; + if p_file_name = raw2varchar2 + ( dbms_lob.substr( p_zipped_blob + , blob2num( p_zipped_blob, 2, t_hd_ind + 28 ) + , t_hd_ind + 46 + ) + , t_encoding + ) + then + t_len := blob2num( p_zipped_blob, 4, t_hd_ind + 24 ); -- uncompressed length + if t_len = 0 + then + if substr( p_file_name, -1 ) in ( '/', '\' ) + then -- directory/folder + return null; + else -- empty file + return empty_blob(); + end if; + end if; +-- + if dbms_lob.substr( p_zipped_blob, 2, t_hd_ind + 10 ) in ( hextoraw( '0800' ) -- deflate + , hextoraw( '0900' ) -- deflate64 + ) + then + t_fl_ind := blob2num( p_zipped_blob, 4, t_hd_ind + 42 ); + t_tmp := hextoraw( '1F8B0800000000000003' ); -- gzip header + dbms_lob.copy( t_tmp + , p_zipped_blob + , blob2num( p_zipped_blob, 4, t_hd_ind + 20 ) + , 11 + , t_fl_ind + 31 + + blob2num( p_zipped_blob, 2, t_fl_ind + 27 ) -- File name length + + blob2num( p_zipped_blob, 2, t_fl_ind + 29 ) -- Extra field length + ); + dbms_lob.append( t_tmp, utl_raw.concat( dbms_lob.substr( p_zipped_blob, 4, t_hd_ind + 16 ) -- CRC32 + , little_endian( t_len ) -- uncompressed length + ) + ); + return utl_compress.lz_uncompress( t_tmp ); + end if; +-- + if dbms_lob.substr( p_zipped_blob, 2, t_hd_ind + 10 ) = hextoraw( '0000' ) -- The file is stored (no compression) + then + t_fl_ind := blob2num( p_zipped_blob, 4, t_hd_ind + 42 ); + dbms_lob.createtemporary( t_tmp, true ); + dbms_lob.copy( t_tmp + , p_zipped_blob + , t_len + , 1 + , t_fl_ind + 31 + + blob2num( p_zipped_blob, 2, t_fl_ind + 27 ) -- File name length + + blob2num( p_zipped_blob, 2, t_fl_ind + 29 ) -- Extra field length + ); + return t_tmp; + end if; + end if; + t_hd_ind := t_hd_ind + 46 + + blob2num( p_zipped_blob, 2, t_hd_ind + 28 ) -- File name length + + blob2num( p_zipped_blob, 2, t_hd_ind + 30 ) -- Extra field length + + blob2num( p_zipped_blob, 2, t_hd_ind + 32 ); -- File comment length + end loop; +-- + return null; + end; +-- + function get_file + ( p_dir varchar2 + , p_zip_file varchar2 + , p_file_name varchar2 + , p_encoding varchar2 := null + ) + return blob + is + begin + return get_file( file2blob( p_dir, p_zip_file ), p_file_name, p_encoding ); + end; +-- + procedure add1file + ( p_zipped_blob in out blob + , p_name varchar2 + , p_content blob + ) + is + t_now date; + t_blob blob; + t_len integer; + t_clen integer; + t_crc32 raw(4) := hextoraw( '00000000' ); + t_compressed boolean := false; + t_name raw(32767); + begin + t_now := sysdate; + t_len := nvl( dbms_lob.getlength( p_content ), 0 ); + if t_len > 0 + then + t_blob := utl_compress.lz_compress( p_content ); + t_clen := dbms_lob.getlength( t_blob ) - 18; + t_compressed := t_clen < t_len; + t_crc32 := dbms_lob.substr( t_blob, 4, t_clen + 11 ); + end if; + if not t_compressed + then + t_clen := t_len; + t_blob := p_content; + end if; + if p_zipped_blob is null + then + dbms_lob.createtemporary( p_zipped_blob, true ); + end if; + t_name := utl_i18n.string_to_raw( p_name, 'AL32UTF8' ); + dbms_lob.append( p_zipped_blob + , utl_raw.concat( c_LOCAL_FILE_HEADER -- Local file header signature + , hextoraw( '1400' ) -- version 2.0 + , case when t_name = utl_i18n.string_to_raw( p_name, 'US8PC437' ) + then hextoraw( '0000' ) -- no General purpose bits + else hextoraw( '0008' ) -- set Language encoding flag (EFS) + end + , case when t_compressed + then hextoraw( '0800' ) -- deflate + else hextoraw( '0000' ) -- stored + end + , little_endian( to_number( to_char( t_now, 'ss' ) ) / 2 + + to_number( to_char( t_now, 'mi' ) ) * 32 + + to_number( to_char( t_now, 'hh24' ) ) * 2048 + , 2 + ) -- File last modification time + , little_endian( to_number( to_char( t_now, 'dd' ) ) + + to_number( to_char( t_now, 'mm' ) ) * 32 + + ( to_number( to_char( t_now, 'yyyy' ) ) - 1980 ) * 512 + , 2 + ) -- File last modification date + , t_crc32 -- CRC-32 + , little_endian( t_clen ) -- compressed size + , little_endian( t_len ) -- uncompressed size + , little_endian( utl_raw.length( t_name ), 2 ) -- File name length + , hextoraw( '0000' ) -- Extra field length + , t_name -- File name + ) + ); + if t_compressed + then + dbms_lob.copy( p_zipped_blob, t_blob, t_clen, dbms_lob.getlength( p_zipped_blob ) + 1, 11 ); -- compressed content + elsif t_clen > 0 + then + dbms_lob.copy( p_zipped_blob, t_blob, t_clen, dbms_lob.getlength( p_zipped_blob ) + 1, 1 ); -- content + end if; + if dbms_lob.istemporary( t_blob ) = 1 + then + dbms_lob.freetemporary( t_blob ); + end if; + end; +-- + procedure finish_zip( p_zipped_blob in out blob ) + is + t_cnt pls_integer := 0; + t_offs integer; + t_offs_dir_header integer; + t_offs_end_header integer; + t_comment raw(32767) := utl_raw.cast_to_raw( 'Implementation by Anton Scheffer' ); + begin + t_offs_dir_header := dbms_lob.getlength( p_zipped_blob ); + t_offs := 1; + while dbms_lob.substr( p_zipped_blob, utl_raw.length( c_LOCAL_FILE_HEADER ), t_offs ) = c_LOCAL_FILE_HEADER + loop + t_cnt := t_cnt + 1; + dbms_lob.append( p_zipped_blob + , utl_raw.concat( hextoraw( '504B0102' ) -- Central directory file header signature + , hextoraw( '1400' ) -- version 2.0 + , dbms_lob.substr( p_zipped_blob, 26, t_offs + 4 ) + , hextoraw( '0000' ) -- File comment length + , hextoraw( '0000' ) -- Disk number where file starts + , hextoraw( '0000' ) -- Internal file attributes => + -- 0000 binary file + -- 0100 (ascii)text file + , case + when dbms_lob.substr( p_zipped_blob + , 1 + , t_offs + 30 + blob2num( p_zipped_blob, 2, t_offs + 26 ) - 1 + ) in ( hextoraw( '2F' ) -- / + , hextoraw( '5C' ) -- \ + ) + then hextoraw( '10000000' ) -- a directory/folder + else hextoraw( '2000B681' ) -- a file + end -- External file attributes + , little_endian( t_offs - 1 ) -- Relative offset of local file header + , dbms_lob.substr( p_zipped_blob + , blob2num( p_zipped_blob, 2, t_offs + 26 ) + , t_offs + 30 + ) -- File name + ) + ); + t_offs := t_offs + 30 + blob2num( p_zipped_blob, 4, t_offs + 18 ) -- compressed size + + blob2num( p_zipped_blob, 2, t_offs + 26 ) -- File name length + + blob2num( p_zipped_blob, 2, t_offs + 28 ); -- Extra field length + end loop; + t_offs_end_header := dbms_lob.getlength( p_zipped_blob ); + dbms_lob.append( p_zipped_blob + , utl_raw.concat( c_END_OF_CENTRAL_DIRECTORY -- End of central directory signature + , hextoraw( '0000' ) -- Number of this disk + , hextoraw( '0000' ) -- Disk where central directory starts + , little_endian( t_cnt, 2 ) -- Number of central directory records on this disk + , little_endian( t_cnt, 2 ) -- Total number of central directory records + , little_endian( t_offs_end_header - t_offs_dir_header ) -- Size of central directory + , little_endian( t_offs_dir_header ) -- Offset of start of central directory, relative to start of archive + , little_endian( nvl( utl_raw.length( t_comment ), 0 ), 2 ) -- ZIP file comment length + , t_comment + ) + ); + end; +-- + procedure save_zip + ( p_zipped_blob blob + , p_dir varchar2 := 'MY_DIR' + , p_filename varchar2 := 'my.zip' + ) + is + t_fh utl_file.file_type; + t_len pls_integer := 32767; + begin + t_fh := utl_file.fopen( p_dir, p_filename, 'wb' ); + for i in 0 .. trunc( ( dbms_lob.getlength( p_zipped_blob ) - 1 ) / t_len ) + loop + utl_file.put_raw( t_fh, dbms_lob.substr( p_zipped_blob, t_len, i * t_len + 1 ) ); + end loop; + utl_file.fclose( t_fh ); + end; +-- +end; +/ \ No newline at end of file diff --git a/lib/as_zip.txt b/lib/as_zip.txt new file mode 100644 index 0000000..dc443d3 --- /dev/null +++ b/lib/as_zip.txt @@ -0,0 +1 @@ +https://technology.amis.nl/2010/03/13/utl_compress-gzip-and-zlib/ \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index c8f19ed..e94149b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1006,9 +1006,9 @@ "integrity": "sha1-3BXKHGcjh8p2vTesCjlbogQqLCg=" }, "glob": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", - "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", + "version": "7.1.4", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.4.tgz", + "integrity": "sha512-hkLPepehmnKk41pUGm3sYxoFs/umurYfYJCerbXEyFIWcAzvpipAgVkBqqT9RBKMGjnq6kMuyYwha6csxbiM1A==", "requires": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", @@ -1521,11 +1521,11 @@ "integrity": "sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A=" }, "ploc": { - "version": "0.5.0", - "resolved": "https://registry.npmjs.org/ploc/-/ploc-0.5.0.tgz", - "integrity": "sha512-CMkHpnpxIWOSxzRQk00oxYWInmTQBOFEcK6srgBZ/dEL0HlXkyb688/axfF4DU11IJQdAJBWdT+vYksM3Fro9g==", + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/ploc/-/ploc-0.6.1.tgz", + "integrity": "sha512-xEiYb8AO7AUC7RGXs6myDHo+xb8eyd2ome5F9sibHuYnT1D8R8RsoAZXoWOfw+APb6AC5nrY015qIJxd5ajcZg==", "requires": { - "glob": "^7.1.2", + "glob": "^7.1.4", "minimist": "^1.2.0" } }, @@ -1623,7 +1623,7 @@ }, "safe-regex": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/safe-regex/-/safe-regex-1.1.0.tgz", + "resolved": "http://registry.npmjs.org/safe-regex/-/safe-regex-1.1.0.tgz", "integrity": "sha1-QKNmnzsHfR6UPURinhV91IAjvy4=", "requires": { "ret": "~0.1.10" @@ -1851,7 +1851,7 @@ }, "strip-eof": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz", + "resolved": "http://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz", "integrity": "sha1-u0P/VZim6wXYm1n80SnJgzE2Br8=" }, "to-object-path": { @@ -2027,7 +2027,7 @@ }, "strip-ansi": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", + "resolved": "http://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", "requires": { "ansi-regex": "^2.0.0" diff --git a/package.json b/package.json index 01620e8..8964fd0 100644 --- a/package.json +++ b/package.json @@ -11,6 +11,6 @@ }, "dependencies": { "chokidar-cli": "^1.2.2", - "ploc": "^0.5.0" + "ploc": "^0.6.1" } } diff --git a/plex_install.sql b/plex_install.sql new file mode 100644 index 0000000..8c235a0 --- /dev/null +++ b/plex_install.sql @@ -0,0 +1,43 @@ +SET DEFINE OFF FEEDBACK OFF +WHENEVER SQLERROR EXIT sql.sqlcode ROLLBACK +prompt +prompt Installing PL/SQL Export Utilities +prompt ================================== +prompt Set compiler flags +DECLARE + v_apex_installed VARCHAR2(5) := 'FALSE'; -- Do not change (is set dynamically). + v_ords_installed VARCHAR2(5) := 'FALSE'; -- Do not change (is set dynamically). + v_utils_public VARCHAR2(5) := 'FALSE'; -- Make utilities public available (for testing or other usages). + v_debug_on VARCHAR2(5) := 'FALSE'; -- Object DDL: extract only one object per type to find problematic ones and save time in big schemas like APEX_XXX. +BEGIN + FOR i IN (SELECT * + FROM all_objects + WHERE object_type = 'SYNONYM' + AND object_name = 'APEX_EXPORT') LOOP + v_apex_installed := 'TRUE'; + END LOOP; + FOR i IN (SELECT * + FROM all_objects + WHERE object_type = 'SYNONYM' + AND object_name = 'ORDS_EXPORT') LOOP + v_ords_installed := 'TRUE'; + END LOOP; + -- Show unset compiler flags as errors (results for example in errors like "PLW-06003: unknown inquiry directive '$$UTILS_PUBLIC'") + EXECUTE IMMEDIATE 'ALTER SESSION SET plsql_warnings = ''ENABLE:6003'''; + -- Finally set compiler flags + EXECUTE IMMEDIATE 'ALTER SESSION SET plsql_ccflags = ''' + || 'apex_installed:' || v_apex_installed || ',' + || 'ords_installed:' || v_ords_installed || ',' + || 'utils_public:' || v_utils_public || ',' + || 'debug_on:' || v_debug_on || ''''; +END; +/ +prompt Compile package plex (spec) +@plex.pks +show errors +prompt Compile package plex (body) +@plex.pkb +show errors +prompt ================================== +prompt Installation Done +prompt diff --git a/plex_uninstall.sql b/plex_uninstall.sql new file mode 100644 index 0000000..f85d4e2 --- /dev/null +++ b/plex_uninstall.sql @@ -0,0 +1,30 @@ +SET DEFINE OFF FEEDBACK OFF +WHENEVER SQLERROR EXIT sql.sqlcode ROLLBACK +prompt +prompt Uninstalling PL/SQL Export Utilities +prompt ==================================== +prompt Drop package plex if exists (body) +BEGIN + FOR i IN (SELECT object_type, + object_name + FROM user_objects + WHERE object_type = 'PACKAGE BODY' + AND object_name = 'PLEX') LOOP + EXECUTE IMMEDIATE 'DROP ' || i.object_type || ' ' || i.object_name; + END LOOP; +END; +/ +prompt Drop package plex if exists (spec) +BEGIN + FOR i IN (SELECT object_type, + object_name + FROM user_objects + WHERE object_type = 'PACKAGE' + AND object_name = 'PLEX') LOOP + EXECUTE IMMEDIATE 'DROP ' || i.object_type || ' ' || i.object_name; + END LOOP; +END; +/ +prompt ==================================== +prompt Uninstallation Done +prompt \ No newline at end of file