diff --git a/docs/integrations/data-ingestion/s3-tigris.md b/docs/integrations/data-ingestion/s3-tigris.md new file mode 100644 index 00000000000..aecf70da8c4 --- /dev/null +++ b/docs/integrations/data-ingestion/s3-tigris.md @@ -0,0 +1,64 @@ +--- +sidebar_label: 'Tigris' +sidebar_position: 7 +slug: /integrations/tigris +description: 'Page describing how to use Tigris with ClickHouse' +title: 'Using Tigris' +doc_type: 'guide' +integration: + - support_level: 'community' + - category: 'data_ingestion' +keywords: ['s3', 'tigris', 'object storage', 'data loading', 'compatible storage'] +--- + + +import SelfManaged from '@site/docs/_snippets/_self_managed_only_no_roadmap.md'; + + + +ClickHouse's `s3` table function and `S3` disk type are compatible with [Tigris](https://www.tigrisdata.com), an S3-compatible object storage service. Tigris exposes a single global endpoint at `https://t3.storage.dev` with reads served from the region nearest the caller, so a multi-region ClickHouse fleet can point at one bucket URL without per-region replicas or cross-region egress. + +The backed merge tree configuration is compatible with minor changes: + +```xml + + + ... + + + s3 + https://your-bucket.t3.storage.dev/tables/ + your_access_key_id + your_secret_access_key + auto + /var/lib/clickhouse/disks/s3/ + + + cache + s3 + /var/lib/clickhouse/disks/s3_cache/ + 10Gi + + + ... + + +``` + +:::tip +Set `auto`. Tigris uses a single global endpoint rather than per-region buckets, but the AWS SigV4 signing flow that ClickHouse uses still requires a region value, and `auto` is the convention. +::: + +The `s3` table function works against the same endpoint: + +```sql +SELECT * +FROM s3( + 'https://your-bucket.t3.storage.dev/path/to/file.parquet', + 'your_access_key_id', + 'your_secret_access_key', + 'Parquet' +); +``` + +Access keys can be created from the [Tigris Console](https://console.storage.dev/). Access key IDs are prefixed with `tid_` and secrets with `tsec_`. diff --git a/sidebars.js b/sidebars.js index 6e930aba098..00e99e486c1 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1024,6 +1024,7 @@ const sidebars = { 'integrations/data-sources/cassandra', 'integrations/data-ingestion/gcs/index', 'integrations/data-ingestion/s3-minio', + 'integrations/data-ingestion/s3-tigris', 'integrations/data-ingestion/emqx/index', 'integrations/data-ingestion/insert-local-files', 'integrations/data-ingestion/dbms/jdbc-with-clickhouse',