Package org.openmetadata.service.jdbi3

Class DatabaseSchemaRepository

java.lang.Object

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

org.openmetadata.service.jdbi3.DatabaseSchemaRepository

public class DatabaseSchemaRepository
extends EntityRepository<DatabaseSchema>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatabaseSchemaRepository.DatabaseSchemaCsv
class	DatabaseSchemaRepository.DatabaseSchemaUpdater

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	DATABASE_SCHEMA_PROFILER_CONFIG
static final String	DATABASE_SCHEMA_PROFILER_CONFIG_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
DatabaseSchemaRepository()

Method Summary

Modifier and Type	Method	Description
DatabaseSchema	addDatabaseSchemaProfilerConfig(UUID databaseSchemaId, DatabaseSchemaProfilerConfig databaseSchemaProfilerConfig)
void	clearFields(DatabaseSchema schema, EntityUtil.Fields fields)	Set the requested fields in an entity.
DatabaseSchema	deleteDatabaseSchemaProfilerConfig(UUID databaseSchemaId)
String	exportToCsv(String name, String user)	Override this method to support downloading CSV functionality
DatabaseSchemaProfilerConfig	getDatabaseSchemaProfilerConfig(DatabaseSchema databaseSchema)
EntityInterface	getParentEntity(DatabaseSchema entity, String fields)
EntityRepository<DatabaseSchema>.EntityUpdater	getUpdater(DatabaseSchema original, DatabaseSchema updated, EntityRepository.Operation operation)
CsvImportResult	importFromCsv(String name, String csv, boolean dryRun, String user)	Load CSV provided for bulk upload
void	prepare(DatabaseSchema schema, 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(DatabaseSchema original, DatabaseSchema updated)	PATCH operations can't overwrite certain fields, such as entity ID, fullyQualifiedNames etc.
void	setFields(DatabaseSchema schema, EntityUtil.Fields fields)	Set the requested fields in an entity.
void	setFullyQualifiedName(DatabaseSchema schema)	Set fullyQualifiedName of an entity
void	setInheritedFields(DatabaseSchema schema, EntityUtil.Fields fields)	This method is called to set inherited fields that an entity inherits from its parent.
void	storeEntity(DatabaseSchema schema, boolean update)	An entity is stored in the backend database as JSON document.
void	storeRelationships(DatabaseSchema schema)	This method is called to store all the relationships of an entity.

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

addFollower, addRelationship, addRelationship, addRelationship, addServiceRelationship, applyColumnTags, applySuggestion, applyTags, 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, getAllTags, 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, getTaskWorkflow, 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, validateTags, validateTaskThread, validateUsers, withHref

Methods inherited from class java.lang.Object

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

Field Details

DATABASE_SCHEMA_PROFILER_CONFIG_EXTENSION

public static final String DATABASE_SCHEMA_PROFILER_CONFIG_EXTENSION

See Also:

• Constant Field Values

DATABASE_SCHEMA_PROFILER_CONFIG

public static final String DATABASE_SCHEMA_PROFILER_CONFIG

See Also:

• Constant Field Values

Constructor Details

DatabaseSchemaRepository

public DatabaseSchemaRepository()

Method Details

setFullyQualifiedName

public void setFullyQualifiedName(DatabaseSchema schema)

Description copied from class: EntityRepository

Set fullyQualifiedName of an entity

Overrides:

setFullyQualifiedName in class EntityRepository<DatabaseSchema>

prepare

public void prepare(DatabaseSchema schema,
 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<DatabaseSchema>

See Also:

• for an example implementation

storeEntity

public void storeEntity(DatabaseSchema schema,
 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<DatabaseSchema>

See Also:

• for an example implementation

storeRelationships

public void storeRelationships(DatabaseSchema schema)

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

See Also:

• for an example implementation

setFields

public void setFields(DatabaseSchema schema,
 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<DatabaseSchema>

clearFields

public void clearFields(DatabaseSchema schema,
 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<DatabaseSchema>

setInheritedFields

public void setInheritedFields(DatabaseSchema schema,
 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<DatabaseSchema>

See Also:

• for an example implementation

restorePatchAttributes

public void restorePatchAttributes(DatabaseSchema original,
 DatabaseSchema 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<DatabaseSchema>

getParentEntity

public EntityInterface getParentEntity(DatabaseSchema entity,
 String fields)

Overrides:

getParentEntity in class EntityRepository<DatabaseSchema>

getUpdater

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

Overrides:

getUpdater in class EntityRepository<DatabaseSchema>

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

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

Throws:

IOException

addDatabaseSchemaProfilerConfig

public DatabaseSchema addDatabaseSchemaProfilerConfig(UUID databaseSchemaId,
 DatabaseSchemaProfilerConfig databaseSchemaProfilerConfig)

getDatabaseSchemaProfilerConfig

public DatabaseSchemaProfilerConfig getDatabaseSchemaProfilerConfig(DatabaseSchema databaseSchema)

deleteDatabaseSchemaProfilerConfig

public DatabaseSchema deleteDatabaseSchemaProfilerConfig(UUID databaseSchemaId)