Thrift module: Hql

ModuleServicesData typesConstants
HqlHqlService
HqlResult
HqlResult2

Data structures

Struct: HqlResult

KeyFieldTypeDescriptionRequirednessDefault value
1resultslist<string>optional
2cellslist<Client.Cell>optional
3scanneri64optional
4mutatori64optional

Result type of HQL queries

results
String results from metadata queries

cells
Resulting table cells of for buffered queries

scanner
Resulting scanner ID for unbuffered queries

mutator
Resulting mutator ID for unflushed modifying queries

Struct: HqlResult2

KeyFieldTypeDescriptionRequirednessDefault value
1resultslist<string>optional
2cellslist<Client.CellAsArray>optional
3scanneri64optional
4mutatori64optional

Same as HqlResult except with cell as array

Services

Service: HqlService

extends Client.ClientService
HQL service is a superset of Client service

It adds capability to execute HQL queries to the service

Function: HqlService.hql_exec

HqlResult hql_exec(i64 ns,
                   string command,
                   bool noflush = 0,
                   bool unbuffered = 0)
    throws Client.ClientException
Execute an HQL command

@param ns - Namespace id

@param command - HQL command

@param noflush - Do not auto commit any modifications (return a mutator)

@param unbuffered - return a scanner instead of buffered results

Function: HqlService.hql_query

HqlResult hql_query(i64 ns,
                    string command)
    throws Client.ClientException
Convenience method for executing an buffered and flushed query

because thrift doesn't (and probably won't) support default argument values

@param ns - Namespace

@param command - HQL command

Function: HqlService.hql_exec2

HqlResult2 hql_exec2(i64 ns,
                     string command,
                     bool noflush = 0,
                     bool unbuffered = 0)
    throws Client.ClientException
@see hql_exec

Function: HqlService.hql_query2

HqlResult2 hql_query2(i64 ns,
                      string command)
    throws Client.ClientException
@see hql_query