clickhouse-connect

(★ 517)

Python driver/sqlalchemy/superset connectors

파일 탐색기

최종 버전 다운로드 (.zip)

- architecture.md
- review.md
- server-map.md
- - clickhouse-server-reader.md
  - docs-drift-reviewer.md
- - users.xml
- - bug_report.md
  - feature_request.md
- - clickhouse_ci.yml
  - cross-repo-bug-relay.yml
  - docs_drift_check.yml
  - docs_sync.yml
  - docs_verify.yml
  - on_push.yml
  - publish.yml
  - publish_core.yml
  - stresshouse-benchmark-compare.yml
- CODEOWNERS
- copilot-instructions.md
- pull_request_template.md
- - __init__.py
  - dialect.py
  - engines.py
  - inspector.py
  - MIGRATING_FROM_CLICKHOUSE_SQLALCHEMY.md
  - types.py
- - __init__.py
  - base.py
  - binary_value.py
  - container.py
  - dynamic.py
  - format.py
  - geometric.py
  - network.py
  - numeric.py
  - postinit.py
  - registry.py
  - special.py
  - string.py
  - temporal.py
  - vector.py
- - __init__.py
  - connection.py
  - cursor.py
- - __init__.py
  - _backendclient.py
  - _chdbclient.py
  - asyncclient.py
  - asyncqueue.py
  - binding.py
  - buffer.py
  - bytesource.py
  - client.py
  - common.py
  - compression.py
  - constants.py
  - context.py
  - ctypes.py
  - dataconv.py
  - ddl.py
  - errors.py
  - exceptions.py
  - external.py
  - httpclient.py
  - httputil.py
  - insert.py
  - models.py
  - npconv.py
  - npquery.py
  - options.py
  - parser.py
  - query.py
  - streaming.py
  - summary.py
  - tools.py
  - transform.py
  - types.py
  - tzutil.py
- - .gitignore
  - __init__.pxd
  - __init__.py
  - buffer.pxd
  - buffer.pyx
  - dataconv.pyx
  - npconv.pyx
- - __init__.py
  - datagen.py
  - testing.py
- __init__.py
- _version.py
- common.py
- entry_points.py
- json_impl.py
- py.typed
- _meta.yml
- additional-options.mdx
- advanced-inserting.mdx
- advanced-querying.mdx
- advanced-usage.mdx
- driver-api.mdx
- index.mdx
- navigation.json
- sqlalchemy.mdx
- benchmark.py
- clear_test_databases.py
- insert_examples.py
- pandas_examples.py
- params_example.py
- quickstart.py
- read_perf.py
- run_async.py
- ssh_tunnels.py
- write_into_file.py
- write_perf.py
- check_public_types.py
- .gitignore
- superset_config.py
- - __init__.py
  - actors.csv
  - conftest.py
  - datasets.py
  - json_test.ndjson
  - movies.csv
  - movies.csv.gz
  - movies.parquet
  - proxy_ca_cert.crt
  - test_arrow.py
  - test_async_features.py
  - test_client.py
  - test_contexts.py
  - test_dbapi.py
  - test_dynamic.py
  - test_error_handling.py
  - test_external_data.py
  - test_form_encode_query.py
  - test_formats.py
  - test_geometric.py
  - test_inserts.py
  - test_jwt_auth.py
  - test_mid_stream_exception.py
  - test_multithreading.py
  - test_native.py
  - test_native_fuzz.py
  - test_network.py
  - test_numeric.py
  - test_numpy.py
  - test_pandas.py
  - test_params.py
  - test_polars.py
  - test_protocol_version.py
  - test_proxy.py
  - test_pyarrow_ddl_integration.py
  - test_raw_insert.py
  - test_session_id.py
  - test_streaming.py
  - test_temporal.py
  - test_timezones.py
  - test_tls.py
  - test_tools.py
  - test_vector.py
- - consumer_smoke.py
  - sqlalchemy_select_smoke.py
- - __init__.py
  - test_asyncqueue.py
  - test_backend_orchestration.py
  - test_binary_value.py
  - test_bytesource.py
  - test_chtypes.py
  - test_dynamic.py
  - test_freethreading.py
  - test_pandas.py
  - test_pyarrow_ddl.py
  - test_qbit_type.py
  - test_streaming_source.py
  - test_version.py
- __init__.py
- conftest.py
- helpers.py
- test_bare_install.py
- test_requirements.txt
- timings.py
.dockerignore
.git-blame-ignore-revs
.gitignore
.pre-commit-config.yaml
AGENTS.md
AI_POLICY.md
CHANGELOG.md
CLAUDE.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
docker-compose.yml
Dockerfile
LICENSE
MANIFEST.in
MIGRATION.md
playtest.py
pyproject.toml
README.md
setup.py

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/ClickHouse/clickhouse-connect

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd clickhouse-connect

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천

사전 준비물

Python 3 pip 명령어를 쓰려면 Python이 필요합니다.

pip install clickhouse-connect

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

pip install clickhouse-connect[alembic]

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

pip install clickhouse-connect[async]

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

✅ 설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Docker

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

docker compose up -d --build

정의된 모든 컨테이너(서버, DB 등)를 한 번에 빌드하고 백그라운드에서 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

4. Python

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).

pip install clickhouse-connect

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

pip install clickhouse-connect[alembic]

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

pip install clickhouse-connect[async]

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

✅ 에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.