org.apache.metamodel.elasticsearch.nativeclient

Class ElasticSearchDataContext

java.lang.Object

org.apache.metamodel.AbstractDataContext

org.apache.metamodel.QueryPostprocessDataContext

org.apache.metamodel.elasticsearch.nativeclient.ElasticSearchDataContext

All Implemented Interfaces:

HasReadTypeConverters, DataContext, UpdateableDataContext

public class ElasticSearchDataContext
extends QueryPostprocessDataContext
implements DataContext, UpdateableDataContext

DataContext implementation for ElasticSearch analytics engine. ElasticSearch has a data storage structure hierarchy that briefly goes like this:

• Index
• Document type (short: Type) (within an index)
• Documents (of a particular type)

When instantiating this DataContext, an index name is provided. Within this index, each document type is represented as a table. This implementation supports either automatic discovery of a schema or manual specification of a schema, through the SimpleTableDef class.

Field Summary

Fields

Modifier and Type	Field and Description
static org.elasticsearch.common.unit.TimeValue	TIMEOUT_SCROLL

Fields inherited from class org.apache.metamodel.QueryPostprocessDataContext

INFORMATION_SCHEMA_NAME

Constructor Summary

Constructors

Constructor and Description
ElasticSearchDataContext(org.elasticsearch.client.Client client, String indexName) Constructs a ElasticSearchDataContext and automatically detects the schema structure/view on all indexes (see detectTable(ClusterState, String, String)).
ElasticSearchDataContext(org.elasticsearch.client.Client client, String indexName, SimpleTableDef... tableDefinitions) Constructs a ElasticSearchDataContext.

Method Summary

Modifier and Type	Method and Description
static SimpleTableDef	detectTable(org.elasticsearch.cluster.ClusterState cs, String indexName, String documentType) Performs an analysis of an available index type in an ElasticSearch Client client and tries to detect the index structure based on the metadata provided by the java client.
protected Number	executeCountQuery(Table table, List<FilterItem> whereItems, boolean functionApproximationAllowed)
protected Row	executePrimaryKeyLookupQuery(Table table, List<SelectItem> selectItems, Column primaryKeyColumn, Object keyValue)
void	executeUpdate(UpdateScript update)
org.elasticsearch.client.Client	getElasticSearchClient() Gets the Client that this DataContext is wrapping.
String	getIndexName() Gets the name of the index that this DataContext is working on.
protected Schema	getMainSchema()
protected String	getMainSchemaName()
protected DataSet	materializeMainSchemaTable(Table table, Column[] columns, int maxRows)
protected DataSet	materializeMainSchemaTable(Table table, List<SelectItem> selectItems, List<FilterItem> whereItems, int firstRow, int maxRows)

Methods inherited from class org.apache.metamodel.QueryPostprocessDataContext

addConverter, executeQuery, getDefaultSchemaName, getMainSchemaInternal, getSchemaByNameInternal, getSchemaNamesInternal, isMainSchemaTable, isScalarFunctionMaterialized, materializeFromItem, materializeMainSchemaTable, materializeMainSchemaTable, materializeTable, materializeTable

Methods inherited from class org.apache.metamodel.AbstractDataContext

compileQuery, executeQuery, executeQuery, getColumnByQualifiedLabel, getDefaultSchema, getSchemaByName, getSchemaNames, getSchemas, getTableByQualifiedLabel, isQualifiedPathDelim, onSchemaCacheRefreshed, parseQuery, query, refreshSchemas

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.metamodel.DataContext

compileQuery, executeQuery, executeQuery, executeQuery, getColumnByQualifiedLabel, getDefaultSchema, getSchemaByName, getSchemaNames, getSchemas, getTableByQualifiedLabel, parseQuery, query, refreshSchemas

Field Detail

TIMEOUT_SCROLL

public static final org.elasticsearch.common.unit.TimeValue TIMEOUT_SCROLL

Constructor Detail

ElasticSearchDataContext

public ElasticSearchDataContext(org.elasticsearch.client.Client client,
                                String indexName,
                                SimpleTableDef... tableDefinitions)

Constructs a ElasticSearchDataContext. This constructor accepts a custom array of SimpleTableDefs which allows the user to define his own view on the indexes in the engine.

Parameters:

client - the ElasticSearch client

indexName - the name of the ElasticSearch index to represent

tableDefinitions - an array of SimpleTableDefs, which define the table and column model of the ElasticSearch index.

ElasticSearchDataContext

public ElasticSearchDataContext(org.elasticsearch.client.Client client,
                                String indexName)

Constructs a ElasticSearchDataContext and automatically detects the schema structure/view on all indexes (see detectTable(ClusterState, String, String)).

Parameters:

client - the ElasticSearch client

indexName - the name of the ElasticSearch index to represent

Method Detail

detectTable

public static SimpleTableDef detectTable(org.elasticsearch.cluster.ClusterState cs,
                                         String indexName,
                                         String documentType)
                                  throws Exception

Performs an analysis of an available index type in an ElasticSearch Client client and tries to detect the index structure based on the metadata provided by the java client.

Parameters:

cs - the ElasticSearch cluster

indexName - the name of the index

documentType - the name of the index type

Returns:

a table definition for ElasticSearch.

Throws:

Exception

getMainSchema

protected Schema getMainSchema()
                        throws MetaModelException

Specified by:

getMainSchema in class QueryPostprocessDataContext

Throws:

MetaModelException

getMainSchemaName

protected String getMainSchemaName()
                            throws MetaModelException

Specified by:

getMainSchemaName in class QueryPostprocessDataContext

Throws:

MetaModelException

materializeMainSchemaTable

protected DataSet materializeMainSchemaTable(Table table,
                                             List<SelectItem> selectItems,
                                             List<FilterItem> whereItems,
                                             int firstRow,
                                             int maxRows)

Overrides:

materializeMainSchemaTable in class QueryPostprocessDataContext

materializeMainSchemaTable

protected DataSet materializeMainSchemaTable(Table table,
                                             Column[] columns,
                                             int maxRows)

Specified by:

materializeMainSchemaTable in class QueryPostprocessDataContext

executePrimaryKeyLookupQuery

protected Row executePrimaryKeyLookupQuery(Table table,
                                           List<SelectItem> selectItems,
                                           Column primaryKeyColumn,
                                           Object keyValue)

Overrides:

executePrimaryKeyLookupQuery in class QueryPostprocessDataContext

executeCountQuery

protected Number executeCountQuery(Table table,
                                   List<FilterItem> whereItems,
                                   boolean functionApproximationAllowed)

Overrides:

executeCountQuery in class QueryPostprocessDataContext

executeUpdate

public void executeUpdate(UpdateScript update)

Specified by:

executeUpdate in interface UpdateableDataContext

getElasticSearchClient

public org.elasticsearch.client.Client getElasticSearchClient()

Gets the Client that this DataContext is wrapping.

Returns:

getIndexName

public String getIndexName()

Gets the name of the index that this DataContext is working on.

Returns: