Oracle | DBMS_DBFS_SFS

Oracle DBMS_DBFS_SFS_ADMIN 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 This package defines provider-specific administrative operations for the POSIX filesystems managed by "dbms_dbfs_sfs".

AUTHID DEFINER

Dependencies

ALL_OBJECTS	DBFS$_MOUNTS	DBMS_FUSE_PUBLIC
ALL_SEQUENCES	DBFS$_STORES	DBMS_SPACE
DBA_INDEXES	DBFS_SFS$_FS	DBMS_STANDARD
DBA_LOBS	DBFS_SFS$_FSSEQ	DBMS_XSTREAM_GG
DBA_LOB_PARTITIONS	DBFS_SFS$_SNAP	DUAL
DBA_NESTED_TABLES	DBFS_SFS$_TAB	EXPDEPACT$
DBA_OBJECTS	DBFS_SFS$_VOL	EXPPKGACT$
DBA_PROCEDURES	DBMS_ASSERT	PLITBLM
DBA_SEGMENTS	DBMS_DBFS_CONTENT	UTL_RAW
DBA_SEQUENCES	DBMS_DBFS_CONTENT_ADMIN	V$DATAFILE
DBA_TABLES	DBMS_DBFS_CONTENT_CONTEXT_T	V$FILESPACE_USAGE
DBA_TABLESPACES	DBMS_DBFS_CONTENT_PROPERTIES_T	V$TABLESPACE
DBA_TS_QUOTAS	DBMS_DBFS_CONTENT_PROPERTY_T	X$KSPPCV
DBA_TYPES	DBMS_DBFS_SFS	X$KSPPI
DBA_USERS	DBMS_DB_VERSION

Data Types TYPE collection_store_name IS TABLE OF VARCHAR2(512) INDEX BY PLS_INTEGER;

Documented No

Exceptions

Error Code	Reason
ORA-00054	Resource busy and acquire with NOWAIT

First Available 11.2

Security Model Owned by SYS with EXECUTE granted to the DBFS_ROLE role

Source {ORACLE_HOME}/rdbms/admin/dbmsfspi.sql

Subprograms

AUTOCLEAN	EXIM_SNAP	PARTITION_SEQUENCE
CREATEFILESYSTEM	EXIM_TAB	PARTITION_SEQUENCE_LOG
CREATEFILESYSTEM_LOG	EXIM_TABP	RECACHE_SEQUENCE
CREATESNAPSHOT	EXIM_TAB_LOG	RECACHE_SEQUENCE_LOG
DEFAULTTABLESPACE	EXIM_VOL	REGISTERFILESYSTEM
DELETE_ORPHANS	GETSTOREID	REGISTERFILESYSTEM_LOG
DELETE_ORPHANS_LOG	GET_PARAM	REVERTSNAPSHOT
DROPFILESYSTEM	INITFILESYSTEM	SCHEMA_INFO_EXP
DROPFILESYSTEM_LOG	INITFILESYSTEM_LOG	SETFSPROPERTIES
DROPSNAPSHOT	INITFS_UNREG_STORE_NAMES	SETFSPROPERTIES_LOG
DROP_ALL_TABLES	INSTANCE_INFO_EXP	SPACEDEPENDENTS
EXIMREGISTERALL	ISAPPLY	SPACEUSAGE
EXIM_ATTRV	LOBUSAGE	SYSTEM_INFO_EXP
EXIM_FS	NEWID	TBSUSAGE
EXIM_GRANTS	NEWIDAUX	UNREGISTERFILESYSTEM
EXIM_SEQ	ORPHAN_STORE_NAMES	UNREGISTERFILESYSTEM_LOG

AUTOCLEAN

Undocumented but related to Bug 27487497 dbms_dbfs_sfs_admin.autoClean( suid IN VARCHAR2, store_name IN VARCHAR2, sname OUT NOCOPY VARCHAR2, tname OUT NOCOPY VARCHAR2) RETURN BOOLEAN;

TBD

CREATEFILESYSTEM

Helper function for repository creation (only for use with dbms_dbfs_sfs.createFilesystem). Creates a POSIX filesystem repository dbms_dbfs_sfs_admin.createFileSystem( tabid IN NUMBER, schema_name IN VARCHAR2, -- owner tbl_name IN VARCHAR2, -- table name ptbl_name IN VARCHAR2, -- properties table name or NULL version IN VARCHAR2, properties IN dbms_content_properties_t DEFAULT NULL);

TBD

CREATEFILESYSTEM_LOG

Undocumented: Internal dbms_dbfs_sfs_admin.createFilesystem_log( tabid IN NUMBER, schema_name IN VARCHAR2, tbl_name IN VARCHAR2, ptbl_name IN VARCHAR2, version IN VARCHAR2, properties IN dbms_dbfs_content_properties_t, suid IN VARCHAR2, ctime IN TIMESTAMP); PRAGMA supplemental_log_data(createFilesystem_log, AUTO);

TBD

CREATESNAPSHOT

Helper functions for snapshot operations meant to be invoked only from dbms_dbfs_sfs dbms_dbfs_sfs_admin.createSnapshot( store_name IN VARCHAR2, snap_name IN VARCHAR2, vol_name IN VARCHAR2 DEFAULT 'main');

TBD

DEFAULTTABLESPACE

Helper function for repository creation (only for use with dbms_dbfs_sfs.createFilesystem) dbms_dbfs_sfs_admin.defaultTablespace(uName IN VARCHAR2) RETURN VARCHAR2;

SELECT dbms_dbfs_sfs_admin.defaultTablespace('POSIX_FS_TBS')

      FROM dual;

DELETE_ORPHANS

Delete orphaned filesystem/table entries dbms_dbfs_sfs_admin.deleteOrphans;

exec dbms_dbfs_sfs_admin.deleteOrphans;

DELETE_ORPHANS_LOG

Undocumented: Internal Use Only dbms_dbfs_sfs_admin.delete_orphans_log( suid IN VARCHAR2, ctime IN TIMESTAMP); PRAGMA supplemental_log_data(delete_orphans_log, AUTO_WITH_COMMIT);

TBD

DROPFILESYSTEM

Remove a POSIX filesystem table from the list of known POSIX filesystem tables dbms_dbfs_sfs_admin.dropFileSystem( schema_name IN VARCHAR2, tbl_name IN VARCHAR2);

TBD

DROPFILESYSTEM_LOG

Undocumented: Internal Use Only dbms_dbfs_sfs_admin.dropFilesystem_log( schema_name IN VARCHAR2, tbl_name IN VARCHAR2, suid IN VARCHAR2, ctime IN TIMESTAMP); PRAGMA supplemental_log_data(dropFilesystem_log, AUTO);

TBD

DROPSNAPSHOT

Helper functions for snapshot operations meant to be invoked only from dbms_dbfs_sfs dbms_dbfs_sfs_admin.defaultSnapshot( store_name IN VARCHAR2, snap_name IN VARCHAR2, vol_name IN VARCHAR2 DEFAULT 'main');

TBD

DROP_ALL_TABLES

Drop all POSIX file system tables dbms_dbfs_sfs_admin.drop_all_tables;

exec dbms_dbfs_sfs_admin.drop_all_tables;

EXIMREGISTERALL

A one-time action to register the SFS entities with the procedural action infrastructure dbms_dbfs_sfs_admin.eximRegisterAll;

exec dbms_dbfs_sfs_admin.eximRegisterAll;

EXIM_ATTRV

Export/mport internal helper function dbms_dbfs_sfs_admin.exim_attrv( tabid IN NUMBER, attrv IN VARCHAR2, asof IN NUMBER, vol# IN NUMBER, goff IN NUMBER);

TBD

EXIM_FS

Export/mport internal helper function dbms_dbfs_sfs_admin.eximFS( tabid IN NUMBER, store_owner IN VARCHAR2, store_name IN VARCHAR2, volid IN NUMBER, snap# IN VARCHAR2, created IN NUMBER);

TBD

EXIM_GRANTS

Export/mport internal helper function dbms_dbfs_sfs_admin.exim_grants(tabid IN NUMBER);

exec dbms_dbfs_sfs_admin.exim_grants(10);

EXIM_SEQ

Export/mport internal helper function dbms_dbfs_sfs_admin.exim_seq(newval IN NUMBER);

exec dbms_dbfs_sfs_admin.exim_seq(10);

EXIM_SNAP

Export/mport internal helper function dbms_dbfs_sfs_admin.exim_snap( tabid IN NUMBER, volid IN NUMBER, snap# IN VARCHAR2, snapname IN VARCHAR2, created IN NUMBER, deleted IN NUMBER);

TBD

EXIM_TAB

Export/mport internal helper function dbms_dbfs_sfs_admin.exim_tab( tabid OUT NUMBER, schema_name IN VARCHAR2, table_name IN VARCHAR2, ptable_name IN VARCHAR2, version# IN VARCHAR2, created IN NUMBER, formatted IN NUMBER);

TBD

EXIM_TABP

Export/mport internal helper function dbms_dbfs_sfs_admin.exim_tabp( tabid IN NUMBER, propname IN VARCHAR2, propvalue IN VARCHAR2, typecode IN NUMBER);

TBD

EXIM_TAB_LOG

Undocumented: Internal dbms_dbfs_sfs_admin.exim_tab_log( tabid IN NUMBER, schema_name IN VARCHAR2, table_name IN VARCHAR2, ptable_name IN VARCHAR2, version# IN VARCHAR2, created IN NUMBER, formatted IN NUMBER); PRAGMA supplemental_log_data(exim_tab_log, AUTO);

TBD

EXIM_VOL

Export/mport internal helper function dbms_dbfs_sfs_admin.exim_vol( tabid IN NUMBER, volid IN NUMBER, volname IN VARCHAR2, created IN NUMBER, csnap# IN NUMBER, dvolid IN NUMBER, dsnap# IN NUMBER, deleted IN NUMBER);

TBD

GETSTOREID

Helper function for looking up a repository id (only for use with dbms_dbfs_sfs.getStoreId) dbms_dbfs_sfs_admin.getStoreId( schema_name IN VARCHAR2, tbl_name IN VARCHAR2) RETURN NUMBER;

TBD

GET_PARAM

Undocumented dbms_dbfs_sfs_admin.get_param( name IN VARCHAR2) RETURN BOOLEAN;

TBD

INITFILESYSTEM

Initialize a POSIX store. This is a helper function for store initialization (only for use with dbms_dbfs_sfs.initFS) dbms_dbfs_sfs_admin.initFileSystem( schema_name IN VARCHAR2, tbl_name IN VARCHAR2);

TBD

INITFILESYSTEM_LOG

Undocumented: Internal dbms_dbfs_sfs_admin.initFilesystem_log( schema_name IN VARCHAR2, tbl_name IN VARCHAR2, suid IN VARCHAR2, ctime IN TIMESTAMP); PRAGMA supplemental_log_data(initFilesystem_log, AUTO);

TBD

INITFS_UNREG_STORE_NAMES

A helper function to collect all the store names and send to the caller function to unregister them rather than calling the unregisterStore from a sys definer procedure (fix for bug 27487497) dbms_dbfs_sfs_admin.iniFS_unReg_store_names( schema_name IN VARCHAR2, tbl_name IN VARCHAR2) RETURN collection_store_name;

TBD

INSTANCE_INFO_EXP

DBFS export/import procedural actions. For internal use only. dbms_dbfs_sfs_admin.instance_info_exp( name IN VARCHAR2, schema IN VARCHAR2, prepost IN PLS_INTEGER, isdba IN PLS_INTEGER, version IN VARCHAR2, new_block OUT PLS_INTEGER) RETURN VARCHAR2;

TBD

ISAPPLY

Undocumented but related to Bug 27487497 dbms_dbfs_sfs_admin.isApply RETURN BOOLEAN;

BEGIN

        IF dbms_sfs_admin_isApply THEN

          dbms_output.put_line('T');

        ELSE

          dbms_output.put_line('F');

        END IF;

      END;

      /

LOBUSAGE

Helper function for space usage queries (only for use with dbms_dbfs_sfs.shrinkFS) dbms_dbfs_sfs_admin.lobUsage( schema_name IN VARCHAR2, tbl_name IN VARCHAR2, part_name IN VARCHAR2 DEFAULT NULL, nbytes OUT INTEGER);

TBD

NEWID

DBFS export/import support (helper function dbms_dbfs_sfs_admin.newID RETURN NUMBER;

SELECT dbms_dbfs_sfs_admin.newID

      FROM dual;

NEWIDAUX (new 21c)

DBFS export/import support (helper function dbms_dbfs_sfs_admin.newIDAux(id OUT NUMBER); PRAGMA supplemental_log_data(newIDAux, AUTO);

TBD

ORPHAN_STORE_NAMES

Collects all the orphan stores of a user and sends it to the calling function to ensure that the unregisterStore call is made by a invoker rights procedure. (fix for bug 27487497) dbms_dbfs_sfs_admin.iniFS_unReg_store_names(suid IN VARCHAR2) RETURN collection_store_name;

TBD

PARTITION_SEQUENCE

Partition the SFS sequence# generator for distributed multi-master environments dbms_dbfs_sfs_admin.partition_sequence( nodes IN NUMBER, myid IN NUMBER, newstart IN NUMBER DEFAULT NULL);

TBD

PARTITION_SEQUENCE_LOG

Undocumented: Internal Use Only dbms_dbfs_sfs_admin.partition_sequence_log( nodes IN NUMBER, myid IN NUMBER, newstart IN NUMBER); PRAGMA supplemental_log_data(partition_sequence_log, AUTO_WITH_COMMIT);

TBD

RECACHE_SEQUENCE

Adjust the SFS sequence# cache to allow for higher concurrency and file ingest throughput. The default cache size is 20 dbms_dbfs_sfs_admin.recache_sequence(newcache IN NUMBER DEFAULT 8192);

exec dbms_dbfs_sfs_admin.recache_sequence(1024);

RECACHE_SEQUENCE_LOG

Undocumented: Internal dbms_dbfs_sfs_admin.recache_sequence_log(newcache IN NUMBER); PRAGMA supplemental_log_data(recache_sequence_log, AUTO_WITH_COMMIT);

exec dbms_dbfs_sfs_admin.recache_sequence_log(100);

REGISTERFILESYSTEM

Registers an already created POSIX filesystem (dbms_posix.createFilesystem) in schema "schema_name", table "tbl_name", as a new repository named "repos_name" dbms_dbfs_sfs_admin.registerFileSystem( store_name IN VARCHAR2, schema_name IN VARCHAR2, tbl_name IN VARCHAR2, volume_name IN VARCHAR2 DEFAULT 'main', snapshot_name IN VARCHAR2 DEFAULT NULL);

TBD

REGISTERFILESYSTEM_LOG

Undocumented: Internal dbms_dbfs_sfs_admin.registerFilesystem_log( store_name IN VARCHAR2, schema_name IN VARCHAR2, tbl_name IN VARCHAR2, volume_name IN VARCHAR2, snapshot_name IN VARCHAR2, suid IN VARCHAR2, ctime IN TIMESTAMP); PRAGMA supplemental_log_data(registerFilesystem_log, AUTO);

TBD

REVERTSNAPSHOT

Helper functions for snapshot operations meant to be invoked only from dbms_dbfs_sfs dbms_dbfs_sfs_admin.revertSnapshot( store_name IN VARCHAR2, snap_name IN VARCHAR2, vol_name IN VARCHAR2 DEFAULT 'main');

TBD

SCHEMA_INFO_EXP

DBFS export/import procedural actions. For internal use only. dbms_dbfs_sfs_admin.schema_info_exp( schema IN VARCHAR2, prepost IN PLS_INTEGER, isdba IN PLS_INTEGER, version IN VARCHAR2, new_block OUT PLS_INTEGER) RETURN VARCHAR2;

TBD

SETFSPROPERTIES

Update the properties of a POSIX store dbms_dbfs_sfs_admin.setFSProperties( schema_name IN VARCHAR2, tbl_name IN VARCHAR2, properties IN dbms_dbfs_content_properties_t);

TBD

SETFSPROPERTIES_LOG

Undocumented: Internal Use Only dbms_dbfs_sfs_admin.setFSProperties_log( schema_name IN VARCHAR2, tbl_name IN VARCHAR2, properties IN dbms_dbfs_content_properties_t, suid IN VARCHAR2, ctime IN TIMESTAMP); PRAGMA supplemental_log_data(setFSProperties_log, AUTO);

TBD

SPACEDEPENDENTS

Helper functions for space usage queries (only for use with dbms_dbfs_sfs.spaceUsage) dbms_dbfs_sfs_admin.spaceDependents( schema_name IN VARCHAR2, tbl_name IN VARCHAR2, potbl_name IN VARCHAR2, dseg IN OUT NOCOPY dbms_dbfs_sfs.dsegments_t);

TBD

SPACEUSAGE

Helper function for space usage queries (only for use with dbms_dbfs_sfs.spaceUsage) dbms_dbfs_sfs_admin.spaceUsage( tbs IN OUT NOCOPY dbms_dbfs_content_properties_t, schema_name IN VARCHAR2, tbl_name IN VARCHAR2, blksize OUT INTEGER, tbytes OUT INTEGER, ubytes OUT INTEGER, fbytes OUT INTEGER, do_fast IN BOOLEAN DEFAULT FALSE, useEstimate IN INTEGER DEFAULT 0);

TBD

SYSTEM_INFO_EXP

DBFS export/import procedural actions. For internal use only. dbms_dbfs_sfs_admin.system_info_exp( prepost IN PLS_INTEGER, connectstring OUT NOCOPY VARCHAR2, version IN VARCHAR2, new_block OUT PLS_INTEGER) RETURN VARCHAR2;

TBD

TBSUSAGE

Helper function for space usage queries (only for use with dbms_dbfs_sfs.spaceUsage) dbms_dbfs_sfs_admin.tbsUsage(tbs IN dbms_dbfs_content_properties_t) RETURN INTEGER;

TBD

UNREGISTERFILESYSTEM

The repository is removed from the metadata tables, unregistered from the content API, but the underlying filesystem itself is otherwise untouched. dbms_dbfs_sfs_admin.unregisterFileSystem(store IN VARCHAR2);

exec dbms_dbfs_sfs_admin.unregisterFileSystem('UWSTORE');

UNREGISTERFILESYSTEM_LOG

Undocumented: Internal dbms_dbfs_sfs_admin.unregisterFilesystem_log( store IN VARCHAR2, suid IN VARCHAR2, ctime IN TIMESTAMP); PRAGMA supplemental_log_data(unregisterFilesystem_log, AUTO);

TBD