public class ElasticsearchTemplate extends Object implements ElasticsearchOperations, ApplicationContextAware
Constructor and Description |
---|
ElasticsearchTemplate(org.elasticsearch.client.Client client) |
ElasticsearchTemplate(org.elasticsearch.client.Client client,
ElasticsearchConverter elasticsearchConverter) |
ElasticsearchTemplate(org.elasticsearch.client.Client client,
ElasticsearchConverter elasticsearchConverter,
EntityMapper entityMapper) |
ElasticsearchTemplate(org.elasticsearch.client.Client client,
ElasticsearchConverter elasticsearchConverter,
ResultsMapper resultsMapper) |
ElasticsearchTemplate(org.elasticsearch.client.Client client,
EntityMapper entityMapper) |
ElasticsearchTemplate(org.elasticsearch.client.Client client,
ResultsMapper resultsMapper) |
Modifier and Type | Method and Description |
---|---|
Boolean |
addAlias(AliasQuery query)
adding new alias
|
void |
bulkIndex(List<IndexQuery> queries)
Bulk index all objects.
|
void |
bulkUpdate(List<UpdateQuery> queries)
Bulk update all objects.
|
void |
clearScroll(String scrollId)
Clears the search contexts associated with specified scroll ids.
|
<T> long |
count(CriteriaQuery query)
return number of elements found by given query
|
<T> long |
count(CriteriaQuery criteriaQuery,
Class<T> clazz)
return number of elements found by given query
|
<T> long |
count(SearchQuery query)
return number of elements found by given query
|
<T> long |
count(SearchQuery searchQuery,
Class<T> clazz)
return number of elements found by given query
|
<T> boolean |
createIndex(Class<T> clazz)
Create an index for a class
|
<T> boolean |
createIndex(Class<T> clazz,
Object settings)
Create an index for given class and Settings
|
boolean |
createIndex(String indexName)
Create an index for given indexName
|
boolean |
createIndex(String indexName,
Object settings)
Create an index for given indexName and Settings
|
<T> String |
delete(Class<T> clazz,
String id)
Delete the one object with provided id
|
<T> void |
delete(CriteriaQuery criteriaQuery,
Class<T> clazz)
Delete all records matching the criteria
|
void |
delete(DeleteQuery deleteQuery)
Delete all records matching the query
|
<T> void |
delete(DeleteQuery deleteQuery,
Class<T> clazz)
Delete all records matching the query
|
String |
delete(String indexName,
String type,
String id)
Delete the one object with provided id
|
<T> boolean |
deleteIndex(Class<T> clazz)
Deletes an index for given entity
|
boolean |
deleteIndex(String indexName)
Deletes an index for given indexName
|
org.elasticsearch.client.Client |
getClient() |
ElasticsearchConverter |
getElasticsearchConverter() |
<T> Map |
getMapping(Class<T> clazz)
Get mapping for a class
|
Map |
getMapping(String indexName,
String type)
Get mapping for a given indexName and type
|
ElasticsearchPersistentEntity |
getPersistentEntityFor(Class clazz) |
protected ResultsMapper |
getResultsMapper() |
<T> Map |
getSetting(Class<T> clazz)
Get settings for a given class
|
Map |
getSetting(String indexName)
Get settings for a given indexName
|
String |
index(IndexQuery query)
Index an object.
|
<T> boolean |
indexExists(Class<T> clazz)
check if index is exists
|
boolean |
indexExists(String indexName)
check if index is exists for given IndexName
|
<T> Page<T> |
moreLikeThis(MoreLikeThisQuery query,
Class<T> clazz)
more like this query to search for documents that are "like" a specific document.
|
<T> LinkedList<T> |
multiGet(SearchQuery searchQuery,
Class<T> clazz)
Execute a multiGet against elasticsearch for the given ids
|
<T> LinkedList<T> |
multiGet(SearchQuery searchQuery,
Class<T> clazz,
MultiGetResultMapper getResultMapper)
Execute a multiGet against elasticsearch for the given ids with MultiGetResultMapper
|
<T> boolean |
putMapping(Class<T> clazz)
Create mapping for a class
|
<T> boolean |
putMapping(Class<T> clazz,
Object mapping)
Create mapping for a class
|
boolean |
putMapping(String indexName,
String type,
Object mapping)
Create mapping for a given indexName and type
|
<T> T |
query(SearchQuery query,
ResultsExtractor<T> resultsExtractor) |
List<org.elasticsearch.cluster.metadata.AliasMetaData> |
queryForAlias(String indexName)
get all the alias pointing to specified index
|
<T> List<String> |
queryForIds(SearchQuery query)
Execute the query against elasticsearch and return ids
|
<T> List<T> |
queryForList(CriteriaQuery query,
Class<T> clazz)
Execute the criteria query against elasticsearch and return result as
List |
<T> List<T> |
queryForList(SearchQuery query,
Class<T> clazz)
Execute the search query against elasticsearch and return result as
List |
<T> List<T> |
queryForList(StringQuery query,
Class<T> clazz)
Execute the string query against elasticsearch and return result as
List |
<T> T |
queryForObject(CriteriaQuery query,
Class<T> clazz)
Execute the query against elasticsearch and return the first returned object
|
<T> T |
queryForObject(GetQuery query,
Class<T> clazz)
Execute the query against elasticsearch and return the first returned object
|
<T> T |
queryForObject(GetQuery query,
Class<T> clazz,
GetResultMapper mapper)
Execute the query against elasticsearch and return the first returned object using custom mapper
|
<T> T |
queryForObject(StringQuery query,
Class<T> clazz)
Execute the query against elasticsearch and return the first returned object
|
<T> Page<T> |
queryForPage(CriteriaQuery criteriaQuery,
Class<T> clazz)
Execute the query against elasticsearch and return result as
Page |
<T> Page<T> |
queryForPage(SearchQuery query,
Class<T> clazz)
Execute the query against elasticsearch and return result as
Page |
<T> Page<T> |
queryForPage(SearchQuery query,
Class<T> clazz,
SearchResultMapper mapper)
Execute the query against elasticsearch and return result as
Page using custom mapper |
<T> Page<T> |
queryForPage(StringQuery query,
Class<T> clazz)
Execute the query against elasticsearch and return result as
Page |
<T> Page<T> |
queryForPage(StringQuery query,
Class<T> clazz,
SearchResultMapper mapper)
Execute the query against elasticsearch and return result as
Page using custom mapper |
static String |
readFileFromClasspath(String url) |
<T> void |
refresh(Class<T> clazz)
refresh the index
|
void |
refresh(String indexName)
refresh the index
|
Boolean |
removeAlias(AliasQuery query)
removing previously created alias
|
String |
scan(CriteriaQuery criteriaQuery,
long scrollTimeInMillis,
boolean noFields)
Returns scroll id for criteria query
|
<T> String |
scan(CriteriaQuery criteriaQuery,
long scrollTimeInMillis,
boolean noFields,
Class<T> clazz)
Returns scroll id for criteria query
|
String |
scan(SearchQuery searchQuery,
long scrollTimeInMillis,
boolean noFields)
Returns scroll id for scan query
|
<T> String |
scan(SearchQuery searchQuery,
long scrollTimeInMillis,
boolean noFields,
Class<T> clazz)
Returns scroll id for scan query
|
<T> Page<T> |
scroll(String scrollId,
long scrollTimeInMillis,
Class<T> clazz)
Scrolls the results for give scroll id
|
<T> Page<T> |
scroll(String scrollId,
long scrollTimeInMillis,
SearchResultMapper mapper)
Scrolls the results for give scroll id using custom result mapper
|
void |
setApplicationContext(ApplicationContext context) |
void |
setSearchTimeout(String searchTimeout) |
<T> CloseableIterator<T> |
stream(CriteriaQuery query,
Class<T> clazz)
Executes the given
CriteriaQuery against elasticsearch and return result as CloseableIterator . |
<T> CloseableIterator<T> |
stream(SearchQuery query,
Class<T> clazz)
Executes the given
SearchQuery against elasticsearch and return result as CloseableIterator . |
<T> CloseableIterator<T> |
stream(SearchQuery query,
Class<T> clazz,
SearchResultMapper mapper)
Executes the given
SearchQuery against elasticsearch and return result as CloseableIterator using custom mapper. |
org.elasticsearch.action.suggest.SuggestResponse |
suggest(org.elasticsearch.search.suggest.SuggestBuilder.SuggestionBuilder<?> suggestion,
Class clazz) |
org.elasticsearch.action.suggest.SuggestResponse |
suggest(org.elasticsearch.search.suggest.SuggestBuilder.SuggestionBuilder<?> suggestion,
String... indices) |
boolean |
typeExists(String index,
String type)
check if type is exists in an index
|
org.elasticsearch.action.update.UpdateResponse |
update(UpdateQuery query)
Partial update of the document
|
public ElasticsearchTemplate(org.elasticsearch.client.Client client)
public ElasticsearchTemplate(org.elasticsearch.client.Client client, EntityMapper entityMapper)
public ElasticsearchTemplate(org.elasticsearch.client.Client client, ElasticsearchConverter elasticsearchConverter, EntityMapper entityMapper)
public ElasticsearchTemplate(org.elasticsearch.client.Client client, ResultsMapper resultsMapper)
public ElasticsearchTemplate(org.elasticsearch.client.Client client, ElasticsearchConverter elasticsearchConverter)
public ElasticsearchTemplate(org.elasticsearch.client.Client client, ElasticsearchConverter elasticsearchConverter, ResultsMapper resultsMapper)
public org.elasticsearch.client.Client getClient()
getClient
in interface ElasticsearchOperations
public void setSearchTimeout(String searchTimeout)
public <T> boolean createIndex(Class<T> clazz)
ElasticsearchOperations
createIndex
in interface ElasticsearchOperations
public boolean createIndex(String indexName)
ElasticsearchOperations
createIndex
in interface ElasticsearchOperations
public <T> boolean putMapping(Class<T> clazz)
ElasticsearchOperations
putMapping
in interface ElasticsearchOperations
public <T> boolean putMapping(Class<T> clazz, Object mapping)
ElasticsearchOperations
putMapping
in interface ElasticsearchOperations
public boolean putMapping(String indexName, String type, Object mapping)
ElasticsearchOperations
putMapping
in interface ElasticsearchOperations
public Map getMapping(String indexName, String type)
ElasticsearchOperations
getMapping
in interface ElasticsearchOperations
public <T> Map getMapping(Class<T> clazz)
ElasticsearchOperations
getMapping
in interface ElasticsearchOperations
public ElasticsearchConverter getElasticsearchConverter()
getElasticsearchConverter
in interface ElasticsearchOperations
public <T> T queryForObject(GetQuery query, Class<T> clazz)
ElasticsearchOperations
queryForObject
in interface ElasticsearchOperations
public <T> T queryForObject(GetQuery query, Class<T> clazz, GetResultMapper mapper)
ElasticsearchOperations
queryForObject
in interface ElasticsearchOperations
public <T> T queryForObject(CriteriaQuery query, Class<T> clazz)
ElasticsearchOperations
queryForObject
in interface ElasticsearchOperations
public <T> T queryForObject(StringQuery query, Class<T> clazz)
ElasticsearchOperations
queryForObject
in interface ElasticsearchOperations
public <T> Page<T> queryForPage(SearchQuery query, Class<T> clazz)
ElasticsearchOperations
Page
queryForPage
in interface ElasticsearchOperations
public <T> Page<T> queryForPage(SearchQuery query, Class<T> clazz, SearchResultMapper mapper)
ElasticsearchOperations
Page
using custom mapperqueryForPage
in interface ElasticsearchOperations
public <T> T query(SearchQuery query, ResultsExtractor<T> resultsExtractor)
query
in interface ElasticsearchOperations
public <T> List<T> queryForList(CriteriaQuery query, Class<T> clazz)
ElasticsearchOperations
List
queryForList
in interface ElasticsearchOperations
public <T> List<T> queryForList(StringQuery query, Class<T> clazz)
ElasticsearchOperations
List
queryForList
in interface ElasticsearchOperations
public <T> List<T> queryForList(SearchQuery query, Class<T> clazz)
ElasticsearchOperations
List
queryForList
in interface ElasticsearchOperations
public <T> List<String> queryForIds(SearchQuery query)
ElasticsearchOperations
queryForIds
in interface ElasticsearchOperations
public <T> Page<T> queryForPage(CriteriaQuery criteriaQuery, Class<T> clazz)
ElasticsearchOperations
Page
queryForPage
in interface ElasticsearchOperations
public <T> Page<T> queryForPage(StringQuery query, Class<T> clazz)
ElasticsearchOperations
Page
queryForPage
in interface ElasticsearchOperations
public <T> Page<T> queryForPage(StringQuery query, Class<T> clazz, SearchResultMapper mapper)
ElasticsearchOperations
Page
using custom mapperqueryForPage
in interface ElasticsearchOperations
public <T> CloseableIterator<T> stream(CriteriaQuery query, Class<T> clazz)
ElasticsearchOperations
CriteriaQuery
against elasticsearch and return result as CloseableIterator
.
Returns a CloseableIterator
that wraps an Elasticsearch scroll context that needs to be closed in case of error.
stream
in interface ElasticsearchOperations
T
- element return typepublic <T> CloseableIterator<T> stream(SearchQuery query, Class<T> clazz)
ElasticsearchOperations
SearchQuery
against elasticsearch and return result as CloseableIterator
.
Returns a CloseableIterator
that wraps an Elasticsearch scroll context that needs to be closed in case of error.
stream
in interface ElasticsearchOperations
T
- element return typepublic <T> CloseableIterator<T> stream(SearchQuery query, Class<T> clazz, SearchResultMapper mapper)
ElasticsearchOperations
SearchQuery
against elasticsearch and return result as CloseableIterator
using custom mapper.
Returns a CloseableIterator
that wraps an Elasticsearch scroll context that needs to be closed in case of error.
stream
in interface ElasticsearchOperations
T
- element return typepublic <T> long count(CriteriaQuery criteriaQuery, Class<T> clazz)
ElasticsearchOperations
count
in interface ElasticsearchOperations
public <T> long count(SearchQuery searchQuery, Class<T> clazz)
ElasticsearchOperations
count
in interface ElasticsearchOperations
public <T> long count(CriteriaQuery query)
ElasticsearchOperations
count
in interface ElasticsearchOperations
public <T> long count(SearchQuery query)
ElasticsearchOperations
count
in interface ElasticsearchOperations
public <T> LinkedList<T> multiGet(SearchQuery searchQuery, Class<T> clazz)
ElasticsearchOperations
multiGet
in interface ElasticsearchOperations
public <T> LinkedList<T> multiGet(SearchQuery searchQuery, Class<T> clazz, MultiGetResultMapper getResultMapper)
ElasticsearchOperations
multiGet
in interface ElasticsearchOperations
public String index(IndexQuery query)
ElasticsearchOperations
index
in interface ElasticsearchOperations
public org.elasticsearch.action.update.UpdateResponse update(UpdateQuery query)
ElasticsearchOperations
update
in interface ElasticsearchOperations
public void bulkIndex(List<IndexQuery> queries)
ElasticsearchOperations
bulkIndex
in interface ElasticsearchOperations
public void bulkUpdate(List<UpdateQuery> queries)
ElasticsearchOperations
bulkUpdate
in interface ElasticsearchOperations
public <T> boolean indexExists(Class<T> clazz)
ElasticsearchOperations
indexExists
in interface ElasticsearchOperations
public boolean indexExists(String indexName)
ElasticsearchOperations
indexExists
in interface ElasticsearchOperations
public boolean typeExists(String index, String type)
ElasticsearchOperations
typeExists
in interface ElasticsearchOperations
public <T> boolean deleteIndex(Class<T> clazz)
ElasticsearchOperations
deleteIndex
in interface ElasticsearchOperations
public boolean deleteIndex(String indexName)
ElasticsearchOperations
deleteIndex
in interface ElasticsearchOperations
public String delete(String indexName, String type, String id)
ElasticsearchOperations
delete
in interface ElasticsearchOperations
public <T> String delete(Class<T> clazz, String id)
ElasticsearchOperations
delete
in interface ElasticsearchOperations
public <T> void delete(DeleteQuery deleteQuery, Class<T> clazz)
ElasticsearchOperations
delete
in interface ElasticsearchOperations
public void delete(DeleteQuery deleteQuery)
ElasticsearchOperations
delete
in interface ElasticsearchOperations
public <T> void delete(CriteriaQuery criteriaQuery, Class<T> clazz)
ElasticsearchOperations
delete
in interface ElasticsearchOperations
public String scan(CriteriaQuery criteriaQuery, long scrollTimeInMillis, boolean noFields)
ElasticsearchOperations
scan
in interface ElasticsearchOperations
criteriaQuery
- The criteria query.scrollTimeInMillis
- The time in millisecond for scroll feature
SearchRequestBuilder.setScroll(org.elasticsearch.common.unit.TimeValue)
.noFields
- The no fields support
SearchRequestBuilder.setNoFields()
.public <T> String scan(CriteriaQuery criteriaQuery, long scrollTimeInMillis, boolean noFields, Class<T> clazz)
ElasticsearchOperations
scan
in interface ElasticsearchOperations
T
- The type of entity to retrieve.criteriaQuery
- The criteria query.scrollTimeInMillis
- The time in millisecond for scroll feature
SearchRequestBuilder.setScroll(org.elasticsearch.common.unit.TimeValue)
.noFields
- The no fields support
SearchRequestBuilder.setNoFields()
.clazz
- The class of entity to retrieve.public String scan(SearchQuery searchQuery, long scrollTimeInMillis, boolean noFields)
ElasticsearchOperations
scan
in interface ElasticsearchOperations
searchQuery
- The search query.scrollTimeInMillis
- The time in millisecond for scroll feature
SearchRequestBuilder.setScroll(org.elasticsearch.common.unit.TimeValue)
.noFields
- The no fields support
SearchRequestBuilder.setNoFields()
.public <T> String scan(SearchQuery searchQuery, long scrollTimeInMillis, boolean noFields, Class<T> clazz)
ElasticsearchOperations
scan
in interface ElasticsearchOperations
T
- The type of entity to retrieve.searchQuery
- The search query.scrollTimeInMillis
- The time in millisecond for scroll feature
SearchRequestBuilder.setScroll(org.elasticsearch.common.unit.TimeValue)
.noFields
- The no fields support
SearchRequestBuilder.setNoFields()
.clazz
- The class of entity to retrieve.public <T> Page<T> scroll(String scrollId, long scrollTimeInMillis, Class<T> clazz)
ElasticsearchOperations
scroll
in interface ElasticsearchOperations
public <T> Page<T> scroll(String scrollId, long scrollTimeInMillis, SearchResultMapper mapper)
ElasticsearchOperations
scroll
in interface ElasticsearchOperations
public void clearScroll(String scrollId)
ElasticsearchOperations
clearScroll
in interface ElasticsearchOperations
public <T> Page<T> moreLikeThis(MoreLikeThisQuery query, Class<T> clazz)
ElasticsearchOperations
moreLikeThis
in interface ElasticsearchOperations
public boolean createIndex(String indexName, Object settings)
ElasticsearchOperations
createIndex
in interface ElasticsearchOperations
public <T> boolean createIndex(Class<T> clazz, Object settings)
ElasticsearchOperations
createIndex
in interface ElasticsearchOperations
public <T> Map getSetting(Class<T> clazz)
ElasticsearchOperations
getSetting
in interface ElasticsearchOperations
public Map getSetting(String indexName)
ElasticsearchOperations
getSetting
in interface ElasticsearchOperations
public void refresh(String indexName)
ElasticsearchOperations
refresh
in interface ElasticsearchOperations
public <T> void refresh(Class<T> clazz)
ElasticsearchOperations
refresh
in interface ElasticsearchOperations
public Boolean addAlias(AliasQuery query)
ElasticsearchOperations
addAlias
in interface ElasticsearchOperations
public Boolean removeAlias(AliasQuery query)
ElasticsearchOperations
removeAlias
in interface ElasticsearchOperations
public List<org.elasticsearch.cluster.metadata.AliasMetaData> queryForAlias(String indexName)
ElasticsearchOperations
queryForAlias
in interface ElasticsearchOperations
public ElasticsearchPersistentEntity getPersistentEntityFor(Class clazz)
getPersistentEntityFor
in interface ElasticsearchOperations
public void setApplicationContext(ApplicationContext context) throws BeansException
setApplicationContext
in interface ApplicationContextAware
BeansException
protected ResultsMapper getResultsMapper()
public org.elasticsearch.action.suggest.SuggestResponse suggest(org.elasticsearch.search.suggest.SuggestBuilder.SuggestionBuilder<?> suggestion, String... indices)
public org.elasticsearch.action.suggest.SuggestResponse suggest(org.elasticsearch.search.suggest.SuggestBuilder.SuggestionBuilder<?> suggestion, Class clazz)
Copyright © 2011-2015–2017 Pivotal Software, Inc.. All rights reserved.