Oracle in a Nutshell

Calls

PROCEDURE DBMS_XMLGEN.newContext (query IN VARCHAR2 | SYS_REFCURSOR) RETURN ctxHandle;

Generates a context handle ctxHandle from either a query sting or a PL/SQL reference cursor.

PROCEDURE DBMS_XMLGEN.setRowTag (ctx IN ctxHandle, rowTag IN VARCHAR2);

Sets the name of the element separating the rows to rowTag in ctx.

PROCEDURE DBMS_XMLGEN.setRowSetTag (ctx IN ctxHandle, rowSetTag IN VARCHAR2);

Sets the name of the root element for the document ctx to rowSetTag.

FUNCTION DBMS_XMLGEN.getXML[Type] ({ctx IN ctxHandle | sqlQuery IN VARCHAR2}, [clobval IN OUT NCOPY clob,] dtdOrSchema IN NUMBER := NONE) RETURN {BOOLEAN | CLOB | SYS.XMLType};

This function has five forms:

• Using ctx for the query and clobval, which appends rows to clobval

• Using ctx and returning the XML document as a CLOB

• Using sqlQuery to send the query string and returning a CLOB

• Using ctx and returning the XML document as SYS.XMLType, which uses the call getXMLType

• Using sqlQuery and returning the XML document as SYS.XMLType, which uses the call getXMLType

All forms use dtdOrSchema, which supports only the default.

FUNCTION DBMS_XMLGEN.getNumRowsProcessed (ctx IN ctxHandle) RETURN NUMBER;

Returns the number of rows in XML document ctx.

PROCEDURE DBMS_XMLGEN.setMaxRows (ctx IN ctxHandle, maxRows IN NUMBER);

Sets the maximum number of rows maxRows to fetch for each invocation getXML call for XML document ctx.

PROCEDURE DBMS_XMLGEN.setSkipRows (ctx IN ctxHandle, skipRows IN NUMBER);

Sets the number of rows to skip (skipRows ...