Skip to content

docs: add Tigris page under S3-compatible integrations#6445

Open
davidmyriel wants to merge 1 commit into
ClickHouse:mainfrom
davidmyriel:myriel/tigris-data
Open

docs: add Tigris page under S3-compatible integrations#6445
davidmyriel wants to merge 1 commit into
ClickHouse:mainfrom
davidmyriel:myriel/tigris-data

Conversation

@davidmyriel

Copy link
Copy Markdown

Summary

Adds a new docs page for using Tigris (an S3-compatible object storage service) as an S3 backend for ClickHouse, mirroring the structure of the existing MinIO page (docs/integrations/data-ingestion/s3-minio.md).

Why

ClickHouse's s3 table function and S3 disk type work against any S3-compatible endpoint, and the docs already include a dedicated page for MinIO. Tigris is increasingly used as a multi-region S3-compatible store, but there is no docs entry for it today, so users have to figure out the endpoint and region handling from the source.

What's in the page

  • One paragraph framing the integration around the operational trade-off (single global endpoint with reads from the nearest region, vs. per-region S3 buckets).
  • The <storage_configuration> XML snippet for a backed-MergeTree disk pointed at Tigris.
  • One :::tip explaining why <region>auto</region> is needed (SigV4 still requires a region value, even when the endpoint is global).
  • One s3() table function example.
  • A link to the Tigris Console for creating access keys.

support_level is set to 'community' (Tigris is not a ClickHouse-supported core integration).

Files

  • docs/integrations/data-ingestion/s3-tigris.md — new page.
  • sidebars.js — one-line addition placing the entry next to the MinIO one.

Docs only; no code changes.

@davidmyriel davidmyriel requested review from a team as code owners June 25, 2026 15:55
@vercel

vercel Bot commented Jun 25, 2026

Copy link
Copy Markdown

@davidmyriel is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant

CLAassistant commented Jun 25, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@dhtclk

dhtclk commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

@davidmyriel - Thanks for the contribution!

The DocsCheck failure is a sentence-casing check on the frontmatter title. Tigris is a product name, so the fix is to add it to the proper-noun allowlist rather than change the title.

Add Tigris to the exceptions: list in styles/ClickHouse/Headings.yml. There's a # Product and tool names section where MinIO already lives, so that's the natural spot. That one file is the single source of truth for both Vale and the frontmatter validator, so the single addition clears the check.

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.

3 participants