Class Connection

A connection to Pinot, normally created via connectionFactory

Hierarchy

Connection

Index

Constructors

Properties

Methods

close execute getBrokerList

Constructors

constructor

new Connection(brokerSelector: BrokerSelector, transport: BrokerClientTransport, logger: Logger, updater?: Updater): Connection
Parameters
- brokerSelector: BrokerSelector
- transport: BrokerClientTransport
- logger: Logger
- updater: Updater = null
Returns Connection
- Defined in connection.ts:13

Properties

`Private` `Optional` updater

updater?: Updater

Methods

close

close(): void
Closes a Pinot cluster connection (stop the periodic table-to-broker mapping refreshes)

Returns void
- Defined in connection.ts:24

execute

execute(table: string, query: string): Promise<BrokerResponse>
Executes an SQL query against a given table

Throws
PinotClientError
Parameters
- table: string
- query: string
Returns Promise<BrokerResponse>
- Defined in connection.ts:41

getBrokerList

getBrokerList(): string[]
Get the list of available broker addresses

Returns
The list of brokers using which the connection can execute queries

Returns string[]
- Defined in connection.ts:34

Generated using TypeDoc