Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Automated Documentation - Phase 3 #380

Closed
dai-chen opened this issue Mar 13, 2020 · 3 comments
Closed

Automated Documentation - Phase 3 #380

dai-chen opened this issue Mar 13, 2020 · 3 comments
Assignees
Labels
maintenance Improves code quality, but not the product

Comments

@dai-chen
Copy link
Member

dai-chen commented Mar 13, 2020

We've already prepared docs for basic usage of plugin and simple SELECT query: https://github.com/opendistro-for-elasticsearch/sql/blob/master/docs/user/index.rst. In this phase, we want to generate more documents for what's left:

  1. DQL
    1.1 Complex query: Subquery, JOIN, MINUS/UNION
    1.2 SHOW/DESCRIBE
    1.3 SQL Functions
  2. DML
    2.1 DELETE
  3. Beyond SQL
    3.1 PartiQL Compatibility
    3.2 Full Text Search
    3.3 Elasticsearch special functions
@dai-chen dai-chen added the maintenance Improves code quality, but not the product label Mar 13, 2020
@dai-chen dai-chen self-assigned this Mar 13, 2020
@dai-chen
Copy link
Member Author

dai-chen commented Mar 13, 2020

Note that SQL Functions need to be generated from our type system in semantic analyzer. And there are many ES special functions in our codebase. So for these parts, we may only put basic information for now due to time limit.

@dai-chen
Copy link
Member Author

dai-chen commented Apr 8, 2020

Due to the time limit, docs for SQL functions only list specification for now. More descriptive information will be added in future. As for ES special functions, it takes time to figure out the spec and semantic so skip it for now too.

@dai-chen dai-chen closed this as completed Apr 8, 2020
@anirudha
Copy link
Contributor

anirudha commented Apr 8, 2020

👍 thanks

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
maintenance Improves code quality, but not the product
Projects
None yet
Development

No branches or pull requests

2 participants