Package org.apache.cassandra.cql3

Interface SchemaElement

All Known Implementing Classes:
JavaBasedUDFunction, KeyspaceMetadata, TableMetadata, TableMetadata.CompactTableMetadata, UDAggregate, UDFunction, UserFunction, UserType, ViewMetadata
public interface SchemaElement
A schema element (keyspace, udt, udf, uda, table, index, view).

  • Field Details

    • NAME_COMPARATOR

      static final Comparator<SchemaElement> NAME_COMPARATOR
      Comparator used to sort Describable name.

  • Method Details

    • elementType

      SchemaElement.SchemaElementType elementType()
      Return the schema element type
      Returns:
      the schema element type

    • elementKeyspace

      String elementKeyspace()
      Returns the CQL name of the keyspace to which this schema element belong.
      Returns:
      the keyspace name.

    • elementName

      String elementName()
      Returns the CQL name of this schema element.
      Returns:
      the name of this schema element.

    • elementNameQuotedIfNeeded

      default String elementNameQuotedIfNeeded()

    • elementKeyspaceQuotedIfNeeded

      default String elementKeyspaceQuotedIfNeeded()

    • toCqlString

      String toCqlString(boolean withInternals, boolean ifNotExists)
      Returns a CQL representation of this element
      Parameters:
      withInternals - if the internals part of the CQL should be exposed.
      ifNotExists - if "IF NOT EXISTS" should be included.
      Returns:
      a CQL representation of this element