getCharacterStream() - Advanced SQL Engine - Teradata Database

SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.05
17.00
Published
June 2020
Language
English (United States)
Last Update
2021-01-24
dita:mapPath
qwr1571437338192.ditamap
dita:ditavalPath
lze1555437562152.ditaval
dita:id
B035-1147
lifecycle
previous
Product Category
Teradata Vantage™

Purpose

Retrieves the XML value designated by this SQLXML instance as a java.io.Reader object.

Syntax

Reader getCharacterStream()
                throws SQLException

Return Value

A stream containing the XML data.

The format of this stream is defined by org.xml.sax.InputSource, where the characters in the stream represent the Unicode code points for XML according to the XML 1.0 specification.

Although an encoding declaration other than Unicode may be present, the encoding of the stream is Unicode.

Usage Notes

The behavior of this method is the same as ResultSet.getCharacterStream() when the designated column of the ResultSet has a type java.sql.Types of SQLXML.

The SQL XML object becomes unreadable when this method is called and may also become not writable depending on the implementation.

Exceptions

Throws SQLException if there is an error processing the XML value. The getCause() method of the exception may provide a more detailed exception, such as if the stream does not contain valid characters.

An exception is thrown if the state is not readable. A database specific code “9752 (ERRUDFJAVAXML) <Error retrieving XML value in getCharacterStream>” is returned.