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 Rust client docs, Rust syntax highlighting #2620

Merged
merged 3 commits into from
Sep 5, 2024
Merged

Conversation

slvrtrn
Copy link
Contributor

@slvrtrn slvrtrn commented Sep 3, 2024

Summary

Most of the things from https://github.com/ClickHouse/clickhouse-rs/tree/main?tab=readme-ov-file#clickhouse-rs were moved to the docs repo

I added several new sections

  • Paul Loyd recognition as the original author
  • An explicit link to the examples
  • HTTPS/CH Cloud connection
  • Async insert example
  • Slightly adjusted inserter example (with end call mentioned in the code as it caused confusion)
  • DDLs with wait_end_of_query
  • CH settings usage examples
  • QueryID, SessionID examples
  • Custom HTTP headers example
  • Custom HTTP client example
  • CANNOT_READ_ALL_DATA troubleshooting
  • "Contact us"

Leftovers for the follow-ups:

  • Rework "Data Types" section, especially when the data types examples PR is merged
  • Add more docs based on the current/past issues in the client repo

Checklist

@slvrtrn slvrtrn marked this pull request as ready for review September 5, 2024 14:44
@slvrtrn slvrtrn requested a review from a team as a code owner September 5, 2024 14:44
@slvrtrn slvrtrn requested review from jkaflik and removed request for a team September 5, 2024 14:44
@slvrtrn slvrtrn merged commit 9ad5159 into main Sep 5, 2024
4 checks passed
@gingerwizard gingerwizard deleted the draft-rust-docs branch January 30, 2025 09:32
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.

2 participants