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

Enhancing and standardizing Clickhouse documentation #604

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from

Conversation

slyons
Copy link
Contributor

@slyons slyons commented Nov 1, 2024

🗣 Description

Standardizing the connector documentation as outlined in #580

🔨 Related Issues

🤔 Concerns

@slyons slyons added the documentation Improvements or additions to documentation label Nov 1, 2024
@slyons slyons self-assigned this Nov 1, 2024
Copy link

vercel bot commented Nov 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
spiceai-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 1:52am

sgrebnov
sgrebnov previously approved these changes Nov 12, 2024
spiceaidocs/docs/components/data-connectors/clickhouse.md Outdated Show resolved Hide resolved
spiceaidocs/docs/components/data-connectors/clickhouse.md Outdated Show resolved Hide resolved
| `clickhouse_user` | The username to connect with. |
| `clickhouse_pass` | The password to connect with. |
| `clickhouse_secure` | Optional. Specifies the SSL/TLS behavior for the connection, supported values:<br /> <ul><li>`true`: (default) This mode requires an SSL connection. If a secure connection cannot be established, server will not connect.</li><li>`false`: This mode will not attempt to use an SSL connection, even if the server supports it.</li></ul> |
| `connection_timeout` | Optional. Specifies the connection timeout in milliseconds. |
Copy link
Contributor

Choose a reason for hiding this comment

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

This should support specifying the timeout in the same format as our other timeout parameters, in a human readable format like 10s or 1m.

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we need to do this now, but we should at least create an issue to track it, since its inconsistent with our other connectors.

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

Successfully merging this pull request may close these issues.

Enhance clickhouse connector documentation
3 participants