ygerzhedovich commented on code in PR #2882: URL: https://github.com/apache/ignite-3/pull/2882#discussion_r1427868516
########## modules/api/src/main/java/org/apache/ignite/sql/async/AsyncClosableCursor.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.sql.async; + +import java.util.concurrent.CompletableFuture; +import org.apache.ignite.sql.ClosableCursor; +import org.apache.ignite.sql.NoRowSetExpectedException; +import org.apache.ignite.table.KeyValueView; +import org.apache.ignite.table.RecordView; +import org.apache.ignite.table.criteria.Criteria; +import org.apache.ignite.table.criteria.CriteriaQueryOptions; +import org.apache.ignite.tx.Transaction; + +/** + * Provides methods for iterate over query results in an asynchronous way. + * + * @param <T> The type of elements returned by this iterator. + * + * @see ClosableCursor + * @see KeyValueView#queryCriteriaAsync(Transaction, Criteria, CriteriaQueryOptions) + * @see RecordView#queryCriteriaAsync(Transaction, Criteria, CriteriaQueryOptions) + */ +public interface AsyncClosableCursor<T> { + /** + * Returns the current page content if the query returns rows. + * + * @return Iterable set of rows. + * @throws NoRowSetExpectedException if no row set is returned. + */ + Iterable<T> currentPage(); + + /** + * Returns the current page size if the query return rows. + * + * @return The size of {@link #currentPage()}. + * @throws NoRowSetExpectedException if no row set is returned. + */ + int currentPageSize(); + + /** + * Fetches the next page of results asynchronously. + * The current page is changed after the future completion. + * The methods {@link #currentPage()}, {@link #currentPageSize()}, {@link #hasMorePages()} + * use the current page and return consistent results between complete last page future and call {@code fetchNextPage}. + * + * @return A future which will be completed when next page will be fetched and set as the current page. + * The future will return {@code this} for chaining. Review Comment: it's not true, about returnin `this` -- 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]
