KeysPath (Couchbase Java SDK)

All Superinterfaces:

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

All Known Subinterfaces:

AsPath, HintPath, JoinPath, NestPath

All Known Implementing Classes:

DefaultAsPath, DefaultHintPath, DefaultJoinPath, DefaultKeysPath, DefaultNestPath
```
public interface KeysPath
extends LetPath
```
.

Author:

Michael Nitschinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`LetPath`	`on(Expression expression)`	ANSI join "on" clause.
`LetPath`	`onKeys(JsonArray keys)`	the on-key clause of a join/nest/unnest clause with an array of constant keys (eg.
`LetPath`	`onKeys(Expression expression)`	the on-key clause of a join/nest/unnest clause
`LetPath`	`onKeys(String key)`	the on-key clause of a join/nest/unnest clause with a single token key (eg.
`LetPath`	`onKeysValues(String... constantKeys)`	the on-key clause of a join/nest/unnest clause with 1-n constant keys (eg.
`LetPath`	`useKeys(JsonArray keys)`	use the primary keyspace (doc id) in a join clause)
`LetPath`	`useKeys(Expression expression)`	use the primary keyspace (doc id) in a join clause)
`LetPath`	`useKeys(String key)`	use the primary keyspace (doc id) in a join clause), with a single key given as a token expression (eg.
`LetPath`	`useKeysValues(String... keys)`	use the primary keyspace (doc id) in a join clause, with one or more keys given as constants (eg.

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.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.LimitPath
limit

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

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

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.WherePath
where, where

- Method Detail
  - onKeys
```
LetPath onKeys(Expression expression)
```
    the on-key clause of a join/nest/unnest clause
  - onKeys
```
LetPath onKeys(String key)
```
    the on-key clause of a join/nest/unnest clause with a single token key (eg. ON KEYS s.id).
  - onKeys
```
LetPath onKeys(JsonArray keys)
```
    the on-key clause of a join/nest/unnest clause with an array of constant keys (eg. ON KEYS ["a", "b"]).
  - onKeysValues
```
LetPath onKeysValues(String... constantKeys)
```
    the on-key clause of a join/nest/unnest clause with 1-n constant keys (eg. ON KEYS "a" or ON KEYS ["a", "b"])
  - useKeys
```
LetPath useKeys(Expression expression)
```
    use the primary keyspace (doc id) in a join clause)
  - useKeys
```
LetPath useKeys(String key)
```
    use the primary keyspace (doc id) in a join clause), with a single key given as a token expression (eg. USE KEYS s.id).
  - useKeysValues
```
LetPath useKeysValues(String... keys)
```
    use the primary keyspace (doc id) in a join clause, with one or more keys given as constants (eg. USE KEYS "test" or USE KEYS ["a", "b"])
  - useKeys
```
LetPath useKeys(JsonArray keys)
```
    use the primary keyspace (doc id) in a join clause)
  - on
```
LetPath on(Expression expression)
```
    ANSI join "on" clause.