API Documentation
Back to top  

DruidNodeDruidQueryExecutor

Implements \DruidFamiliar\Interfaces\IDruidQueryExecutor

package

Default

Methods

__construct

__construct( $ip,  $port,  $endpoint = '/druid/v2/',  $protocol = 'http',  $httpMethod = 'POST')

Arguments

$ip

$port

$endpoint

$protocol

$httpMethod

Create a Guzzle Request object using the given JSON parameters

createRequest(string $query) : \Guzzle\Http\Message\RequestInterface
throws

Arguments

$query

string

JSON String

Response

\Guzzle\Http\Message\RequestInterface

Execute a Druid query using the provided query generator, parameters, and response payload handler.

executeQuery(\DruidFamiliar\Interfaces\IDruidQueryGenerator $queryGenerator, \DruidFamiliar\Interfaces\IDruidQueryParameters $params, \DruidFamiliar\Interfaces\IDruidQueryResponseHandler $responseHandler) : mixed

See DruidFamiliar\ResponseHandler\DoNothingResponseHandler.

Arguments

$queryGenerator

\DruidFamiliar\Interfaces\IDruidQueryGenerator

$params

\DruidFamiliar\Interfaces\IDruidQueryParameters

$responseHandler

\DruidFamiliar\Interfaces\IDruidQueryResponseHandler

Response

mixed

getBaseUrl

getBaseUrl()

getEndpoint

getEndpoint() : string

Response

string

Get the HTTP Method.

getHttpMethod() : string

Response

string

getIp

getIp() : String

Response

String

getPort

getPort() : \DruidFamiliar\QueryExecutor\Number

Response

\DruidFamiliar\QueryExecutor\Number

Get the protocol.

getProtocol() : string

Response

string

setEndpoint

setEndpoint(string $endpoint)

Arguments

$endpoint

string

Set the HTTP Method.

setHttpMethod( $method)

Supported methods are: GET, POST

throws

Arguments

$method

setIp

setIp(String $ip)

Arguments

$ip

String

setPort

setPort(\DruidFamiliar\QueryExecutor\Number $port)

Arguments

$port

\DruidFamiliar\QueryExecutor\Number

Set the protocol.

setProtocol(string $protocol)

Supported protocols are: http, https

Arguments

$protocol

string

Properties

IP to Druid node

ip : String
var

Type(s)

String

Port to Druid node

port : \DruidFamiliar\QueryExecutor\Number
var

Type(s)

\DruidFamiliar\QueryExecutor\Number

The endpoint to hit on the Druid node

endpoint : string
var

Type(s)

string

The protocol the Druid node is listening on. (http or https)

protocol : integer
var

Type(s)

integer

HTTP Method to use

httpMethod : string
var

Type(s)

string