Package org.openmetadata.service.search.opensearch

Class OpenSearchClient

java.lang.Object

org.openmetadata.service.search.opensearch.OpenSearchClient

All Implemented Interfaces:

SearchClient

public class OpenSearchClient
extends Object
implements SearchClient

Field Summary

Fields inherited from interface org.openmetadata.service.search.SearchClient

ADD, ADD_UPDATE_LINEAGE, DEFAULT_UPDATE_SCRIPT, DELETE, GLOBAL_SEARCH_ALIAS, NOT_IMPLEMENTED_ERROR_TYPE, PROPAGATE_ENTITY_REFERENCE_FIELD_SCRIPT, PROPAGATE_FIELD_SCRIPT, REMOVE_DOMAINS_CHILDREN_SCRIPT, REMOVE_LINEAGE_SCRIPT, REMOVE_PROPAGATED_ENTITY_REFERENCE_FIELD_SCRIPT, REMOVE_PROPAGATED_FIELD_SCRIPT, REMOVE_TAGS_CHILDREN_SCRIPT, REMOVE_TEST_SUITE_CHILDREN_SCRIPT, SOFT_DELETE_RESTORE_SCRIPT, UPDATE, UPDATE_ADDED_DELETE_GLOSSARY_TAGS, UPDATE_PROPAGATED_ENTITY_REFERENCE_FIELD_SCRIPT

Constructor Summary

Constructors

Constructor	Description
OpenSearchClient(ElasticSearchConfiguration config)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	aggregate(String index, String fieldName, String value, String query)
javax.json.JsonObject	aggregate(String query, String index, javax.json.JsonObject aggregationJson)
static List<os.org.opensearch.search.aggregations.AggregationBuilder>	buildAggregation(javax.json.JsonObject aggregations)
os.org.opensearch.action.bulk.BulkResponse	bulk(os.org.opensearch.action.bulk.BulkRequest data, os.org.opensearch.client.RequestOptions options)
void	close()
void	createAliases(IndexMapping indexMapping)
void	createEntity(String indexName, String docId, String doc)
void	createIndex(IndexMapping indexMapping, String indexMappingContent)
os.org.opensearch.client.RestHighLevelClient	createOpenSearchClient(ElasticSearchConfiguration esConfig)
void	createTimeSeriesEntity(String indexName, String docId, String doc)
void	deleteByScript(String indexName, String scriptTxt, Map<String,Object> params)
void	deleteEntity(String indexName, String docId)
void	deleteEntityByFields(String indexName, List<org.apache.commons.lang3.tuple.Pair<String,String>> fieldAndValue)
void	deleteIndex(IndexMapping indexMapping)
ElasticSearchConfiguration.SearchType	getSearchType()
TreeMap<Long,List<Object>>	getSortedDate(String team, Long scheduleTime, Long currentTime, DataInsightChartResult.DataInsightChartType chartType, String indexName)
int	getSuccessFromBulkResponse(os.org.opensearch.action.bulk.BulkResponse response)
boolean	indexExists(String indexName)
boolean	isClientAvailable()
javax.ws.rs.core.Response	listDataInsightChartResult(Long startTs, Long endTs, String tier, String team, DataInsightChartResult.DataInsightChartType dataInsightChartName, Integer size, Integer from, String queryFilter, String dataReportIndex)
javax.ws.rs.core.Response	search(SearchRequest request)
javax.ws.rs.core.Response	searchByField(String fieldName, String fieldValue, String index)
javax.ws.rs.core.Response	searchBySourceUrl(String sourceUrl)
javax.ws.rs.core.Response	searchLineage(String fqn, int upstreamDepth, int downstreamDepth, String queryFilter, boolean deleted, String entityType)
void	softDeleteOrRestoreChildren(String indexName, String scriptTxt, List<org.apache.commons.lang3.tuple.Pair<String,String>> fieldAndValue)
void	softDeleteOrRestoreEntity(String indexName, String docId, String scriptTxt)
javax.ws.rs.core.Response	suggest(SearchRequest request)
void	updateChildren(String indexName, org.apache.commons.lang3.tuple.Pair<String,String> fieldAndValue, org.apache.commons.lang3.tuple.Pair<String,Map<String,Object>> updates)
void	updateEntity(String indexName, String docId, Map<String,Object> doc, String scriptTxt)
void	updateIndex(IndexMapping indexMapping, String indexMappingContent)
void	updateLineage(String indexName, org.apache.commons.lang3.tuple.Pair<String,String> fieldAndValue, Map<String,Object> lineagaData)
void	updateOpenSearch(os.org.opensearch.action.update.UpdateRequest updateRequest)
void	updateSearch(os.org.opensearch.action.update.UpdateRequest updateRequest)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmetadata.service.search.SearchClient

bulk, createElasticSearchSSLContext, getSuccessFromBulkResponse

Constructor Details

OpenSearchClient

public OpenSearchClient(ElasticSearchConfiguration config)

Method Details

isClientAvailable

public boolean isClientAvailable()

Specified by:

isClientAvailable in interface SearchClient

indexExists

public boolean indexExists(String indexName)

Specified by:

indexExists in interface SearchClient

createIndex

public void createIndex(IndexMapping indexMapping,
 String indexMappingContent)

Specified by:

createIndex in interface SearchClient

createAliases

public void createAliases(IndexMapping indexMapping)

Specified by:

createAliases in interface SearchClient

updateIndex

public void updateIndex(IndexMapping indexMapping,
 String indexMappingContent)

Specified by:

updateIndex in interface SearchClient

deleteIndex

public void deleteIndex(IndexMapping indexMapping)

Specified by:

deleteIndex in interface SearchClient

search

public javax.ws.rs.core.Response search(SearchRequest request)
                                 throws IOException

Specified by:

search in interface SearchClient

Throws:

IOException

searchBySourceUrl

public javax.ws.rs.core.Response searchBySourceUrl(String sourceUrl)
                                            throws IOException

Specified by:

searchBySourceUrl in interface SearchClient

Throws:

IOException

searchLineage

public javax.ws.rs.core.Response searchLineage(String fqn,
 int upstreamDepth,
 int downstreamDepth,
 String queryFilter,
 boolean deleted,
 String entityType)
                                        throws IOException

Specified by:

searchLineage in interface SearchClient

Throws:

IOException

searchByField

public javax.ws.rs.core.Response searchByField(String fieldName,
 String fieldValue,
 String index)
                                        throws IOException

Specified by:

searchByField in interface SearchClient

Throws:

IOException

aggregate

public javax.ws.rs.core.Response aggregate(String index,
 String fieldName,
 String value,
 String query)
                                    throws IOException

Specified by:

aggregate in interface SearchClient

Throws:

IOException

buildAggregation

public static List<os.org.opensearch.search.aggregations.AggregationBuilder> buildAggregation(javax.json.JsonObject aggregations)

aggregate

public javax.json.JsonObject aggregate(String query,
 String index,
 javax.json.JsonObject aggregationJson)
                                throws IOException

Specified by:

aggregate in interface SearchClient

Throws:

IOException

updateSearch

public void updateSearch(os.org.opensearch.action.update.UpdateRequest updateRequest)

suggest

public javax.ws.rs.core.Response suggest(SearchRequest request)
                                  throws IOException

Specified by:

suggest in interface SearchClient

Throws:

IOException

getSearchType

public ElasticSearchConfiguration.SearchType getSearchType()

Specified by:

getSearchType in interface SearchClient

createEntity

public void createEntity(String indexName,
 String docId,
 String doc)

Specified by:

createEntity in interface SearchClient

createTimeSeriesEntity

public void createTimeSeriesEntity(String indexName,
 String docId,
 String doc)

Specified by:

createTimeSeriesEntity in interface SearchClient

deleteByScript

public void deleteByScript(String indexName,
 String scriptTxt,
 Map<String,Object> params)

Specified by:

deleteByScript in interface SearchClient

deleteEntity

public void deleteEntity(String indexName,
 String docId)

Specified by:

deleteEntity in interface SearchClient

deleteEntityByFields

public void deleteEntityByFields(String indexName,
 List<org.apache.commons.lang3.tuple.Pair<String,String>> fieldAndValue)

Specified by:

deleteEntityByFields in interface SearchClient

softDeleteOrRestoreEntity

public void softDeleteOrRestoreEntity(String indexName,
 String docId,
 String scriptTxt)

Specified by:

softDeleteOrRestoreEntity in interface SearchClient

softDeleteOrRestoreChildren

public void softDeleteOrRestoreChildren(String indexName,
 String scriptTxt,
 List<org.apache.commons.lang3.tuple.Pair<String,String>> fieldAndValue)

Specified by:

softDeleteOrRestoreChildren in interface SearchClient

updateEntity

public void updateEntity(String indexName,
 String docId,
 Map<String,Object> doc,
 String scriptTxt)

Specified by:

updateEntity in interface SearchClient

updateChildren

public void updateChildren(String indexName,
 org.apache.commons.lang3.tuple.Pair<String,String> fieldAndValue,
 org.apache.commons.lang3.tuple.Pair<String,Map<String,Object>> updates)

Specified by:

updateChildren in interface SearchClient

updateLineage

public void updateLineage(String indexName,
 org.apache.commons.lang3.tuple.Pair<String,String> fieldAndValue,
 Map<String,Object> lineagaData)

Specified by:

updateLineage in interface SearchClient

Parameters:

indexName -

fieldAndValue -

updateOpenSearch

public void updateOpenSearch(os.org.opensearch.action.update.UpdateRequest updateRequest)

close

public void close()

Specified by:

close in interface SearchClient

bulk

public os.org.opensearch.action.bulk.BulkResponse bulk(os.org.opensearch.action.bulk.BulkRequest data,
 os.org.opensearch.client.RequestOptions options)
                                                throws IOException

Specified by:

bulk in interface SearchClient

Throws:

IOException

getSuccessFromBulkResponse

public int getSuccessFromBulkResponse(os.org.opensearch.action.bulk.BulkResponse response)

Specified by:

getSuccessFromBulkResponse in interface SearchClient

getSortedDate

public TreeMap<Long,List<Object>> getSortedDate(String team,
 Long scheduleTime,
 Long currentTime,
 DataInsightChartResult.DataInsightChartType chartType,
 String indexName)
                                         throws IOException,
ParseException

Specified by:

getSortedDate in interface SearchClient

Throws:

IOException

ParseException

listDataInsightChartResult

public javax.ws.rs.core.Response listDataInsightChartResult(Long startTs,
 Long endTs,
 String tier,
 String team,
 DataInsightChartResult.DataInsightChartType dataInsightChartName,
 Integer size,
 Integer from,
 String queryFilter,
 String dataReportIndex)
                                                     throws IOException,
ParseException

Specified by:

listDataInsightChartResult in interface SearchClient

Throws:

IOException

ParseException

createOpenSearchClient

public os.org.opensearch.client.RestHighLevelClient createOpenSearchClient(ElasticSearchConfiguration esConfig)