Package org.openmetadata.service.jdbi3

Class TableRepository

java.lang.Object

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

org.openmetadata.service.jdbi3.TableRepository

public class TableRepository
extends EntityRepository<Table>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TableRepository.TableCsv
class	TableRepository.TableUpdater	Handles entity updated from PUT and POST operation.

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLUMN_FIELD
static final String	CUSTOM_METRICS
static final String	CUSTOM_METRICS_EXTENSION
static final String	FIELD_RELATION_COLUMN_TYPE
static final String	FIELD_RELATION_TABLE_TYPE
static final String	SYSTEM_PROFILE_EXTENSION
static final String	TABLE_COLUMN_EXTENSION
static final String	TABLE_COLUMN_PROFILE_EXTENSION
static final String	TABLE_EXTENSION
static final String	TABLE_PROFILE_EXTENSION
static final String	TABLE_PROFILER_CONFIG
static final String	TABLE_PROFILER_CONFIG_EXTENSION
static final String	TABLE_SAMPLE_DATA_EXTENSION

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
TableRepository()

Method Summary

Modifier and Type	Method	Description
Table	addCustomMetric(UUID tableId, CustomMetric customMetric)
Table	addDataModel(UUID tableId, DataModel dataModel)
Table	addJoins(UUID tableId, TableJoins joins)
Table	addSampleData(UUID tableId, TableData tableData)
Table	addTableProfileData(UUID tableId, CreateTableProfile createTableProfile)
Table	addTableProfilerConfig(UUID tableId, TableProfilerConfig tableProfilerConfig)
Table	applySuggestion(EntityInterface entity, String columnFQN, Suggestion suggestion)
void	applyTags(Table table)
void	clearFields(Table table, EntityUtil.Fields fields)	Set the requested fields in an entity.
Table	deleteCustomMetric(UUID tableId, String columnName, String metricName)
Table	deleteSampleData(UUID tableId)
void	deleteTableProfile(String fqn, String entityType, Long timestamp)
Table	deleteTableProfilerConfig(UUID tableId)
String	exportToCsv(String name, String user)	Override this method to support downloading CSV functionality
List<TagLabel>	getAllTags(EntityInterface entity)
ResultList<ColumnProfile>	getColumnProfiles(String fqn, Long startTs, Long endTs)
Table	getLatestTableProfile(String fqn, boolean authorizePII)
EntityInterface	getParentEntity(Table entity, String fields)
Table	getSampleData(UUID tableId, boolean authorizePII)
String	getSuggestionFields(Suggestion suggestion)	Bring in the necessary fields required to have all the information before applying a suggestion
ResultList<SystemProfile>	getSystemProfiles(String fqn, Long startTs, Long endTs)
TableProfilerConfig	getTableProfilerConfig(Table table)
ResultList<TableProfile>	getTableProfiles(String fqn, Long startTs, Long endTs)
FeedRepository.TaskWorkflow	getTaskWorkflow(FeedRepository.ThreadContext threadContext)
TestSuite	getTestSuite(Table table)
EntityRepository<Table>.EntityUpdater	getUpdater(Table original, Table updated, EntityRepository.Operation operation)
CsvImportResult	importFromCsv(String name, String csv, boolean dryRun, String user)	Load CSV provided for bulk upload
void	prepare(Table table, 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	restorePatchAttributes(Table original, Table updated)	PATCH operations can't overwrite certain fields, such as entity ID, fullyQualifiedNames etc.
void	setFields(Table table, EntityUtil.Fields fields)	Set the requested fields in an entity.
void	setFullyQualifiedName(Table table)	Set fullyQualifiedName of an entity
void	setInheritedFields(Table table, EntityUtil.Fields fields)	This method is called to set inherited fields that an entity inherits from its parent.
void	storeEntity(Table table, boolean update)	An entity is stored in the backend database as JSON document.
void	storeRelationships(Table table)	This method is called to store all the relationships of an entity.
static void	validateColumn(Table table, String columnName)
void	validateTags(Table entity)

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

addFollower, addRelationship, addRelationship, addRelationship, addServiceRelationship, applyColumnTags, applyTags, bulkAddToRelationship, bulkAssetsOperation, checkSystemEntityDeletion, cleanup, clearFieldsInternal, copy, create, createInternal, createOrUpdate, delete, deleteByName, deleteExtensionAtTimestamp, deleteExtensionBeforeTimestamp, deleteFollower, deleteFrom, deleteFromSearch, deleteInternal, deleteInternalByName, deleteRelationship, deleteTo, ensureSingleRelationship, 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, getSuggestionWorkflow, getTags, getTags, getTagsByPrefix, getToEntityRef, getVersion, getVotes, inheritDomain, inheritExperts, inheritOwner, inheritReviewers, initializeEntity, initSeedDataFromResources, listAfter, listAfterWithSkipFailure, listAll, listBefore, listVersions, patch, populateOwner, postCreate, postDelete, postUpdate, preDelete, prepareInternal, removeExtension, restoreEntity, restoreFromSearch, setFieldsInternal, 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

Field Details

FIELD_RELATION_COLUMN_TYPE

public static final String FIELD_RELATION_COLUMN_TYPE

See Also:

• Constant Field Values

FIELD_RELATION_TABLE_TYPE

public static final String FIELD_RELATION_TABLE_TYPE

See Also:

• Constant Field Values

TABLE_PROFILE_EXTENSION

public static final String TABLE_PROFILE_EXTENSION

See Also:

• Constant Field Values

SYSTEM_PROFILE_EXTENSION

public static final String SYSTEM_PROFILE_EXTENSION

See Also:

• Constant Field Values

TABLE_COLUMN_PROFILE_EXTENSION

public static final String TABLE_COLUMN_PROFILE_EXTENSION

See Also:

• Constant Field Values

TABLE_SAMPLE_DATA_EXTENSION

public static final String TABLE_SAMPLE_DATA_EXTENSION

See Also:

• Constant Field Values

TABLE_PROFILER_CONFIG_EXTENSION

public static final String TABLE_PROFILER_CONFIG_EXTENSION

See Also:

• Constant Field Values

TABLE_COLUMN_EXTENSION

public static final String TABLE_COLUMN_EXTENSION

See Also:

• Constant Field Values

TABLE_EXTENSION

public static final String TABLE_EXTENSION

See Also:

• Constant Field Values

CUSTOM_METRICS_EXTENSION

public static final String CUSTOM_METRICS_EXTENSION

See Also:

• Constant Field Values

TABLE_PROFILER_CONFIG

public static final String TABLE_PROFILER_CONFIG

See Also:

• Constant Field Values

COLUMN_FIELD

public static final String COLUMN_FIELD

See Also:

• Constant Field Values

CUSTOM_METRICS

public static final String CUSTOM_METRICS

See Also:

• Constant Field Values

Constructor Details

TableRepository

public TableRepository()

Method Details

setFields

public void setFields(Table table,
 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<Table>

clearFields

public void clearFields(Table table,
 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<Table>

setInheritedFields

public void setInheritedFields(Table table,
 EntityUtil.Fields fields)

Description copied from class: EntityRepository

This method is called to set inherited fields that an entity inherits from its parent.

Overrides:

setInheritedFields in class EntityRepository<Table>

See Also:

• for an example implementation

restorePatchAttributes

public void restorePatchAttributes(Table original,
 Table updated)

Description copied from class: EntityRepository

PATCH operations can't overwrite certain fields, such as entity ID, fullyQualifiedNames etc. Instead of throwing an error, we take lenient approach of ignoring the user error and restore those attributes based on what is already stored in the original entity.

Overrides:

restorePatchAttributes in class EntityRepository<Table>

setFullyQualifiedName

public void setFullyQualifiedName(Table table)

Description copied from class: EntityRepository

Set fullyQualifiedName of an entity

Overrides:

setFullyQualifiedName in class EntityRepository<Table>

addJoins

public Table addJoins(UUID tableId,
 TableJoins joins)

addSampleData

public Table addSampleData(UUID tableId,
 TableData tableData)

getSampleData

public Table getSampleData(UUID tableId,
 boolean authorizePII)

deleteSampleData

public Table deleteSampleData(UUID tableId)

getTableProfilerConfig

public TableProfilerConfig getTableProfilerConfig(Table table)

getTestSuite

public TestSuite getTestSuite(Table table)

addTableProfilerConfig

public Table addTableProfilerConfig(UUID tableId,
 TableProfilerConfig tableProfilerConfig)

deleteTableProfilerConfig

public Table deleteTableProfilerConfig(UUID tableId)

addTableProfileData

public Table addTableProfileData(UUID tableId,
 CreateTableProfile createTableProfile)

deleteTableProfile

public void deleteTableProfile(String fqn,
 String entityType,
 Long timestamp)

getTableProfiles

public ResultList<TableProfile> getTableProfiles(String fqn,
 Long startTs,
 Long endTs)

getColumnProfiles

public ResultList<ColumnProfile> getColumnProfiles(String fqn,
 Long startTs,
 Long endTs)

getSystemProfiles

public ResultList<SystemProfile> getSystemProfiles(String fqn,
 Long startTs,
 Long endTs)

getLatestTableProfile

public Table getLatestTableProfile(String fqn,
 boolean authorizePII)

addCustomMetric

public Table addCustomMetric(UUID tableId,
 CustomMetric customMetric)

deleteCustomMetric

public Table deleteCustomMetric(UUID tableId,
 String columnName,
 String metricName)

addDataModel

public Table addDataModel(UUID tableId,
 DataModel dataModel)

prepare

public void prepare(Table table,
 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<Table>

See Also:

• for an example implementation

storeEntity

public void storeEntity(Table table,
 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<Table>

See Also:

• for an example implementation

storeRelationships

public void storeRelationships(Table table)

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

See Also:

• for an example implementation

getUpdater

public EntityRepository<Table>.EntityUpdater getUpdater(Table original,
 Table updated,
 EntityRepository.Operation operation)

Overrides:

getUpdater in class EntityRepository<Table>

applyTags

public void applyTags(Table table)

Overrides:

applyTags in class EntityRepository<Table>

getParentEntity

public EntityInterface getParentEntity(Table entity,
 String fields)

Overrides:

getParentEntity in class EntityRepository<Table>

validateTags

public void validateTags(Table entity)

Overrides:

validateTags in class EntityRepository<Table>

getAllTags

public List<TagLabel> getAllTags(EntityInterface entity)

Overrides:

getAllTags in class EntityRepository<Table>

getTaskWorkflow

public FeedRepository.TaskWorkflow getTaskWorkflow(FeedRepository.ThreadContext threadContext)

Overrides:

getTaskWorkflow in class EntityRepository<Table>

getSuggestionFields

public String getSuggestionFields(Suggestion suggestion)

Description copied from class: EntityRepository

Bring in the necessary fields required to have all the information before applying a suggestion

Overrides:

getSuggestionFields in class EntityRepository<Table>

applySuggestion

public Table applySuggestion(EntityInterface entity,
 String columnFQN,
 Suggestion suggestion)

Overrides:

applySuggestion in class EntityRepository<Table>

exportToCsv

public String exportToCsv(String name,
 String user)
                   throws IOException

Description copied from class: EntityRepository

Override this method to support downloading CSV functionality

Overrides:

exportToCsv in class EntityRepository<Table>

Throws:

IOException

importFromCsv

public CsvImportResult importFromCsv(String name,
 String csv,
 boolean dryRun,
 String user)
                              throws IOException

Description copied from class: EntityRepository

Load CSV provided for bulk upload

Overrides:

importFromCsv in class EntityRepository<Table>

Throws:

IOException

validateColumn

public static void validateColumn(Table table,
 String columnName)