Oracle | DBMS_FILE_GROUP

Oracle DBMS_FILE_GROUP_UTL Version 21c

General Information

Library Note

Morgan's Library Page Header

ACE Director Alum Daniel Morgan, founder of Morgan's Library, is scheduling complimentary technical Workshops on Database Security for the first 30 Oracle Database customers located anywhere in North America, EMEA, LATAM, or APAC that send an email to asra_us@oracle.com. Request a Workshop for your organization today.

Purpose Internal utilities for building and managing a File Group repository.

AUTHID DEFINER

Dependencies

DBA_SCHEDULER_JOBS	DBMS_SCHEDULER	FGR$_FILE_GROUPS
DBMS_ASSERT	DBMS_SQL	FGR$_FILE_GROUP_EXPORT_INFO
DBMS_FILE_GROUP	DBMS_STANDARD	FGR$_FILE_GROUP_FILES
DBMS_FILE_GROUP_DECL	DBMS_STREAMS_DECL	FGR$_FILE_GROUP_VERSIONS
DBMS_FILE_GROUP_EXP	DBMS_STREAMS_TABLESPACE_ADM	FGR$_NAMES_S
DBMS_FILE_GROUP_IMP_INTERNAL	DBMS_STREAMS_TBS_INT	FGR$_TABLESPACE_INFO
DBMS_FILE_GROUP_INTERNAL_INVOK	DBMS_SYSTEM	FGR$_TABLE_INFO
DBMS_FILE_GROUP_LIB	DBMS_SYS_SQL	KU$_JOBDESC
DBMS_FILE_GROUP_UTL_INVOK	DBMS_UTILITY	OBJ$
DBMS_LOGREP_UTIL	DUAL	USER$

Documented No

First Available Not known

Security Model Owned by SYS with no privileges granted

Source {ORACLE_HOME}/rdbms/admin/prvthfgr.plb
{ORACLE_HOME}/rdbms/admin/prvtbfgr.plb

Subprograms

AS_POS_INTEGER	ENABLE_PURGE_JOB	INSERT_FILE_METADATA
AUTO_PURGE_FILE_GROUPS	GENERATE_NAME	INSERT_VERSION_METADATA
BOOLEAN_STR	GET_FGV_LOCK	IS_INTEGER
CANONICALIZE	GET_FG_LOCK	POPULATE_DATAPUMP_INFO
CHECK_FILE_GROUP_FOR_DP_INFO	GET_FILES_PURGE_CURSOR	PURGE_DATAPUMP_INFO
CHECK_VERSION_FOR_DP_INFO	GET_FILE_GROUP_METADATA	RAISE_DP_ERRORS
CREATE_VERSEQ	GET_FILE_METADATA	RELOAD_VERSION_METADATA
DELETE_FILE_METADATA	GET_NEXTSEQVAL	TRACE_ON
DELETE_VERSION_METADATA	GET_VERSIONS_PURGE_CURSOR	UPDATE_FILE_METADATA
DISABLE_PURGE_JOB	GET_VERSION_METADATA	UPDATE_VERSION_METADATA
DROP_VERSEQ	GET_VERSION_METADATA_CURSOR	WRITE_TRACE

AS_POS_INTEGER

Undocumented dbms_file_group_utl.as_pos_integer(version_name IN VARCHAR2) RETURN NUMBER;

TBD

AUTO_PURGE_FILE_GROUPS

Undocumented dbms_file_group_utl.auto_purge_file_groups;

exec dbms_file_group_utl.auto_purge_file_groups;

      

      PL/SQL procedure successfully completed.

BOOLEAN_STR

Undocumented dbms_file_group_utl.boolean_str(value IN BOOLEAN) RETURN VARCHAR2;

DECLARE

       retVal dbms_id;

      BEGIN

        retVal := dbms_file_group_utl.boolean_str(TRUE);

        dbms_output.put_line(retVal);

      END;

      /

      TRUE

      

      PL/SQL procedure successfully completed.

CANONICALIZE

Raises a DBMS_ASSERT exception if the "value" is not a valid Oracle name

Recommend a direct call to DBMS_ASSERT rather than this call to make specific the objective dbms_file_group_utl.canonicalize( value IN VARCHAR2, canon_value OUT VARCHAR2, type IN NUMBER);

DECLARE

       outVal dbms_id;

      BEGIN

        dbms_file_group_utl.canonicalize('UWCLASS', outVal, 0);

        dbms_output.put_line(outVal);

      END;

      /

      UWCLASS

      

      PL/SQL procedure successfully completed.

CHECK_FILE_GROUP_FOR_DP_INFO

Undocumented dbms_file_group_utl.check_file_group_for_dp_info(file_group_id IN NUMBER) RETURN VARCHAR2;

TBD

CHECK_VERSION_FOR_DP_INFO

Undocumented dbms_file_group_utl.check_version_for_dp_info(version_guid IN RAW) RETURN BOOLEAN;

TBD

CREATE_VERSEQ

Undocumented dbms_file_group_utl.create_verseq(canon_file_group_name IN VARCHAR2) RETURN VARCHAR2;

TBD

DELETE_FILE_METADATA

Undocumented dbms_file_group_utl.delete_file_metadata( file_name IN VARCHAR2, version_guid IN RAW);

TBD

DELETE_VERSION_METADATA

Undocumented dbms_file_group_utl.delete_version_metadata(version_guid IN RAW);

TBD

DISABLE_PURGE_JOB

Undocumented dbms_file_group_utl.disable_purge_job;

exec dbms_file_group_utl.disable_purge_job;

      

      PL/SQL procedure successfully completed.

DROP_VERSEQ

Undocumented dbms_file_group_utl.drop_verseq(canon_verseq_name IN VARCHAR2);

TBD

ENABLE_PURGE_JOB

Undocumented dbms_file_group_utl.enable_purge_job;

exec dbms_file_group_utl.enable_purge_job;

GENERATE_NAME

Undocumented dbms_file_group_utl.generate_name(seed_name IN VARCHAR2) RETURN VARCHAR2;

SELECT dbms_file_group_utl.generate_name('UW')

      FROM dual;

      

      DBMS_FILE_GROUP_UTL.GENERATE_NAME('UW')

      ----------------------------------------

      UW1

GET_FGV_LOCK

Undocumented dbms_file_group_utl.get_fgv_lock( file_group_id IN BINARY_INTEGER, version_id IN BINARY_INTEGER, lockmode IN BINARY_INTEGER, duration IN BINARY_INTEGER, timeout IN BINARY_INTEGER);

TBD

GET_FG_LOCK

Undocumented dbms_file_group_utl.get_fg_lock( file_group_id IN NUMBER, lockmode IN BINARY_INTEGER, duration IN BINARY_INTEGER, timeout IN BINARY_INTEGER);

TBD

GET_FILES_PURGE_CURSOR

Undocumented dbms_file_group_utl.get_files_purge_cursor( version_guid IN RAW, c_files OUT sys.fgr$_file_group_files);

TBD

GET_FILE_GROUP_METADATA

Undocumented dbms_file_group_utl.get_file_group_metadata( canon_file_group_owner IN VARCHAR2, canon_file_group_name IN VARCHAR2, fg_rec OUT sys.dbms_file_group_decl.file_group_rec, raise_error IN BOOLEAN, lock_mode IN NUMBER, lock_duration IN NUMBER) RETURN BOOLEAN;

TBD

GET_FILE_METADATA

Undocumented dbms_file_group_utl.get_file_metadata( file_name IN VARCHAR2, version_guid IN RAW, f_rec OUT sys.dbms_file_group_decl.file_rec, raise_error IN BOOLEAN) RETURN BOOLEAN;

TBD

GET_NEXTSEQVAL

Undocumented dbms_file_group_utl.get_nextseqval(canon_verseq_name IN VARCHAR2) RETURN NUMBER;

TBD

GET_VERSIONS_PURGE_CURSOR

Undocumented dbms_file_group_utl.get_versions_purge_cursor( file_group_id IN NUMBER, c_versions OUT sys.fgr$_file_group_versions);

TBD

GET_VERSION_METADATA

Undocumented dbms_file_group_utl.get_version_metadata( canon_file_group_owner IN VARCHAR2, canon_file_group_name IN VARCHAR2, canon_version_name IN VARCHAR2, version_id IN NUMBER, v_rec OUT sys.dbms_file_group_decl.version_rec, raise_error IN BOOLEAN, query_type IN NUMBER, version_guid IN RAW) RETURN BOOLEAN;

TBD

GET_VERSION_METADATA_CURSOR

Undocumented dbms_file_group_utl.get_version_metadata_cursor( file_group_id IN NUMBER, c_versions OUT sys.dbms_file_group_decl.version_rid_rec, canon_version_name IN VARCHAR2, version_id IN NUMBER, query_type IN NUMBER, version_guid IN RAW, file_name IN VARCHAR2);

TBD

INSERT_FILE_METADATA

Undocumented dbms_file_group_utl.insert_file_metadata(f_rec IN sys.dbms_file_group_decl.file_rec);

TBD

INSERT_VERSION_METADATA

Undocumented dbms_file_group_utl.insert_version_metadata( v_rec IN sys.dbms_file_group_decl.version_rec);

TBD

IS_INTEGER

Returns TRUE if a number is an integer but FALSE if the number is a decimal dbms_file_group_utl.is_integer(num IN NUMBER) RETURN BOOLEAN;

BEGIN

        IF dbms_file_group_utl.is_integer(999) THEN

          dbms_output.put_line('T');

        ELSE

          dbms_output.put_line('F');

        END IF;

      END;

      /

      T

      

      PL/SQL procedure successfully completed.

      

      BEGIN

        IF dbms_file_group_utl.is_integer(99.9) 
      THEN

          dbms_output.put_line('T');

        ELSE

          dbms_output.put_line('F');

        END IF;

      END;

      /

      F

      

      PL/SQL procedure successfully completed.

POPULATE_DATAPUMP_INFO

Undocumented dbms_file_group_utl.populate_datapump_info( canon_owner IN VARCHAR2, canon_tab_view_name IN VARCHAR2, canon_tts_view_name IN VARCHAR2, canon_mt_name IN VARCHAR2, dp_job_desc IN public.ku$_jobdesc, version_guid IN RAW);

TBD

PURGE_DATAPUMP_INFO

Undocumented dbms_file_group_utl.purge_datapump_info(version_guid IN RAW);

TBD

RAISE_DP_ERRORS

Undocumented dbms_file_group_utl.raise_dp_errors( error_num IN BINARY_INTEGER, args IN sys.dbms_utility.lname_array);

TBD

RELOAD_VERSION_METADATA

Undocumented dbms_file_group_utl.reload_version_metadata( v_rec IN OUT sys.dbms_file_group_decl.version_rid_rec);

TBD

TRACE_ON

Undocumented dbms_file_group_utl.trace_on(event_level IN BINARY_INTEGER) RETURN BOOLEAN;

BEGIN

        IF dbms_file_group_utl.trace_on(10046) THEN

          dbms_output.put_line('T');

        ELSE

          dbms_output.put_line('F');

        END IF;

      END;

      /

      F

      

      PL/SQL procedure successfully completed.

UPDATE_FILE_METADATA

Undocumented dbms_file_group_utl.update_file_metadata(f_rec IN sys.dbms_file_group_decl.file_rec);

TBD

UPDATE_VERSION_METADATA

Undocumented dbms_file_group_utl.update_version_metadata( v_rec IN sys.dbms_file_group_decl.version_rec);

TBD

WRITE_TRACE

Undocumented dbms_file_group_utl.write_trace( message IN VARCHAR2 event_level IN BINARY_INTEGER time_info IN BOOLEAN);

exec dbms_file_group_utl.write_trace('Test Msg To Alert', '10047', TRUE);

      

      PL/SQL procedure successfully completed.

      

      -- a relevant write to trace was not found