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

Improve and expand client protocol docs #23836

Merged
merged 4 commits into from
Nov 27, 2024
Merged

Conversation

mosabua
Copy link
Member

@mosabua mosabua commented Oct 18, 2024

Description

Revamped client protocol docs and added spooling info.

Additional context and related issues

#22271 and various others.

Release notes

(x) This is not user-visible or is docs only, and no release notes are required.

@cla-bot cla-bot bot added the cla-signed label Oct 18, 2024
@github-actions github-actions bot added the docs label Oct 18, 2024
@mosabua mosabua requested a review from wendigo October 18, 2024 23:07
@mosabua mosabua force-pushed the spool branch 3 times, most recently from 5cfaa00 to 30d3bfc Compare October 25, 2024 18:37
@mosabua mosabua force-pushed the spool branch 10 times, most recently from 57b2ce5 to c2849c6 Compare November 26, 2024 00:30
@mosabua mosabua marked this pull request as ready for review November 26, 2024 01:01
@mosabua
Copy link
Member Author

mosabua commented Nov 26, 2024

@wendigo I have to complete the properties list and the client-protocol page yet - specifically how to configure spooling and aim to do that tomorrow .. but I would appreciate a first look so I can figure out if I am on the right track and how close I am.

Also note that the developer guide section should be done later since I dont want to hold this up any longer.

@mosabua mosabua force-pushed the spool branch 3 times, most recently from a9e9671 to edee585 Compare November 27, 2024 01:15
@mosabua
Copy link
Member Author

mosabua commented Nov 27, 2024

Alright @wendigo .. I think this is good to go now. Let me know if anything else is needed. For example, it might be nice to add config snippets for Azure and GCS but that is optional.

@mosabua mosabua force-pushed the spool branch 2 times, most recently from 438567c to 4a82054 Compare November 27, 2024 20:11
Include the new spooling protocol and its configuration for CLI and JDBC
driver.
@mosabua
Copy link
Member Author

mosabua commented Nov 27, 2024

Thanks for all your help @wendigo !

@mosabua mosabua merged commit b2dc49a into trinodb:master Nov 27, 2024
5 checks passed
@mosabua mosabua deleted the spool branch November 27, 2024 21:19
@github-actions github-actions bot added this to the 466 milestone Nov 27, 2024
from using the spooling protocol.
* Requires newer client drivers or client applications that support the spooling
protocol and actively request usage of the spooling protocol.
* Clients must have access to the object storage.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This mixes two things:

  • The protocol does not require clients to have access to object storage. They need to have access to whatever endpoints are referenced by the URLs returned in the responses. These could be object storage, endpoints in the coordinator, workers, etc.
  • Object storage is just an implementation strategy for realizing the protocol on the server side. When that implementation is used by the server, then clients need to have access to the object storage endpoints.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay .. that makes sense .. how do we write that though so its not completely abstract or super long.

  • Clients must have access to the spooled segments. Their locations are specified as
    URLs to external object storage, the coordinator, or workers in the cluster.

Thats a lot of hedging.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also I can work that into #24288 or another PR .. once we figured out what we want to write.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants