Class HttpStream

A stream for executing SQL statements (a "database connection").

Hierarchy

Stream
- HttpStream

Implements

SqlOwner

Index

Properties

Accessors

Methods

batch client close closeGracefully describe getAutocommit query queryRow queryValue run sequence storeSql

Properties

intMode

intMode: IntMode

Representation of integers returned from the database. See IntMode.

This value affects the results of all operations on this stream.

Accessors

closed

get closed(): boolean
True if the stream is closed.

Returns boolean
Overrides Stream.closed
- Defined in src/http/stream.ts:199

Methods

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
Inherited from Stream.batch
- Defined in src/stream.ts:76

client

client(): HttpClient
Get the HttpClient object that this stream belongs to.

Returns HttpClient
Overrides Stream.client
- Defined in src/http/stream.ts:86

close

close(): void
Immediately close the stream.

Returns void
Overrides Stream.close
- Defined in src/http/stream.ts:188

closeGracefully

closeGracefully(): void
Gracefully close the stream.

Returns void
Overrides Stream.closeGracefully
- Defined in src/http/stream.ts:193

describe

describe(inSql): Promise<DescribeResult>
Parse and analyze a statement. This requires protocol version 2 or higher.
Parameters
- inSql: InSql
Returns Promise<DescribeResult>
Inherited from Stream.describe
- Defined in src/stream.ts:81

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>
Overrides Stream.getAutocommit
- Defined in src/http/stream.ts:156

query

query(stmt): Promise<RowsResult>
Execute a statement and return rows.
Parameters
- stmt: InStmt
Returns Promise<RowsResult>
Inherited from Stream.query
- Defined in src/stream.ts:42

queryRow

queryRow(stmt): Promise<RowResult>
Execute a statement and return at most a single row.
Parameters
- stmt: InStmt
Returns Promise<RowResult>
Inherited from Stream.queryRow
- Defined in src/stream.ts:47

queryValue

queryValue(stmt): Promise<ValueResult>
Execute a statement and return at most a single value.
Parameters
- stmt: InStmt
Returns Promise<ValueResult>
Inherited from Stream.queryValue
- Defined in src/stream.ts:52

run

run(stmt): Promise<StmtResult>
Execute a statement without returning rows.
Parameters
- stmt: InStmt
Returns Promise<StmtResult>
Inherited from Stream.run
- Defined in src/stream.ts:57

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>
Inherited from Stream.sequence
- Defined in src/stream.ts:88

storeSql

storeSql(sql): Sql
Cache a SQL text on the server.
Parameters
- sql: string
Returns Sql
Implementation of SqlOwner.storeSql
- Defined in src/http/stream.ts:96

Generated using TypeDoc