Package org.openmetadata.service.jdbi3

Interface EntityDAO<T extends EntityInterface>

All Known Subinterfaces:

CollectionDAO.ApplicationDAO, CollectionDAO.ApplicationMarketPlaceDAO, CollectionDAO.BotDAO, CollectionDAO.ChartDAO, CollectionDAO.ClassificationDAO, CollectionDAO.ContainerDAO, CollectionDAO.DashboardDAO, CollectionDAO.DashboardServiceDAO, CollectionDAO.DatabaseDAO, CollectionDAO.DatabaseSchemaDAO, CollectionDAO.DatabaseServiceDAO, CollectionDAO.DataInsightChartDAO, CollectionDAO.DataModelDAO, CollectionDAO.DataProductDAO, CollectionDAO.DocStoreDAO, CollectionDAO.DomainDAO, CollectionDAO.EventSubscriptionDAO, CollectionDAO.GlossaryDAO, CollectionDAO.GlossaryTermDAO, CollectionDAO.IngestionPipelineDAO, CollectionDAO.KpiDAO, CollectionDAO.MessagingServiceDAO, CollectionDAO.MetadataServiceDAO, CollectionDAO.MetricsDAO, CollectionDAO.MlModelDAO, CollectionDAO.MlModelServiceDAO, CollectionDAO.PersonaDAO, CollectionDAO.PipelineDAO, CollectionDAO.PipelineServiceDAO, CollectionDAO.PolicyDAO, CollectionDAO.QueryDAO, CollectionDAO.ReportDAO, CollectionDAO.RoleDAO, CollectionDAO.SearchIndexDAO, CollectionDAO.SearchServiceDAO, CollectionDAO.StorageServiceDAO, CollectionDAO.StoredProcedureDAO, CollectionDAO.TableDAO, CollectionDAO.TagDAO, CollectionDAO.TeamDAO, CollectionDAO.TestCaseDAO, CollectionDAO.TestConnectionDefinitionDAO, CollectionDAO.TestDefinitionDAO, CollectionDAO.TestSuiteDAO, CollectionDAO.TopicDAO, CollectionDAO.TypeEntityDAO, CollectionDAO.UserDAO, CollectionDAO.WebAnalyticEventDAO, CollectionDAO.WorkflowDAO

public interface EntityDAO<T extends EntityInterface>

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method	Description
void	analyze(String table)
default void	analyzeTable()
int	delete(String table, UUID id)
default void	delete(UUID id)
boolean	exists(String table, UUID id)
default void	exists(UUID id)
default void	existsByName(String fqn)
boolean	existsByName(String table, String nameColumnHash, String fqnHash)
String	findById(String table, UUID id, String cond)
String	findByName(String table, String nameColumn, String name, String cond)
default T	findEntityById(UUID id)
default T	findEntityById(UUID id, Include include)
default T	findEntityByName(String fqn)
default T	findEntityByName(String fqn, String nameHashColumn, Include include)
default T	findEntityByName(String fqn, Include include)
default String	getCondition(Include include)
Class<T>	getEntityClass()
default String	getNameHashColumn()
String	getTableName()	Methods that need to be overridden by interfaces extending this
void	insert(String table, String nameHashColumn, String nameHashColumnValue, String json)	Common queries for all entities implemented here.
default void	insert(String nameHash, EntityInterface entity, String fqn)
default void	insert(EntityInterface entity, String fqn)	Default methods that interfaces with implementation.
default T	jsonToEntity(String json, Object identity)
List<String>	listAfter(String table, String mysqlCond, String postgresCond, int limit, String afterName, String afterId, String groupBy)
List<String>	listAfter(String table, Map<String,?> params, String cond, int limit, int offset)
List<String>	listAfter(String table, Map<String,?> params, String cond, int limit, String afterName, String after)
List<String>	listAfter(String table, Map<String,?> params, String mysqlCond, String postgresCond, int limit, String afterName, String afterId)
default List<String>	listAfter(ListFilter filter, int limit, int offset)
default List<String>	listAfter(ListFilter filter, int limit, String afterName, String afterId)
default List<String>	listAfterWithOffset(int limit, int offset)
List<String>	listAfterWithOffset(String table, int limit, int offset)
List<String>	listBefore(String table, String mysqlCond, String postgresCond, int limit, String beforeName, String beforeId, String groupBy)
List<String>	listBefore(String table, Map<String,?> params, String cond, int limit, String beforeName, String beforeId)
List<String>	listBefore(String table, Map<String,?> params, String mysqlCond, String postgresCond, int limit, String beforeName, String beforeId)
default List<String>	listBefore(ListFilter filter, int limit, String beforeName, String beforeId)
int	listCount(String table, String nameHashColumn, Map<String,?> params, String cond)
int	listCount(String table, String nameHashColumn, Map<String,?> params, String mysqlCond, String postgresCond)
default int	listCount(ListFilter filter)
int	listCountDistinct(String table, String mysqlCond, String postgresCond, String distinctColumn)
default int	listTotalCount()
int	listTotalCount(String table, String nameHashColumn)
default List<String>	migrationListAfterWithOffset(int limit, String nameHashColumn)
List<String>	migrationListAfterWithOffset(String table, String nameHashColumnName, int limit)
default boolean	supportsSoftDelete()
void	update(String table, String nameHashColumn, String nameHashColumnValue, String id, String json)
default void	update(String nameHashColumn, EntityInterface entity)
default void	update(UUID id, String fqn, String json)
default void	update(EntityInterface entity)
default void	updateFqn(String oldPrefix, String newPrefix)
void	updateFqnInternal(String mySqlUpdate, String postgresUpdate)

Field Details

LOG

static final org.slf4j.Logger LOG

Method Details

getTableName

String getTableName()

Methods that need to be overridden by interfaces extending this

getEntityClass

Class<T> getEntityClass()

getNameHashColumn

default String getNameHashColumn()

supportsSoftDelete

default boolean supportsSoftDelete()

insert

void insert(String table,
 String nameHashColumn,
 String nameHashColumnValue,
 String json)

Common queries for all entities implemented here. Do not override.

update

void update(String table,
 String nameHashColumn,
 String nameHashColumnValue,
 String id,
 String json)

updateFqn

default void updateFqn(String oldPrefix,
 String newPrefix)

updateFqnInternal

void updateFqnInternal(String mySqlUpdate,
 String postgresUpdate)

findById

String findById(String table,
 UUID id,
 String cond)

findByName

String findByName(String table,
 String nameColumn,
 String name,
 String cond)

listCount

int listCount(String table,
 String nameHashColumn,
 Map<String,?> params,
 String cond)

listCount

int listCount(String table,
 String nameHashColumn,
 Map<String,?> params,
 String mysqlCond,
 String postgresCond)

listBefore

List<String> listBefore(String table,
 Map<String,?> params,
 String mysqlCond,
 String postgresCond,
 int limit,
 String beforeName,
 String beforeId)

listAfter

List<String> listAfter(String table,
 Map<String,?> params,
 String mysqlCond,
 String postgresCond,
 int limit,
 String afterName,
 String afterId)

listTotalCount

int listTotalCount(String table,
 String nameHashColumn)

listCountDistinct

int listCountDistinct(String table,
 String mysqlCond,
 String postgresCond,
 String distinctColumn)

listBefore

List<String> listBefore(String table,
 String mysqlCond,
 String postgresCond,
 int limit,
 String beforeName,
 String beforeId,
 String groupBy)

listAfter

List<String> listAfter(String table,
 String mysqlCond,
 String postgresCond,
 int limit,
 String afterName,
 String afterId,
 String groupBy)

listBefore

List<String> listBefore(String table,
 Map<String,?> params,
 String cond,
 int limit,
 String beforeName,
 String beforeId)

listAfter

List<String> listAfter(String table,
 Map<String,?> params,
 String cond,
 int limit,
 String afterName,
 String after)

listAfterWithOffset

List<String> listAfterWithOffset(String table,
 int limit,
 int offset)

migrationListAfterWithOffset

List<String> migrationListAfterWithOffset(String table,
 String nameHashColumnName,
 int limit)

listAfter

List<String> listAfter(String table,
 Map<String,?> params,
 String cond,
 int limit,
 int offset)

exists

boolean exists(String table,
 UUID id)

existsByName

boolean existsByName(String table,
 String nameColumnHash,
 String fqnHash)

delete

int delete(String table,
 UUID id)

analyze

void analyze(String table)

analyzeTable

default void analyzeTable()

insert

default void insert(EntityInterface entity,
 String fqn)

Default methods that interfaces with implementation. Don't override

insert

default void insert(String nameHash,
 EntityInterface entity,
 String fqn)

update

default void update(UUID id,
 String fqn,
 String json)

update

default void update(EntityInterface entity)

update

default void update(String nameHashColumn,
 EntityInterface entity)

getCondition

default String getCondition(Include include)

findEntityById

default T findEntityById(UUID id,
 Include include)

findEntityById

default T findEntityById(UUID id)

findEntityByName

default T findEntityByName(String fqn)

findEntityByName

default T findEntityByName(String fqn,
 Include include)

findEntityByName

default T findEntityByName(String fqn,
 String nameHashColumn,
 Include include)

jsonToEntity

default T jsonToEntity(String json,
 Object identity)

listCount

default int listCount(ListFilter filter)

listTotalCount

default int listTotalCount()

listBefore

default List<String> listBefore(ListFilter filter,
 int limit,
 String beforeName,
 String beforeId)

listAfter

default List<String> listAfter(ListFilter filter,
 int limit,
 String afterName,
 String afterId)

listAfterWithOffset

default List<String> listAfterWithOffset(int limit,
 int offset)

migrationListAfterWithOffset

default List<String> migrationListAfterWithOffset(int limit,
 String nameHashColumn)

listAfter

default List<String> listAfter(ListFilter filter,
 int limit,
 int offset)

exists

default void exists(UUID id)

existsByName

default void existsByName(String fqn)

delete

default void delete(UUID id)