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

[DOP-11906] Improve Clickhouse documentation #211

Merged
merged 1 commit into from
Feb 20, 2024
Merged

Conversation

dolfinus
Copy link
Member

@dolfinus dolfinus commented Feb 8, 2024

Change Summary

  • Improved Clickhouse's documentation about reading, writing and executing statements. Previously it was just crosslinks to DBReader, DBWriter and connection own methods docstrings. Now there are more Clickhouse-specific examples and recommendations
  • Added new section describing type compatibility between Clickhouse and Spark, including some recommendations for reading/writing unsupported column types.
  • Added new section describing which actions should be performed to connect to Clickhouse.

See https://onetl--211.org.readthedocs.build/en/211/connection/db_connection/clickhouse/index.html

If new documentation layout will be approved, we can drop generic examples from JDBC.fetch(), JDBC.execute(), JDBC.sql(), JDBC.JDBCOptions and so on, and replace them with DB-specific documentation and examples.

Related issue number

Checklist

  • Commit message and PR title is comprehensive
  • Keep the change as small as possible
  • Unit and integration tests for the changes exist
  • Tests pass on CI and coverage does not decrease
  • Documentation reflects the changes where applicable
  • docs/changelog/next_release/<pull request or issue id>.<change type>.rst file added describing change
    (see CONTRIBUTING.rst for details.)
  • My PR is ready to review.

@codecov-commenter
Copy link

codecov-commenter commented Feb 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a8c8403) 94.11% compared to head (4731d92) 94.12%.
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #211      +/-   ##
===========================================
+ Coverage    94.11%   94.12%   +0.01%     
===========================================
  Files          204      204              
  Lines         7836     7836              
  Branches      1399     1399              
===========================================
+ Hits          7375     7376       +1     
+ Misses         336      335       -1     
  Partials       125      125              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dolfinus dolfinus marked this pull request as ready for review February 19, 2024 14:57
@dolfinus dolfinus merged commit d2536b6 into develop Feb 20, 2024
33 checks passed
@dolfinus dolfinus deleted the feature/DOP-11906 branch February 20, 2024 14:55
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

4 participants