Package com.datastax.astra.client.tables.mapping

Annotation Interface ColumnVector

@Target(FIELD) @Retention(RUNTIME) public @interface ColumnVector
Annotation to define properties for a database column. This annotation can be used on fields to specify custom column names, types, and additional properties.

The Column annotation provides flexibility for mapping fields to database columns, with options to customize column name, type, and other attributes.

  • Element Details

    • name

      String name
      Specifies the name of the column. If not provided, the field's name will be used.
      Returns:
      the custom column name or an empty string if not set
      Default:
      ""

    • dimension

      int dimension
      Specifies the dimension of the column, usually relevant for multidimensional data. Defaults to -1, indicating unspecified dimensions.
      Returns:
      the dimension value or -1 if not set
      Default:
      -1

    • metric

      SimilarityMetric metric
      Specifies the similarity metric for the column. Defaults to SimilarityMetric.COSINE.
      Returns:
      the similarity metric
      Default:
      COSINE

    • sourceModel

      String sourceModel
      Specifies source model for the column. Defaults to "other".
      Returns:
      the source model value or "other" if not set
      Default:
      "other"

    • provider

      String provider
      Specifies the provider for the column. Defaults to an empty string.
      Returns:
      the provider value or an empty string if not set
      Default:
      ""

    • modelName

      String modelName
      Specifies the model name for the column. Defaults to an empty string.
      Returns:
      the model name value or an empty string if not set
      Default:
      ""

    • authentication

      KeyValue[] authentication
      List some authentication information for the column. Defaults to an empty array.
      Returns:
      the index value or -1 if not set
      Default:
      {}

    • parameters

      KeyValue[] parameters
      Specifies the parameters for authentication
      Returns:
      a key value array
      Default:
      {}