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

Interface OnPath

All Superinterfaces:

Path

All Known Implementing Classes:

DefaultOnPath

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public interface OnPath
extends Path

On path in the Index creation DSL.

Since:

2.2

Author:

Simon Baslé

Method Summary

Modifier and Type	Method and Description
WherePath	on(String keyspace, Expression expression, Expression... additionalExpressions) Describes the target of a secondary N1QL index.
WherePath	on(String namespace, String keyspace, Expression expression, Expression... additionalExpressions) Describes the target of a secondary N1QL index.

Method Detail

on

WherePath on(String keyspace,
             Expression expression,
             Expression... additionalExpressions)

Describes the target of a secondary N1QL index.

Parameters:

keyspace - the keyspace (bucket name, it will be automatically escaped).

expression - the base expression to be indexed (mandatory).

additionalExpressions - additional expressions to be indexed (optional).

on

WherePath on(String namespace,
             String keyspace,
             Expression expression,
             Expression... additionalExpressions)

Describes the target of a secondary N1QL index.

Parameters:

namespace - optional prefix for the keyspace (it will be automatically escaped).

keyspace - the keyspace (bucket name, it will be automatically escaped).

expression - the base expression to be indexed (mandatory).

additionalExpressions - additional expressions to be indexed (optional).