Package org.openmetadata.service.search

Interface SearchClient

All Known Implementing Classes:

ElasticSearchClient, OpenSearchClient

public interface SearchClient

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD
static final String	ADD_UPDATE_LINEAGE
static final String	DEFAULT_UPDATE_SCRIPT
static final String	DELETE
static final String	GLOBAL_SEARCH_ALIAS
static final String	NOT_IMPLEMENTED_ERROR_TYPE
static final String	PROPAGATE_ENTITY_REFERENCE_FIELD_SCRIPT
static final String	PROPAGATE_FIELD_SCRIPT
static final String	REMOVE_DOMAINS_CHILDREN_SCRIPT
static final String	REMOVE_LINEAGE_SCRIPT
static final String	REMOVE_PROPAGATED_ENTITY_REFERENCE_FIELD_SCRIPT
static final String	REMOVE_PROPAGATED_FIELD_SCRIPT
static final String	REMOVE_TAGS_CHILDREN_SCRIPT
static final String	REMOVE_TEST_SUITE_CHILDREN_SCRIPT
static final String	SOFT_DELETE_RESTORE_SCRIPT
static final String	UPDATE
static final String	UPDATE_ADDED_DELETE_GLOSSARY_TAGS
static final String	UPDATE_PROPAGATED_ENTITY_REFERENCE_FIELD_SCRIPT

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)
default es.org.elasticsearch.action.bulk.BulkResponse	bulk(es.org.elasticsearch.action.bulk.BulkRequest data, es.org.elasticsearch.client.RequestOptions options)
default 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)
default SSLContext	createElasticSearchSSLContext(ElasticSearchConfiguration elasticSearchConfiguration)
void	createEntity(String indexName, String docId, String doc)
void	createIndex(IndexMapping indexMapping, String indexMappingContent)
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)
default int	getSuccessFromBulkResponse(es.org.elasticsearch.action.bulk.BulkResponse response)
default 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)

Field Details

UPDATE

static final String UPDATE

See Also:

• Constant Field Values

ADD

static final String ADD

See Also:

• Constant Field Values

DELETE

static final String DELETE

See Also:

• Constant Field Values

GLOBAL_SEARCH_ALIAS

static final String GLOBAL_SEARCH_ALIAS

See Also:

• Constant Field Values

DEFAULT_UPDATE_SCRIPT

static final String DEFAULT_UPDATE_SCRIPT

See Also:

• Constant Field Values

REMOVE_DOMAINS_CHILDREN_SCRIPT

static final String REMOVE_DOMAINS_CHILDREN_SCRIPT

See Also:

• Constant Field Values

PROPAGATE_ENTITY_REFERENCE_FIELD_SCRIPT

static final String PROPAGATE_ENTITY_REFERENCE_FIELD_SCRIPT

See Also:

• Constant Field Values

PROPAGATE_FIELD_SCRIPT

static final String PROPAGATE_FIELD_SCRIPT

See Also:

• Constant Field Values

REMOVE_PROPAGATED_ENTITY_REFERENCE_FIELD_SCRIPT

static final String REMOVE_PROPAGATED_ENTITY_REFERENCE_FIELD_SCRIPT

See Also:

• Constant Field Values

REMOVE_PROPAGATED_FIELD_SCRIPT

static final String REMOVE_PROPAGATED_FIELD_SCRIPT

See Also:

• Constant Field Values

UPDATE_PROPAGATED_ENTITY_REFERENCE_FIELD_SCRIPT

static final String UPDATE_PROPAGATED_ENTITY_REFERENCE_FIELD_SCRIPT

See Also:

• Constant Field Values

SOFT_DELETE_RESTORE_SCRIPT

static final String SOFT_DELETE_RESTORE_SCRIPT

See Also:

• Constant Field Values

REMOVE_TAGS_CHILDREN_SCRIPT

static final String REMOVE_TAGS_CHILDREN_SCRIPT

See Also:

• Constant Field Values

REMOVE_LINEAGE_SCRIPT

static final String REMOVE_LINEAGE_SCRIPT

See Also:

• Constant Field Values

ADD_UPDATE_LINEAGE

static final String ADD_UPDATE_LINEAGE

See Also:

• Constant Field Values

UPDATE_ADDED_DELETE_GLOSSARY_TAGS

static final String UPDATE_ADDED_DELETE_GLOSSARY_TAGS

See Also:

• Constant Field Values

REMOVE_TEST_SUITE_CHILDREN_SCRIPT

static final String REMOVE_TEST_SUITE_CHILDREN_SCRIPT

See Also:

• Constant Field Values

NOT_IMPLEMENTED_ERROR_TYPE

static final String NOT_IMPLEMENTED_ERROR_TYPE

See Also:

• Constant Field Values

Method Details

isClientAvailable

boolean isClientAvailable()

getSearchType

ElasticSearchConfiguration.SearchType getSearchType()

indexExists

boolean indexExists(String indexName)

createIndex

void createIndex(IndexMapping indexMapping,
 String indexMappingContent)

updateIndex

void updateIndex(IndexMapping indexMapping,
 String indexMappingContent)

deleteIndex

void deleteIndex(IndexMapping indexMapping)

createAliases

void createAliases(IndexMapping indexMapping)

search

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

Throws:

IOException

searchBySourceUrl

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

Throws:

IOException

searchLineage

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

Throws:

IOException

searchByField

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

Throws:

IOException

aggregate

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

Throws:

IOException

aggregate

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

Throws:

IOException

suggest

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

Throws:

IOException

createEntity

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

createTimeSeriesEntity

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

updateEntity

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

deleteByScript

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

deleteEntity

void deleteEntity(String indexName,
 String docId)

deleteEntityByFields

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

softDeleteOrRestoreEntity

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

softDeleteOrRestoreChildren

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

updateChildren

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

updateLineage

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

getSortedDate

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

Throws:

IOException

ParseException

listDataInsightChartResult

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

Throws:

IOException

ParseException

bulk

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

Throws:

IOException

bulk

default es.org.elasticsearch.action.bulk.BulkResponse bulk(es.org.elasticsearch.action.bulk.BulkRequest data,
 es.org.elasticsearch.client.RequestOptions options)
                                                    throws IOException

Throws:

IOException

getSuccessFromBulkResponse

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

getSuccessFromBulkResponse

default int getSuccessFromBulkResponse(es.org.elasticsearch.action.bulk.BulkResponse response)

close

void close()

createElasticSearchSSLContext

default SSLContext createElasticSearchSSLContext(ElasticSearchConfiguration elasticSearchConfiguration)
                                          throws KeyStoreException

Throws:

KeyStoreException