pych-client 0.2.4

No project description provided

pych-client

pych-client is a ClickHouse client for Python. It targets the HTTP interface and offers the following features:

• Sync (ClickHouseClient) and async (AsyncClickHouseClient) clients.
• Streaming requests and responses.
• Optionally load credentials from environment variables, or from a configuration file.

Installation

# Default Python JSON parser:
pip install pych-client
# Faster orjson parser:
pip install pych-client[orjson]

Usage

from pych_client import ClickHouseClient

params = {"table": "test_pych"}
with ClickHouseClient() as client:
    client.text('''
        CREATE TABLE {table:Identifier} (a Int64, b Int64)
        ENGINE MergeTree() ORDER BY (a, b)
    ''', params)
    client.text("INSERT INTO {table:Identifier} VALUES", params, "(1, 2), (3, 4)")
    client.text("INSERT INTO {table:Identifier} VALUES", params, [b"(5, 6)", b"(7, 8)"])
    client.json("SELECT * FROM {table:Identifier} ORDER BY a", params)
# [{'a': '1', 'b': '2'}, {'a': '3', 'b': '4'}, {'a': '5', 'b': '6'}, {'a': '7', 'b': '8'}]

Command-line interface

pipx install pych-client
pych-client --help

Credential provider chain

The client looks for credentials in a way similar to the AWS SDK:

1. If one of base_url, database, username or password is specified, these values will be used.
2. If none of the previous values are specified, and one of PYCH_BASE_URL, PYCH_DATABASE, PYCH_USERNAME or PYCH_PASSWORD environment variables are present, these values will be used.
3. If none of the previous values are specified, and the file ~/.config/pych-client/credentials.json exists, the fields base_url, database and username and password will be used.
4. If none of the previous values are specified, the values http://localhost:8213, default and default will be used.