Oracle DBMS_XMLSCHEMA_ANNOTATE
Version 21c

General Information
Library Note Morgan's Library Page Header
Which has the higher priority in your organization: Deploying a new database or securing the ones you already have? Looking for a website, and resources, dedicated solely to securing Oracle databases? Check out DBSecWorx.
Purpose XML Annotation Support
AUTHID CURRENT_USER
Dependencies
DBMS_STANDARD DBMS_XMLDOM XMLSEQUENCE
DBMS_XDB_CONSTANTS DUAL XMLTYPE
Documented No
Exceptions
Error Code Reason
   
   
   
First Available 12.1
Pragma PRAGMA SUPPLEMENTAL_LOG_DATA(default, NONE);
Security Model Owned by XDB with EXECUTE granted to PUBLIC
Source {ORACLE_HOME}/rdbms/admin/dbmsxutil.sql
{ORACLE_HOME}/rdbms/admin/prvtxutil.plb
Subprograms
 
ADDXDBNAMESPACE
Adds the XDB namespace required for XDB annotation dbms_xmlschema_annotate.addXDBNamespace(xmlschema IN OUT XMLType);
TBD
 
DISABLEDEFAULTTABLECREATION
Add a default table attribute with an empty value to the top level element with the specified name

Overload 1
dbms_xmlschema_annotate.disbleDeaultTableCreation(
xmlschema         IN OUT XMLType,
globalElementName IN     VARCHAR2);
TBD
Add a default table attribute with an empty value to ALL top level elements that have no defined default table name

Overload 2
dbms_xmlschema_annotate.disbleDeaultTableCreation(xmlschema IN OUT XMLType);
TBD
 
DISABLEMAINTAINDOM
sets DOM fidelity to FALSE to ALL complex types irregardless of their names

Overload 1
dbms_xmlschema_annotate.disableMaintainDOM(
xmlschema IN OUT XMLType,
overwrite        BOOLEAN DEFAULT TRUE);
TBD
Sets the DOM fidelity attribute for the given complex type name to FALSE

Overload 2
dbms_xmlschema_annotate.disableMaintainDOM(
xmlschema       IN OUT XMLType,
complexTypeName IN     VARCHAR2,
overwrite       IN     BOOLEAN DEFAULT TRUE);
TBD
 
ENABLEDEFAULTTABLECREATION
Enables the creation of top level tables by removing the empty default table name annotation.

Overload 1
dbms_xmlschema_annotate.enableDefaultTableCreation(
xmlschema         IN OUT XMLType,
globalElementName IN     VARCHAR2);
TBD
Enables the creation of ALL top level tables by removing the empty default table name annotation.

Overload 2
dbms_xmlschema_annotate.enableDefaultTableCreation(xmlschema IN OUT XMLType);
TBD
 
ENABLEMAINTAINDOM
Sets DOM fidelity to TRUE to ALL complex types irregardless of their names

Overload 1
dbms_xmlschema_annotate.enableMaintainDOM(
xmlschema IN OUT XMLType,
overwrite        BOOLEAN DEFAULT TRUE);
TBD
Sets the DOM fidelity attribute for the given complex type name to TRUE

Overload 2
dbms_xmlschema_annotate.enableMaintainDOM(
xmlschema       IN OUT XMLType,
complexTypeName IN     VARCHAR2,
overwrite       IN     BOOLEAN DEFAULT TRUE);
TBD
 
GETSCHEMAANNOTATIONS
Creates a diff of the annotated XML schema and the non-annotated XML schema dbms_xmlschema_annotate.getSchemaNotations(xmlschema IN xmlType) RETURN XMLType;
TBD
 
PRINTWARNINGS
Undocumented dbms_xmlschema_annotate.printWarnings(value IN BOOLEAN DEFAULT TRUE);
TBD
 
REMOVEANYSTORAGE
Removes the sqltype of any dbms_xmlschema_annotate.removeAnyStorage(
xmlschema       IN OUT XMLType,
complexTypeName IN     VARCHAR2);
TBD
 
REMOVEDEFAULTTABLE
Removes the default table attribute for the given element. After calling this function system generated table names will be used dbms_xmlschema_annotate.removeDefaultTable(
xmlschema         IN OUT XMLType,
globalElementName IN     VARCHAR2);
TBD
 
REMOVEMAINTAINDOM
Removes all maintain DOM annotations from given schema dbms_xmlschema_annotate.removeMaintainDOM(xmlschema IN OUT XMLType);
TBD
 
REMOVEOUTOFLINE
Removes the sqlInline attribute for the element specified by its name

Overload 1
dbms_xmlschema_annotate.removeOutOfLine(
xmlschema   IN OUT XMLType,
elementName IN     VARCHAR2,
elementType IN     VARCHAR2);
TBD
Removes the sqlInline attribute for the element specified by its global and local name

Overload 2
dbms_xmlschema_annotate.removeOutOfLine(
xmlschema        IN OUT XMLType,
globalObject     IN     VARCHAR2,
globalObjectName IN     VARCHAR2,
localElementName IN     VARCHAR2);
TBD
Overload 3 dbms_xmlschema_annotate.removeOutOfLine(
xmlschema IN OUT XMLType,
reference IN     VARCHAR2);
TBD
 
REMOVESQLCOLLTYPE
Removes the sql collection type dbms_xmlschema_annotate.removeSQLCollType(
xmlschema        IN OUT XMLType,
globalObject     IN     VARCHAR2,
globalObjectName IN     VARCHAR2,
localElementName IN     VARCHAR2);
TBD
 
REMOVESQLNAME
Removes a sqlname from a global element dbms_xmlschema_annotate.removeSQLName(
xmlschema        IN OUT XMLType,
globalObject     IN     VARCHAR2,
globalObjectName IN     VARCHAR2,
localObject      IN     VARCHAR2,
localObjectName  IN     VARCHAR2);
TBD
 
REMOVESQLTYPE
Removes a sqltype from a global element

Overload 1
dbms_xmlschema_annotate.removeSQLType(
xmlschema         IN OUT XMLType,
globalElementName IN     VARCHAR2);
TBD
Removes a sqltype inside a complex type (local)

Overload 2
dbms_xmlschema_annotate.removeSQLType(
xmlschema        IN OUT XMLType,
globalObject     IN     VARCHAR2,
globalObjectName IN     VARCHAR2,
localObject      IN     VARCHAR2,
localObjectName  IN     VARCHAR2);
TBD
 
REMOVESQLTYPEMAPPING
Removes the sqltype mapping for the given schema type dbms_xmlschema_annotate.removeSQLTypeMapping(
xmlschema      IN OUT XMLType,
schemaTypeName IN     VARCHAR2);
TBD
 
REMOVETABLEPROPS
Removes the table storage props

Overload 1
dbms_xmlschema_annotate.removeTableProps(
xmlschema         IN OUT XMLType,
globalElementName IN     VARCHAR2);
TBD
Removes the TABLE storage clause that is appended to the default CREATE TABLE statement.

Overload 2
dbms_xmlschema_annotate.removeTableProps(
xmlschema        IN OUT XMLType,
globalObject     IN     VARCHAR2,
globalObjectName IN     VARCHAR2,
localElementName IN     VARCHAR2);
TBD
 
REMOVETIMESTAMPWITHTIMEZONE
Removes the TimeStampWithTimeZone datatype to dateTime typed element dbms_xmlschema_annotate.removeTimestampWithTimezone(xmlschema IN OUT xmlType);
TBD
 
SETANYSTORAGE
Sets the sqltype of any dbms_xmlschema_annotate.setanyStorage(
xmlschema       IN OUT XMLType,
complexTypeName IN     VARCHAR2,
sqlTypeName     IN     VARCHAR2,
overwrite       IN     BOOLEAN DEFAULT TRUE);
TBD
 
SETDEFAULTTABLE
Sets the name of the default table for a given global element that is specified by its name dbms_xmlschema_annotate.setDefaultTable(
xmlschema         IN OUT XMLType,
globalElementName IN     VARCHAR2,
tableName         IN     VARCHAR2,
overwrite         IN     BOOLEAN DEFAULT TRUE);
TBD
 
SETOUTOFLINE
Set the sqlInline attribute to FALSE and forces the out of line storage for the element specified by its name

Overload 1
dbms_xmlschema_annotate.setOutOfLine(
xmlschema        IN OUT XMLType,
elementName      IN     VARCHAR2,
elementType      IN     VARCHAR2,
defaultTableName IN     VARCHAR2,
overwrite        IN     BOOLEAN DEFAULT TRUE);
TBD
Set the sqlInline attribute to FALSE and forces the out of line storage for the element specified by its local and global name

Overload 2
dbms_xmlschema_annotate.setOutOfLine(
xmlschema        IN OUT XMLType,
globalObject     IN     VARCHAR2,
globalObjectName IN     VARCHAR2,
localElementName In     VARCHAR2,
defaultTableName IN     VARCHAR2,
overwrite        IN     BOOLEAN DEFAULT TRUE);
TBD
Sets the default table name and sqlinline attribute for all references to a particular global Element

Overload 3
dbms_xmlschema_annotate.setOutOfLine(
xmlschema        IN OUT XMLType,
reference        IN     VARCHAR2,
defaultTableName IN     VARCHAR2,
overwrite        IN     BOOLEAN DEFAULT TRUE);
TBD
 
SETSCHEMAANNOTATIONS
Accepts annotations (diff result from call to 'getSchemaAnnotations' and patches in the provided XML schema dbms_xmlschema_annotate.setSchemaAnnotations(
xmlschema   IN OUT xmlType,
annotations IN     XMLTYPE);
TBD
 
SETSQLCOLLTYPE
Name of the SQL collection type that corresponds to this XML element. inside a complex type

Overload 1
dbms_xmlschema_annotate.setSQLCollType(
xmlschema        IN OUT XMLType,
globalObject     IN     VARCHAR2,
globalObjectName IN     VARCHAR2,
localElementName IN     VARCHAR2,
sqlCollType      IN     VARCHAR2,
overwrite        IN     BOOLEAN DEFAULT TRUE );
TBD
Overload 2 dbms_xmlschema_annotate.setSQLCollType(
TBD
 
SETSQLNAME
Assigns a sqlname to an element dbms_xmlschema_annotate.setSQLName(
xmlschema        IN OUT XMLType,
globalObject     IN     VARCHAR2,
globalObjectName IN     VARCHAR2,
localObject      IN     VARCHAR2,
localObjectName  IN     VARCHAR2,
sqlName          IN     VARCHAR2,
overwrite        IN     BOOLEAN DEFAULT TRUE);
TBD
 
SETSQLTYPE
Assigns a sqltype to a global element

Overload 1
dbms_xmlschema_annotate.setSQLType(
xmlschema         IN OUT XMLType,
globalElementName IN     VARCHAR2,
sqlType           IN     VARCHAR2,
overwrite         IN     BOOLEAN DEFAULT TRUE);
TBD
Assigns a sqltype inside a complex type (local)

Overload 2
dbms_xmlschema_annotate.setSQLType(
xmlschema        IN OUT XMLType,
globalObject     IN     VARCHAR2,
globalObjectName IN     VARCHAR2,
localObject      IN     VARCHAR2,
localObjectName  IN     VARCHAR2,
sqlType          IN     VARCHAR2,
overwrite        IN     BOOLEAN DEFAULT TRUE);
TBD
 
SETSQLTYPEMAPPING
Defines a mapping of schema type and sqltype dbms_xmlschema_annotate.setSQLTypeMapping(
xmlschema      IN OUT XMLType,
schemaTypeName IN     VARCHAR2,
sqlTypeName    IN     VARCHAR2,
overwrite      IN     BOOLEAN DEFAULT TRUE);
TBD
 
SETTABLEPROPS
Specifies the TABLE storage clause that is appended to the default CREATE TABLE statement

Overload 1
dbms_xmlschema_annotate.setTableProps(
xmlschema         IN OUT XMLType,
globalElementName IN     VARCHAR2,
tableProps        IN     VARCHAR2,
overwrite         IN     BOOLEAN DEFAULT TRUE);
TBD
Specifies the TABLE storage clause that is appended to the default CREATE TABLE statement

Overload 2
dbms_xmlschema_annotate.setTableProps(
xmlschema        IN OUT XMLType,
globalObject     IN     VARCHAR2,
globalObjectName IN     VARCHAR2,
localElementName IN     VARCHAR2,
tableProps       IN     VARCHAR2,
overwrite        IN     BOOLEAN DEFAULT TRUE);
TBD
 
SETTIMESTAMPWITHTIMEZONE
Sets the TimeStampWithTimeZone datatype to dateTime typed element dbms_xmlschema_annotate.setTimestampWithTimezone(
xmlschema IN OUT xmlType,
overwrite IN     BOOLEAN DEFAULT TRUE);
TBD

Related Topics
Built-in Functions
Built-in Packages
Database Security
What's New In 19c
What's New In 20c-21c

Morgan's Library Page Footer
This site is maintained by Dan Morgan. Last Updated: This site is protected by copyright and trademark laws under U.S. and International law. © 1998-2021 Daniel A. Morgan All Rights Reserved
  DBSecWorx