Export from Mixpanel to ClickHouse

CloudQuery is an open-source data integration platform that allows you to export data from any source to any destination.

The CloudQuery Mixpanel plugin allows you to sync data from Mixpanel to any destination, including ClickHouse. It's free, open source, requires no account, and takes only minutes to get started.

Ready? Let's dive right in!

Step 1. Install the CloudQuery CLI

The CloudQuery CLI is a command-line tool that runs the sync. It supports MacOS, Linux and Windows.

brew install cloudquery/tap/cloudquery

Step 2. Configure the Mixpanel source plugin

Create a configuration file for the Mixpanel plugin and set up authentication.

Configuration

Create a file called mixpanel.yaml and add the following contents:

kind: source
# Common source-plugin configuration
spec:
  name: mixpanel
  path: cloudquery/mixpanel
  version: "v1.3.0"
  tables: ["*"]
  destinations: ["clickhouse"]
  backend: local
  # Mixpanel specific configuration
  spec:
    username: "<YOUR_SERVICE_ACCOUNT_USER_HERE>"
    secret: "<YOUR_SERVICE_ACCOUNT_SECRET_HERE>"
    project_id: 12345 # Your project ID

The Mixpanel plugin supports incremental syncing for event data. This means that only new events will be fetched from Mixpanel and loaded into your destination. This is done by keeping track of the last event fetched and only fetching events that has been created since then. To enable this, backend option must be set in the spec (as shown in the example). This is documented in the Managing Incremental Tables section.

Fine-tune this configuration to match your needs. For more information, see the Mixpanel Plugin ↗ page in the docs.

Authentication

In order to fetch information from Mixpanel, cloudquery needs to be authenticated using a Service Account (opens in a new tab) from your Mixpanel account. You can view and manage your Service Accounts in Mixpanel Organization Settings > Service Accounts.

Step 3. Configure the ClickHouse destination plugin

Create a configuration file for the ClickHouse plugin and set up authentication.

Configuration

Create a file called clickhouse.yaml and add the following contents:

kind: destination
spec:
  name: "clickhouse"
  registry: "github"
  path: "cloudquery/clickhouse"
  version: "v3.1.1"
  write_mode: "append"
  spec:
    connection_string: "clickhouse://${CH_USER}:${CH_PASSWORD}@localhost:9000/${CH_DATABASE}"

This example configures a ClickHouse instance, located at localhost:9000. It expects CH_USER, CH_PASSWORD and CH_DATABASE environment variables to be set. The (top level) spec section is described in the Destination Spec Reference.

Fine-tune this configuration to match your needs. For more information, see the ClickHouse Plugin ↗ page in the docs.

Step 4. Start the Sync

Run the following command in your terminal to start the sync

cloudquery sync mixpanel.yaml clickhouse.yaml

And away we go! 🚀 The sync will run until completion, fetching all selected tables from Mixpanel. Any errors will be logged to a file called cloudquery.log.

Export from Mixpanel to ClickHouse

Step 1. Install the CloudQuery CLI

Step 2. Configure the Mixpanel source plugin

Configuration

Authentication

Step 3. Configure the ClickHouse destination plugin

Configuration

Step 4. Start the Sync

Further Reading