com.couchbase.client.java.query.dsl.path.index.OnPath Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016 Couchbase, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.couchbase.client.java.query.dsl.path.index;

import com.couchbase.client.core.annotations.InterfaceAudience;
import com.couchbase.client.core.annotations.InterfaceStability;
import com.couchbase.client.java.query.dsl.Expression;
import com.couchbase.client.java.query.dsl.path.Path;

/**
 * On path in the Index creation DSL.
 *
 * @author Simon Baslé
 * @since 2.2
 */
@InterfaceStability.Experimental
@InterfaceAudience.Public
public interface OnPath extends Path {

    /**
     * Describes the target of a secondary N1QL index.
     *
     * @param keyspace the keyspace (bucket name, it will be automatically escaped).
     * @param expression the base expression to be indexed (mandatory).
     * @param additionalExpressions additional expressions to be indexed (optional).
     */
    WherePath on(String keyspace, Expression expression, Expression... additionalExpressions);

    /**
     * Describes the target of a secondary N1QL index.
     *
     * @param namespace optional prefix for the keyspace (it will be automatically escaped).
     * @param keyspace the keyspace (bucket name, it will be automatically escaped).
     * @param expression the base expression to be indexed (mandatory).
     * @param additionalExpressions additional expressions to be indexed (optional).
     */
    WherePath on(String namespace, String keyspace, Expression expression, Expression... additionalExpressions);



}