Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The <rowsets-tag> tag can have the following children, which are described in the following sections:

Anchor
Rowset
Rowset
<rowset> Tag

...

Each <rowset> tag gets the same ID as the <free-query> tag in the retrieval request document to indicate to which query this rowset replies.

AttributeDefinition
idRequired. Holds the same ID value as the <free-query> tag in the retrieval request document to help identify to which query this rowset replies.

The <rowset> tag can have the following children, which are described in the following sections:

Anchor
Row
Row
<row> Tag

Holds the value for a specific row.

AttributeDefinition
rownumRequired. Holds the ordinal number of the row.

The <row> tag can have the following children, which are described in the following sections:

Anchor
ColumnName
ColumnName
<column name> tag

Holds the actual name of the column or its alias (as it is retrieved from the RDBMS), depending on the query.

AttributeDefinition
typeOptional. Holds the Java representation of the column type, such as STRING, INTEGER, FLOAT, DOUBLE. If the retrieval request contains the type attribute, each column of the response request consequently contains a type attribute, too.

Anchor
RowsetInfo
RowsetInfo
<rowset-info> tag

Holds metadata on the query, such as the number of rows affected.

ChildDefinition
<affected-rows>

Optional. Indicates how many rows have been affected:

  • In case of a query, it indicates the number of rows returned in response.
  • In case of a DML, it indicates, for example, how many rows have been deleted.
<more-rows>

Optional. Indicates if more rows are to be retrieved. Can have the values TRUE or FALSE.

For example, if the <meta-data> tag of the <free-query> tag requests only five rows and the query returns 10 rows, the value of the <affected-rows> tag is five and the <more-rows> tag is TRUE.

Anchor
Error
Error
<error> tag

Holds information if an error has occurred. Upon successful connection, this tag has a value of zero. Any other value indicates an error.

ChildDefinition
<code>Required. Contains an integer value of the retrieve results. A value of 0 indicates a successful, error-free completion. Any other value indicates an error.
<description>Optional. If an error occurs, this tag contains the error description.
<external-code>Optional. If an RDBMS error occurs, this tag contains the RDBMS code.
<external-description>Optional. If an RDBMS error occurs, this tag contains the RDBSM error description.
Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
Newtabfooter
aliasIDERA
urlhttp://www.idera.com
 | 
Newtabfooter
aliasProducts
urlhttps://www.idera.com/productssolutions/sqlserver
 
Newtabfooter
aliasPurchase
urlhttps://www.idera.com/buynow/onlinestore
 | 
Newtabfooter
aliasSupport
urlhttps://idera.secure.force.com/precise/
 | 
Newtabfooter
aliasCommunity
urlhttp://community.idera.com
 
|
 
Newtabfooter
aliasResources
urlhttp://www.idera.com/resourcecentral
 | 
Newtabfooter
aliasAbout Us
urlhttp://www.idera.com/about/aboutus
 
Newtabfooter
aliasLegal
urlhttps://www.idera.com/legal/termsofuse