Skip to content

Latest commit

 

History

History
186 lines (100 loc) · 2.37 KB

pinot-noir.pinotbrokerjsontransport.md

File metadata and controls

186 lines (100 loc) · 2.37 KB

Home > pinot-noir > PinotBrokerJSONTransport

PinotBrokerJSONTransport class

Pinot broker JSON transport based on "undici" HTTP client.

Signature:

export declare class PinotBrokerJSONTransport implements IPinotBrokerTransport

Implements: IPinotBrokerTransport

Constructors

Constructor

Modifiers

Description

(constructor)({ bodyTimeout, brokerUrl, connections, keepAliveTimeout, headersTimeout, keepAliveMaxTimeout, token, maxQueueSize, })

Constructs a new instance of the PinotBrokerJSONTransport class

Properties

Property

Modifiers

Type

Description

maxQueueSize

protected

number | undefined

Maximum query queue size.

pool

protected

readonly

Pool

HTTP client pool.

stats

readonly

IPinotPoolStats

HTTP pool statistics.

token

protected

readonly

string

Pinot broker auth token.

Methods

Method

Modifiers

Description

close()

Closes connection to Pinot broker.

request({ body, headers, method, path, query, options, })

Perform HTTP request to Pinot.

setMaxQueueSize(size)

Set maximum query queue size.