Skip to content

Docs: add Linux installation to the ODBC driver page - #617

Open
singhpratech wants to merge 1 commit into
ClickHouse:masterfrom
singhpratech:docs-linux-install
Open

singhpratech wants to merge 1 commit into
ClickHouse:masterfrom
singhpratech:docs-linux-install

Conversation

@singhpratech

@singhpratech singhpratech commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Moved here from ClickHouse/ClickHouse#132189 at @Blargian's request, since docs/index.mdx in this repository is the source the ClickHouse docs are synced from.

docs/index.mdx describes installation on Windows only. Since 1.6.0 every release attaches a prebuilt Linux driver, so this adds an "Installation on Linux" section next to the Windows one:

  • download and extract the release archive
  • register the ANSI and Unicode drivers in odbcinst.ini
  • define a data source in odbc.ini
  • test with isql

I ran the steps as written on Ubuntu with the 1.6.0 release archive against ClickHouse 26.10; isql returned the server version. The registration entries follow the odbcinst.ini.sample shipped in the archive.

The release also attaches a macOS archive. I have not tested it, so this change does not cover macOS.


Note

Low Risk
Documentation-only change with no runtime or security impact.

Overview
Adds an Installation on Linux section to docs/index.mdx, which previously only covered Windows.

The new section documents end-to-end setup for the prebuilt x86_64 Linux release: installing unixODBC, downloading and extracting the release archive (e.g. under /opt/clickhouse-odbc), registering the ANSI and Unicode drivers in /etc/odbcinst.ini, defining a DSN in ~/.odbc.ini, and verifying connectivity with isql.

Reviewed by Cursor Bugbot for commit c337227. Bugbot is set up for automated code reviews on this repo. Configure here.

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.

1 participant