[
https://issues.apache.org/jira/browse/IGNITE-10512?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Andrew Mashenkov updated IGNITE-10512:
--------------------------------------
Description:
CacheQuery javadoc looks outdated and useless to used as it is resides in
internal package and we omit javadocs building for 'internal' package.
Let's update javadoc for SqlQuery, SqlFieldsQuery, ScanQuery, SpiQuery with
next info:
- short query type description
- usage example (how to create and run)
- detailed query flags description
- known limitations
- additional features (e.g. geo-spatial support with LGPL package)
was:
The documentation for Full TEXT Queries is thin at best:
* What syntax does it use?
* ...is it the full [Lucene Classic Query Parser
Syntax|https://lucene.apache.org/core/6_3_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html]?
* ...if so how does the syntax map to the {{@QueryTextField}} annotation?
* How is Lucene analyser customisation performed?
* What version is supported? (looks like 3.5.0 which is pretty old, latest is
6.4.1)
* The
[{{@QueryTextField}}|https://ignite.apache.org/releases/latest/javadoc/org/apache/ignite/cache/query/annotations/QueryTextField.html]
JavaDoc refers to
[{{CacheQuery}}|https://ignite.apache.org/releases/latest/javadoc/org/apache/ignite/internal/processors/cache/query/CacheQuery.html]
but strangely this doesn't even appear in the official JavaDoc. It is because
it's an 'internal' class?
It's mentioned multiple times as a feature, but doesn't look like much of
Lucene can actually be utilised so clarifications would help greatly.
> Fix javadoc for public Query classes.
> -------------------------------------
>
> Key: IGNITE-10512
> URL: https://issues.apache.org/jira/browse/IGNITE-10512
> Project: Ignite
> Issue Type: Improvement
> Components: documentation, sql
> Affects Versions: 1.9
> Reporter: Andrew Mashenkov
> Assignee: Andrew Mashenkov
> Priority: Major
> Labels: full-text-search, javadoc
> Fix For: 2.8
>
>
> CacheQuery javadoc looks outdated and useless to used as it is resides in
> internal package and we omit javadocs building for 'internal' package.
> Let's update javadoc for SqlQuery, SqlFieldsQuery, ScanQuery, SpiQuery with
> next info:
> - short query type description
> - usage example (how to create and run)
> - detailed query flags description
> - known limitations
> - additional features (e.g. geo-spatial support with LGPL package)
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
