Skip to main content
ClickHouse 연결을 위한 공식 Rust 클라이언트입니다. 최초 개발자는 Paul Loyd이며, 클라이언트 소스 코드는 GitHub 리포지토리에서 확인할 수 있습니다.

개요

  • 행 인코딩/디코딩에 serde를 사용합니다.
  • serde 속성인 skip_serializing, skip_deserializing, rename을 지원합니다.
  • HTTP 전송을 통해 RowBinary 포맷을 사용합니다.
    • 향후 TCP를 통해 Native를 사용하도록 전환할 계획입니다.
  • TLS(native-tlsrustls-tls 기능 사용)를 지원합니다.
  • 압축 및 압축 해제(LZ4)를 지원합니다.
  • 데이터 조회 및 삽입, DDL 실행, 클라이언트 측 배칭을 위한 API를 제공합니다.
  • 단위 테스트를 위한 편리한 모의 객체를 제공합니다.

설치

크레이트를 사용하려면 다음을 Cargo.toml에 추가하십시오:
관련 항목: crates.io 페이지.

Cargo 기능

  • lz4 (기본적으로 활성화됨) — Compression::Lz4Compression::Lz4Hc(_) variant를 활성화합니다. 활성화되면 WATCH를 제외한 모든 쿼리에 기본적으로 Compression::Lz4가 사용됩니다.
  • native-tls — OpenSSL에 링크되는 hyper-tls를 통해 HTTPS 스키마의 URL을 지원합니다.
  • rustls-tls — OpenSSL에 링크되지 않는 hyper-rustls를 통해 HTTPS 스키마의 URL을 지원합니다.
  • inserterclient.inserter()를 활성화합니다.
  • test-util — 모의 객체를 추가합니다. 예시를 참조하십시오. dev-dependencies에서만 사용하십시오.
  • watchclient.watch 기능을 활성화합니다. 자세한 내용은 해당 섹션을 참조하십시오.
  • uuiduuid 크레이트와 함께 사용할 수 있도록 serde::uuid를 추가합니다.
  • timetime 크레이트와 함께 사용할 수 있도록 serde::time를 추가합니다.
HTTPS URL을 통해 ClickHouse에 연결할 때는 native-tls 또는 rustls-tls 기능 중 하나를 활성화해야 합니다. 둘 다 활성화된 경우 rustls-tls 기능이 우선 적용됩니다.

ClickHouse 버전 호환성

이 클라이언트는 LTS 및 그 이후 버전의 ClickHouse는 물론 ClickHouse Cloud와도 호환됩니다. v22.6 이전의 ClickHouse 서버는 드물게 일부 경우에 RowBinary를 잘못 처리합니다. 이 문제를 해결하려면 v0.11+를 사용하고 wa-37420 기능을 활성화할 수 있습니다. 참고: 이 기능은 더 최신 버전의 ClickHouse에서는 사용하지 않아야 합니다.

예시

클라이언트 리포지토리의 예시를 통해 클라이언트 사용의 다양한 시나리오를 다루고자 합니다. 개요는 예시 README에서 확인할 수 있습니다. 예시나 아래 문서에서 불명확하거나 누락된 내용이 있으면 언제든지 문의해 주세요.

사용법

ch2rs 크레이트는 ClickHouse로부터 행 타입을 생성하는 데 유용합니다.

클라이언트 인스턴스 생성

기반이 되는 hyper 연결 풀을 재사용하려면, 생성한 클라이언트를 재사용하거나 복제하세요.

HTTPS 또는 ClickHouse Cloud 연결

HTTPS는 cargo 기능인 rustls-tls 또는 native-tls와 함께 사용할 수 있습니다. 그런 다음 평소와 같이 클라이언트를 생성합니다. 이 예시에서는 연결 정보를 저장하는 데 환경 변수를 사용합니다:
URL에는 프로토콜과 포트가 모두 포함되어야 합니다. 예: https://instance.clickhouse.cloud:8443.
관련 항목:
  • 클라이언트 리포지토리의 ClickHouse Cloud HTTPS 예시를 참조하십시오. 이는 온프레미스 환경의 HTTPS 연결에도 적용됩니다.

행 조회

  • 플레이스홀더 ?fieldsno, name(Row의 필드)으로 대체됩니다.
  • 플레이스홀더 ?는 이어지는 bind() 호출의 값으로 대체됩니다.
  • 첫 번째 행 또는 모든 행을 각각 가져오려면 fetch_one::<Row>()fetch_all::<Row>() 메서드를 편리하게 사용할 수 있습니다.
  • 테이블 이름을 바인딩하는 데 sql::Identifier를 사용할 수 있습니다.
참고: 전체 응답이 스트리밍되므로 커서는 일부 행을 반환한 후에도 오류를 반환할 수 있습니다. 사용 사례에서 이런 문제가 발생하면 서버 측 응답 버퍼링을 활성화하기 위해 query(...).with_option("wait_end_of_query", "1")를 시도해 볼 수 있습니다. 자세한 내용. buffer_size 옵션도 유용할 수 있습니다.
행을 조회할 때는 wait_end_of_query를 주의해서 사용하십시오. 서버 측 메모리 사용량이 증가할 수 있으며, 전체 성능도 저하될 가능성이 높습니다.

행 삽입

  • end()가 호출되지 않으면 INSERT가 취소됩니다.
  • 네트워크 부하를 분산하기 위해 행은 스트림 형태로 순차적으로 전송됩니다.
  • ClickHouse는 모든 행이 동일한 파티션에 속하고 행 수가 max_insert_block_size 미만인 경우에만 배치를 원자적으로 삽입합니다.

Async insert (서버 측 배칭)

수신 데이터에 대해 클라이언트 측 배칭을 하지 않으려면 ClickHouse asynchronous inserts를 사용할 수 있습니다. 이렇게 하려면 insert 메서드에 async_insert 옵션만 지정하면 됩니다(또는 Client 인스턴스 자체에 지정하여 모든 insert 호출에 적용되도록 할 수도 있습니다).
관련 항목:

Inserter 기능(클라이언트 측 배칭)

inserter Cargo 기능이 필요합니다.
  • Inserter는 임계값(max_bytes, max_rows, period) 중 하나에 도달하면 commit()에서 진행 중인 삽입을 종료합니다.
  • 진행 중인 INSERT 종료 간격에는 with_period_bias로 바이어스를 적용할 수 있으며, 이를 통해 병렬 inserter로 인한 부하 급증을 방지할 수 있습니다.
  • Inserter::time_left()는 현재 주기가 언제 끝나는지 감지하는 데 사용할 수 있습니다. 스트림에서 항목이 드물게 들어오는 경우, 한도를 확인하려면 Inserter::commit()을 다시 호출하십시오.
  • 시간 임계값은 inserter의 성능을 높이기 위해 quanta 크레이트를 사용해 구현됩니다. test-util이 활성화된 경우에는 사용되지 않으므로, 사용자 정의 테스트에서는 tokio::time::advance()로 시간을 관리할 수 있습니다.
  • commit() 호출 사이의 모든 행은 동일한 INSERT 문에 삽입됩니다.
삽입을 종료하거나 마무리하려면 플러시하는 것을 잊지 마십시오:

DDL 실행

단일 노드로 배포한 경우 다음과 같이 DDL을 실행하면 됩니다:
그러나 로드 밸런서가 있는 클러스터형 배포 환경이나 ClickHouse Cloud에서는 wait_end_of_query 옵션을 사용해 DDL이 모든 레플리카에 적용될 때까지 기다리는 것이 좋습니다. 다음과 같이 수행할 수 있습니다:

ClickHouse 설정

with_option 메서드로 다양한 ClickHouse 설정을 적용할 수 있습니다. 예시는 다음과 같습니다:
query뿐만 아니라 insertinserter 메서드도 같은 방식으로 동작하며, 또한 Client 인스턴스에서 동일한 메서드를 호출해 모든 쿼리에 적용되는 전역 설정을 지정할 수 있습니다.

쿼리 ID

.with_option을 사용하면 query_id 옵션을 설정해 ClickHouse query log에서 쿼리를 식별할 수 있습니다.
query뿐만 아니라 insertinserter 메서드에도 비슷하게 적용됩니다.
query_id를 수동으로 설정하는 경우 고유한 값이어야 합니다. 이를 위해 UUID가 적합합니다.
관련 항목: 클라이언트 리포지토리의 query_id 예시.

세션 ID

query_id와 마찬가지로 session_id를 설정하면 동일한 session에서 SQL 문을 실행할 수 있습니다. session_id는 클라이언트 수준에서 전역으로 설정하거나 각 query, insert 또는 inserter 호출별로 설정할 수 있습니다.
클러스터형 배포 환경에서는 “sticky sessions”가 없기 때문에, 이 기능을 제대로 활용하려면 특정 클러스터 노드에 연결되어 있어야 합니다. 예를 들어, 라운드 로빈 로드 밸런서는 후속 요청이 동일한 ClickHouse 노드에서 처리된다고 보장하지 않습니다.
관련 항목: 클라이언트 리포지토리의 session_id 예시.

사용자 지정 HTTP 헤더

프록시 인증을 사용하거나 사용자 지정 헤더를 전달해야 하는 경우, 다음과 같이 할 수 있습니다:
관련 항목: 클라이언트 리포지토리의 사용자 지정 HTTP 헤더 예시를 참조하십시오.

사용자 지정 HTTP 클라이언트

이 기능은 내부 HTTP 연결 풀 설정을 조정할 때 유용할 수 있습니다.
이 예시는 기존 Hyper API를 사용하므로, 향후 변경될 수 있습니다.
관련 항목: 클라이언트 리포지토리의 사용자 지정 HTTP 클라이언트 예시.

데이터 타입

  • (U)Int(8|16|32|64|128)는 해당 (u|i)(8|16|32|64|128) 타입 또는 이를 감싼 newtype에 매핑되거나, 그 반대로도 매핑될 수 있습니다.
  • (U)Int256은 직접 지원되지 않지만, 이를 위한 우회 방법이 있습니다.
  • Float(32|64)는 해당 f(32|64) 또는 이를 감싼 newtype에 매핑되거나, 그 반대로도 매핑될 수 있습니다.
  • Decimal(32|64|128)는 해당 i(32|64|128) 또는 이를 감싼 newtype에 매핑되거나, 그 반대로도 매핑될 수 있습니다. 부호 있는 고정소수점 수를 구현하려면 fixnum 또는 다른 구현체를 사용하는 편이 더 편리합니다.
  • Booleanbool 또는 이를 감싼 newtype에 매핑되거나, 그 반대로도 매핑될 수 있습니다.
  • String은 모든 문자열 또는 바이트 타입(예: &str, &[u8], String, Vec<u8>, SmartString)에 매핑되거나, 그 반대로도 매핑될 수 있습니다. newtype도 지원됩니다. 바이트를 저장할 때는 serde_bytes가 더 효율적이므로 사용을 고려하십시오.
  • FixedString(N)은(는) 바이트 배열로 지원되며, 예를 들어 [u8; N]와 같습니다.
  • Enum(8|16)serde_repr를 통해 지원됩니다.
  • UUIDserde::uuid를 사용해 uuid::Uuid로 또는 그 반대로 매핑됩니다. uuid 기능이 필요합니다.
  • Dateu16 또는 이를 감싼 newtype과 상호 매핑되며, 1970-01-01 이후 경과한 일수를 나타냅니다. 또한 time::Dateserde::time::date를 통해 지원되며, 이를 사용하려면 time 기능이 필요합니다.
  • Date32i32 또는 이를 감싼 newtype로/에서 매핑되며, 1970-01-01 이후 경과한 일수를 나타냅니다. 또한 time 기능이 필요하며, serde::time::date32를 사용하면 time::Date도 지원합니다.
  • DateTimeu32 또는 이를 래핑한 newtype에 매핑되거나 그로부터 매핑되며, UNIX epoch 이후 경과한 초 수를 나타냅니다. 또한 time::OffsetDateTimeserde::time::datetime을 사용해 지원되며, 이 경우 time 기능이 필요합니다.
  • DateTime64(_)i32 또는 이를 감싼 newtype에 매핑되거나 그로부터 매핑되며, Unix epoch 이후 경과한 시간을 나타냅니다. 또한 time::OffsetDateTimeserde::time::datetime64::*를 사용해 지원되며, 이 경우 time 기능이 필요합니다.
  • Tuple(A, B, ...)(A, B, ...) 또는 이를 감싼 newtype으로/에서 매핑됩니다.
  • Array(_)는 모든 슬라이스로/에서 매핑됩니다. 예: Vec<_>, &[_]. 사용자 정의 타입도 지원됩니다.
  • Map(K, V)Array((K, V))처럼 동작합니다.
  • LowCardinality(_)는 별도 처리 없이 지원됩니다.
  • Nullable(_)Option<_>으로/에서 매핑됩니다. clickhouse::serde::* helpers를 사용할 때는 ::option을 추가하십시오.
  • Nested는 이름을 변경한 여러 배열을 지정하는 방식으로 지원됩니다.
  • Geo 타입이 지원됩니다. Point는 튜플 (f64, f64)처럼 동작하며, 나머지 타입은 모두 Point의 슬라이스입니다.
  • Variant, Dynamic, (새로운) JSON 데이터 타입은 아직 지원되지 않습니다.

모킹

이 크레이트는 CH 서버를 모킹하고 DDL, SELECT, INSERT, WATCH 쿼리를 테스트하기 위한 유틸리티를 제공합니다. 이 기능은 test-util 기능을 활성화하면 사용할 수 있습니다. 반드시 개발 의존성으로만 사용하세요. 예시를 참조하세요.

문제 해결

CANNOT_READ_ALL_DATA

CANNOT_READ_ALL_DATA 오류의 가장 일반적인 원인은 애플리케이션 측의 행 정의가 ClickHouse의 행 정의와 일치한다는 것입니다. 다음 테이블을 살펴보십시오:
그런 다음 애플리케이션 측에서 EventLog가 서로 다른 타입으로 정의된 경우(예:):
데이터 삽입 시 다음 오류가 발생할 수 있습니다:
이 예시에서는 EventLog 구조체를 올바르게 정의하면 이 문제가 해결됩니다:

알려진 제한 사항

  • Variant, Dynamic, (new) JSON 데이터 타입은 아직 지원되지 않습니다.
  • 서버 측 매개변수 바인딩은 아직 지원되지 않습니다. 관련 진행 상황은 this issue에서 추적하고 있습니다.

문의하기

질문이 있거나 도움이 필요하시면 Community Slack 또는 GitHub 이슈를 통해 언제든지 문의하세요.
마지막 수정일 2026년 7월 23일