Export from Shopify to ClickHouse

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

The CloudQuery Shopify plugin allows you to sync data from Shopify 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 Shopify source plugin

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

Configuration

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

kind: source
# Common source-plugin configuration
spec:
  name: shopify
  path: cloudquery/shopify
  version: "v3.1.4"
  tables: ["*"]
  destinations: ["clickhouse"]
  # Shopify specific configuration
  spec:
    backend_options:
      table_name: "test_state_table"
      connection: "@@plugins.clickhouse.connection"
    api_key: "<YOUR_API_KEY_HERE>"
    api_secret: "<YOUR_API_SECRET_HERE>"
    shop_url: "https://<YOUR_SHOP>.myshopify.com"
#    concurrency: 1000

The Shopify plugin supports incremental syncing for event data. This means that only new events will be fetched from Shopify 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 Shopify Plugin ↗ page in the docs.

Authentication

In order to fetch information from Shopify, cloudquery needs to be authenticated. Either an API key and password (in the case of basic custom/private apps) or an access token (for OAuth apps) is required for authentication.

Refer to the Shopify Help Center article on Custom apps (opens in a new tab) and create a custom app. Follow Get the API credentials for a custom app section to get the credentials for Admin API and put them in your plugin configuration as api_key and api_secret.

If you have a large or busy store, API key/secret type credentials might not be enough due to the heavy rate limiting. In this case, you can use OAuth in your custom app to get an access token which allow many more requests a second. To use that token in your plugin configuration instead, just set it in access_token and remove api_key and api_secret sections. For more information, refer to Shopify.dev (opens in a new tab) on the subject.

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.4.0"
  write_mode: "append"
  spec:
    connection_string: "clickhouse://${CH_USER}:${CH_PASSWORD}@localhost:9000/${CH_DATABASE}"
    # Optional parameters
    # cluster: ""
    # ca_cert: ""
    # engine:
    #   name: MergeTree
    #   parameters: []
    #
    # batch_size: 10000
    # batch_size_bytes: 5242880 # 5 MiB
    # batch_timeout: 20s

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 shopify.yaml clickhouse.yaml

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

Export from Shopify to ClickHouse

Step 1. Install the CloudQuery CLI

Step 2. Configure the Shopify source plugin

Configuration

Authentication

Step 3. Configure the ClickHouse destination plugin

Configuration

Step 4. Start the Sync

Further Reading