16.20 - getBinaryStream() - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
16.20
Release Date
April 2020
Content Type
Programming Reference
Publication ID
B035-1147-162K
Language
English (United States)

Purpose

Retrieves the XML value designated by this SQLXML instance as a stream.

Syntax

InputStream getBinaryStream()
                       throws SQLException

Return Value

A stream containing the XML data.

The bytes of the input stream are interpreted according to Appendix F of the XML 1.0 specification.

Usage Notes

The behavior of this method is the same as ResultSet.getBinaryStream() 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. An exception is thrown if the state is not readable. A database specific code “9752 (ERRUDFJAVAXML) <Error retrieving XML value in getBinaryStream>” is returned.