Enum Class RedisInternalFieldDescription

java.lang.Object
java.lang.Enum<RedisInternalFieldDescription>
io.trino.plugin.redis.RedisInternalFieldDescription
All Implemented Interfaces:
Serializable, Comparable<RedisInternalFieldDescription>, Constable

public enum RedisInternalFieldDescription extends Enum<RedisInternalFieldDescription>
Describes an internal (managed by the connector) field which is added to each table row. The definition itself makes the row show up in the tables (the columns are hidden by default, so they must be explicitly selected) but unless the field is hooked in using the forBooleanValue/forLongValue/forBytesValue methods and the resulting FieldValueProvider is then passed into the appropriate row decoder, the fields will be null. Most values are assigned in the RedisRecordSet.
  • Enum Constant Details

    • KEY_FIELD

      public static final RedisInternalFieldDescription KEY_FIELD
      _key - Represents the key as a text column.
    • VALUE_FIELD

      public static final RedisInternalFieldDescription VALUE_FIELD
      _value - Represents the value as a text column. Format is UTF-8
    • VALUE_CORRUPT_FIELD

      public static final RedisInternalFieldDescription VALUE_CORRUPT_FIELD
      _value_corrupt - True if the row converter could not read the value. May be null if the row converter does not set a value (e.g. the dummy row converter does not).
    • VALUE_LENGTH_FIELD

      public static final RedisInternalFieldDescription VALUE_LENGTH_FIELD
      _value_length - length in bytes of the value.
    • KEY_CORRUPT_FIELD

      public static final RedisInternalFieldDescription KEY_CORRUPT_FIELD
      _key_corrupt - True if the row converter could not read the key. May be null if the row converter does not set a value (e.g. the dummy row converter does not).
    • KEY_LENGTH_FIELD

      public static final RedisInternalFieldDescription KEY_LENGTH_FIELD
      _key_length - length in bytes of the key.
  • Method Details

    • values

      public static RedisInternalFieldDescription[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static RedisInternalFieldDescription valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • forColumnName

      public static RedisInternalFieldDescription forColumnName(String columnName)
    • getColumnName

      public String getColumnName()
    • getType

      public Type getType()