Package org.openmetadata.service.jdbi3

Class TeamRepository

java.lang.Object

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

org.openmetadata.service.jdbi3.TeamRepository

public class TeamRepository
extends EntityRepository<Team>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TeamRepository.TeamCsv
class	TeamRepository.TeamUpdater	Handles entity updated from PUT and POST operation.

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

EntityRepository.EntityUpdater, EntityRepository.Operation

Field Summary

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
TeamRepository(CollectionDAO dao)

Method Summary

Modifier and Type	Method	Description
protected void	cleanup(Team team)
Team	clearFields(Team team, EntityUtil.Fields fields)	Set the requested fields in an entity.
String	exportToCsv(String parentTeam, String user)	Override this method to support downloading CSV functionality
protected List<EntityReference>	getChildren(UUID teamId)
protected List<EntityReference>	getChildren(Team team)
TeamRepository.TeamUpdater	getUpdater(Team original, Team updated, EntityRepository.Operation operation)
CsvImportResult	importFromCsv(String name, String csv, boolean dryRun, String user)	Load CSV provided for bulk upload
void	initOrganization()
List<TeamHierarchy>	listHierarchy(ListFilter filter, int limit, Boolean isJoinable)
protected void	preDelete(Team entity)
void	prepare(Team team)	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(Team original, Team updated)	PATCH operations can't overwrite certain fields, such as entity ID, fullyQualifiedNames etc.
Team	setFields(Team team, EntityUtil.Fields fields)	Set the requested fields in an entity.
void	storeEntity(Team team, boolean update)	An entity is stored in the backend database as JSON document.
void	storeRelationships(Team team)	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, clearFieldsInternal, create, createInternal, createOrUpdate, createOrUpdateInternal, delete, deleteByName, deleteExtensionAtTimestamp, deleteExtensionBeforeTimestamp, deleteFollower, deleteFrom, deleteInternal, deleteInternalByName, deleteRelationship, deleteTo, ensureSingleRelationship, find, findBoth, findByName, findByNameOrNull, findFrom, findFromRecords, findTo, findToRecords, get, get, getAllowedFieldsCopy, getAllTags, getByName, getByName, 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, initializeEntity, initSeedDataFromResources, listAfter, listAfterWithSkipFailure, listAll, listBefore, listVersions, patch, populateOwner, postCreate, postDelete, postUpdate, prepareInternal, removeExtension, restoreEntity, 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

Constructor Detail

TeamRepository

public TeamRepository(CollectionDAO dao)

Method Detail

setFields

public Team setFields(Team team,
                      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<Team>

clearFields

public Team clearFields(Team team,
                        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<Team>

restorePatchAttributes

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

prepare

public void prepare(Team team)

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

See Also:

for an example implementation

storeEntity

public void storeEntity(Team team,
                        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<Team>

See Also:

for an example implementation

storeRelationships

public void storeRelationships(Team team)

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

See Also:

for an example implementation

getUpdater

public TeamRepository.TeamUpdater getUpdater(Team original,
                                             Team updated,
                                             EntityRepository.Operation operation)

Overrides:

getUpdater in class EntityRepository<Team>

preDelete

protected void preDelete(Team entity)

Overrides:

preDelete in class EntityRepository<Team>

cleanup

protected void cleanup(Team team)

Overrides:

cleanup in class EntityRepository<Team>

exportToCsv

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

Description copied from class: EntityRepository

Override this method to support downloading CSV functionality

Overrides:

exportToCsv in class EntityRepository<Team>

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

Throws:

IOException

listHierarchy

public List<TeamHierarchy> listHierarchy(ListFilter filter,
                                         int limit,
                                         Boolean isJoinable)

getChildren

protected List<EntityReference> getChildren(Team team)

Overrides:

getChildren in class EntityRepository<Team>

getChildren

protected List<EntityReference> getChildren(UUID teamId)

initOrganization

public void initOrganization()
                      throws IOException

Throws:

IOException