Class QueryIndex


  • public class QueryIndex
    extends Object
    Describes a N1QL index.
    • Constructor Detail

      • QueryIndex

        public QueryIndex​(JsonObject raw)
    • Method Detail

      • primary

        public boolean primary()
      • state

        public String state()
      • keyspace

        public String keyspace()
        Returns:
        the keyspace for the index, typically the bucket name.
      • namespace

        public String namespace()
        Returns:
        the namespace for the index. A namespace is a resource pool that contains multiple keyspaces.
        See Also:
        keyspace()
      • indexKey

        public JsonArray indexKey()
        Return an array of Strings that represent the index key(s). The array is empty in the case of a PRIMARY INDEX. Note that the query service can present the key in a slightly different manner from when you declared the index: for instance, it will show the indexed fields in an escaped format (surrounded by backticks).
        Returns:
        an array of Strings that represent the index key(s), or an empty array in the case of a PRIMARY index.
      • condition

        public Optional<String> condition()
        Return the String representation of the index's condition (the WHERE clause of the index), or an empty Optional if no condition was set.

        Note that the query service can present the condition in a slightly different manner from when you declared the index: for instance it will wrap expressions with parentheses and show the fields in an escaped format (surrounded by backticks).

        Returns:
        the condition/WHERE clause of the index or empty string if none.
      • raw

        public JsonObject raw()
        Returns:
        the raw JSON representation of the index information, as returned by the query service.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object