# Class: SQLRowStream

## vertx-sql-js/sql_row_stream~ SQLRowStream

#### new SQLRowStream()

A ReadStream of Rows from the underlying RDBMS. This class follows the ReadStream semantics and will automatically close the underlying resources if all returned rows are returned. For cases where the results are ignored before the full processing of the returned rows is complete the close method **MUST** be called in order to release underlying resources. The interface is minimal in order to support all SQL clients not just JDBC.

Source:
  - vertx-sql-js/sql_row_stream.js, line 35

### Methods

#### close(handler)

Closes the stream/underlying cursor(s). The actual close happens asynchronously.

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function | called when the stream/underlying cursor(s) is(are) closed

Source:
  - vertx-sql-js/sql_row_stream.js, line 179

#### column(name) → {number}

Will convert the column name to the json array index.

##### Parameters:

Name | Type | Description
--- | --- | ---
`name` | string | the column name

Source:
  - vertx-sql-js/sql_row_stream.js, line 122

##### Returns:

the json array index

Type
  number

#### columns() → {Array.<string>}

Returns all column names available in the underlying resultset. One needs to carefully use this method since in contrast to the singular version it does not perform case insensitive lookups or takes alias in consideration on the column names.

Source:
  - vertx-sql-js/sql_row_stream.js, line 138

##### Returns:

the list of columns names returned by the query

Type
  Array.<string>

#### endHandler(endHandler) → {SQLRowStream}

##### Parameters:

Name | Type | Description
--- | --- | ---
`endHandler` | function |

Source:
  - vertx-sql-js/sql_row_stream.js, line 107

##### Returns:

Type
  SQLRowStream

#### exceptionHandler(handler) → {SQLRowStream}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |

Source:
  - vertx-sql-js/sql_row_stream.js, line 47

##### Returns:

Type
  SQLRowStream

#### handler(handler) → {SQLRowStream}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |

Source:
  - vertx-sql-js/sql_row_stream.js, line 63

##### Returns:

Type
  SQLRowStream

#### moreResults()

Request for more results if available

Source:
  - vertx-sql-js/sql_row_stream.js, line 166

#### pause() → {SQLRowStream}

Source:
  - vertx-sql-js/sql_row_stream.js, line 79

##### Returns:

Type
  SQLRowStream

#### resultSetClosedHandler(handler) → {SQLRowStream}

Event handler when a resultset is closed. This is useful to request for more results.

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function | called when the current result set is closed

Source:
  - vertx-sql-js/sql_row_stream.js, line 152

##### Returns:

Type
  SQLRowStream

#### resume() → {SQLRowStream}

Source:
  - vertx-sql-js/sql_row_stream.js, line 93

##### Returns:

Type
  SQLRowStream