Interface TableDescriptor

All Known Implementing Classes:
CollectionTableDescriptor, EntityTableDescriptor
@Incubating public interface TableDescriptor
Details about a table in the domain model, used to creation mutation operations in the graph-based ActionQueue implementation.
Since:
8.0

  • Method Details

    • name

      String name()
      The table's name.

    • isOptional

      boolean isOptional()
      Whether the table is considered optional in relation to its group of tables.
      See Also:
      Implementation Note:
      Effectively means a SecondaryTable mapped as SecondaryRow.optional().

    • keyDescriptor

      TableKeyDescriptor keyDescriptor()
      Details about the key for this table.

    • isSelfReferential

      boolean isSelfReferential()
      Whether this table has foreign-keys which refer back to the same table.
      Implementation Note:
      E.g., an employee table which has a manager_fk key that targets back at employee.`

    • hasUniqueConstraints

      boolean hasUniqueConstraints()

    • cascadeDeleteEnabled

      boolean cascadeDeleteEnabled()
      Whether cascade deletion is defined on the underlying database table.

    • insertDetails

      TableMapping.MutationDetails insertDetails()
      Details about insertions into this table.

    • updateDetails

      TableMapping.MutationDetails updateDetails()
      Details about updates to this table.

    • deleteDetails

      TableMapping.MutationDetails deleteDetails()
      Details about deletions to this table.

    • getRelativePosition

      int getRelativePosition()
      This table's relative position within its "table group".