com.couchbase.client.java.query.dsl.path

Interface HintPath

All Superinterfaces:

GroupByPath, KeysPath, LetPath, LimitPath, OffsetPath, OrderByPath, Path, SelectResultPath, Statement, WherePath

All Known Subinterfaces:

AsPath

All Known Implementing Classes:

DefaultAsPath, DefaultHintPath

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public interface HintPath
extends KeysPath

Hint clause (especially for specifying indexes to use) after a from clause.

Since:

2.2

Author:

Simon Baslé

Method Summary

Modifier and Type	Method and Description
KeysPath	useIndex(IndexReference... indexes) Hint at what index(es) to use for this query.
KeysPath	useIndex(String... indexes) Hint at what index(es) to use for this query by giving names (will look for default index type).

Methods inherited from interface com.couchbase.client.java.query.dsl.path.KeysPath

on, onKeys, onKeys, onKeys, onKeysValues, useKeys, useKeys, useKeys, useKeysValues

Methods inherited from interface com.couchbase.client.java.query.dsl.path.LetPath

innerJoin, innerJoin, innerNest, innerNest, innerUnnest, innerUnnest, join, join, leftJoin, leftJoin, leftNest, leftNest, leftOuterJoin, leftOuterJoin, leftOuterNest, leftOuterNest, leftOuterUnnest, leftOuterUnnest, leftUnnest, leftUnnest, let, nest, nest, unnest, unnest

Methods inherited from interface com.couchbase.client.java.query.dsl.path.WherePath

where, where

Methods inherited from interface com.couchbase.client.java.query.dsl.path.GroupByPath

groupBy, groupBy

Methods inherited from interface com.couchbase.client.java.query.dsl.path.SelectResultPath

except, except, exceptAll, exceptAll, intersect, intersect, intersectAll, intersectAll, union, union, unionAll, unionAll

Methods inherited from interface com.couchbase.client.java.query.dsl.path.OrderByPath

orderBy

Methods inherited from interface com.couchbase.client.java.query.dsl.path.LimitPath

limit

Methods inherited from interface com.couchbase.client.java.query.dsl.path.OffsetPath

offset

Method Detail

useIndex

KeysPath useIndex(IndexReference... indexes)

Hint at what index(es) to use for this query. Use IndexReference's factory methods.

useIndex

KeysPath useIndex(String... indexes)

Hint at what index(es) to use for this query by giving names (will look for default index type). The index names will be escaped.