com.couchbase.client.core.api.query.CoreQueryOps Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-io Show documentation
Show all versions of core-io Show documentation
The official Couchbase JVM Core IO Library
/*
* Copyright (c) 2023 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.core.api.query;
import com.couchbase.client.core.annotation.Stability;
import com.couchbase.client.core.api.kv.CoreAsyncResponse;
import com.couchbase.client.core.node.NodeIdentifier;
import reactor.core.publisher.Mono;
import reactor.util.annotation.Nullable;
import java.util.function.Function;
@Stability.Internal
public interface CoreQueryOps {
/**
* Performs a query. This can handle single-query transactions.
*
* @param statement the statement to execute
* @param options query options
* @param queryContext non-null iff this query is on a Scope
* @param target this is required for some use-cases (transactions, notably, where all queries in a transaction attempt must be sent to the same node). The way targets are
* identified is currently very bound to Classic, and will need to be abstracted if we need to support the same functionality for Protostellar ultimately. However, the nature of Protostellar makes
* that unlikely.
* @param errorConverter required for converting Core errors into their final SDK forms. (It could be handled externally in most cases, but this DRYs the logic, and there is
* at least one transactions use-case that requires doing this conversion on the rows as they stream back.
*/
default CoreQueryResult queryBlocking(String statement,
CoreQueryOptions options,
@Nullable CoreQueryContext queryContext,
@Nullable NodeIdentifier target,
@Nullable Function errorConverter) {
return queryAsync(statement, options, queryContext, target, errorConverter).toBlocking();
}
CoreAsyncResponse queryAsync(String statement,
CoreQueryOptions options,
@Nullable CoreQueryContext queryContext,
@Nullable NodeIdentifier target,
@Nullable Function errorConverter);
Mono queryReactive(String statement,
CoreQueryOptions options,
@Nullable CoreQueryContext queryContext,
@Nullable NodeIdentifier target,
@Nullable Function errorConverter);
}