Package com.atlan.model.assets

Class Database

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.relations.Reference

com.atlan.model.assets.Asset

com.atlan.model.assets.Database

All Implemented Interfaces:

IAsset, ICatalog, IDatabase, IReferenceable, ISQL, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2")
public class Database
extends Asset
implements IDatabase, ISQL, ICatalog, IAsset, IReferenceable

Instance of a (relational) database in Atlan.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Database.DatabaseBuilder<C extends Database,B extends Database.DatabaseBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.assets.Asset

Asset.AssetBuilder<C extends Asset,B extends Asset.AssetBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.relations.Reference

Reference.ReferenceBuilder<C extends Reference,B extends Reference.ReferenceBuilder<C,B>>, Reference.SaveSemantic

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_NAME

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Fields inherited from interface com.atlan.model.assets.IAsset

ADMIN_GROUPS, ADMIN_ROLES, ADMIN_USERS, ANNOUNCEMENT_MESSAGE, ANNOUNCEMENT_TITLE, ANNOUNCEMENT_TYPE, ANNOUNCEMENT_UPDATED_AT, ANNOUNCEMENT_UPDATED_BY, ANOMALO_CHECKS, APPLICATION, APPLICATION_FIELD, APPLICATION_FIELD_QUALIFIED_NAME, APPLICATION_QUALIFIED_NAME, ASSET_ANOMALO_APPLIED_CHECK_TYPES, ASSET_ANOMALO_CHECK_COUNT, ASSET_ANOMALO_CHECK_STATUSES, ASSET_ANOMALO_DQ_STATUS, ASSET_ANOMALO_FAILED_CHECK_COUNT, ASSET_ANOMALO_FAILED_CHECK_TYPES, ASSET_ANOMALO_LAST_CHECK_RUN_AT, ASSET_ANOMALO_SOURCE_URL, ASSET_COVER_IMAGE, ASSET_DBT_ACCOUNT_NAME, ASSET_DBT_ALIAS, ASSET_DBT_ENVIRONMENT_DBT_VERSION, ASSET_DBT_ENVIRONMENT_NAME, ASSET_DBT_JOB_LAST_RUN, ASSET_DBT_JOB_LAST_RUN_ARTIFACT_S3PATH, ASSET_DBT_JOB_LAST_RUN_ARTIFACTS_SAVED, ASSET_DBT_JOB_LAST_RUN_CREATED_AT, ASSET_DBT_JOB_LAST_RUN_DEQUED_AT, ASSET_DBT_JOB_LAST_RUN_EXECUTED_BY_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_GIT_BRANCH, ASSET_DBT_JOB_LAST_RUN_GIT_SHA, ASSET_DBT_JOB_LAST_RUN_HAS_DOCS_GENERATED, ASSET_DBT_JOB_LAST_RUN_HAS_SOURCES_GENERATED, ASSET_DBT_JOB_LAST_RUN_NOTIFICATIONS_SENT, ASSET_DBT_JOB_LAST_RUN_OWNER_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_STARTED_AT, ASSET_DBT_JOB_LAST_RUN_STATUS_MESSAGE, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_UPDATED_AT, ASSET_DBT_JOB_LAST_RUN_URL, ASSET_DBT_JOB_NAME, ASSET_DBT_JOB_NEXT_RUN, ASSET_DBT_JOB_NEXT_RUN_HUMANIZED, ASSET_DBT_JOB_SCHEDULE, ASSET_DBT_JOB_SCHEDULE_CRON_HUMANIZED, ASSET_DBT_JOB_STATUS, ASSET_DBT_META, ASSET_DBT_PACKAGE_NAME, ASSET_DBT_PROJECT_NAME, ASSET_DBT_SEMANTIC_LAYER_PROXY_URL, ASSET_DBT_SOURCE_FRESHNESS_CRITERIA, ASSET_DBT_TAGS, ASSET_DBT_TEST_STATUS, ASSET_DBT_UNIQUE_ID, ASSET_DBT_WORKFLOW_LAST_UPDATED, ASSET_ICON, ASSET_INTERNAL_POPULARITY_SCORE, ASSET_MC_ALERT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_NAMES, ASSET_MC_INCIDENT_PRIORITIES, ASSET_MC_INCIDENT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_SEVERITIES, ASSET_MC_INCIDENT_STATES, ASSET_MC_INCIDENT_SUB_TYPES, ASSET_MC_INCIDENT_TYPES, ASSET_MC_IS_MONITORED, ASSET_MC_LAST_SYNC_RUN_AT, ASSET_MC_MONITOR_NAMES, ASSET_MC_MONITOR_QUALIFIED_NAMES, ASSET_MC_MONITOR_SCHEDULE_TYPES, ASSET_MC_MONITOR_STATUSES, ASSET_MC_MONITOR_TYPES, ASSET_POLICIES_COUNT, ASSET_POLICY_GUIDS, ASSET_REDIRECT_GUIDS, ASSET_SODA_CHECK_COUNT, ASSET_SODA_CHECK_STATUSES, ASSET_SODA_DQ_STATUS, ASSET_SODA_LAST_SCAN_AT, ASSET_SODA_LAST_SYNC_RUN_AT, ASSET_SODA_SOURCE_URL, ASSET_SOURCE_README, ASSET_TAGS, ASSET_THEME_HEX, ASSET_USER_DEFINED_TYPE, CERTIFICATE_STATUS, CERTIFICATE_STATUS_MESSAGE, CERTIFICATE_UPDATED_AT, CERTIFICATE_UPDATED_BY, CONNECTION_NAME, CONNECTION_QUALIFIED_NAME, CONNECTOR_NAME, CONNECTOR_TYPE, CUSTOM_CONNECTOR_TYPE, DATA_CONTRACT_LATEST, DATA_CONTRACT_LATEST_CERTIFIED, DBT_QUALIFIED_NAME, DESCRIPTION, DISPLAY_NAME, DOMAIN_GUIDS, FILES, HAS_CONTRACT, HAS_LINEAGE, INPUT_PORT_DATA_PRODUCTS, IS_AI_GENERATED, IS_DISCOVERABLE, IS_EDITABLE, IS_PARTIAL, LAST_ROW_CHANGED_AT, LAST_SYNC_RUN, LAST_SYNC_RUN_AT, LAST_SYNC_WORKFLOW_NAME, LEXICOGRAPHICAL_SORT_ORDER, LINKS, MC_INCIDENTS, MC_MONITORS, METRICS, NAME, NON_COMPLIANT_ASSET_POLICY_GUIDS, OUTPUT_PORT_DATA_PRODUCTS, OUTPUT_PRODUCT_GUIDS, OWNER_GROUPS, OWNER_USERS, POPULARITY_SCORE, PRODUCT_GUIDS, QUALIFIED_NAME, README, SAMPLE_DATA_URL, SCHEMA_REGISTRY_SUBJECTS, SODA_CHECKS, SOURCE_COST_UNIT, SOURCE_CREATED_AT, SOURCE_CREATED_BY, SOURCE_EMBED_URL, SOURCE_LAST_READ_AT, SOURCE_OWNERS, SOURCE_QUERY_COMPUTE_COST_RECORDS, SOURCE_QUERY_COMPUTE_COSTS, SOURCE_READ_COUNT, SOURCE_READ_EXPENSIVE_QUERY_RECORDS, SOURCE_READ_POPULAR_QUERY_RECORDS, SOURCE_READ_QUERY_COST, SOURCE_READ_RECENT_USER_RECORDS, SOURCE_READ_RECENT_USERS, SOURCE_READ_SLOW_QUERY_RECORDS, SOURCE_READ_TOP_USER_RECORDS, SOURCE_READ_TOP_USERS, SOURCE_READ_USER_COUNT, SOURCE_TOTAL_COST, SOURCE_UPDATED_AT, SOURCE_UPDATED_BY, SOURCE_URL, STARRED_BY, STARRED_COUNT, STARRED_DETAILS, SUB_TYPE, TENANT_ID, USER_DEF_RELATIONSHIP_FROMS, USER_DEF_RELATIONSHIP_TOS, USER_DESCRIPTION, VIEW_SCORE, VIEWER_GROUPS, VIEWER_USERS

Fields inherited from interface com.atlan.model.assets.ICatalog

INPUT_TO_AIRFLOW_TASKS, INPUT_TO_PROCESSES, INPUT_TO_SPARK_JOBS, MODEL_IMPLEMENTED_ATTRIBUTES, MODEL_IMPLEMENTED_ENTITIES, OUTPUT_FROM_AIRFLOW_TASKS, OUTPUT_FROM_PROCESSES, OUTPUT_FROM_SPARK_JOBS

Fields inherited from interface com.atlan.model.assets.IDatabase

SCHEMA_COUNT, SCHEMAS

Fields inherited from interface com.atlan.model.assets.IReferenceable

ASSIGNED_TERMS, ATLAN_TAGS, CREATE_TIME, CREATED_BY, CUSTOM_ATTRIBUTES, GUID, PROPAGATED_ATLAN_TAGS, STATUS, SUPER_TYPE_NAMES, UPDATE_TIME, UPDATED_BY

Fields inherited from interface com.atlan.model.assets.ISQL

CALCULATION_VIEW_NAME, CALCULATION_VIEW_QUALIFIED_NAME, DATABASE_NAME, DATABASE_QUALIFIED_NAME, DBT_MODELS, DBT_SEED_ASSETS, DBT_SOURCES, DBT_TESTS, IS_PROFILED, LAST_PROFILED_AT, QUERY_COUNT, QUERY_COUNT_UPDATED_AT, QUERY_USER_COUNT, QUERY_USER_MAP, SCHEMA_NAME, SCHEMA_QUALIFIED_NAME, SQL_AI_MODEL_CONTEXT_QUALIFIED_NAME, SQL_DBT_MODELS, SQL_DBT_SOURCES, TABLE_NAME, TABLE_QUALIFIED_NAME, VIEW_NAME, VIEW_QUALIFIED_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Database(Database.DatabaseBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static Database.DatabaseBuilder<?,?>	_internal()
static Database	appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames)	Deprecated. see Asset.AssetBuilder.appendAtlanTags(List)
static Database	appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation)	Deprecated. see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)
static Database	appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)	Deprecated. see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)
protected boolean	canEqual(Object other)
static Database.DatabaseBuilder<?,?>	creator(String name, String connectionQualifiedName)	Builds the minimal object necessary to create a database.
boolean	equals(Object o)
static String	generateQualifiedName(String name, String connectionQualifiedName)	Generate a unique database name.
static Database	get(AtlanClient client, String id)	Retrieves a Database by one of its identifiers, complete with all of its relationships.
static Database	get(AtlanClient client, String id, boolean includeAllRelationships)	Retrieves a Database by one of its identifiers, optionally complete with all of its relationships.
static Database	get(AtlanClient client, String id, Collection<AtlanField> attributes)	Retrieves a Database by one of its identifiers, with only the requested attributes (and relationships).
static Database	get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated)	Retrieves a Database by one of its identifiers, with only the requested attributes (and relationships).
String	getCalculationViewName()	Simple name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.
String	getCalculationViewQualifiedName()	Unique name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.
String	getDatabaseName()	Simple name of the database in which this SQL asset exists, or empty if it does not exist within a database.
String	getDatabaseQualifiedName()	Unique name of the database in which this SQL asset exists, or empty if it does not exist within a database.
SortedSet<IDbtModel>	getDbtModels()	(Deprecated) Model containing the assets.
SortedSet<IDbtSeed>	getDbtSeedAssets()	DBT seeds that materialize the SQL asset.
SortedSet<IDbtSource>	getDbtSources()	Source containing the assets.
SortedSet<IDbtTest>	getDbtTests()	Tests related to this asset.
SortedSet<IAirflowTask>	getInputToAirflowTasks()	Tasks to which this asset provides input.
SortedSet<ILineageProcess>	getInputToProcesses()	Processes to which this asset provides input.
SortedSet<ISparkJob>	getInputToSparkJobs()	TBC
Boolean	getIsProfiled()	Whether this asset has been profiled (true) or not (false).
Long	getLastProfiledAt()	Time (epoch) at which this asset was last profiled, in milliseconds.
SortedSet<IModelAttribute>	getModelImplementedAttributes()	Attributes implemented by this asset.
SortedSet<IModelEntity>	getModelImplementedEntities()	Entities implemented by this asset.
SortedSet<IAirflowTask>	getOutputFromAirflowTasks()	Tasks from which this asset is output.
SortedSet<ILineageProcess>	getOutputFromProcesses()	Processes from which this asset is produced as output.
SortedSet<ISparkJob>	getOutputFromSparkJobs()	TBC
Long	getQueryCount()	Number of times this asset has been queried.
Long	getQueryCountUpdatedAt()	Time (epoch) at which the query count was last updated, in milliseconds.
Long	getQueryUserCount()	Number of unique users who have queried this asset.
Map<String,Long>	getQueryUserMap()	Map of unique users who have queried this asset to the number of times they have queried it.
Integer	getSchemaCount()	Number of schemas in this database.
String	getSchemaName()	Simple name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
String	getSchemaQualifiedName()	Unique name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
SortedSet<ISchema>	getSchemas()	Schemas that exist within this database.
String	getSqlAIModelContextQualifiedName()	Unique name of the context in which the model versions exist, or empty if it does not exist within an AI model context.
SortedSet<IDbtModel>	getSqlDbtModels()	Assets related to the model.
SortedSet<IDbtSource>	getSqlDBTSources()	Sources related to this asset.
String	getTableName()	Simple name of the table in which this SQL asset exists, or empty if it does not exist within a table.
String	getTableQualifiedName()	Unique name of the table in which this SQL asset exists, or empty if it does not exist within a table.
String	getTypeName()	Fixed typeName for Databases.
String	getViewName()	Simple name of the view in which this SQL asset exists, or empty if it does not exist within a view.
String	getViewQualifiedName()	Unique name of the view in which this SQL asset exists, or empty if it does not exist within a view.
int	hashCode()
static Database	refByGuid(String guid)	Reference to a Database by GUID.
static Database	refByGuid(String guid, Reference.SaveSemantic semantic)	Reference to a Database by GUID.
static Database	refByQualifiedName(String qualifiedName)	Reference to a Database by qualifiedName.
static Database	refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)	Reference to a Database by qualifiedName.
static Database	removeAnnouncement(AtlanClient client, String qualifiedName, String name)	Remove the announcement from a Database.
static void	removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName)	Deprecated. see Asset.AssetBuilder.removeAtlanTag(String)
static Database	removeCertificate(AtlanClient client, String qualifiedName, String name)	Remove the certificate from a Database.
static Database	removeDescription(AtlanClient client, String qualifiedName, String name)	Remove the system description from a Database.
static Database	removeOwners(AtlanClient client, String qualifiedName, String name)	Remove the owners from a Database.
static Database	removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)	Deprecated. see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)
static Database	removeUserDescription(AtlanClient client, String qualifiedName, String name)	Remove the user's description from a Database.
static Database	replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms)	Replace the terms linked to the Database.
static boolean	restore(AtlanClient client, String qualifiedName)	Restore the archived (soft-deleted) Database to active.
static FluentSearch.FluentSearchBuilder<?,?>	select(AtlanClient client)	Start a fluent search that will return all Database assets.
static FluentSearch.FluentSearchBuilder<?,?>	select(AtlanClient client, boolean includeArchived)	Start a fluent search that will return all Database assets.
Database.DatabaseBuilder<?,?>	toBuilder()
String	toString()
Database	trimToReference()	Builds the minimal object necessary to create a relationship to a Database, from a potentially more-complete Database object.
Database.DatabaseBuilder<?,?>	trimToRequired()	Builds the minimal object necessary to apply an update to a Database, from a potentially more-complete Database object.
static Database	updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message)	Update the announcement on a Database.
static Database	updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message)	Update the certificate on a Database.
static Database.DatabaseBuilder<?,?>	updater(String qualifiedName, String name)	Builds the minimal object necessary to update a Database.

Methods inherited from class com.atlan.model.assets.Asset

addApiTokenAsAdmin, appendAtlanTags, appendAtlanTags, appendTerms, delete, get, getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getAtlanTagNames, getAtlanTags, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCreatedBy, getCreateTime, getCustomConnectorType, getCustomMetadata, getCustomMetadataSets, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDeleteHandler, getDepth, getDescription, getDisplayName, getDomainGUIDs, getFiles, getHasContract, getHasLineage, getIconUrl, getImmediateDownstream, getImmediateUpstream, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsIncomplete, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMeaningNames, getMeanings, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getNullFields, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPendingTasks, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getStatus, getSubType, getTenantId, getUpdatedBy, getUpdateTime, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, lineage, lineage, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceTerms, requestLineage, restore, save, save, saveMergingCM, saveMergingCM, saveReplacingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, updateMergingCM, updateMergingCM, updateReplacingCM, updateReplacingCM

Methods inherited from class com.atlan.model.relations.Reference

builder, by, compareTo, getCompleteObject, getCustomAttributes, getDisplayText, getEntityStatus, getGuid, getLabels, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSemantic, getUniqueAttributes, isComplete, isValidReference, isValidReferenceByGuid, isValidReferenceByQualifiedName, setCompleteObject, to, validateRelationship, validateRequired

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlan.model.search.AuditDetail

getRawJsonObject, setRawJsonObject

Methods inherited from interface com.atlan.model.assets.IAsset

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.ICatalog

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IDatabase

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IReferenceable

getAtlanTagNames, getAtlanTags, getCreatedBy, getCreateTime, getCustomMetadataSets, getDeleteHandler, getGuid, getIsIncomplete, getMeaningNames, getMeanings, getPendingTasks, getQualifiedName, getStatus, getUpdatedBy, getUpdateTime

Methods inherited from interface com.atlan.model.assets.ISQL

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Field Details

TYPE_NAME

public static final String TYPE_NAME

See Also:

• Constant Field Values

Constructor Details

Database

protected Database(Database.DatabaseBuilder<?,?> b)

Method Details

trimToReference

public Database trimToReference()
                         throws InvalidRequestException

Builds the minimal object necessary to create a relationship to a Database, from a potentially more-complete Database object.

Overrides:

trimToReference in class Asset

Returns:

the minimal object necessary to relate to the Database

Throws:

InvalidRequestException - if any of the minimal set of required properties for a Database relationship are not found in the initial object

select

public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)

Start a fluent search that will return all Database assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) Database assets will be included.

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the assets

Returns:

a fluent search that includes all Database assets

select

public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client,
 boolean includeArchived)

Start a fluent search that will return all Database assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the assets

includeArchived - when true, archived (soft-deleted) Databases will be included

Returns:

a fluent search that includes all Database assets

refByGuid

public static Database refByGuid(String guid)

Reference to a Database by GUID. Use this to create a relationship to this Database, where the relationship should be replaced.

Parameters:

guid - the GUID of the Database to reference

Returns:

reference to a Database that can be used for defining a relationship to a Database

refByGuid

public static Database refByGuid(String guid,
 Reference.SaveSemantic semantic)

Reference to a Database by GUID. Use this to create a relationship to this Database, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).

Parameters:

guid - the GUID of the Database to reference

semantic - how to save this relationship (replace all with this, append it, or remove it)

Returns:

reference to a Database that can be used for defining a relationship to a Database

refByQualifiedName

public static Database refByQualifiedName(String qualifiedName)

Reference to a Database by qualifiedName. Use this to create a relationship to this Database, where the relationship should be replaced.

Parameters:

qualifiedName - the qualifiedName of the Database to reference

Returns:

reference to a Database that can be used for defining a relationship to a Database

refByQualifiedName

public static Database refByQualifiedName(String qualifiedName,
 Reference.SaveSemantic semantic)

Reference to a Database by qualifiedName. Use this to create a relationship to this Database, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).

Parameters:

qualifiedName - the qualifiedName of the Database to reference

semantic - how to save this relationship (replace all with this, append it, or remove it)

Returns:

reference to a Database that can be used for defining a relationship to a Database

get

public static Database get(AtlanClient client,
 String id)
                    throws AtlanException

Retrieves a Database by one of its identifiers, complete with all of its relationships.

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the asset

id - of the Database to retrieve, either its GUID or its full qualifiedName

Returns:

the requested full Database, complete with all of its relationships

Throws:

AtlanException - on any error during the API invocation, such as the NotFoundException if the Database does not exist or the provided GUID is not a Database

get

public static Database get(AtlanClient client,
 String id,
 boolean includeAllRelationships)
                    throws AtlanException

Retrieves a Database by one of its identifiers, optionally complete with all of its relationships.

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the asset

id - of the Database to retrieve, either its GUID or its full qualifiedName

includeAllRelationships - if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved

Returns:

the requested full Database, optionally complete with all of its relationships

Throws:

AtlanException - on any error during the API invocation, such as the NotFoundException if the Database does not exist or the provided GUID is not a Database

get

public static Database get(AtlanClient client,
 String id,
 Collection<AtlanField> attributes)
                    throws AtlanException

Retrieves a Database by one of its identifiers, with only the requested attributes (and relationships).

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the asset

id - of the Database to retrieve, either its GUID or its full qualifiedName

attributes - to retrieve for the Database, including any relationships

Returns:

the requested Database, with only its minimal information and the requested attributes (and relationships)

Throws:

AtlanException - on any error during the API invocation, such as the NotFoundException if the Database does not exist or the provided GUID is not a Database

get

public static Database get(AtlanClient client,
 String id,
 Collection<AtlanField> attributes,
 Collection<AtlanField> attributesOnRelated)
                    throws AtlanException

Retrieves a Database by one of its identifiers, with only the requested attributes (and relationships).

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the asset

id - of the Database to retrieve, either its GUID or its full qualifiedName

attributes - to retrieve for the Database, including any relationships

attributesOnRelated - to retrieve on each relationship retrieved for the Database

Returns:

the requested Database, with only its minimal information and the requested attributes (and relationships)

Throws:

AtlanException - on any error during the API invocation, such as the NotFoundException if the Database does not exist or the provided GUID is not a Database

restore

public static boolean restore(AtlanClient client,
 String qualifiedName)
                       throws AtlanException

Restore the archived (soft-deleted) Database to active.

Parameters:

client - connectivity to the Atlan tenant on which to restore the asset

qualifiedName - for the Database

Returns:

true if the Database is now active, and false otherwise

Throws:

AtlanException - on any API problems

creator

public static Database.DatabaseBuilder<?,?> creator(String name,
 String connectionQualifiedName)

Builds the minimal object necessary to create a database.

Parameters:

name - of the database

connectionQualifiedName - unique name of the specific instance of the software / system that hosts the database

Returns:

the minimal request necessary to create the database, as a builder

generateQualifiedName

public static String generateQualifiedName(String name,
 String connectionQualifiedName)

Generate a unique database name.

Parameters:

name - of the database

connectionQualifiedName - unique name of the specific instance of the software / system that hosts the database

Returns:

a unique name for the database

updater

public static Database.DatabaseBuilder<?,?> updater(String qualifiedName,
 String name)

Builds the minimal object necessary to update a Database.

Parameters:

qualifiedName - of the Database

name - of the Database

Returns:

the minimal request necessary to update the Database, as a builder

trimToRequired

public Database.DatabaseBuilder<?,?> trimToRequired()
                                             throws InvalidRequestException

Builds the minimal object necessary to apply an update to a Database, from a potentially more-complete Database object.

Overrides:

trimToRequired in class Asset

Returns:

the minimal object necessary to update the Database, as a builder

Throws:

InvalidRequestException - if any of the minimal set of required properties for Database are not found in the initial object

removeDescription

public static Database removeDescription(AtlanClient client,
 String qualifiedName,
 String name)
                                  throws AtlanException

Remove the system description from a Database.

Parameters:

client - connectivity to the Atlan tenant on which to remove the asset's description

qualifiedName - of the Database

name - of the Database

Returns:

the updated Database, or null if the removal failed

Throws:

AtlanException - on any API problems

removeUserDescription

public static Database removeUserDescription(AtlanClient client,
 String qualifiedName,
 String name)
                                      throws AtlanException

Remove the user's description from a Database.

Parameters:

client - connectivity to the Atlan tenant on which to remove the asset's description

qualifiedName - of the Database

name - of the Database

Returns:

the updated Database, or null if the removal failed

Throws:

AtlanException - on any API problems

removeOwners

public static Database removeOwners(AtlanClient client,
 String qualifiedName,
 String name)
                             throws AtlanException

Remove the owners from a Database.

Parameters:

client - connectivity to the Atlan tenant from which to remove the Database's owners

qualifiedName - of the Database

name - of the Database

Returns:

the updated Database, or null if the removal failed

Throws:

AtlanException - on any API problems

updateCertificate

public static Database updateCertificate(AtlanClient client,
 String qualifiedName,
 CertificateStatus certificate,
 String message)
                                  throws AtlanException

Update the certificate on a Database.

Parameters:

client - connectivity to the Atlan tenant on which to update the Database's certificate

qualifiedName - of the Database

certificate - to use

message - (optional) message, or null if no message

Returns:

the updated Database, or null if the update failed

Throws:

AtlanException - on any API problems

removeCertificate

public static Database removeCertificate(AtlanClient client,
 String qualifiedName,
 String name)
                                  throws AtlanException

Remove the certificate from a Database.

Parameters:

client - connectivity to the Atlan tenant from which to remove the Database's certificate

qualifiedName - of the Database

name - of the Database

Returns:

the updated Database, or null if the removal failed

Throws:

AtlanException - on any API problems

updateAnnouncement

public static Database updateAnnouncement(AtlanClient client,
 String qualifiedName,
 AtlanAnnouncementType type,
 String title,
 String message)
                                   throws AtlanException

Update the announcement on a Database.

Parameters:

client - connectivity to the Atlan tenant on which to update the Database's announcement

qualifiedName - of the Database

type - type of announcement to set

title - (optional) title of the announcement to set (or null for no title)

message - (optional) message of the announcement to set (or null for no message)

Returns:

the result of the update, or null if the update failed

Throws:

AtlanException - on any API problems

removeAnnouncement

public static Database removeAnnouncement(AtlanClient client,
 String qualifiedName,
 String name)
                                   throws AtlanException

Remove the announcement from a Database.

Parameters:

client - connectivity to the Atlan client from which to remove the Database's announcement

qualifiedName - of the Database

name - of the Database

Returns:

the updated Database, or null if the removal failed

Throws:

AtlanException - on any API problems

replaceTerms

public static Database replaceTerms(AtlanClient client,
 String qualifiedName,
 String name,
 List<IGlossaryTerm> terms)
                             throws AtlanException

Replace the terms linked to the Database.

Parameters:

client - connectivity to the Atlan tenant on which to replace the Database's assigned terms

qualifiedName - for the Database

name - human-readable name of the Database

terms - the list of terms to replace on the Database, or null to remove all terms from the Database

Returns:

the Database that was updated (note that it will NOT contain details of the replaced terms)

Throws:

AtlanException - on any API problems

appendTerms

@Deprecated
public static Database appendTerms(AtlanClient client,
 String qualifiedName,
 List<IGlossaryTerm> terms)
                            throws AtlanException

Deprecated.

see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)

Link additional terms to the Database, without replacing existing terms linked to the Database. Note: this operation must make two API calls — one to retrieve the Database's existing terms, and a second to append the new terms.

Parameters:

client - connectivity to the Atlan tenant on which to append terms to the Database

qualifiedName - for the Database

terms - the list of terms to append to the Database

Returns:

the Database that was updated (note that it will NOT contain details of the appended terms)

Throws:

AtlanException - on any API problems

removeTerms

@Deprecated
public static Database removeTerms(AtlanClient client,
 String qualifiedName,
 List<IGlossaryTerm> terms)
                            throws AtlanException

Deprecated.

see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)

Remove terms from a Database, without replacing all existing terms linked to the Database. Note: this operation must make two API calls — one to retrieve the Database's existing terms, and a second to remove the provided terms.

Parameters:

client - connectivity to the Atlan tenant from which to remove terms from the Database

qualifiedName - for the Database

terms - the list of terms to remove from the Database, which must be referenced by GUID

Returns:

the Database that was updated (note that it will NOT contain details of the resulting terms)

Throws:

AtlanException - on any API problems

appendAtlanTags

@Deprecated
public static Database appendAtlanTags(AtlanClient client,
 String qualifiedName,
 List<String> atlanTagNames)
                                throws AtlanException

Deprecated.

see Asset.AssetBuilder.appendAtlanTags(List)

Add Atlan tags to a Database, without replacing existing Atlan tags linked to the Database. Note: this operation must make two API calls — one to retrieve the Database's existing Atlan tags, and a second to append the new Atlan tags.

Parameters:

client - connectivity to the Atlan tenant on which to append Atlan tags to the Database

qualifiedName - of the Database

atlanTagNames - human-readable names of the Atlan tags to add

Returns:

the updated Database

Throws:

AtlanException - on any API problems

appendAtlanTags

@Deprecated
public static Database appendAtlanTags(AtlanClient client,
 String qualifiedName,
 List<String> atlanTagNames,
 boolean propagate,
 boolean removePropagationsOnDelete,
 boolean restrictLineagePropagation)
                                throws AtlanException

Deprecated.

see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)

Add Atlan tags to a Database, without replacing existing Atlan tags linked to the Database. Note: this operation must make two API calls — one to retrieve the Database's existing Atlan tags, and a second to append the new Atlan tags.

Parameters:

client - connectivity to the Atlan tenant on which to append Atlan tags to the Database

qualifiedName - of the Database

atlanTagNames - human-readable names of the Atlan tags to add

propagate - whether to propagate the Atlan tag (true) or not (false)

removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)

restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)

Returns:

the updated Database

Throws:

AtlanException - on any API problems

removeAtlanTag

@Deprecated
public static void removeAtlanTag(AtlanClient client,
 String qualifiedName,
 String atlanTagName)
                           throws AtlanException

Deprecated.

see Asset.AssetBuilder.removeAtlanTag(String)

Remove an Atlan tag from a Database.

Parameters:

client - connectivity to the Atlan tenant from which to remove an Atlan tag from a Database

qualifiedName - of the Database

atlanTagName - human-readable name of the Atlan tag to remove

Throws:

AtlanException - on any API problems, or if the Atlan tag does not exist on the Database

_internal

public static Database.DatabaseBuilder<?,?> _internal()

toBuilder

public Database.DatabaseBuilder<?,?> toBuilder()

Overrides:

toBuilder in class Reference

getCalculationViewName

public String getCalculationViewName()

Simple name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.

Specified by:

getCalculationViewName in interface IDatabase

Specified by:

getCalculationViewName in interface ISQL

getCalculationViewQualifiedName

public String getCalculationViewQualifiedName()

Unique name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.

Specified by:

getCalculationViewQualifiedName in interface IDatabase

Specified by:

getCalculationViewQualifiedName in interface ISQL

getDatabaseName

public String getDatabaseName()

Simple name of the database in which this SQL asset exists, or empty if it does not exist within a database.

Specified by:

getDatabaseName in interface IDatabase

Specified by:

getDatabaseName in interface ISQL

getDatabaseQualifiedName

public String getDatabaseQualifiedName()

Unique name of the database in which this SQL asset exists, or empty if it does not exist within a database.

Specified by:

getDatabaseQualifiedName in interface IDatabase

Specified by:

getDatabaseQualifiedName in interface ISQL

getDbtModels

public SortedSet<IDbtModel> getDbtModels()

(Deprecated) Model containing the assets.

Specified by:

getDbtModels in interface IDatabase

Specified by:

getDbtModels in interface ISQL

getDbtSeedAssets

public SortedSet<IDbtSeed> getDbtSeedAssets()

DBT seeds that materialize the SQL asset.

Specified by:

getDbtSeedAssets in interface IDatabase

Specified by:

getDbtSeedAssets in interface ISQL

getDbtSources

public SortedSet<IDbtSource> getDbtSources()

Source containing the assets.

Specified by:

getDbtSources in interface IDatabase

Specified by:

getDbtSources in interface ISQL

getDbtTests

public SortedSet<IDbtTest> getDbtTests()

Tests related to this asset.

Specified by:

getDbtTests in interface IDatabase

Specified by:

getDbtTests in interface ISQL

getInputToAirflowTasks

public SortedSet<IAirflowTask> getInputToAirflowTasks()

Tasks to which this asset provides input.

Specified by:

getInputToAirflowTasks in interface ICatalog

Specified by:

getInputToAirflowTasks in interface IDatabase

Specified by:

getInputToAirflowTasks in interface ISQL

getInputToProcesses

public SortedSet<ILineageProcess> getInputToProcesses()

Processes to which this asset provides input.

Specified by:

getInputToProcesses in interface ICatalog

Specified by:

getInputToProcesses in interface IDatabase

Specified by:

getInputToProcesses in interface ISQL

getInputToSparkJobs

public SortedSet<ISparkJob> getInputToSparkJobs()

TBC

Specified by:

getInputToSparkJobs in interface ICatalog

Specified by:

getInputToSparkJobs in interface IDatabase

Specified by:

getInputToSparkJobs in interface ISQL

getIsProfiled

public Boolean getIsProfiled()

Whether this asset has been profiled (true) or not (false).

Specified by:

getIsProfiled in interface IDatabase

Specified by:

getIsProfiled in interface ISQL

getLastProfiledAt

public Long getLastProfiledAt()

Time (epoch) at which this asset was last profiled, in milliseconds.

Specified by:

getLastProfiledAt in interface IDatabase

Specified by:

getLastProfiledAt in interface ISQL

getModelImplementedAttributes

public SortedSet<IModelAttribute> getModelImplementedAttributes()

Attributes implemented by this asset.

Specified by:

getModelImplementedAttributes in interface ICatalog

Specified by:

getModelImplementedAttributes in interface IDatabase

Specified by:

getModelImplementedAttributes in interface ISQL

getModelImplementedEntities

public SortedSet<IModelEntity> getModelImplementedEntities()

Entities implemented by this asset.

Specified by:

getModelImplementedEntities in interface ICatalog

Specified by:

getModelImplementedEntities in interface IDatabase

Specified by:

getModelImplementedEntities in interface ISQL

getOutputFromAirflowTasks

public SortedSet<IAirflowTask> getOutputFromAirflowTasks()

Tasks from which this asset is output.

Specified by:

getOutputFromAirflowTasks in interface ICatalog

Specified by:

getOutputFromAirflowTasks in interface IDatabase

Specified by:

getOutputFromAirflowTasks in interface ISQL

getOutputFromProcesses

public SortedSet<ILineageProcess> getOutputFromProcesses()

Processes from which this asset is produced as output.

Specified by:

getOutputFromProcesses in interface ICatalog

Specified by:

getOutputFromProcesses in interface IDatabase

Specified by:

getOutputFromProcesses in interface ISQL

getOutputFromSparkJobs

public SortedSet<ISparkJob> getOutputFromSparkJobs()

TBC

Specified by:

getOutputFromSparkJobs in interface ICatalog

Specified by:

getOutputFromSparkJobs in interface IDatabase

Specified by:

getOutputFromSparkJobs in interface ISQL

getQueryCount

public Long getQueryCount()

Number of times this asset has been queried.

Specified by:

getQueryCount in interface IDatabase

Specified by:

getQueryCount in interface ISQL

getQueryCountUpdatedAt

public Long getQueryCountUpdatedAt()

Time (epoch) at which the query count was last updated, in milliseconds.

Specified by:

getQueryCountUpdatedAt in interface IDatabase

Specified by:

getQueryCountUpdatedAt in interface ISQL

getQueryUserCount

public Long getQueryUserCount()

Number of unique users who have queried this asset.

Specified by:

getQueryUserCount in interface IDatabase

Specified by:

getQueryUserCount in interface ISQL

getQueryUserMap

public Map<String,Long> getQueryUserMap()

Map of unique users who have queried this asset to the number of times they have queried it.

Specified by:

getQueryUserMap in interface IDatabase

Specified by:

getQueryUserMap in interface ISQL

getSchemaCount

public Integer getSchemaCount()

Number of schemas in this database.

Specified by:

getSchemaCount in interface IDatabase

getSchemaName

public String getSchemaName()

Simple name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.

Specified by:

getSchemaName in interface IDatabase

Specified by:

getSchemaName in interface ISQL

getSchemaQualifiedName

public String getSchemaQualifiedName()

Unique name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.

Specified by:

getSchemaQualifiedName in interface IDatabase

Specified by:

getSchemaQualifiedName in interface ISQL

getSchemas

public SortedSet<ISchema> getSchemas()

Schemas that exist within this database.

Specified by:

getSchemas in interface IDatabase

getSqlAIModelContextQualifiedName

public String getSqlAIModelContextQualifiedName()

Unique name of the context in which the model versions exist, or empty if it does not exist within an AI model context.

Specified by:

getSqlAIModelContextQualifiedName in interface IDatabase

Specified by:

getSqlAIModelContextQualifiedName in interface ISQL

getSqlDBTSources

public SortedSet<IDbtSource> getSqlDBTSources()

Sources related to this asset.

Specified by:

getSqlDBTSources in interface IDatabase

Specified by:

getSqlDBTSources in interface ISQL

getSqlDbtModels

public SortedSet<IDbtModel> getSqlDbtModels()

Assets related to the model.

Specified by:

getSqlDbtModels in interface IDatabase

Specified by:

getSqlDbtModels in interface ISQL

getTableName

public String getTableName()

Simple name of the table in which this SQL asset exists, or empty if it does not exist within a table.

Specified by:

getTableName in interface IDatabase

Specified by:

getTableName in interface ISQL

getTableQualifiedName

public String getTableQualifiedName()

Unique name of the table in which this SQL asset exists, or empty if it does not exist within a table.

Specified by:

getTableQualifiedName in interface IDatabase

Specified by:

getTableQualifiedName in interface ISQL

getViewName

public String getViewName()

Simple name of the view in which this SQL asset exists, or empty if it does not exist within a view.

Specified by:

getViewName in interface IDatabase

Specified by:

getViewName in interface ISQL

getViewQualifiedName

public String getViewQualifiedName()

Unique name of the view in which this SQL asset exists, or empty if it does not exist within a view.

Specified by:

getViewQualifiedName in interface IDatabase

Specified by:

getViewQualifiedName in interface ISQL

equals

public boolean equals(Object o)

Overrides:

equals in class Asset

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class Asset

hashCode

public int hashCode()

Overrides:

hashCode in class Asset

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class Asset

getTypeName

public String getTypeName()

Fixed typeName for Databases.

Specified by:

getTypeName in interface AuditDetail

Specified by:

getTypeName in interface IAsset

Specified by:

getTypeName in interface ICatalog

Specified by:

getTypeName in interface IDatabase

Specified by:

getTypeName in interface IReferenceable

Specified by:

getTypeName in interface ISQL

Overrides:

getTypeName in class Reference