|
IRISLIB database
|
|
|
IRISLIB database
|
|
FOR INTERNAL USE - do not invoke directly. More...
Public Member Functions | |
| BeforeFirst () | |
| Position the cursor before the first row in the result set. | |
| _.Library.RawString | Get (_.Library.RawString colindex) |
| Returns the value of the column with the name colname in the current row of the result set. More... | |
| _.Library.List | GetBuffer (_.Library.Boolean moreBuffers) |
| Returns the current row buffer to the caller. More... | |
| _.Library.Integer | GetFetchSize () |
| Retrieves the fetch size for this ResultSet object. | |
| _.XDBC.Gateway.ResultSetMetaData | GetMetaData () |
| Return the result set metadata as a SQL.StatementMetadata instance. | |
| _.Library.ObjectHandle | GetObject (_.Library.Integer columnIndex) |
| Gets the value of the designated column in the current row of this ResultSet object as ObjectHandle. | |
| _.Library.List | GetRow () |
| Advance to the next row in the result referenced by <property>ProcCursor</property>. More... | |
| _.Library.Integer | GetRows (_.Library.Integer rowCount, _.Library.List rows, _.Library.Status sc) |
| Advance the next <parameter>rowCount</parameter> rows in the result. More... | |
| _.Library.Boolean | IsBeforeFirst () |
| Getter method for the isBeforeFirst property on this class, which tracks. More... | |
| _.Library.Boolean | Next () |
| Advance to the next row in the result referenced by <property>ProcCursor</property>. More... | |
| SetFetchSize (_.Library.Integer rowCount) | |
| Gives the driver a hint as to the number of rows that should be fetched from the database when more rows are needed for this ResultSet object. | |
| _.Library.Boolean | WasNull () |
| Reports whether the last column read had a value of SQL NULL. | |
 Public Member Functions inherited from ResultSet | |
| _.Library.Integer | GetRows (_.Library.Integer rowCount) |
| Advance the next <parameter>rowCount</parameter> rows in the result referenced by <property>ProcCursor</property>. More... | |
| Public Member Functions inherited from RegisteredObject | |
| _.Library.Status | OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount) |
| This callback method is invoked when the current object is added to the SaveSet,. More... | |
| _.Library.Status | OnClose () |
| This callback method is invoked by the <METHOD>Close</METHOD> method to. More... | |
| _.Library.Status | OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned) |
| This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More... | |
| _.Library.Status | OnNew () |
| This callback method is invoked by the <METHOD>New</METHOD> method to. More... | |
| _.Library.Status | OnValidateObject () |
| This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More... | |
Private Member Functions | |
| _.Library.Boolean | Next () |
| Advance to the next row in the result referenced by <property>ProcCursor</property>. More... | |
| _.Library.Status | Print (_.Library.String pDelimiter, _.Library.Integer colAlign, _.Library.ArrayOfObjects metadata) |
| Print() More... | |
Additional Inherited Members | |
| Static Public Attributes inherited from RegisteredObject | |
| CAPTION = None | |
| Optional name used by the Form Wizard for a class when generating forms. More... | |
| JAVATYPE = None | |
| The Java type to be used when exported. | |
| PROPERTYVALIDATION = None | |
| This parameter controls the default validation behavior for the object. More... | |
FOR INTERNAL USE - do not invoke directly.
|
private |
Advance to the next row in the result referenced by <property>ProcCursor</property>.
Returns 0 if the cursor is at the end of the
result set. An optional argument contains a <class>Library.Status</class> value on return. This Status value indicates success or failure of the Next call. <property>SQLCODE</property> is also set by Next. This implementation is overridden by classes that implement the result set interface.
Reimplemented from ResultSet.
|
private |
Print()
Write the current row to the current device. An optional column delimiter can be specified. No formatting is applied other than writing pDelimiter between column values. This can be useful for exporting result set data to tab delimited files.
For example:
set sql = "select name,home_street,home_city,home_state,home_zip from sample.person" set rset = ##class(ResultSet.SQL).Prepare(.sql,.err,"") if '$Isobject(err) { set file="c:\temp\names.asv" open file:"WNS" use file while rset.Next() { do rset.Print($char(9)) } close file }
Example data:
| Cornell,Ezra M. | 340 Franklin Court | Sarasota | NY | 12866 |
| Huff,Stephen A. | 548 Washington Blvd | Brownfield Center | MD | 53436 |
| Sands,Jeep Q. | 7298 Washington Drive | Xavier | WY | 23685 |
| _.Library.RawString Get | ( | _.Library.RawString | colindex | ) |
Returns the value of the column with the name colname in the current row of the result set.
If colname is not a valid column name, this method throws a <PROPERTY DOES NOT EXIST> error.
Reimplemented from ResultSet.
| _.Library.List GetBuffer | ( | _.Library.Boolean | moreBuffers | ) |
Returns the current row buffer to the caller.
This method will refuse to return the buffer if there result set is already being iterated over by cursor (if the cursor is not before the start of the result set) Returns 1 if more buffers exist, 0 if this is the last buffer
Reimplemented from ResultSet.
| _.Library.List GetRow | ( | ) |
Advance to the next row in the result referenced by <property>ProcCursor</property>.
Returns 0 if the cursor is at the end of the
result set. An optional argument contains a <class>Library.Status</class> value on return. This Status value indicates success or failure of the <method>GetRow</method> call. <property>SQLCODE</property> is also set by <method>GetRow</method>. The row is returned in $List format by reference in the <parameter>Row</parameter> argument. If SQLCODE'=0, Row will be null (""). This implementation is overridden by classes that implement the result set interface.
Reimplemented from ResultSet.
| _.Library.Integer GetRows | ( | _.Library.Integer | rowCount, |
| _.Library.List | rows, | ||
| _.Library.Status | sc | ||
| ) |
Advance the next <parameter>rowCount</parameter> rows in the result.
Returns 0 if the cursor is at the end of the
result set. Note, when 0 is returned, it is likely there are rows returned in the <parameter>rows</parameter> array. An optional argument contains a <class>Library.Status</class> value on return. This Status value indicates success or failure of the <method>GetRows</method> call. <property>SQLCODE</property> is also set by GetRows. The rows are returned in an array of $List values in the <parameter>Row</parameter> array argument. If SQLCODE'=0 for a row, that will be the end of the results.
For example, suppose rset.GetRows(10,.tenrows,.sc) is called:
- If there are more then 10 rows remaining to be fetched from the result set, tenrows=10, tenrows(1)=$lb(first row's contents), ..., tenrows(10)=$lb(tenth row's contents), and <method>GetRows</method> will return 1.
- If there are 5 rows remaining to be fetched from the result set, tenrows=5, tenrows(1)=$lb(first row's contents), ..., tenrows(5)=$lb(fifth row's contents), and <method>GetRows</method> will return 0.
- If there are 0 rows remaining to be fetched from the result set, tenrows=0 and <method>GetRows</method> will return 0.
This implementation is overridden by classes that implement the result set interface. Signature/behavior here to match that of SQL.StatementResult:GetRows()
| _.Library.Boolean IsBeforeFirst | ( | ) |
Getter method for the isBeforeFirst property on this class, which tracks.
whether the IRIS-side result set is before the first row and may not match up with whether the Java-side result set is before the first row.
| _.Library.Boolean Next | ( | ) |
Advance to the next row in the result referenced by <property>ProcCursor</property>.
Returns 0 if the cursor is at the end of the
result set. An optional argument contains a <class>Library.Status</class> value on return. This Status value indicates success or failure of the Next call. <property>SQLCODE</property> is also set by Next. This implementation is overridden by classes that implement the result set interface.
Reimplemented from ResultSet.
1.9.1