com._4paradigm.hybridse.sdk

Class SqlEngine

java.lang.Object

com._4paradigm.hybridse.sdk.SqlEngine

All Implemented Interfaces:

AutoCloseable

public class SqlEngine
extends Object
implements AutoCloseable

Implementation of HybridSE SQL simple engine that compiled queries with given sql and database.

Constructor Summary

Constructors

Constructor and Description
SqlEngine(String sql, TypeOuterClass.Database database) Construct SQL engine for specific sql and database.
SqlEngine(String sql, TypeOuterClass.Database database, EngineOptions engineOptions) Construct SQL engine for specific sql, database and EngineOptions.

Method Summary

Modifier and Type	Method and Description
void	close()
static EngineOptions	createDefaultEngineOptions() Create default engine option.
ByteBuffer	getIrBuffer() Return compile IR result as ByteBuffer.
PhysicalOpNode	getPlan() Return physical plan.
void	initilize(String sql, TypeOuterClass.Database database, EngineOptions engineOptions) Initialize engine with given sql, database and specified engine options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SqlEngine

public SqlEngine(String sql,
                 TypeOuterClass.Database database)
          throws UnsupportedHybridSeException

Construct SQL engine for specific sql and database.

Throws:

UnsupportedHybridSeException - throws exception when fail to compile queries

SqlEngine

public SqlEngine(String sql,
                 TypeOuterClass.Database database,
                 EngineOptions engineOptions)
          throws UnsupportedHybridSeException

Construct SQL engine for specific sql, database and EngineOptions.

Throws:

UnsupportedHybridSeException - throws exception when fail to compile queries

Method Detail

createDefaultEngineOptions

public static EngineOptions createDefaultEngineOptions()

Create default engine option.

- Enable store ir results into SQL context - Only compile SQL - Disable performance sensitive mode.

Returns:

Return default engine option

initilize

public void initilize(String sql,
                      TypeOuterClass.Database database,
                      EngineOptions engineOptions)
               throws UnsupportedHybridSeException

Initialize engine with given sql, database and specified engine options.

Parameters:

sql - query sql string

database - query on the database

engineOptions - query engine options

Throws:

UnsupportedHybridSeException - throw when query unsupported or has syntax error

getPlan

public PhysicalOpNode getPlan()

Return physical plan.

getIrBuffer

public ByteBuffer getIrBuffer()

Return compile IR result as ByteBuffer.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception