Package org.openmetadata.service.jdbi3

Class SearchIndexRepository

java.lang.Object

org.openmetadata.service.jdbi3.EntityRepository<SearchIndex>

org.openmetadata.service.jdbi3.SearchIndexRepository

public class SearchIndexRepository
extends EntityRepository<SearchIndex>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SearchIndexRepository.SearchIndexUpdater

Nested classes/interfaces inherited from class org.openmetadata.service.jdbi3.EntityRepository

EntityRepository.DescriptionTaskWorkflow, EntityRepository.EntityUpdater, EntityRepository.Operation, EntityRepository.TagTaskWorkflow

Field Summary

Fields inherited from class org.openmetadata.service.jdbi3.EntityRepository

allowedFields, CACHE_WITH_ID, CACHE_WITH_NAME, dao, daoCollection, entityType, putFields, quoteFqn, renameAllowed, searchRepository, supportsDataProducts, supportsDomain, supportsExperts, supportsExtension, supportsFollower, supportsLifeCycle, supportsOwner, supportsReviewers, supportsSearch, supportsSoftDelete, supportsStyle, supportsTags, supportsVotes

Constructor Summary

Constructors

Constructor	Description
SearchIndexRepository()

Method Summary

Modifier and Type	Method	Description
SearchIndex	addSampleData(UUID searchIndexId, SearchIndexSampleData sampleData)
void	applyTags(SearchIndex searchIndex)
void	clearFields(SearchIndex searchIndex, EntityUtil.Fields fields)	Set the requested fields in an entity.
List<TagLabel>	getAllTags(EntityInterface entity)
EntityInterface	getParentEntity(SearchIndex entity, String fields)
SearchIndex	getSampleData(UUID searchIndexId, boolean authorizePII)
FeedRepository.TaskWorkflow	getTaskWorkflow(FeedRepository.ThreadContext threadContext)
SearchIndexRepository.SearchIndexUpdater	getUpdater(SearchIndex original, SearchIndex updated, EntityRepository.Operation operation)
void	prepare(SearchIndex searchIndex, boolean update)	This method is used for validating an entity to be created during POST, PUT, and PATCH operations and prepare the entity with all the required attributes and relationships.
void	setFields(SearchIndex searchIndex, EntityUtil.Fields fields)	Set the requested fields in an entity.
void	setFullyQualifiedName(SearchIndex searchIndex)	Set fullyQualifiedName of an entity
void	storeEntity(SearchIndex searchIndex, boolean update)	An entity is stored in the backend database as JSON document.
void	storeRelationships(SearchIndex searchIndex)	This method is called to store all the relationships of an entity.
void	validateTags(SearchIndex entity)

Methods inherited from class org.openmetadata.service.jdbi3.EntityRepository

addFollower, addRelationship, addRelationship, addRelationship, addServiceRelationship, applyColumnTags, applySuggestion, applyTags, bulkAddToRelationship, bulkAssetsOperation, checkSystemEntityDeletion, cleanup, clearFieldsInternal, copy, create, createInternal, createOrUpdate, delete, deleteByName, deleteExtensionAtTimestamp, deleteExtensionBeforeTimestamp, deleteFollower, deleteFrom, deleteFromSearch, deleteInternal, deleteInternalByName, deleteRelationship, deleteTo, ensureSingleRelationship, exportToCsv, find, findBoth, findByName, findByNameOrNull, findFrom, findFromRecords, findTo, findToRecords, get, get, getAllowedFieldsCopy, getByName, getByName, getChildren, getCommonFields, getContainer, getContainer, getCustomPropertyFQN, getCustomPropertyFQNPrefix, getDomain, getEntitiesFromSeedData, getEntitiesFromSeedData, getEntitiesFromSeedData, getExperts, getExtension, getExtensionAtTimestamp, getFields, getFields, getFollowers, getFromEntityRef, getHref, getIngestionPipelines, getLatestExtensionFromTimeSeries, getOwner, getOwner, getParent, getReference, getReferenceByName, getResultList, getResultList, getResultsFromAndToTimestamps, getResultsFromAndToTimestamps, getReviewers, getSuggestionFields, getSuggestionWorkflow, getTags, getTags, getTagsByPrefix, getToEntityRef, getVersion, getVotes, importFromCsv, inheritDomain, inheritExperts, inheritOwner, inheritReviewers, initializeEntity, initSeedDataFromResources, listAfter, listAfterWithSkipFailure, listAll, listBefore, listVersions, patch, populateOwner, postCreate, postDelete, postUpdate, preDelete, prepareInternal, removeExtension, restoreEntity, restoreFromSearch, restorePatchAttributes, setFieldsInternal, setInheritedFields, store, storeDataProducts, storeDomain, storeExtension, storeOwner, storeRelationshipsInternal, storeTimeSeries, update, updateOwner, updateVote, validateColumnTags, validateDataProducts, validateDomain, validateDomain, validateOwner, validateRoles, validateTags, validateTaskThread, validateUsers, withHref

Methods inherited from class java.lang.Object

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

Constructor Details

SearchIndexRepository

public SearchIndexRepository()

Method Details

setFullyQualifiedName

public void setFullyQualifiedName(SearchIndex searchIndex)

Description copied from class: EntityRepository

Set fullyQualifiedName of an entity

Overrides:

setFullyQualifiedName in class EntityRepository<SearchIndex>

prepare

public void prepare(SearchIndex searchIndex,
 boolean update)

Description copied from class: EntityRepository

This method is used for validating an entity to be created during POST, PUT, and PATCH operations and prepare the entity with all the required attributes and relationships.

The implementation of this method must perform the following:

1. Prepare the values for attributes that are not required in the request but can be derived on the server side. Example - >FullyQualifiedNames of an entity can be derived from the hierarchy that an entity belongs to .
2. Validate all the attributes of an entity.
3. Validate all the relationships of an entity. As an example - during table creation, relationships such as Tags, Owner, Databasea table belongs to are validated. During validation additional information that is not required in the create/update request are set up in the corresponding relationship fields.

At the end of this operation, entity is expected to be valid and fully constructed with all the fields that will be sent as payload in the POST, PUT, and PATCH operations response.

Specified by:

prepare in class EntityRepository<SearchIndex>

See Also:

• for an example implementation

storeEntity

public void storeEntity(SearchIndex searchIndex,
 boolean update)

Description copied from class: EntityRepository

An entity is stored in the backend database as JSON document. The JSON includes some attributes of the entity and does not include attributes such as href. The relationship fields of an entity is never stored in the JSON document. It is always reconstructed based on relationship edges from the backend database.

As an example, when table entity is stored, the attributes such as href and the relationships such as owner, database, and tags are set to null. These attributes are restored back after the JSON document is stored to be sent as response.

Specified by:

storeEntity in class EntityRepository<SearchIndex>

See Also:

• for an example implementation

storeRelationships

public void storeRelationships(SearchIndex searchIndex)

Description copied from class: EntityRepository

This method is called to store all the relationships of an entity. It is expected that all relationships are already validated and completely setup before this method is called and no validation of relationships is required.

Specified by:

storeRelationships in class EntityRepository<SearchIndex>

See Also:

• for an example implementation

setFields

public void setFields(SearchIndex searchIndex,
 EntityUtil.Fields fields)

Description copied from class: EntityRepository

Set the requested fields in an entity. This is used for requesting specific fields in the object during GET operations. It is also used during PUT and PATCH operations to set up fields that can be updated.

Specified by:

setFields in class EntityRepository<SearchIndex>

clearFields

public void clearFields(SearchIndex searchIndex,
 EntityUtil.Fields fields)

Description copied from class: EntityRepository

Set the requested fields in an entity. This is used for requesting specific fields in the object during GET operations. It is also used during PUT and PATCH operations to set up fields that can be updated.

Specified by:

clearFields in class EntityRepository<SearchIndex>

getUpdater

public SearchIndexRepository.SearchIndexUpdater getUpdater(SearchIndex original,
 SearchIndex updated,
 EntityRepository.Operation operation)

Overrides:

getUpdater in class EntityRepository<SearchIndex>

getSampleData

public SearchIndex getSampleData(UUID searchIndexId,
 boolean authorizePII)

addSampleData

public SearchIndex addSampleData(UUID searchIndexId,
 SearchIndexSampleData sampleData)

validateTags

public void validateTags(SearchIndex entity)

Overrides:

validateTags in class EntityRepository<SearchIndex>

applyTags

public void applyTags(SearchIndex searchIndex)

Overrides:

applyTags in class EntityRepository<SearchIndex>

getParentEntity

public EntityInterface getParentEntity(SearchIndex entity,
 String fields)

Overrides:

getParentEntity in class EntityRepository<SearchIndex>

getAllTags

public List<TagLabel> getAllTags(EntityInterface entity)

Overrides:

getAllTags in class EntityRepository<SearchIndex>

getTaskWorkflow

public FeedRepository.TaskWorkflow getTaskWorkflow(FeedRepository.ThreadContext threadContext)

Overrides:

getTaskWorkflow in class EntityRepository<SearchIndex>