You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by ti...@apache.org on 2023/12/18 12:24:16 UTC
(ignite) branch master updated: IGNITE-21051 Bulletpoints added for index discovering algorithms in Javadoc in IndexQuery class (#11091)
This is an automated email from the ASF dual-hosted git repository.
timoninmaxim pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push:
new 136e9a31587 IGNITE-21051 Bulletpoints added for index discovering algorithms in Javadoc in IndexQuery class (#11091)
136e9a31587 is described below
commit 136e9a31587b384ae9645fce3999a96c2426f30b
Author: oleg-vlsk <15...@users.noreply.github.com>
AuthorDate: Mon Dec 18 22:24:09 2023 +1000
IGNITE-21051 Bulletpoints added for index discovering algorithms in Javadoc in IndexQuery class (#11091)
---
.../java/org/apache/ignite/cache/query/IndexQuery.java | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/modules/core/src/main/java/org/apache/ignite/cache/query/IndexQuery.java b/modules/core/src/main/java/org/apache/ignite/cache/query/IndexQuery.java
index 8c61ccc1936..69874941c80 100644
--- a/modules/core/src/main/java/org/apache/ignite/cache/query/IndexQuery.java
+++ b/modules/core/src/main/java/org/apache/ignite/cache/query/IndexQuery.java
@@ -30,12 +30,17 @@ import org.jetbrains.annotations.Nullable;
/**
* Index queries work over distributed indexes and retrieve cache entries that match the specified criteria.
+ * <p>
* {@code QueryCursor} delivers sorted cache entries by the order defined for queried index.
- *
- * {@code IndexQuery} has to be initialized with cache value class or type. The algorithm of discovering index is as follows:
- * 1. If {@link #idxName} is set, then use it.
- * 2. If {@link #idxName} is not set, then find an index that matches criteria fields.
- * 3. If neither {@link #idxName}, nor {@link #setCriteria(List)} is used, then perform index scan over PK index for specified Value type.
+ * <p>
+ * {@code IndexQuery} has to be initialized with cache value class or type. The algorithm of discovering index is
+ * as follows:
+ * <ul>
+ * <li>If {@link #idxName} is set, then use it.</li>
+ * <li>If {@link #idxName} is not set, then find an index that matches criteria fields.</li>
+ * <li>If neither {@link #idxName}, nor {@link #setCriteria(List)} is used, then perform index scan over PK index
+ * for specified Value type.</li>
+ * </ul>
*
* Conjuction of items in {@link #criteria} has to represent a valid range to traverse the index tree.
*/