Package com.atlan.model.assets

Class Schema

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.Schema
All Implemented Interfaces:
IAsset, ICatalog, IReferenceable, ISchema, ISQL, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class Schema extends Asset implements ISchema, ISQL, ICatalog, IAsset, IReferenceable
Instance of a database schema in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

      public Schema trimToReference() throws InvalidRequestException
      Builds the minimal object necessary to create a relationship to a Schema, from a potentially more-complete Schema object.
      Overrides:
      trimToReference in class Asset
      Returns:
      the minimal object necessary to relate to the Schema
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for a Schema relationship are not found in the initial object

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all Schema 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) Schema assets will be included.
      Returns:
      a fluent search that includes all Schema assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all Schema 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) Schema assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all Schema assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all Schema 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:
      includeArchived - when true, archived (soft-deleted) Schemas will be included
      Returns:
      a fluent search that includes all Schema assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all Schema 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) Schemas will be included
      Returns:
      a fluent search that includes all Schema assets

    • refByGuid

      public static Schema refByGuid(String guid)
      Reference to a Schema by GUID. Use this to create a relationship to this Schema, where the relationship should be replaced.
      Parameters:
      guid - the GUID of the Schema to reference
      Returns:
      reference to a Schema that can be used for defining a relationship to a Schema

    • refByGuid

      public static Schema refByGuid(String guid, Reference.SaveSemantic semantic)
      Reference to a Schema by GUID. Use this to create a relationship to this Schema, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      guid - the GUID of the Schema to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a Schema that can be used for defining a relationship to a Schema

    • refByQualifiedName

      public static Schema refByQualifiedName(String qualifiedName)
      Reference to a Schema by qualifiedName. Use this to create a relationship to this Schema, where the relationship should be replaced.
      Parameters:
      qualifiedName - the qualifiedName of the Schema to reference
      Returns:
      reference to a Schema that can be used for defining a relationship to a Schema

    • refByQualifiedName

      public static Schema refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
      Reference to a Schema by qualifiedName. Use this to create a relationship to this Schema, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      qualifiedName - the qualifiedName of the Schema to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a Schema that can be used for defining a relationship to a Schema

    • get

      public static Schema get(String id) throws AtlanException
      Retrieves a Schema by one of its identifiers, complete with all of its relationships.
      Parameters:
      id - of the Schema to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full Schema, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the Schema does not exist or the provided GUID is not a Schema

    • get

      public static Schema get(AtlanClient client, String id) throws AtlanException
      Retrieves a Schema 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 Schema to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full Schema, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the Schema does not exist or the provided GUID is not a Schema

    • get

      public static Schema get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
      Retrieves a Schema 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 Schema to retrieve, either its GUID or its full qualifiedName
      includeRelationships - if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full Schema, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the Schema does not exist or the provided GUID is not a Schema

    • restore

      public static boolean restore(String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) Schema to active.
      Parameters:
      qualifiedName - for the Schema
      Returns:
      true if the Schema is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • restore

      public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) Schema to active.
      Parameters:
      client - connectivity to the Atlan tenant on which to restore the asset
      qualifiedName - for the Schema
      Returns:
      true if the Schema is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • creator

      public static Schema.SchemaBuilder<?,?> creator(String name, Database database) throws InvalidRequestException
      Builds the minimal object necessary to create a schema.
      Parameters:
      name - of the schema
      database - in which the schema should be created, which must have at least a qualifiedName
      Returns:
      the minimal request necessary to create the schema, as a builder
      Throws:
      InvalidRequestException - if the database provided is without a qualifiedName

    • creator

      public static Schema.SchemaBuilder<?,?> creator(String name, String databaseQualifiedName)
      Builds the minimal object necessary to create a schema.
      Parameters:
      name - of the schema
      databaseQualifiedName - unique name of the database in which this schema exists
      Returns:
      the minimal request necessary to create the schema, as a builder

    • creator

      public static Schema.SchemaBuilder<?,?> creator(String name, String connectionQualifiedName, String databaseName, String databaseQualifiedName)
      Builds the minimal object necessary to create a schema.
      Parameters:
      name - of the schema
      connectionQualifiedName - unique name of the connection in which to create the Schema
      databaseName - simple name of the database in which to create the Schema
      databaseQualifiedName - unique name of the database in which to create the Schema
      Returns:
      the minimal request necessary to create the schema, as a builder

    • generateQualifiedName

      public static String generateQualifiedName(String name, String databaseQualifiedName)
      Generate a unique schema name.
      Parameters:
      name - of the schema
      databaseQualifiedName - unique name of the database in which this schema exists
      Returns:
      a unique name for the schema

    • updater

      public static Schema.SchemaBuilder<?,?> updater(String qualifiedName, String name)
      Builds the minimal object necessary to update a Schema.
      Parameters:
      qualifiedName - of the Schema
      name - of the Schema
      Returns:
      the minimal request necessary to update the Schema, as a builder

    • trimToRequired

      public Schema.SchemaBuilder<?,?> trimToRequired() throws InvalidRequestException
      Builds the minimal object necessary to apply an update to a Schema, from a potentially more-complete Schema object.
      Overrides:
      trimToRequired in class Asset
      Returns:
      the minimal object necessary to update the Schema, as a builder
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for Schema are not found in the initial object

    • removeDescription

      public static Schema removeDescription(String qualifiedName, String name) throws AtlanException
      Remove the system description from a Schema.
      Parameters:
      qualifiedName - of the Schema
      name - of the Schema
      Returns:
      the updated Schema, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeDescription

      public static Schema removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the system description from a Schema.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the Schema
      name - of the Schema
      Returns:
      the updated Schema, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static Schema removeUserDescription(String qualifiedName, String name) throws AtlanException
      Remove the user's description from a Schema.
      Parameters:
      qualifiedName - of the Schema
      name - of the Schema
      Returns:
      the updated Schema, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static Schema removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the user's description from a Schema.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the Schema
      name - of the Schema
      Returns:
      the updated Schema, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static Schema removeOwners(String qualifiedName, String name) throws AtlanException
      Remove the owners from a Schema.
      Parameters:
      qualifiedName - of the Schema
      name - of the Schema
      Returns:
      the updated Schema, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static Schema removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the owners from a Schema.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the Schema's owners
      qualifiedName - of the Schema
      name - of the Schema
      Returns:
      the updated Schema, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static Schema updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a Schema.
      Parameters:
      qualifiedName - of the Schema
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated Schema, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static Schema updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a Schema.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the Schema's certificate
      qualifiedName - of the Schema
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated Schema, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static Schema removeCertificate(String qualifiedName, String name) throws AtlanException
      Remove the certificate from a Schema.
      Parameters:
      qualifiedName - of the Schema
      name - of the Schema
      Returns:
      the updated Schema, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static Schema removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the certificate from a Schema.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the Schema's certificate
      qualifiedName - of the Schema
      name - of the Schema
      Returns:
      the updated Schema, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static Schema updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a Schema.
      Parameters:
      qualifiedName - of the Schema
      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

    • updateAnnouncement

      public static Schema updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a Schema.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the Schema's announcement
      qualifiedName - of the Schema
      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 Schema removeAnnouncement(String qualifiedName, String name) throws AtlanException
      Remove the announcement from a Schema.
      Parameters:
      qualifiedName - of the Schema
      name - of the Schema
      Returns:
      the updated Schema, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static Schema removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the announcement from a Schema.
      Parameters:
      client - connectivity to the Atlan client from which to remove the Schema's announcement
      qualifiedName - of the Schema
      name - of the Schema
      Returns:
      the updated Schema, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • replaceTerms

      public static Schema replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the Schema.
      Parameters:
      qualifiedName - for the Schema
      name - human-readable name of the Schema
      terms - the list of terms to replace on the Schema, or null to remove all terms from the Schema
      Returns:
      the Schema that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • replaceTerms

      public static Schema replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the Schema.
      Parameters:
      client - connectivity to the Atlan tenant on which to replace the Schema's assigned terms
      qualifiedName - for the Schema
      name - human-readable name of the Schema
      terms - the list of terms to replace on the Schema, or null to remove all terms from the Schema
      Returns:
      the Schema that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static Schema appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the Schema, without replacing existing terms linked to the Schema. Note: this operation must make two API calls — one to retrieve the Schema's existing terms, and a second to append the new terms.
      Parameters:
      qualifiedName - for the Schema
      terms - the list of terms to append to the Schema
      Returns:
      the Schema that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static Schema appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the Schema, without replacing existing terms linked to the Schema. Note: this operation must make two API calls — one to retrieve the Schema'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 Schema
      qualifiedName - for the Schema
      terms - the list of terms to append to the Schema
      Returns:
      the Schema that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static Schema removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a Schema, without replacing all existing terms linked to the Schema. Note: this operation must make two API calls — one to retrieve the Schema's existing terms, and a second to remove the provided terms.
      Parameters:
      qualifiedName - for the Schema
      terms - the list of terms to remove from the Schema, which must be referenced by GUID
      Returns:
      the Schema that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static Schema removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a Schema, without replacing all existing terms linked to the Schema. Note: this operation must make two API calls — one to retrieve the Schema'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 Schema
      qualifiedName - for the Schema
      terms - the list of terms to remove from the Schema, which must be referenced by GUID
      Returns:
      the Schema that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static Schema appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a Schema, without replacing existing Atlan tags linked to the Schema. Note: this operation must make two API calls — one to retrieve the Schema's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the Schema
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated Schema
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static Schema appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a Schema, without replacing existing Atlan tags linked to the Schema. Note: this operation must make two API calls — one to retrieve the Schema'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 Schema
      qualifiedName - of the Schema
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated Schema
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static Schema appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a Schema, without replacing existing Atlan tags linked to the Schema. Note: this operation must make two API calls — one to retrieve the Schema's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the Schema
      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 Schema
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static Schema appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a Schema, without replacing existing Atlan tags linked to the Schema. Note: this operation must make two API calls — one to retrieve the Schema'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 Schema
      qualifiedName - of the Schema
      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 Schema
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a Schema.
      Parameters:
      qualifiedName - of the Schema
      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 Schema

    • removeAtlanTag

      public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a Schema.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a Schema
      qualifiedName - of the Schema
      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 Schema

    • _internal

      public static Schema.SchemaBuilder<?,?> _internal()

    • toBuilder

      public Schema.SchemaBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getApplicationContainer

      public IApplicationContainer getApplicationContainer()
      ApplicationContainer asset containing this Catalog asset.
      Specified by:
      getApplicationContainer in interface ICatalog
      Specified by:
      getApplicationContainer in interface ISchema
      Specified by:
      getApplicationContainer in interface ISQL

    • getAssetApplicationQualifiedName

      public String getAssetApplicationQualifiedName()
      Qualified name of the Application Container that contains this asset.
      Specified by:
      getAssetApplicationQualifiedName in interface ICatalog
      Specified by:
      getAssetApplicationQualifiedName in interface ISchema
      Specified by:
      getAssetApplicationQualifiedName in interface ISQL

    • 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 ISchema
      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 ISchema
      Specified by:
      getCalculationViewQualifiedName in interface ISQL

    • getCalculationViews

      public SortedSet<ICalculationView> getCalculationViews()
      TBC
      Specified by:
      getCalculationViews in interface ISchema

    • getDatabase

      public IDatabase getDatabase()
      Database in which this schema exists.
      Specified by:
      getDatabase in interface ISchema

    • 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 ISchema
      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 ISchema
      Specified by:
      getDatabaseQualifiedName in interface ISQL

    • getDbtModels

      public SortedSet<IDbtModel> getDbtModels()
      TBC
      Specified by:
      getDbtModels in interface ISchema
      Specified by:
      getDbtModels in interface ISQL

    • getDbtSources

      public SortedSet<IDbtSource> getDbtSources()
      TBC
      Specified by:
      getDbtSources in interface ISchema
      Specified by:
      getDbtSources in interface ISQL

    • getDbtTests

      public SortedSet<IDbtTest> getDbtTests()
      TBC
      Specified by:
      getDbtTests in interface ISchema
      Specified by:
      getDbtTests in interface ISQL

    • getFunctions

      public SortedSet<IFunction> getFunctions()
      Functions that exist within this schema.
      Specified by:
      getFunctions in interface ISchema

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface ISchema
      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 ISchema
      Specified by:
      getInputToProcesses in interface ISQL

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ISchema
      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 ISchema
      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 ISchema
      Specified by:
      getLastProfiledAt in interface ISQL

    • getLinkedSchemaQualifiedName

      public String getLinkedSchemaQualifiedName()
      Unique name of the Linked Schema on which this Schema is dependent. This concept is mostly applicable for linked datasets/datasource in Google BigQuery via Analytics Hub Listing
      Specified by:
      getLinkedSchemaQualifiedName in interface ISchema

    • getMaterializedViews

      public SortedSet<IMaterializedView> getMaterializedViews()
      Materialized views that exist within this schema.
      Specified by:
      getMaterializedViews in interface ISchema

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface ISchema
      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 ISchema
      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 ISchema
      Specified by:
      getOutputFromProcesses in interface ISQL

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ISchema
      Specified by:
      getOutputFromSparkJobs in interface ISQL

    • getProcedures

      public SortedSet<IProcedure> getProcedures()
      Stored procedures that exist within this schema.
      Specified by:
      getProcedures in interface ISchema

    • getQueryCount

      public Long getQueryCount()
      Number of times this asset has been queried.
      Specified by:
      getQueryCount in interface ISchema
      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 ISchema
      Specified by:
      getQueryCountUpdatedAt in interface ISQL

    • getQueryUserCount

      public Long getQueryUserCount()
      Number of unique users who have queried this asset.
      Specified by:
      getQueryUserCount in interface ISchema
      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 ISchema
      Specified by:
      getQueryUserMap in interface ISQL

    • 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 ISchema
      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 ISchema
      Specified by:
      getSchemaQualifiedName in interface ISQL

    • getSnowflakeDynamicTables

      public SortedSet<ISnowflakeDynamicTable> getSnowflakeDynamicTables()
      Snowflake dynamic tables that exist within this schema.
      Specified by:
      getSnowflakeDynamicTables in interface ISchema

    • getSnowflakePipes

      public SortedSet<ISnowflakePipe> getSnowflakePipes()
      Snowflake pipes that exist within this schema.
      Specified by:
      getSnowflakePipes in interface ISchema

    • getSnowflakeStreams

      public SortedSet<ISnowflakeStream> getSnowflakeStreams()
      Snowflake streams that exist within this schema.
      Specified by:
      getSnowflakeStreams in interface ISchema

    • getSnowflakeTags

      public SortedSet<ISnowflakeTag> getSnowflakeTags()
      Snowflake tags that exist within this schema.
      Specified by:
      getSnowflakeTags in interface ISchema

    • getSqlDBTSources

      public SortedSet<IDbtSource> getSqlDBTSources()
      TBC
      Specified by:
      getSqlDBTSources in interface ISchema
      Specified by:
      getSqlDBTSources in interface ISQL

    • getSqlDbtModels

      public SortedSet<IDbtModel> getSqlDbtModels()
      TBC
      Specified by:
      getSqlDbtModels in interface ISchema
      Specified by:
      getSqlDbtModels in interface ISQL

    • getTableCount

      public Integer getTableCount()
      Number of tables in this schema.
      Specified by:
      getTableCount in interface ISchema

    • 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 ISchema
      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 ISchema
      Specified by:
      getTableQualifiedName in interface ISQL

    • getTables

      public SortedSet<ITable> getTables()
      Tables that exist within this schema.
      Specified by:
      getTables in interface ISchema

    • getViewCount

      public Integer getViewCount()
      Number of views in this schema.
      Specified by:
      getViewCount in interface ISchema

    • 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 ISchema
      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 ISchema
      Specified by:
      getViewQualifiedName in interface ISQL

    • getViews

      public SortedSet<IView> getViews()
      Views that exist within this schema.
      Specified by:
      getViews in interface ISchema

    • 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 Schemas.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface ISchema
      Specified by:
      getTypeName in interface ISQL
      Overrides:
      getTypeName in class Reference