Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/web-console-docs/warehouse-native/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 8,
"collapsible": true,
"collapsed": true,
"label": "Warehouse Native"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 2,
"collapsible": true,
"collapsed": true,
"label": "Connect Your Warehouse"
}
78 changes: 78 additions & 0 deletions docs/web-console-docs/warehouse-native/connect/bigquery.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
sidebar_position: 1
title: "BigQuery"
description: "Connect ABsmartly to Google BigQuery."
---

import Image from "../../../../src/components/Image";

# Connect to BigQuery

## Google Cloud prerequisites

Before connecting ABsmartly to BigQuery, you need a Google Cloud service account with the right permissions. The steps below walk through creating one from scratch.

### 1. Enable the BigQuery API

In the [Google Cloud Console](https://console.cloud.google.com), open the project that contains your BigQuery dataset and navigate to **APIs & Services → Library**. Search for **BigQuery API** and enable it if it isn't already.

### 2. Create a service account

1. Go to **IAM & Admin → Service Accounts** and click **Create service account**.
2. Give it a name (e.g., `absmartly-warehouse`) and an optional description, then click **Create and continue**.
3. Skip the optional step of granting users access to the service account, then click **Done**.

### 3. Grant permissions

ABsmartly needs two roles:

| Role | Where to grant it | Why |
|---|---|---|
| **BigQuery Data Viewer** (`roles/bigquery.dataViewer`) | On the dataset | Allows reading your experiment tables |
| **BigQuery Job User** (`roles/bigquery.jobUser`) | On the project | Allows running queries |

:::tip
If you've enabled **"Forward native events to this table"** on your exposures or goals table, ABsmartly also needs to write data back. In that case, replace **BigQuery Data Viewer** with **BigQuery Data Editor** (`roles/bigquery.dataEditor`) on the dataset.
:::

To grant dataset-level access, open **BigQuery Studio**, select the dataset, click **Sharing → Permissions**, and add the service account email with the appropriate role. To grant the project-level Job User role, go to **IAM & Admin → IAM**, click **Grant access**, paste the service account email, and assign `roles/bigquery.jobUser`.

### 4. Create and download the service account key

1. In **IAM & Admin → Service Accounts**, click the service account you just created.
2. Go to the **Keys** tab and click **Add key → Create new key**.
3. Select **JSON** and click **Create**. A `.json` file will download automatically.

This is the file you'll paste into the **Service Account Credentials** field in ABsmartly.

---

## Add the data source in ABsmartly

Navigate to **Settings → Data Sources** and click **Add data source**. Give your data source a **name** and optional **description**, then select **BigQuery** from the **Database type** dropdown.

<Image maxWidth="40rem" centered img="warehouse-native/datasource-bigquery.png" alt="BigQuery data source configuration" />

## Connection credentials

| Field | Description |
|---|---|
| **Project ID** | Your GCP project ID |
| **Dataset ID** | The BigQuery dataset containing your experiment tables |
| **Service Account Credentials (JSON)** | A GCP service account key in JSON format. You can paste the JSON directly into the editor or use the **Upload JSON file** button. This field is required. |

:::tip
Create a dedicated service account with read-only access to the relevant dataset. Don't reuse a service account that has broader permissions than necessary.
:::

## Test the connection

Click **Test connection** at the bottom of the form. If everything is configured correctly, you'll see a green **"Connected"** confirmation.

<Image maxWidth="40rem" centered img="warehouse-native/datasource-bigquery-connected.png" alt="Successful BigQuery connection test" />

:::note
If the test fails, double-check your credentials and make sure ABsmartly's IP addresses are allowed through your BigQuery project's network policies.
:::

Once connected, save the data source and proceed to [map your tables](../get-started#step-2-map-your-tables).
33 changes: 33 additions & 0 deletions docs/web-console-docs/warehouse-native/connect/clickhouse.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
sidebar_position: 3
title: "ClickHouse"
description: "Connect ABsmartly to ClickHouse."
---

import Image from "../../../../src/components/Image";

# Connect to ClickHouse

Navigate to **Settings → Data Sources** and click **Add data source**. Give your data source a **name** and optional **description**, then select **ClickHouse** from the **Database type** dropdown.

<Image maxWidth="40rem" centered img="warehouse-native/datasource-clickhouse.png" alt="ClickHouse data source configuration" />

## Connection credentials

| Field | Description |
|---|---|
| **Host** | The ClickHouse server hostname |
| **Port** | Connection port (default: `8123`) |
| **Database** | The database containing your experiment tables |
| **Username** | Database username |
| **Password** | Database password |

## Test the connection

Click **Test connection** at the bottom of the form. If everything is configured correctly, you'll see a green **"Connected"** confirmation.

:::note
If the test fails, double-check your credentials and make sure ABsmartly's IP addresses are allowed through your ClickHouse firewall or network policies.
:::

Once connected, save the data source and proceed to [map your tables](../get-started#step-2-map-your-tables).
34 changes: 34 additions & 0 deletions docs/web-console-docs/warehouse-native/connect/databricks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
sidebar_position: 5
title: "Databricks"
description: "Connect ABsmartly to Databricks."
---

import Image from "../../../../src/components/Image";

# Connect to Databricks

Navigate to **Settings → Data Sources** and click **Add data source**. Give your data source a **name** and optional **description**, then select **Databricks** from the **Database type** dropdown.

<Image maxWidth="40rem" centered img="warehouse-native/datasource-databricks.png" alt="Databricks data source configuration" />

## Connection credentials

| Field | Description |
|---|---|
| **Server Hostname** | The Databricks server hostname |
| **Port** _(optional)_ | Connection port (default: `443`) |
| **HTTP Path** | The HTTP path to your SQL warehouse (e.g., `/sql/1.0/warehouses/xxx`) |
| **Catalog** | The Unity Catalog name |
| **Schema** _(optional)_ | The schema to use. Defaults to `default` if not specified |
| **Access Token** | A Databricks personal access token |

## Test the connection

Click **Test connection** at the bottom of the form. If everything is configured correctly, you'll see a green **"Connected"** confirmation.

:::note
If the test fails, double-check your credentials and make sure ABsmartly's IP addresses are allowed through your Databricks workspace network settings.
:::

Once connected, save the data source and proceed to [map your tables](../get-started#step-2-map-your-tables).
34 changes: 34 additions & 0 deletions docs/web-console-docs/warehouse-native/connect/redshift.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
sidebar_position: 4
title: "Redshift"
description: "Connect ABsmartly to Amazon Redshift."
---

import Image from "../../../../src/components/Image";

# Connect to Redshift

Navigate to **Settings → Data Sources** and click **Add data source**. Give your data source a **name** and optional **description**, then select **Redshift** from the **Database type** dropdown.

<Image maxWidth="40rem" centered img="warehouse-native/datasource-redshift.png" alt="Redshift data source configuration" />

## Connection credentials

| Field | Description |
|---|---|
| **Host** | The Redshift cluster endpoint |
| **Port** | Connection port (default: `5439`) |
| **Database** | The database containing your experiment tables |
| **Schema** _(optional)_ | The schema to use. Defaults to `public` if not specified |
| **Username** | Database username |
| **Password** | Database password |

## Test the connection

Click **Test connection** at the bottom of the form. If everything is configured correctly, you'll see a green **"Connected"** confirmation.

:::note
If the test fails, double-check your credentials and make sure ABsmartly's IP addresses are allowed through your Redshift cluster's security groups and VPC settings.
:::

Once connected, save the data source and proceed to [map your tables](../get-started#step-2-map-your-tables).
34 changes: 34 additions & 0 deletions docs/web-console-docs/warehouse-native/connect/snowflake.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
sidebar_position: 2
title: "Snowflake"
description: "Connect ABsmartly to Snowflake."
---

import Image from "../../../../src/components/Image";

# Connect to Snowflake

Navigate to **Settings → Data Sources** and click **Add data source**. Give your data source a **name** and optional **description**, then select **Snowflake** from the **Database type** dropdown.

<Image maxWidth="40rem" centered img="warehouse-native/datasource-snowflake.png" alt="Snowflake data source configuration" />

## Connection credentials

| Field | Description |
|---|---|
| **Account** | Your Snowflake account identifier (e.g., `xy12345.us-east-1`) |
| **Warehouse** | The compute warehouse to use for queries |
| **Database** | The database containing your experiment tables |
| **Schema** _(optional)_ | The schema to use. Defaults to `PUBLIC` if not specified |
| **Username** | Database username |
| **Password** | Database password |

## Test the connection

Click **Test connection** at the bottom of the form. If everything is configured correctly, you'll see a green **"Connected"** confirmation.

:::note
If the test fails, double-check your credentials and make sure ABsmartly's IP addresses are allowed through your Snowflake network policies.
:::

Once connected, save the data source and proceed to [map your tables](../get-started#step-2-map-your-tables).
Loading
Loading