setCharacterStream() - Analytics Database - Teradata Vantage

SQL External Routine Programming

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Analytics Database
Teradata Vantage
Release Number
17.20
Published
June 2022
ft:locale
en-US
ft:lastEdition
2025-03-30
dita:mapPath
iiv1628111441820.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
qnu1472247494689
lifecycle
latest
Product Category
Teradata Vantage™

Retrieves a stream to be used to write the XML value that this SQLXML instance represents.

Returns a stream to which data can be written.

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.

Syntax

Writer setCharacterStream()
                throws SQLException

Usage Notes

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

The SQL XML object becomes not writeable when this method is called and may also become unreadable 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 writable. A database specific code “9752 (ERRUDFJAVAXML) < Error processing XML value in setCharacterStream>” is returned.