Cardinal Desktop Application
Connectors
ClickHouse
ClickHouse

ClickHouse

Connect Cardinal Desktop Application to ClickHouse for querying and analyzing data in your ClickHouse cluster.

Overview

ClickHouse is a fast, open-source columnar database management system. With the ClickHouse connector, your AI agents can:

  • Query ClickHouse databases and retrieve data
  • Access tables across your ClickHouse cluster
  • Analyze columnar data with high performance
  • Execute analytical queries at scale
  • Integrate data from your ClickHouse instance

Connection Details

FieldDescription
Server AddressClickHouse server address (host:port format)
UsernameUsername for ClickHouse authentication
PasswordPassword for ClickHouse authentication
ProtocolConnection protocol (Native TCP or HTTP)
Secure (TLS)(Optional) Enable TLS encryption
Share credentials(Optional) Share credentials with organization

Prerequisites

  • ClickHouse server deployed and running
  • Network access to your ClickHouse server
  • Valid ClickHouse credentials (username and password)
  • Databases and tables available in your ClickHouse instance

Setup Wizard

Step 1 - Connection Details

  1. In Cardinal Desktop Application, go to Connectors and click Browse Connectors
  2. Select ClickHouse
  3. Enter your Server Address
    • Format: host:port (e.g., localhost:9000 for native, localhost:8123 for HTTP)
    • Native: port 9000, HTTP: port 8123
  4. Enter your Username
    • Example: default
    • ClickHouse username for authentication
  5. Enter your Password
    • Your ClickHouse password

Step 2 - Configuration Options

  1. Select your Protocol from the dropdown

    • Native (TCP) - Default ClickHouse protocol on port 9000
    • HTTP - HTTP protocol on port 8123
    • Native offers better performance for analytical queries

  2. (Optional) Enable Secure (TLS)

    • Toggle to enable TLS encryption for the connection
    • Required for secure connections to remote ClickHouse servers

Step 3 - Select Database

  1. Browse and select a Database
    • Click to view available databases
    • Select the database containing your tables

Step 4 - Select Tables

  1. Browse and select Tables from your database
    • Choose one or more tables to include
    • Click to see table structure and columns

Step 5 - Credentials Storage (Optional)

  1. Check Share credentials with organization to securely share with your organization
    • When disabled: credentials are stored locally on this device
    • When enabled: credentials are securely shared with your organization members

Step 6 - Save

  1. Click Save to complete the configuration
  2. Cardinal Desktop Application will verify connectivity to your ClickHouse server

Your AI agent can now query ClickHouse databases and tables.

Understand the assets and product features →

Reach out to support@cardinalhq.io for support or to ask questions not answered in our documentation.

AWS AthenaSnowflake