Record Class SqlIndexMapping

java.lang.Object
java.lang.Record
io.micronaut.data.model.schema.sql.SqlIndexMapping
Record Components:
name - The index name
unique - Whether the index is unique
columns - The column names in the index
sqlIndexDefinitionProvider - Optional vendor-specific index DDL provider
vectorIndexMetadata - Vector index metadata, if any
spatial - Whether the index is spatial
srid - The spatial reference identifier
@Internal public record SqlIndexMapping(String name, boolean unique, String[] columns, @Nullable SqlIndexDefinitionProvider sqlIndexDefinitionProvider, @Nullable VectorIndexMetadata vectorIndexMetadata, boolean spatial, @Nullable Integer srid) extends Record
The SQL table index mapping.

  • Constructor Details

    • SqlIndexMapping

      public SqlIndexMapping(String name, boolean unique, String[] columns)

    • SqlIndexMapping

      public SqlIndexMapping(String name, boolean unique, String[] columns, boolean spatial)

    • SqlIndexMapping

      public SqlIndexMapping(String name, boolean unique, String[] columns, boolean spatial, @Nullable Integer srid)

    • SqlIndexMapping

      public SqlIndexMapping(String name, boolean unique, String[] columns, @Nullable SqlIndexDefinitionProvider sqlIndexDefinitionProvider, @Nullable VectorIndexMetadata vectorIndexMetadata, boolean spatial)

    • SqlIndexMapping

      public SqlIndexMapping(String name, boolean unique, String[] columns, @Nullable SqlIndexDefinitionProvider sqlIndexDefinitionProvider)

    • SqlIndexMapping

      public SqlIndexMapping(String name, boolean unique, String[] columns, @Nullable SqlIndexDefinitionProvider sqlIndexDefinitionProvider, @Nullable VectorIndexMetadata vectorIndexMetadata, boolean spatial, @Nullable Integer srid)
      Creates an instance of a SqlIndexMapping record class.
      Parameters:
      name - the value for the name record component
      unique - the value for the unique record component
      columns - the value for the columns record component
      sqlIndexDefinitionProvider - the value for the sqlIndexDefinitionProvider record component
      vectorIndexMetadata - the value for the vectorIndexMetadata record component
      spatial - the value for the spatial record component
      srid - the value for the srid record component

  • Method Details

    • equals

      public boolean equals(Object object)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      object - the object with which to compare
      Returns:
      true if this object is the same as the object argument; false otherwise.

    • hashCode

      public int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • unique

      public boolean unique()
      Returns the value of the unique record component.
      Returns:
      the value of the unique record component

    • columns

      public String[] columns()
      Returns the value of the columns record component.
      Returns:
      the value of the columns record component

    • sqlIndexDefinitionProvider

      public @Nullable SqlIndexDefinitionProvider sqlIndexDefinitionProvider()
      Returns the value of the sqlIndexDefinitionProvider record component.
      Returns:
      the value of the sqlIndexDefinitionProvider record component

    • vectorIndexMetadata

      public @Nullable VectorIndexMetadata vectorIndexMetadata()
      Returns the value of the vectorIndexMetadata record component.
      Returns:
      the value of the vectorIndexMetadata record component

    • spatial

      public boolean spatial()
      Returns the value of the spatial record component.
      Returns:
      the value of the spatial record component

    • srid

      public @Nullable Integer srid()
      Returns the value of the srid record component.
      Returns:
      the value of the srid record component