Oracle | DBMS_DBFS

Oracle DBMS_DBFS_CONTENT 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 The DBFS Store API

Note See also {ORACLE_HOME}/rdbms/admin/dbfs_create_filesystem_advanced.sql

AUTHID CURRENT_USER

Constants

Name	Data Type	Value
Content ID Constants
prop_none (none)	PLS_INTEGER	0
prop_std (mandatory)	PLS_INTEGER	1
prop_opt (optional)	PLS_INTEGER	2
CONTENT_ID_MAX	PLS_INTEGER	128
NAME_MAX	PLS_INTEGER	256
PATH_MAX	PLS_INTEGER	1024
TYPE_DIRECTORY (directory)	PLS_INTEGER	2
TYPE_FILE (normal file)	PLS_INTEGER	1
TYPE_LINK (symbolic link)	PLS_INTEGER	3
TYPE_REFERENCE (hard link)	PLS_INTEGER	4
Feature Types
feature_folders	PLS_INTEGER	1
feature_foiat	PLS_INTEGER	2
feature_nowait	PLS_INTEGER	4
feature_acls	PLS_INTEGER	8
feature_links	PLS_INTEGER	16
feature_link_deref	PLS_INTEGER	32
feature_references	PLS_INTEGER	64
feature_locking	PLS_INTEGER	128
feature_hierarchy	PLS_INTEGER	256
feature_convert	PLS_INTEGER	512
feature_versioning	PLS_INTEGER	1024
feature_version_path	PLS_INTEGER	2048
feature_soft_deletes	PLS_INTEGER	4096
feature_hashing	PLS_INTEGER	8192
feature_hash_lookup	PLS_INTEGER	16384
feature_filtering	PLS_INTEGER	32768
feature_searching	PLS_INTEGER	65536
feature_asof	PLS_INTEGER	131072
feature_provider_props	PLS_INTEGER	262144
feature_snapshots	PLS_INTEGER	524288
feature_dot_snapshot	PLS_INTEGER	1048576
feature_clones	PLS_INTEGER	209712
feature_locator	PLS_INTEGER	4194304
feature_content_id	PLS_INTEGER	8388608
feature_lazy_path	PLS_INTEGER	16777216
feature_no_special	PLS_INTEGER	33554432
feature_getattr_view	PLS_INTEGER	67108864
Lock Types
lock_read_only	PLS_INTEGER	1
lock_write_only	PLS_INTEGER	2
lock_read_write	PLS_INTEGER	3
Optional Properties
opt_hash_type	VARCHAR2(32)	'opt:hash_type'
opt_hash_value	VARCHAR2(32)	'opt:hash_value'
opt_lock_count	VARCHAR2(32)	'opt:lock_count'
opt_lock_data	VARCHAR2(32)	'opt:lock_data'
opt_locker	VARCHAR2(32)	'opt:locker'
opt_lock_status	VARCHAR2(32)	'opt:lock_status'
opt_version	VARCHAR2(32)	'opt:version'
opt_version_path	VARCHAR2(32)	'opt:version_path'
opt_content_id	VARCHAR2(32)	'opt:content_id'
Path Names
NAME_MAX	PLS_INTEGER	256
PATH_MAX	PLS_INTEGER	1024
Path Properties
PROPNAME_MAX	PLS_INTEGER	32
PROPVAL_MAX	PLS_INTEGER	1024
Property Access Flags
prop_none (none)	PLS_INTEGER	0
prop_std (mandatory)	PLS_INTEGER	1
prop_opt (optional)	PLS_INTEGER	2
prop_usr (user defined)	PLS_INTEGER	4
prop_all (all)	PLS_INTEGER	prop_std + prop_opt + prop_usr
prop_data (content)	PLS_INTEGER	8
prop_spc (specific)	PLS_INTEGER	16
Standard Properties
std_access_time	VARCHAR2(32)	'std:access_time'
std_acl constant	VARCHAR2(32)	'std:acl'
std_canonical_path	VARCHAR2(32)	'std:canonical_path'
std_change_time	VARCHAR2(32)	'std:change_time'
std_children	VARCHAR2(32)	'std:children'
std_content_type	VARCHAR2(32)	'std:content_type'
std_creation_time	VARCHAR2(32)	'std:creation_time'
std_deleted	VARCHAR2(32)	'std:deleted'
std_guid	VARCHAR2(32)	'std:guid'
std_length	VARCHAR2(32)	'std:length'
std_modification_time	VARCHAR2(32)	'std:modification_time'
std_owner	VARCHAR2(32)	'std:owner'
std_parent_guid	VARCHAR2(32)	'std:parent_guid'
std_referent	VARCHAR2(32)	'std:referent'

Data Types SUBSTYPE content_id_t IS RAW(128); SUBTYPE name_t IS VARCHAR2(256); SUBTYPE path_t IS VARCHAR2(1024); SUBTYPE propname_t IS VARCHAR2(32); SUBTYPE propval_t IS VARCHAR2(1024);

Dependencies

ALL_OBJECTS	DBMS_ASSERT	DBMS_DB_VERSION
ALL_PROCEDURES	DBMS_DBFS_CONTENT_ADMIN	DBMS_FUSE
ALL_SYNONYMS	DBMS_DBFS_CONTENT_CONTEXT_T	DBMS_LOB
ALL_VIEWS	DBMS_DBFS_CONTENT_LIST_ITEMS_T	DBMS_LOB_AM_PRIVATE
DBFS$_CLIENTS	DBMS_DBFS_CONTENT_LIST_ITEM_T	DBMS_LOG
DBFS$_MOUNTS	DBMS_DBFS_CONTENT_PROPERTIES_T	DBMS_TYPES
DBFS$_STORES	DBMS_DBFS_CONTENT_PROPERTY_T	DBMS_UTILITY
DBFS_CONTENT	DBMS_DBFS_CONTENT_RAW_T	DBMS_XDB_CONTENT
DBFS_CONTENT_PROPERTIES	DBMS_DBFS_HS	DUAL
DBFS_OFS_CONVERSION	DBMS_DBFS_SFS	PLITBLM
DBMS_ARCH_PROVIDER_INTL	DBMS_DBFS_SFS_ADMIN

Documented Yes: Packages and Types Reference

Exceptions

Error Code	Reason
ORA-64000	path_exists
ORA-64001	invalid_parent
ORA-64002	invalid_path
ORA-64003	unsupported_operations
ORA-64004	invalid_arguments
ORA-64005	invalid_access
ORA-64006	lock_conflict
ORA-64007	invalid_store
ORA-64008	invalid_mount
ORA-64009	invalid_provider
ORA-64010	readonly_path

First Available 11.1

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

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

Subprograms

BUILDATTRIBUTESVIEW	GETSTATS	PUTPATH
CHECKACCESS	GETSTOREBYMOUNT	REGISTERCLIENT
CHECKSPI	GETSTOREBYNAME	REGISTERSTORE
CREATEDIRECTORY	GETSTOREBYPATH	REMOUNTALL
CREATEFILE	GETTRACE	REMOUNTSTORE
CREATELINK	GETVERSION	RENAMEPATH
CREATEREFERENCE	ISPATHLOCKED	RESTOREALL
DECODEFEATURES	LIST	RESTOREPATH
DELETECONTENT	LISTALLCONTENT	SEARCH
DELETEDIRECTORY	LISTALLPROPERTIES	SETDEFAULTACL
DELETEFILE	LISTCLIENTS	SETDEFAULTASOF
DOWNGRADEATTRIBUTEVIEW	LISTCURSOR	SETDEFAULTCONTEXT
DOWNGRADEGETATTRVIEW	LISTMOUNTS	SETDEFAULTOWNER
FEATURENAME	LISTSTORES	SETDEFAULTPRINCIPAL
FLUSHSTATS	LOCKPATH - missing an overload?	SETPATH - missing an overload?
GETATTR_VIEW	MOUNTSTORE	SETSTATS
GETDEFAULTACL	MOVEPATH	SETTRACE
GETDEFAULTASOF	NORMALIZEPATH	SPACEUSAGE
GETDEFAULTCONTEXT	PROPANY	TRACE
GETDEFAULTOWNER	PROPERTIESH2T	TRACEENABLED
GETDEFAULTPRINCIPAL	PROPERTIEST2H	UNLOCKPATH - missing an overload?
GETFEATURESBYMOUNT	PROPNUMBER	UNMOUNTALL
GETFEATURESBYNAME	PROPRAW	UNMOUNTSTORE
GETFEATURESBYPATH	PROPTIMESTAMP	UNREGISTERCLIENT
GETPATH	PROPVARCHAR2	UNREGISTERSTORE
GETPATHBYMOUNTID	PURGEALL	UPGRADEATTRIBUTEVIEW
GETPATHBYSTOREID	PURGEPATH	UPGRADEGETATTRVIEW
GETPATHNOWAIT

BUILDATTRIBUTESVIEW (new 21c)

Create Fastpath lookup acceleration view dbms_dbfs_content.buildAttributesView(schema_name IN VARCHAR2 DEFAULT NULL); PRAGMA SUPPLEMENTAL_LOG_DATA(buildAttributesView, AUTO_WITH_COMMIT);

exec dbms_dbfs_content.buildAttributesView('UWCLASS');

CHECKACCESS

Check if a given pathname (path, pathtype, store_name) can be manipulated by "operation (see the various "op_xxx" opcode above) by "principal"

alt. description

Reports if the user (principal) can perform the specified operation on the given path dbms_dbfs_content.checkAccess( path IN VARCHAR2, pathtype IN INTEGER, operation IN VARCHAR2, principal IN VARCHAR2, store_name IN VARCHAR2 DEFAULT NULL) RETURN BOOLEAN;

TBD

CHECKSPI

Given the name of a putative dbms_dbfs_content_spi conforming package, attempt to check the package implements provider methods (with the proper signatures), and report on the conformance
Overload 1 dbms_dbfs_content.checkSpi(package_name IN VARCHAR2) RETURN CLOB;

TBD

Overload 2 dbms_dbfs_content.checkSpi( schema_name IN VARCHAR2, package_name IN VARCHAR2) RETURN CLOB;

TBD

Overload 3 dbms_dbfs_content.checkSpi( package_name IN VARCHAR2, chk IN OUT NOCOPY CLOB);

TBD

Overload 4 dbms_dbfs_content.checkSpi( schema_name IN VARCHAR2, package_name IN VARCHAR2, chk IN OUT NOCOPY CLOB);

TBD

CREATEDIRECTORY

Creates a directory

Overload 1 dbms_dbfs_content.createDirectory( path IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, prop_flags IN INTEGER DEFAULT prop_std, recurse IN BOOLEAN DEFAULT FALSE, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2 dbms_dbfs_content.createDirectory( path IN VARCHAR2, properties IN OUT NOCOPY properties_t, prop_flags IN INTEGER DEFAULT prop_std, recurse IN BOOLEAN DEFAULT FALSE, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

CREATEFILE

Creates a file

Overload 1 dbms_dbfs_content.createFile( store_name IN VARCHAR2, path IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, content IN OUT NOCOPY BLOB, prop_flags IN INTEGER, ctx IN dbms_dbfs_content_context_t);

TBD

Overload 2 dbms_dbfs_content.createFile( path IN VARCHAR2, properties IN OUT NOCOPY properties_t, content IN OUT NOCOPY BLOB, prop_flags IN INTEGER DEFAULT (prop_std + prop_data), store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

CREATELINK

Creates a new reference to the source file system element

Overload 1 dbms_dbfs_content.createLink( srcPath IN VARCHAR2, dstPath IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, prop_flags IN INTEGER DEFAULT prop_std, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2 dbms_dbfs_content.createLink( srcPath IN VARCHAR2, dstPath IN VARCHAR2, properties IN OUT NOCOPY properties_t, prop_flags IN INTEGER DEFAULT prop_std, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

CREATEREFERENCE

Creates a physical link to an already existing file system element

Overload 1 dbms_dbfs_content.createReference( srcPath IN VARCHAR2, dstPath IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, prop_flags IN INTEGER DEFAULT prop_std, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2 dbms_dbfs_content.createreference( srcPath IN VARCHAR2, dstPath IN VARCHAR2, properties IN OUT NOCOPY properties_t, prop_flags IN INTEGER DEFAULT prop_std, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

DECODEFEATURES

Given a feature bit set integer value, returns a FEATURES_T table of the feature bits as FEATURE_T records dbms_dbfs_content.decodeFeatures(featureSet IN INTEGER) RETURN features_t deterministic PIPELINED;

TBD

DELETECONTENT

Deletes the file specified by the given contentID dbms_dbfs_content.decodeContent( store_name IN VARCHAR2, contentID IN RAW, filter IN VARCHAR2 DEFAULT NULL, soft_delete IN BOOLEAN DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

DELETEDIRECTORY

Deletes a directory dbms_dbfs_content.deleteDirectory( path IN VARCHAR2, filter IN VARCHAR2 DEFAULT NULL, soft_delete IN BOOLEAN DEFAULT NULL, recurse IN BOOLEAN DEFAULT FALSE, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

DELETEFILE

Deletes a file dbms_dbfs_content.deleteFile( path IN VARCHAR2, filter IN VARCHAR2 DEFAULT NULL, soft_delete IN BOOLEAN DEFAULT NULL, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

DOWNGRADEATTRIBUTEVIEW (new 21c)

Undocumented dbms_dbfs_content.downgradeAttributeView(store_owner IN VARCHAR2); PRAGMA SUPPLEMENTAL_LOG_DATA(downgradeAttributeView, AUTO_WITH_COMMIT);

exec dbms_dbfs_content.downgradeAttributeView('UWCLASS');

DOWNGRADEGETATTRVIEW (new 21c)

Undocumented dbms_dbfs_content.downgradeGetAttrView( store_name IN VARCHAR2, store_mount IN VARCHAR2, store_prop IN dbms_dbfs_content_properties_t, store_owner IN VARCHAR2 DEFAULT NULL);

TBD

FEATURENAME

Given a feature bit, returns a VARCHAR2 of that feature's name dbms_dbfs_content.featureName(featureBit IN INTEGER) RETURN VARCHAR2 DETERMINISTIC;

TBD

FLUSHSTATS

Flushes DBMS_DBFS_CONTENT statistics to disk dbms_dbfs_content.FlushStats;

exec dbms_dbfs_content.FlushStats;

GETATTR_VIEW

Returns the name of the Fastpath lookup acceleration view dbms_dbfs_content.getAttr_View( path IN VARCHAR2, prefix OUT NOCOPY VARCHAR2, view_name OUT NOCOPY VARCHAR2);

TBD

GETDEFAULTACL

Returns the ACL parameter of the default context dbms_dbfs_content.getDefaultACL RETURN VARCHAR2;

SELECT dbms_dbfs_content.getDEFAULTacl FROM dual;

GETDEFAULTASOF

Returns the asof parameter of the default context dbms_dbfs_content.getDefaultAsOf RETURN TIMESTAMP;

SELECT dbms_dbfs_content.getDEFAULTasof FROM dual;

GETDEFAULTCONTEXT

Returns the default context dbms_dbfs_content.getDefaultContext( principal OUT NOCOPY VARCHAR2, owner OUT NOCOPY VARCHAR2, acl OUT NOCOPY VARCHAR2, asof OUT TIMESTAMP);

TBD

GETDEFAULTOWNER

Returns the owner parameter of the default context dbms_dbfs_content.getDefaultOwner RETURN VARCHAR2;

SELECT dbms_dbfs_content.getDefaultOwner FROM dual;

GETDEFAULTPRINCIPAL

Returns the principal parameter of the default context dbms_dbfs_content.getDefaultPrincipal RETURN VARCHAR2;

SELECT dbms_dbfs_content.getDefaultPrincipal FROM dual;

GETFEATURESBYMOUNT

Returns features of a store by mount point dbms_dbfs_content.getFeaturesByMount(store_mount IN VARCHAR2) RETURN INTEGER;

TBD

GETFEATURESBYNAME

Returns features of a store by store name dbms_dbfs_content.getFeaturesByName(store_name IN VARCHAR2) RETURN INTEGER;

TBD

GETFEATURESBYPATH

Returns features of a store by path dbms_dbfs_content.getFeaturesByPath(path IN path_t) RETURN INTEGER;

TBD

GETPATH

Returns existing path items (such as files and directories)

Overload 1 dbms_dbfs_content.getPath( path IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, content OUT NOCOPY BLOB, item_type OUT INTEGER, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt + prop_data), asof IN TIMESTAMP DEFAULT NULL, forUpdate IN BOOLEAN DEFAULT FALSE, deref IN BOOLEAN DEFAULT FALSE, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2 dbms_dbfs_content.getPath( path IN VARCHAR2, properties IN OUT NOCOPY properties_t, content OUT NOCOPY BLOB, item_type OUT INTEGER, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt + prop_data), asof IN TIMESTAMP DEFAULT NULL, forUpdate IN BOOLEAN DEFAULT FALSE, deref IN BOOLEAN DEFAULT FALSE, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 3 dbms_dbfs_content.getPath( path IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, amount IN OUT NUMBER, offset IN NUMBER, buffer OUT NOCOPY RAW, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt), asof IN TIMESTAMP DEFAULT NULL, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 4 dbms_dbfs_content.getPath( path IN VARCHAR2, properties IN OUT NOCOPY properties_t, amount IN OUT NUMBER, offset IN NUMBER, buffer OUT NOCOPY RAW, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt), asof IN TIMESTAMP DEFAULT NULL, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 5 dbms_dbfs_content.getPath( path IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, amount IN OUT NUMBER, offset IN NUMBER, buffers OUT NOCOPY dbms_dbfs_content_RAW_t, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt), asof IN TIMESTAMP DEFAULT NULL, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 6 dbms_dbfs_content.getPath( path IN VARCHAR2, properties IN OUT NOCOPY properties_t, amount IN OUT NUMBER, offset IN NUMBER, buffers OUT NOCOPY dbms_dbfs_content_RAW_t, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt), asof IN TIMESTAMP DEFAULT NULL, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

GETPATHBYMOUNTID

Returns the full absolute path name dbms_dbfs_content.getPathByMountID(store_mount IN VARCHAR2, guid IN INTEGER) RETURN VARCHAR2;

TBD

GETPATHBYSTOREID

If the underlying GUID is found in the underlying store, returns the store-qualified path name dbms_dbfs_content.getPathByStoreID(store_name IN VARCHAR2, guid IN INTEGER) RETURN VARCHAR2;

TBD

GETPATHNOWAIT

Implies that the operation is for an update, and, if implemented, allows providers to return an exception (ORA-00054) rather than wait for row locks

Overload 1 dbms_dbfs_content.getPathNoWait( path IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, content OUT NOCOPY BLOB, item_type OUT INTEGER, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt + prop_data), deref IN BOOLEAN DEFAULT FALSE, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2 dbms_dbfs_content.getPathNoWait( path IN VARCHAR2, properties IN OUT NOCOPY properties_t, content OUT NOCOPY BLOB, item_type OUT INTEGER, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt + prop_data), deref IN BOOLEAN DEFAULT FALSE, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

GETSTATS

Returns information about DBMS_DBFS_CONTENT statistics collection

Note: Stats collection is very expensive as is their maintenance dbms_dbfs_content.getStats( enabled OUT BOOLEAN, flush_time OUT INTEGER, flush_count OUT INTEGER);

DECLARE

       enab  BOOLEAN;

       ftime INTEGER;

       fcnt  INTEGER; 

      BEGIN

        dbms_dbfs_content.getStats(enab, ftime, fcnt);

        IF enab THEN

          dbms_output.put_line('TRUE: Flush Time = ' || TO_CHAR(ftime) || ' - Flush Count = ' || TO_CHAR(fcnt));

        ELSE

          dbms_output.put_line('FALSE: Flush Time = ' || TO_CHAR(ftime) || ' - Flush Count = ' || TO_CHAR(fcnt));

        END IF;

      END;

      /

GETSTOREBYMOUNT

Returns a store by way of its mount point dbms_dbfs_content.getStoreByMount(store_mount IN VARCHAR2) RETURN store_t;

TBD

GETSTOREBYNAME

Returns a store by way of its name dbms_dbfs_content.getStoreByName(store_name IN VARCHAR2) RETURN store_t;

TBD

GETSTOREBYPATH

Returns a store by way of its path dbms_dbfs_content.getStoreByPath(path IN path_t) RETURN store_t;

TBD

GETTRACE

Returns whether or not DBMS_DBFS_CONTENT tracing is turned on
Returns 0 if no not currently tracing: Otherwise 1 dbms_dbfs_content.getTrace RETURN INTEGER;

SELECT dbms_dbfs_content.getTrace

      FROM dual;

      

      exec dbms_dbfs_content.setTrace(1);

      

      SELECT dbms_dbfs_content.getTrace

      FROM dual;

GETVERSION

Returns the version of the DBMS_DBFS_CONTENT interface in a standardized format associated with a store dbms_dbfs_content.getVersion;

SELECT dbms_dbfs_content.getVersion FROM dual;

ISPATHLOCKED

Undocumented

Overload 1 dbms_dbfs_content.isPathLocked( path IN VARCHAR2, who IN VARCHAR2, lock_type IN OUT INTEGER, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2 dbms_dbfs_content.isPathLocked( store_name IN VARCHAR2, path IN VARCHAR2, who IN VARCHAR2, lock_type IN OUT INTEGER, ctx IN dbms_dbfs_content_context_t);

TBD

LIST

Lists the path items in the specified path meeting the specified filter and other criteria dbms_dbfs_content.list( path IN VARCHAR2, filter IN VARCHAR2 DEFAULT NULL, recurse IN INTEGER DEFAULT 0, asof IN TIMESTAMP DEFAULT NULL, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL) RETURN dbms_dbfs_content_list_items_t PIPELINED;

TBD

LISTALLCONTENT

Lists all path items in all mounts dbms_dbfs_content.listAllContent RETURN path_items_t PIPELINED;

SELECT * FROM TABLE(dbms_dbfs_content.listallcontent);

LISTALLPROPERTIES

Returns a table of all properties for all path items in all mounts dbms_dbfs_content.listAllProperties RETURN prop_items_t PIPELINED;

SELECT * FROM TABLE(dbms_dbfs_content.listallproperties);

LISTCLIENTS

Lists all client registrations and their status dbms_dbfs_content.listClients RETURN clients_t PIPELINED;

SELECT * FROM TABLE(dbms_dbfs_content.listClients));

LISTCURSOR

A highly specialized directory enumerator that is meant for use with "dbms_fuse" and "dbfs_client" as callers, and with "dbms_dbfs_sfs.listCursor" as the callee dbms_dbfs_content.listCursor( path IN VARCHAR2, withProps IN INTEGER DEFAULT 0, doSort IN INTEGER DEFAULT 0, doFts IN INTEGER DEFAULT 0, doBulk IN INTEGER DEFAULT 0) RETURN INTEGER;

TBD

LISTMOUNTS

Lists all available mount points, their backing stores, and the store features dbms_dbfs_content.listMounts RETURN mounts_t PIPELINED;

SELECT * FROM TABLE(dbms_dbfs_content.listMounts);

LISTSTORES

Lists all available stores and their features dbms_dbfs_content.listStores RETURN stores_t PIPELINED;

SELECT * FROM TABLE(dbms_dbfs_content.listStores);

LOCKPATH

Apply user-level locks to any valid pathname (subject to store feature support) dbms_dbfs_content.lockPath( path IN VARCHAR2, lock_type IN INTEGER DEFAULT lock_read_only, lock_data IN VARCHAR2 DEFAULT NULL, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

MOUNTSTORE

Mount a registered store "store_name" and bind it to the "store_mount" mount-point dbms_dbfs_content.mountStore( store_name IN VARCHAR2, store_mount IN VARCHAR2 DEFAULT NULL, singleton IN BOOLEAN DEFAULT FALSE, principal IN VARCHAR2 DEFAULT NULL, owner IN VARCHAR2 DEFAULT NULL, acl IN VARCHAR2 DEFAULT NULL, asof IN TIMESTAMP DEFAULT NULL, read_only IN BOOLEAN DEFAULT FALSE, view_name IN VARCHAR2 DEFAULT NULL);

TBD

MOVEPATH

Change the path of a DBFS store

Overload 1 dbms_dbfs_content.movePath( oldpath IN VARCHAR2, newpath IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_content_properties_t, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2 dbms_dbfs_content.movePath( oldpath IN VARCHAR2, newpath IN VARCHAR2, properties IN OUT NOCOPY properties_t, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

NORMALIZEPATH

Convert a store-specific or full-absolute pathname into normalized form: -> verifies that the pathname is absolute, i.e. starts with a "/".

Overload 1 dbms_dbfs_content.normalizePath( path IN VARCHAR2, parent OUT NOCOPY VARCHAR2, tpath OUT NOCOPY VARCHAR2) RETURN VARCHAR2;

TBD

Overload 2 dbms_dbfs_content.normalizePath( path IN VARCHAR2, store_name OUT NOCOPY VARCHAR2, parent OUT NOCOPY VARCHAR2, tpath OUT NOCOPY VARCHAR2) RETURN VARCHAR2;

TBD

Overload 3 dbms_dbfs_content.normalizePath( path IN VARCHAR2, forWrite IN INTEGER, store_name OUT NOCOPY VARCHAR2, parent OUT NOCOPY VARCHAR2, tpath OUT NOCOPY VARCHAR2, provider OUT NOCOPY VARCHAR2, ctx OUT NOCOPY dbms_dbfs_content_context_t) RETURN VARCHAR2;

TBD

PROPANY

Constructors that take one of a variety of types and return a PROPERTY_T
Overload 1 dbms_dbfs_content.propany(val IN NUMBER) RETURN property_t;

TBD

Overload 2 dbms_dbfs_content.propany(val IN VARCHAR2) RETURN property_t;

TBD

Overload 3 dbms_dbfs_content.propany(val IN TIMESTAMP) RETURN property_t;

TBD

Overload 4 dbms_dbfs_content.propany(val IN RAW) RETURN property_t;

TBD

PROPERTIESH2T

Converts a PROPERTY_T hash to a DBMS_DBFS_CONTENT_PROPERTIES_T table dbms_dbfs_content.propertiesH2T(pprops IN properties_t) RETURN dbms_dbfs_content_properties_t;

TBD

PROPERTIEST2H

Converts a DBMS_DBFS_CONTENT_PROPERTIES_T table to a PROPERTY_T hash dbms_dbfs_content.propertiesT2H(sprops IN dbms_dbfs_content_properties_t) RETURN properties_t;

TBD

PROPNUMBER

Constructor that takes a NUMBER and returns a PROPERTY_T dbms_dbfs_content.propNumber(val IN NUMBER) RETURN property_t;

TBD

PROPRAW

Constructor that takes a RAW and returns a PROPERTY_T dbms_dbfs_content.propRaw(val IN RAW) RETURN property_t;

TBD

PROPTIMESTAMP

constructor that takes a TIMESTAMP and returns a PROPERTY_T dbms_dbfs_content.propTimestamp(val IN TIMESTAMP) RETURN property_t;

TBD

PROPVARCHAR2

constructor that takes a VARCHAR2 and returns a PROPERTY_T dbms_dbfs_content.propVarchar2(val IN VARCHAR2) RETURN property_t;

TBD

PURGEALL

Purges all soft-deleted entries matching the path and optional filter criteria dbms_dbfs_content.purgeAll( path IN VARCHAR2, filter IN VARCHAR2 DEFAULT NULL, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

PURGEPATH

Purges any soft-deleted versions of the given path item dbms_dbfs_content.purgePath( path IN VARCHAR2, filter IN VARCHAR2 DEFAULT NULL, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

PUTPATH

Creates a new path item

Overload 1 dbms_dbfs_content.putPath( path IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, content IN OUT NOCOPY BLOB, item_type OUT INTEGER, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt + prop_data), store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2 dbms_dbfs_content.putPath( path IN VARCHAR2, properties IN OUT NOCOPY properties_t, content IN OUT NOCOPY BLOB, item_type OUT INTEGER, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt + prop_data), store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 3 dbms_dbfs_content.putPath( path IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, amount IN NUMBER, offset IN NUMBER, buffer IN RAW, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt), store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 4 dbms_dbfs_content.putPath( path IN VARCHAR2, properties IN OUT NOCOPY properties_t, amount IN NUMBER, offset IN NUMBER, buffer IN RAW, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt), store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 5 dbms_dbfs_content.putPath( path IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, written OUT NUMBER, offset IN NUMBER, buffers IN dbms_dbfs_content_raw_t, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt), store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 6 dbms_dbfs_content.putPath( path IN VARCHAR2, properties IN OUT NOCOPY properties_t, written OUT NUMBER, offset IN NUMBER, buffers IN dbms_dbfs_content_raw_t, prop_flags IN INTEGER DEFAULT (prop_std + prop_opt), store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

REGISTERCLIENT

Add a DBFS clients registrations dbms_dbfs_content.registerClient( client_info IN VARCHAR2, client_data IN VARCHAR2 DEFAULT NULL);

See unRegisterClient Below

REGISTERSTORE

Register a new store "store_name" backed by provider "provider_name" that uses "provider_package" as the store provider (conforming to the "dbms_dbfs_content_spi" package signature) dbms_dbfs_content.registerStore( store_name IN VARCHAR2, provider_name IN VARCHAR2, provider_package IN VARCHAR2);

TBD

REMOUNTALL

Remount all DBFS stores dbms_dbfs_content.remountAll;

exec dbms_dbfs_content.remountAll;

REMOUNTSTORE

Remount an existing DBFS store dbms_dbfs_content.remountStore( store_name IN VARCHAR2 DEFAULT NULL, store_mount IN VARCHAR2 DEFAULT NULL, ignore_unknown IN BOOLEAN DEFAULT FALSE);

TBD

RENAMEPATH

Rename a store path

Overload 1 dbms_dbfs_content.renamePath( oldPath IN VARCHAR2, newPath IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2 dbms_dbfs_content.renamePath( oldPath IN VARCHAR2, newPath IN VARCHAR2, properties IN OUT NOCOPY properties_t, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

RESTOREALL

Restores all soft-deleted path items meeting the path and filter criteria dbms_dbfs_content.restoreAll( path IN VARCHAR2, filter IN VARCHAR2 DEFAULT NULL, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

RESTOREPATH

Restores all soft-deleted path items that match the given path and filter criteria dbms_dbfs_content.restorePath( path IN VARCHAR2, filter IN VARCHAR2 DEFAULT NULL, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

Search the contents of a directory path dbms_dbfs_content.search( path IN VARCHAR2, filter IN VARCHAR2 DEFAULT NULL, recurse IN INTEGER DEFAULT 0, asof IN TIMESTAMP DEFAULT NULL, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL) RETURN dbms_dbfs_content_list_items_t PIPELINED;

TBD

SETDEFAULTACL

Sets the ACL parameter of the default context dbms_dbfs_content.setDefaultACL(acl IN VARCHAR2);

TBD

SETDEFAULTASOF

Sets the "as of" parameter of the default context dbms_dbfs_content.setDefaultAsOf(asof IN TIMESTAMP);

exec dbms_dbfs_content.setDefaultAsOf(SYSTIMESTAMP-1);

SETDEFAULTCONTEXT

Sets the default context dbms_dbfs_content.setDefaultContext( principal OUT NOCOPY VARCHAR2, owner OUT NOCOPY VARCHAR2, acl OUT NOCOPY VARCHAR2, asof OUT TIMESTAMP);

DECLARE

       princ  VARCHAR2(30);

       owner  VARCHAR2(30);

       aclval VARCHAR2(30);

       asof   TIMESTAMP(9);

      BEGIN

        dbms_dbfs_content.setDefaultContext(princ, owner, aclval, asof);

        dbms_output.put_line(princ);

        dbms_output.put_line(owner);

        dbms_output.put_line(aclval);

        dbms_output.put_line(TO_CHAR(asof));

      END;

      /

SETDEFAULTOWNER

Set the DEFAULT store owner dbms_dbfs_content.setDefaultOwner(owner IN VARCHAR2);

exec dbms_dbfs_content.setDefaultOwner('UWCLASS');

SETDEFAULTPRINCIPAL

Sets the "principal" parameter of the default context dbms_dbfs_content.setDefaultPrincipal(principal IN VARCHAR2);

exec dbms_dbfs_content.setDefaultOwner('UWUSER');

SETPATH

Assigns a path name to a path item represented by contentID

Overload 1 dbms_dbfs_content.setPath( store_name IN VARCHAR2, contentID IN RAW, path IN VARCHAR2, properties IN OUT NOCOPY dbms_dbfs_content_properties_t, principal IN VARCHAR2 DEFAULT NULL);

TBD

Overload 2 dbms_dbfs_content.setPath( store_name IN VARCHAR2, contentID IN RAW, path IN VARCHAR2, properties IN OUT NOCOPY properties_t, principal IN VARCHAR2 DEFAULT NULL);

TBD

SETSTATS

Enables and disables statistics collection dbms_dbfs_content.setStats( enable IN BOOLEAN, flush_time IN INTEGER DEFAULT NULL, flush_count IN INTEGER DEFAULT NULL);

exec dbms_dbfs_content.setStats(TRUE);

SETTRACE

Enable tracing by setting the trace level dbms_dbfs_content.setTrace(trclvl IN INTEGER);

See getTrace Demo Above

SPACEUSAGE

Query file system space usage statistics

Overload 1 dbms_dbfs_content.spaceUsage( store_name IN VARCHAR2, blksize OUT INTEGER, tbytes OUT INTEGER, fbytes OUT INTEGER, nfile OUT INTEGER, ndir OUT INTEGER, nlink OUT INTEGER, nref OUT INTEGER);

TBD

Overload 2 dbms_dbfs_content.spaceUsage( store_name IN VARCHAR2, blksize OUT INTEGER, tbytes OUT INTEGER, fbytes OUT INTEGER, nfile OUT INTEGER, ndir OUT INTEGER, nlink OUT INTEGER, nref OUT INTEGER, useEstimate IN INTEGER);

TBD

TRACE

Undocumented dbms_dbfs_content.trace( sev IN INTEGER, msg0 IN VARCHAR2, msg1 IN VARCHAR DEFAULT '', msg2 IN VARCHAR DEFAULT '', msg3 IN VARCHAR DEFAULT '', msg4 IN VARCHAR DEFAULT '', msg5 IN VARCHAR DEFAULT '', msg6 IN VARCHAR DEFAULT '', msg7 IN VARCHAR DEFAULT '', msg8 IN VARCHAR DEFAULT '', msg9 IN VARCHAR DEFAULT '', msg10 IN VARCHAR DEFAULT '');

TBD

TRACEENABLED

Undocumented dbms_dbfs_content.traceEnabled(sev IN INTEGER) RETURN INTEGER;

set serveroutput on

      

      DECLARE

       x INTEGER;

      BEGIN

        x := dbms_dbfs_content.traceEnabled(2);

        dbms_output.put_line(x);

      END;

      /

UNLOCKPATH

Undocumented dbms_dbfs_content.unlockPath( path IN VARCHAR2, store_name IN VARCHAR2 DEFAULT NULL, principal IN VARCHAR2 DEFAULT NULL);

TBD

UNMOUNTALL

Unmount all DBFS stores dbms_dbfs_content.unmountAll;

exec dbms_dbfs_content.unmountAll;

UNMOUNTSTORE

Unmounts a registered store dbms_dbfs_content.unmountStore( store_name IN VARCHAR2 DEFAULT NULL, store_mount IN VARCHAR2 DEFAULT NULL, ignore_unknown IN BOOLEAN DEFAULT FALSE);

TBD

UNREGISTERCLIENT

Remove a DBFS clients registrations dbms_dbfs_dbfs_content.unregisterClient(client_info IN VARCHAR2);

exec dbms_dbfs_content.registerClient('REGTEST');

      exec dbms_dbfs_content.unregisterClient('REGTEST');

UNREGISTERSTORE

Unregisters a store dbms_dbfs_content.unregisterStore( store_name IN VARCHAR2, ignore_unknown IN BOOLEAN DEFAULT FALSE);

TBD

UPGRADEATTRIBUTEVIEW (new 21c)

Undocumented dbms_dbfs_content.upgradeAttributeView(store_owner IN VARCHAR2);

exec dbms_dbfs_content.upgradeAttributeView('UWCLASS');

UPGRADEGETATTRVIEW (new 21c)

Undocumented dbms_dbfs_content.upgradeGetAttrView( store_name IN VARCHAR2, store_mount IN VARCHAR2, store_prop IN dbms_dbfs_content_properties_t, store_owner IN VARCHAR2 DEFAULT NULL);

TBD