Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Nested Documentation for 2.7 Related Features #1620

Merged
merged 6 commits into from
May 23, 2023

Conversation

forestmvey
Copy link
Collaborator

Description

Added documentation for architectural changes from PR-1490. The added features covers the nested function used in the SELECT clause of an SQL statement. Future work has placeholders in documentation and can be added to with proposals as development continues.

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test and doctest
  • New functionality has been documented.
    • New functionality has javadoc added
    • New functionality has user manual doc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

forestmvey and others added 6 commits May 9, 2023 13:45
… comments and adding table of contents.

Signed-off-by: forestmvey <[email protected]>
…tion for examples, and used a better example to describe response flattening and cross join.

Signed-off-by: forestmvey <[email protected]>
…uery examples, minor clarifications on descriptions.

Signed-off-by: forestmvey <[email protected]>
Signed-off-by: forestmvey <[email protected]>
Add `Nested` Documentation for 2.7 Related Features
@Yury-Fridlyand Yury-Fridlyand added documentation Improvements or additions to documentation backport 2.x labels May 10, 2023
@penghuo penghuo merged commit 83ad166 into opensearch-project:main May 23, 2023
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-1620-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 83ad16603337208f4ee1edd623d94034dfd7ccb7
# Push it to GitHub
git push --set-upstream origin backport/backport-1620-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-1620-to-2.x.

forestmvey added a commit to Bit-Quill/opensearch-project-sql that referenced this pull request May 23, 2023
…#1620)

* Initial commit for adding nested documentation and select clause specific documentation.

Signed-off-by: forestmvey <[email protected]>

* Adding priorities, additional examples, cleaning up diagrams based on comments and adding table of contents.

Signed-off-by: forestmvey <[email protected]>

* Fixing using complete class names for state diagrams, added clarification for examples, and used a better example to describe response flattening and cross join.

Signed-off-by: forestmvey <[email protected]>

* Removing release schedule, removing unnecessary portions to DSL for query examples, minor clarifications on descriptions.

Signed-off-by: forestmvey <[email protected]>

* Cleaning up Class diagram.

Signed-off-by: forestmvey <[email protected]>

---------

Signed-off-by: forestmvey <[email protected]>
(cherry picked from commit 83ad166)
@forestmvey forestmvey mentioned this pull request May 23, 2023
6 tasks
forestmvey added a commit to Bit-Quill/opensearch-project-sql that referenced this pull request May 24, 2023
…#1620)

* Initial commit for adding nested documentation and select clause specific documentation.

Signed-off-by: forestmvey <[email protected]>

* Adding priorities, additional examples, cleaning up diagrams based on comments and adding table of contents.

Signed-off-by: forestmvey <[email protected]>

* Fixing using complete class names for state diagrams, added clarification for examples, and used a better example to describe response flattening and cross join.

Signed-off-by: forestmvey <[email protected]>

* Removing release schedule, removing unnecessary portions to DSL for query examples, minor clarifications on descriptions.

Signed-off-by: forestmvey <[email protected]>

* Cleaning up Class diagram.

Signed-off-by: forestmvey <[email protected]>

---------

Signed-off-by: forestmvey <[email protected]>
(cherry picked from commit 83ad166)
MitchellGale pushed a commit to Bit-Quill/opensearch-project-sql that referenced this pull request Jun 12, 2023
…#1620)

* Initial commit for adding nested documentation and select clause specific documentation.

Signed-off-by: forestmvey <[email protected]>

* Adding priorities, additional examples, cleaning up diagrams based on comments and adding table of contents.

Signed-off-by: forestmvey <[email protected]>

* Fixing using complete class names for state diagrams, added clarification for examples, and used a better example to describe response flattening and cross join.

Signed-off-by: forestmvey <[email protected]>

* Removing release schedule, removing unnecessary portions to DSL for query examples, minor clarifications on descriptions.

Signed-off-by: forestmvey <[email protected]>

* Cleaning up Class diagram.

Signed-off-by: forestmvey <[email protected]>

---------

Signed-off-by: forestmvey <[email protected]>
MitchellGale pushed a commit to Bit-Quill/opensearch-project-sql that referenced this pull request Jun 12, 2023
…#1620)

* Initial commit for adding nested documentation and select clause specific documentation.

Signed-off-by: forestmvey <[email protected]>

* Adding priorities, additional examples, cleaning up diagrams based on comments and adding table of contents.

Signed-off-by: forestmvey <[email protected]>

* Fixing using complete class names for state diagrams, added clarification for examples, and used a better example to describe response flattening and cross join.

Signed-off-by: forestmvey <[email protected]>

* Removing release schedule, removing unnecessary portions to DSL for query examples, minor clarifications on descriptions.

Signed-off-by: forestmvey <[email protected]>

* Cleaning up Class diagram.

Signed-off-by: forestmvey <[email protected]>

---------

Signed-off-by: forestmvey <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x documentation Improvements or additions to documentation v2.8.0
Projects
Status: Planned work items
Development

Successfully merging this pull request may close these issues.

6 participants