ygerzhedovich commented on code in PR #2882: URL: https://github.com/apache/ignite-3/pull/2882#discussion_r1427880783
########## modules/api/src/main/java/org/apache/ignite/table/criteria/CriteriaQuerySource.java: ########## @@ -0,0 +1,80 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.ignite.table.criteria; + +import java.util.concurrent.CompletableFuture; +import org.apache.ignite.sql.ClosableCursor; +import org.apache.ignite.sql.SqlException; +import org.apache.ignite.sql.async.AsyncClosableCursor; +import org.apache.ignite.tx.Transaction; +import org.jetbrains.annotations.Nullable; + +/** + * Represents an object which can be queried with criteria. + * + * @param <T> Entry type. + */ +public interface CriteriaQuerySource<T> { + /** + * Criteria query over cache entries. + * + * @param tx Transaction to execute the query within or {@code null}. + * @param criteria If {@code null} then all entries will be returned. + * @throws SqlException If failed. + */ + default ClosableCursor<T> queryCriteria(@Nullable Transaction tx, @Nullable Criteria criteria) { + return queryCriteria(tx, criteria, CriteriaQueryOptions.DEFAULT); + } + + /** + * Criteria query over cache entries. + * + * @param tx Transaction to execute the query within or {@code null}. + * @param criteria If {@code null} then all entries will be returned. + * @param opts Criteria query options. + * @throws SqlException If failed. + */ + ClosableCursor<T> queryCriteria(@Nullable Transaction tx, @Nullable Criteria criteria, CriteriaQueryOptions opts); + + /** + * Execute criteria query over cache entries in an asynchronous way. + * + * @param tx Transaction to execute the query within or {@code null}. + * @param criteria If {@code null} then all entries will be returned. + * @return Operation future. + * @throws SqlException If failed. + */ + default CompletableFuture<? extends AsyncClosableCursor<T>> queryCriteriaAsync(@Nullable Transaction tx, @Nullable Criteria criteria) { + return queryCriteriaAsync(tx, criteria, CriteriaQueryOptions.DEFAULT); + } + + /** + * Execute criteria query over cache entries in an asynchronous way. + * + * @param tx Transaction to execute the query within or {@code null}. Review Comment: what does mean null for transaction? I suggest to review carefully all part related to API module - it's a face of our product -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
