Package com.atlan.model.assets

Class Table

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • creator

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

    • creator

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

    • creator

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

    • updater

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

    • generateQualifiedName

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static Table.TableBuilder<?,?> _internal()

    • toBuilder

      public Table.TableBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getAlias

      public String getAlias()
      Alias for this table.
      Specified by:
      getAlias in interface ITable

    • getApplicationContainer

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

    • 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 ISQL
      Specified by:
      getAssetApplicationQualifiedName in interface ITable

    • 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 ISQL
      Specified by:
      getCalculationViewName in interface ITable

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

    • getColumnCount

      public Long getColumnCount()
      Number of columns in this table.
      Specified by:
      getColumnCount in interface ITable

    • getColumns

      public SortedSet<IColumn> getColumns()
      Columns that exist within this table.
      Specified by:
      getColumns in interface ITable

    • 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 ISQL
      Specified by:
      getDatabaseName in interface ITable

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

    • getDbtModels

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

    • getDbtSources

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

    • getDbtTests

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

    • getDimensions

      public SortedSet<ITable> getDimensions()
      TBC
      Specified by:
      getDimensions in interface ITable

    • getExternalLocation

      public String getExternalLocation()
      External location of this table, for example: an S3 object location.
      Specified by:
      getExternalLocation in interface ITable

    • getExternalLocationFormat

      public String getExternalLocationFormat()
      Format of the external location of this table, for example: JSON, CSV, PARQUET, etc.
      Specified by:
      getExternalLocationFormat in interface ITable

    • getExternalLocationRegion

      public String getExternalLocationRegion()
      Region of the external location of this table, for example: S3 region.
      Specified by:
      getExternalLocationRegion in interface ITable

    • getFacts

      public SortedSet<ITable> getFacts()
      TBC
      Specified by:
      getFacts in interface ITable

    • getIcebergCatalogName

      public String getIcebergCatalogName()
      iceberg table catalog name (can be any user defined name)
      Specified by:
      getIcebergCatalogName in interface ITable

    • getIcebergCatalogSource

      public String getIcebergCatalogSource()
      iceberg table catalog type (glue, polaris, snowflake)
      Specified by:
      getIcebergCatalogSource in interface ITable

    • getIcebergCatalogTableName

      public String getIcebergCatalogTableName()
      catalog table name (actual table name on the catalog side).
      Specified by:
      getIcebergCatalogTableName in interface ITable

    • getIcebergCatalogTableNamespace

      public String getIcebergCatalogTableNamespace()
      catalog table namespace (actual database name on the catalog side).
      Specified by:
      getIcebergCatalogTableNamespace in interface ITable

    • getIcebergTableBaseLocation

      public String getIcebergTableBaseLocation()
      iceberg table base location inside the external volume.
      Specified by:
      getIcebergTableBaseLocation in interface ITable

    • getIcebergTableType

      public String getIcebergTableType()
      iceberg table type (managed vs unmanaged)
      Specified by:
      getIcebergTableType in interface ITable

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface ISQL
      Specified by:
      getInputToAirflowTasks in interface ITable

    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface ISQL
      Specified by:
      getInputToProcesses in interface ITable

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ISQL
      Specified by:
      getInputToSparkJobs in interface ITable

    • getIsPartitioned

      public Boolean getIsPartitioned()
      Whether this table is partitioned (true) or not (false).
      Specified by:
      getIsPartitioned in interface ITable

    • getIsProfiled

      public Boolean getIsProfiled()
      Whether this asset has been profiled (true) or not (false).
      Specified by:
      getIsProfiled in interface ISQL
      Specified by:
      getIsProfiled in interface ITable

    • getIsQueryPreview

      public Boolean getIsQueryPreview()
      Whether preview queries are allowed for this table (true) or not (false).
      Specified by:
      getIsQueryPreview in interface ITable

    • getIsSharded

      public Boolean getIsSharded()
      Whether this table is a sharded table (true) or not (false).
      Specified by:
      getIsSharded in interface ITable

    • getIsTemporary

      public Boolean getIsTemporary()
      Whether this table is temporary (true) or not (false).
      Specified by:
      getIsTemporary in interface ITable

    • getLastProfiledAt

      public Long getLastProfiledAt()
      Time (epoch) at which this asset was last profiled, in milliseconds.
      Specified by:
      getLastProfiledAt in interface ISQL
      Specified by:
      getLastProfiledAt in interface ITable

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface ISQL
      Specified by:
      getModelImplementedEntities in interface ITable

    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface ISQL
      Specified by:
      getOutputFromAirflowTasks in interface ITable

    • 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 ISQL
      Specified by:
      getOutputFromProcesses in interface ITable

    • getOutputFromSparkJobs

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

    • getPartitionCount

      public Long getPartitionCount()
      Number of partitions in this table.
      Specified by:
      getPartitionCount in interface ITable

    • getPartitionList

      public String getPartitionList()
      List of partitions in this table.
      Specified by:
      getPartitionList in interface ITable

    • getPartitionStrategy

      public String getPartitionStrategy()
      Partition strategy for this table.
      Specified by:
      getPartitionStrategy in interface ITable

    • getPartitions

      public SortedSet<ITablePartition> getPartitions()
      Partitions that exist within this table.
      Specified by:
      getPartitions in interface ITable

    • getQueries

      public SortedSet<IAtlanQuery> getQueries()
      Queries that access this table.
      Specified by:
      getQueries in interface ITable

    • getQueryCount

      public Long getQueryCount()
      Number of times this asset has been queried.
      Specified by:
      getQueryCount in interface ISQL
      Specified by:
      getQueryCount in interface ITable

    • getQueryCountUpdatedAt

      public Long getQueryCountUpdatedAt()
      Time (epoch) at which the query count was last updated, in milliseconds.
      Specified by:
      getQueryCountUpdatedAt in interface ISQL
      Specified by:
      getQueryCountUpdatedAt in interface ITable

    • getQueryPreviewConfig

      public Map<String,String> getQueryPreviewConfig()
      Configuration for preview queries.
      Specified by:
      getQueryPreviewConfig in interface ITable

    • getQueryUserCount

      public Long getQueryUserCount()
      Number of unique users who have queried this asset.
      Specified by:
      getQueryUserCount in interface ISQL
      Specified by:
      getQueryUserCount in interface ITable

    • 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 ISQL
      Specified by:
      getQueryUserMap in interface ITable

    • getRowCount

      public Long getRowCount()
      Number of rows in this table.
      Specified by:
      getRowCount in interface ITable

    • getSchema

      public ISchema getSchema()
      Schema in which this table exists.
      Specified by:
      getSchema in interface ITable

    • 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 ISQL
      Specified by:
      getSchemaName in interface ITable

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

    • getSizeBytes

      public Long getSizeBytes()
      Size of this table, in bytes.
      Specified by:
      getSizeBytes in interface ITable

    • getSqlDBTSources

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

    • getSqlDbtModels

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

    • getTableExternalVolumeName

      public String getTableExternalVolumeName()
      external volume name for the table.
      Specified by:
      getTableExternalVolumeName in interface ITable

    • 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 ISQL
      Specified by:
      getTableName in interface ITable

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

    • getTableRetentionTime

      public Long getTableRetentionTime()
      Data retention time in days.
      Specified by:
      getTableRetentionTime in interface ITable

    • getTableType

      public TableType getTableType()
      Type of the table.
      Specified by:
      getTableType in interface ITable

    • 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 ISQL
      Specified by:
      getViewName in interface ITable

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

    • 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 Tables.
      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 ISQL
      Specified by:
      getTypeName in interface ITable
      Overrides:
      getTypeName in class Reference