Class StreamAbstract

intMode

Abstract closed

• get closed(): boolean

• True if the stream is closed or closing.

  If you call closeGracefully, this will become true immediately, even if the underlying stream is not physically closed yet.

  Returns boolean

batch

• batch(useCursor?): Batch

• Return a builder for creating and executing a batch.

  If useCursor is true, the batch will be executed using a Hrana cursor, which will stream results from the server to the client, which consumes less memory on the server. This requires protocol version 3 or higher.

  Parameters

  • useCursor: boolean = false

  Returns Batch

Abstract client

• client(): Client

• Get the client object that this stream belongs to.

  Returns Client

Abstract close

• close(): void

• Immediately close the stream.

  This closes the stream immediately, aborting any pending operations.

  Returns void

Abstract closeGracefully

• closeGracefully(): void

• Gracefully close the stream.

  After calling this method, you will not be able to start new operations, but existing operations will complete.

  Returns void

describe

• describe(inSql): Promise<DescribeResult>

• Parse and analyze a statement. This requires protocol version 2 or higher.

  Parameters

  • inSql: InSql

  Returns Promise<DescribeResult>

Abstract getAutocommit

• getAutocommit(): Promise<boolean>

• Check whether the SQL connection underlying this stream is in autocommit state (i.e., outside of an explicit transaction). This requires protocol version 3 or higher.

  Returns Promise<boolean>

query

• query(stmt): Promise<RowsResult>

• Execute a statement and return rows.

  Parameters

  • stmt: InStmt

  Returns Promise<RowsResult>

queryRow

• queryRow(stmt): Promise<RowResult>

• Execute a statement and return at most a single row.

  Parameters

  • stmt: InStmt

  Returns Promise<RowResult>

queryValue

• queryValue(stmt): Promise<ValueResult>

• Execute a statement and return at most a single value.

  Parameters

  • stmt: InStmt

  Returns Promise<ValueResult>

run

• run(stmt): Promise<StmtResult>

• Execute a statement without returning rows.

  Parameters

  • stmt: InStmt

  Returns Promise<StmtResult>

sequence

• sequence(inSql): Promise<void>

• Execute a sequence of statements separated by semicolons. This requires protocol version 2 or higher.

  Parameters

  • inSql: InSql

  Returns Promise<void>