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

Update the java client documentation #2408

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jaydeluca
Copy link

@jaydeluca jaydeluca commented Jun 16, 2024

While approaching using the client for the first time, I encountered a few things that took me a while to sort out, so I wanted to contribute to the docs so it might be more clear.

I also came across other related issues where others discuss these same issues:

What I changed in this PR:

  • I added another example for how to connect to a cluster with a single node using a connection string that doesn't include the jdbc:ch prefix. I had originally tried copying the example code with that included and got all kinds of errors with using the jdbc:ch:http://server1.domain format. I am not sure if the original code is correct or not, but if someone can help me confirm i can either leave it or update it if it needs changing
  • I added a section about the LZ4 dependency, showing how to add it or how to work around it. This tripped me up for a bit figuring out how to change/disable it.
  • I updated the limit syntax in the queries. I couldn't get the syntax in the examples to work with the limit in parenthesis.

I am new to using this client, so I apologize if I'm misunderstanding something or missing something obvious. I think these additions might make it easier for others who try to use the example code snippets as a starting point.

@jaydeluca jaydeluca requested a review from a team as a code owner June 16, 2024 20:53
@jaydeluca jaydeluca requested review from kschlarman and removed request for a team June 16, 2024 20:53
@CLAassistant
Copy link

CLAassistant commented Jun 16, 2024

CLA assistant check
All committers have signed the CLA.

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

Successfully merging this pull request may close these issues.

None yet

2 participants