public class ElasticSearchDataContext extends QueryPostprocessDataContext implements DataContext, UpdateableDataContext
SimpleTableDef
class.Modifier and Type | Field and Description |
---|---|
static org.elasticsearch.common.unit.TimeValue |
TIMEOUT_SCROLL |
INFORMATION_SCHEMA_NAME
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 . |
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)
Executes a simple count query, if possible.
|
protected Row |
executePrimaryKeyLookupQuery(Table table,
List<SelectItem> selectItems,
Column primaryKeyColumn,
Object keyValue)
Executes a query which obtains a row by primary key (as defined by
Column.isPrimaryKey() ). |
void |
executeUpdate(UpdateScript update)
Submits an
UpdateScript for execution on the DataContext . |
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)
Executes a simple one-table query against a table in the main schema of
the subclasses of this class.
|
protected DataSet |
materializeMainSchemaTable(Table table,
List<SelectItem> selectItems,
List<FilterItem> whereItems,
int firstRow,
int maxRows)
Execute a simple one-table query against a table in the main schema of
the subclasses of this class.
|
addConverter, executeQuery, getDefaultSchemaName, getMainSchemaInternal, getSchemaByNameInternal, getSchemaNamesInternal, isMainSchemaTable, isScalarFunctionMaterialized, materializeFromItem, materializeMainSchemaTable, materializeMainSchemaTable, materializeTable, materializeTable
compileQuery, executeQuery, executeQuery, getColumnByQualifiedLabel, getDefaultSchema, getSchemaByName, getSchemaNames, getSchemas, getTableByQualifiedLabel, isQualifiedPathDelim, onSchemaCacheRefreshed, parseQuery, query, refreshSchemas
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
compileQuery, executeQuery, executeQuery, executeQuery, getColumnByQualifiedLabel, getDefaultSchema, getSchemaByName, getSchemaNames, getSchemas, getTableByQualifiedLabel, parseQuery, query, refreshSchemas
public static final org.elasticsearch.common.unit.TimeValue TIMEOUT_SCROLL
public ElasticSearchDataContext(org.elasticsearch.client.Client client, String indexName, SimpleTableDef... tableDefinitions)
ElasticSearchDataContext
. This constructor accepts a
custom array of SimpleTableDef
s which allows the user to define
his own view on the indexes in the engine.client
- the ElasticSearch clientindexName
- the name of the ElasticSearch index to representtableDefinitions
- an array of SimpleTableDef
s, which define the table
and column model of the ElasticSearch index.public ElasticSearchDataContext(org.elasticsearch.client.Client client, String indexName)
ElasticSearchDataContext
and automatically detects
the schema structure/view on all indexes (see
detectTable(ClusterState, String, String)
).client
- the ElasticSearch clientindexName
- the name of the ElasticSearch index to representpublic static SimpleTableDef detectTable(org.elasticsearch.cluster.ClusterState cs, String indexName, String documentType) throws Exception
Client
client and tries to detect the index structure based on
the metadata provided by the java client.cs
- the ElasticSearch clusterindexName
- the name of the indexdocumentType
- the name of the index typeException
protected Schema getMainSchema() throws MetaModelException
getMainSchema
in class QueryPostprocessDataContext
MetaModelException
protected String getMainSchemaName() throws MetaModelException
getMainSchemaName
in class QueryPostprocessDataContext
MetaModelException
protected DataSet materializeMainSchemaTable(Table table, List<SelectItem> selectItems, List<FilterItem> whereItems, int firstRow, int maxRows)
QueryPostprocessDataContext
QueryPostprocessDataContext.materializeMainSchemaTable(Table, List, int, int)
and apply
WHERE item filtering afterwards.materializeMainSchemaTable
in class QueryPostprocessDataContext
protected DataSet materializeMainSchemaTable(Table table, Column[] columns, int maxRows)
QueryPostprocessDataContext
materializeMainSchemaTable
in class QueryPostprocessDataContext
table
- the table to querycolumns
- the columns of the table to querymaxRows
- the maximum amount of rows needed or -1 if all rows are
wanted.protected Row executePrimaryKeyLookupQuery(Table table, List<SelectItem> selectItems, Column primaryKeyColumn, Object keyValue)
QueryPostprocessDataContext
Column.isPrimaryKey()
). This method is provided to allow
subclasses to optimize lookup queries since they are quite common and
often a datastore can retrieve the row using some specialized means which
is much more performant than scanning all records manually.executePrimaryKeyLookupQuery
in class QueryPostprocessDataContext
table
- the table on which the lookup is requested.selectItems
- the items to select from the lookup query.primaryKeyColumn
- the column that is the primary keykeyValue
- the primary key value that is specified in the lookup query.protected Number executeCountQuery(Table table, List<FilterItem> whereItems, boolean functionApproximationAllowed)
QueryPostprocessDataContext
executeCountQuery
in class QueryPostprocessDataContext
table
- the table on which the count is requested.whereItems
- a (sometimes empty) list of WHERE items.functionApproximationAllowed
- whether approximation is allowed or not.public void executeUpdate(UpdateScript update)
UpdateableDataContext
UpdateScript
for execution on the DataContext
.
Since implementations of the DataContext
vary quite a lot, there
is no golden rule as to how an update script will be executed. But the
implementors should strive towards handling an UpdateScript
as a
single transactional change to the data store.executeUpdate
in interface UpdateableDataContext
update
- the update script to executepublic org.elasticsearch.client.Client getElasticSearchClient()
Client
that this DataContext
is wrapping.public String getIndexName()
DataContext
is working on.Copyright © 2007–2016 The Apache Software Foundation. All rights reserved.