Package org.openmetadata.service.jdbi3

Class KpiRepository

java.lang.Object

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

org.openmetadata.service.jdbi3.KpiRepository

public class KpiRepository
extends EntityRepository<Kpi>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	KpiRepository.KpiUpdater

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

EntityRepository.EntityUpdater, EntityRepository.Operation

Field Summary

Fields

Modifier and Type	Field	Description
static String	COLLECTION_PATH
static String	KPI_RESULT_EXTENSION

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

allowedFields, CACHE_WITH_ID, CACHE_WITH_NAME, dao, daoCollection, entityType, putFields, quoteFqn, supportsExtension, supportsFollower, supportsOwner, supportsSoftDelete, supportsTags, supportsVotes

Constructor Summary

Constructors

Constructor	Description
KpiRepository(CollectionDAO dao)

Method Summary

Modifier and Type	Method	Description
RestUtil.PutResponse<?>	addKpiResult(javax.ws.rs.core.UriInfo uriInfo, String fqn, KpiResult kpiResult)
Kpi	clearFields(Kpi kpi, EntityUtil.Fields fields)	Set the requested fields in an entity.
RestUtil.PutResponse<?>	deleteKpiResult(String fqn, Long timestamp)
KpiResult	getKpiResult(String fqn)
ResultList<KpiResult>	getKpiResults(String fqn, Long startTs, Long endTs, CollectionDAO.EntityExtensionTimeSeriesDAO.OrderBy orderBy)
EntityRepository.EntityUpdater	getUpdater(Kpi original, Kpi updated, EntityRepository.Operation operation)
void	prepare(Kpi kpi)	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.
Kpi	setFields(Kpi kpi, EntityUtil.Fields fields)	Set the requested fields in an entity.
void	storeEntity(Kpi kpi, boolean update)	An entity is stored in the backend database as JSON document.
void	storeRelationships(Kpi kpi)	This method is called to store all the relationships of an entity.

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

addDerivedTags, addFollower, addRelationship, addRelationship, addRelationship, applyTags, applyTags, bulkAddToRelationship, checkSystemEntityDeletion, cleanup, clearFieldsInternal, create, createInternal, createOrUpdate, createOrUpdateInternal, delete, deleteByName, deleteExtensionAtTimestamp, deleteExtensionBeforeTimestamp, deleteFollower, deleteFrom, deleteInternal, deleteInternalByName, deleteRelationship, deleteTo, ensureSingleRelationship, exportToCsv, find, findBoth, findByName, findByNameOrNull, findFrom, findFromRecords, findTo, findToRecords, get, get, getAllowedFieldsCopy, getAllTags, getByName, getByName, getChildren, getCommonFields, getContainer, getCustomPropertyFQN, getCustomPropertyFQNPrefix, getEntitiesFromSeedData, getEntitiesFromSeedData, getEntitiesFromSeedData, getExtension, getExtensionAtTimestamp, getExtensionAtTimestampWithOperation, getFields, getFields, getFollowers, getFromEntityRef, getHref, getIngestionPipelines, getLatestExtensionFromTimeseries, getOwner, getOwner, getParent, getReference, getReferenceByName, getResultList, getResultList, getResultsFromAndToTimestamps, getResultsFromAndToTimestamps, getReviewers, getTags, getTags, getToEntityRef, getVersion, getVotes, importFromCsv, initializeEntity, initSeedDataFromResources, listAfter, listAfterWithSkipFailure, listAll, listBefore, listVersions, patch, populateOwner, postCreate, postDelete, postUpdate, preDelete, prepareInternal, removeExtension, restoreEntity, restorePatchAttributes, setFieldsInternal, setFullyQualifiedName, setInheritedFields, store, storeExtension, storeOwner, storeRelationshipsInternal, storeTimeSeries, storeTimeSeriesWithOperation, update, update, updateOwner, updateVote, validateOwner, validateRoles, validateUsers, withHref

Methods inherited from class java.lang.Object

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

Field Detail

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

Constant Field Values

KPI_RESULT_EXTENSION

public static final String KPI_RESULT_EXTENSION

See Also:

Constant Field Values

Constructor Detail

KpiRepository

public KpiRepository(CollectionDAO dao)

Method Detail

setFields

public Kpi setFields(Kpi kpi,
                     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<Kpi>

clearFields

public Kpi clearFields(Kpi kpi,
                       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<Kpi>

prepare

public void prepare(Kpi kpi)

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<Kpi>

See Also:

for an example implementation

storeEntity

public void storeEntity(Kpi kpi,
                        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<Kpi>

See Also:

for an example implementation

storeRelationships

public void storeRelationships(Kpi kpi)

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<Kpi>

See Also:

for an example implementation

addKpiResult

public RestUtil.PutResponse<?> addKpiResult(javax.ws.rs.core.UriInfo uriInfo,
                                            String fqn,
                                            KpiResult kpiResult)

deleteKpiResult

public RestUtil.PutResponse<?> deleteKpiResult(String fqn,
                                               Long timestamp)

getKpiResult

public KpiResult getKpiResult(String fqn)

getKpiResults

public ResultList<KpiResult> getKpiResults(String fqn,
                                           Long startTs,
                                           Long endTs,
                                           CollectionDAO.EntityExtensionTimeSeriesDAO.OrderBy orderBy)

getUpdater

public EntityRepository.EntityUpdater getUpdater(Kpi original,
                                                 Kpi updated,
                                                 EntityRepository.Operation operation)

Overrides:

getUpdater in class EntityRepository<Kpi>