# Heroku (v1)

Information note **Heroku extraction is supported by Stitch**   
This integration is powered by [Singer's](https://www.singer.io/) Postgres tap and certified by Stitch. [Check out and contribute to the repo on GitHub](https://github.com/singer-io/tap-postgres).  
  
For support, contact [Support](https://community.qlik.com/t5/Support/ct-p/qlikSupport).

Information note

**Important:** **Heroku as an input data source**

This article describes how to connect Heroku **as an input data source.**

If you want to connect a Heroku instance as a **destination**, refer to the [Connecting a Heroku Destination guide](https://help.qlik.com/en-US/stitch/destinations/postgresql/connecting-a-heroku-postgres-data-warehouse-to-stitch).

## Heroku feature snapshot

A high-level look at Stitch's Heroku (v1) integration, including release status, useful links, and the features supported in Stitch.

| **STITCH** |  |  |  |
| --- | --- | --- | --- |
| **[Release status](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on July 31, 2018 | **Supported by**<br><br>the Info icon<br><br>Indicates if the integration is supported by Stitch or the Singer community. | [Stitch](https://community.qlik.com/t5/Support/ct-p/qlikSupport) |
| **Stitch plan**<br><br>the Info icon<br><br>The type of Stitch plan required to use the integration. | Standard | **Supported versions**<br><br>the Info icon<br><br>Indicates if the integration is supported by Stitch or the Singer community. | 9.3+ |
| **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**<br><br>the Info icon<br><br>Indicates if the integration is available as a source in Stitch Connect. | the Success icon<br><br>This version of the integration is available via the API.<br><br><br>Available | **Singer GitHub repository** | [singer-io/tap-postgres](https://github.com/singer-io/tap-postgres) |
| **CONNECTION METHODS** |  |  |  |
| **SSH connections**<br><br>the Info icon<br><br>Indicates if SSH tunnels are supported for connecting this database to Stitch. | the Remove icon<br><br>This feature is not supported for this version of the integration.<br><br><br>Unsupported | **SSL connections**<br><br>the Info icon<br><br>Indicates if SSL connections are supported for connecting this database to Stitch. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **REPLICATION SETTINGS** |  |  |  |
| **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**<br><br>the Info icon<br><br>A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**<br><br>the Info icon<br><br>A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **Table-level reset**<br><br>the Info icon<br><br>Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**<br><br>the Info icon<br><br>Indicates if Replication Methods can be defined by you for tables in the integration. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **REPLICATION METHODS** |  |  |  |
| **[Log-based Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/log-based-incremental)**<br><br>the Info icon<br><br>Log-based Incremental Replication is a replication method in which Stitch identifies modifications to records - including inserts, updates, and deletes - using a database's binary log files. | the Remove icon<br><br>This feature is not supported for this version of the integration.<br><br><br>Unsupported | **[Key-based Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/key-based-incremental)**<br><br>the Info icon<br><br>Key-based Incremental Replication is a replication method in which Stitch identifies new and updated data using a column called a Replication Key. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **[Full Table Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/full-table)**<br><br>the Info icon<br><br>Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |  |  |
| **DATA SELECTION** |  |  |  |
| **Table selection**<br><br>the Info icon<br><br>The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **Column selection**<br><br>the Info icon<br><br>The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **[View replication](https://help.qlik.com/en-US/stitch/replication/replicating-database-views)**<br><br>the Info icon<br><br>Indicates if Stitch supports replicating views from this database integration. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **Select all**<br><br>the Info icon<br><br>Indicates if the integration supports selecting all available tables and columns. | the Remove icon<br><br>Heroku integrations don't currently support a default Replication Method, which is required to use the Select All feature. The default Replication Method setting is only available for integrations that support Log-based Incremental Replication.<br><br><br>Unsupported |
| **TRANSPARENCY** |  |  |  |
| **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**<br><br>the Info icon<br><br>Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**<br><br>the Info icon<br><br>Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |

## Connecting Heroku

### Step 1: Locate the database connection details in Heroku

First, you’ll retrieve the Heroku database’s connection details. This info will be used to connect Stitch to your Heroku database.

1. [Sign into your Heroku account](https://id.heroku.com/login).

2. Click the app that contains the database you want to connect to Stitch. This will open the app’s dashboard page.

3. Locate the **Installed add-ons** section and click the **Heroku Postgres** database you want to connect to Stitch. This will open the database’s dashboard page.

4. Click the **Settings** tab.

5. Click the **View Credentials…** button. This will display the database credentials:

   ![Heroku Connection Settings](https://help.qlik.com/en-US/stitch/images/destinations/heroku-connection-settings.png)Heroku Connection SettingsHeroku Connection Settings

Leave this page open for now - you’ll need it to wrap things up.

### Step 2: Connect Stitch

In this step, you’ll complete the setup by entering the database’s connection details and defining replication settings in Stitch.

#### Step 2.1: Define the database connection details in Stitch

1. If you aren’t signed into your Stitch account, [sign in now](https://app.stitchdata.com/).

2. On the Stitch Dashboard page, click the **Add Integration** button.

3. Locate and click the **Heroku** icon.

4. Fill in the fields as follows:

   * **Integration Name**: Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

     For example, the name “Stitch Heroku” would create a schema called `stitch_heroku` in the destination. **Note:** The schema name cannot be changed after the integration is saved.

   * **Host (Endpoint)**: Paste the **Host** address from the Heroku Database Settings page into this field.

   * **Port**: Enter the port used by the Heroku instance. The default is `5432`.

   * **Username**: Paste the **User** name from the Heroku Database Settings page into this field.

   * **Password**: Paste the **Password** from the Heroku Database Settings page into this field.

   * **\*\*: Paste the \*\*Database** name from the Heroku Database Settings page into this field.

   * **Include PostgreSQL schema names in destination tables**: Checking this setting will include schema names from the source database in the destination table name - for example: `<source_schema_name>__<table_name>`.

     Stitch loads all selected replicated tables to a single schema, preserving only the table name. If two tables canonicalize to the same name - even if they’re in different source databases or schemas - name collision errors can arise. Checking this setting can prevent these issues.

     **Note**: This setting can not be changed after the integration is saved. Additionally, this setting may create table names that exceed your destination’s limits. For more info, refer to the [Database Integration Table Name Collisions guide](https://help.qlik.com/en-US/stitch/troubleshooting/data-discrepancies/database-integration-table-name-collisions).

#### Step 2.2: Define the SSL connection details

Because Heroku enforces SSL by default, you don’t need to take any further action to encrypt your data. Skip to the next step.

#### Step 2.3: Create a replication schedule

Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information.

In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Heroku integrations support the following replication scheduling methods:

* [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency)

* [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)

* [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage.

#### Step 2.4: Save the integration

When finished, click **Check and Save**.

Stitch will perform a connection test to the Heroku database; if successful, a *Success!* message will display at the top of the screen. **Note**: This test may take a few minutes to complete.

### Step 3: Select data to replicate

Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements).

The last step is to select the tables and columns you want to replicate. [](https://help.qlik.com/en-US/stitch/integrations/databases/heroku/v1#schema)

**Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts.

* Selection options
* Individual tables and columns
* Database views

For Heroku integrations, you can select:

1. **Individual tables and columns**

2. **Database views**

Click the tabs to view instructions for each selection method.

1. In the Integration Details page, click the **Tables to Replicate** tab.

2. Locate a table you want to replicate.

3. Click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate.

4. After you set a table to replicate, a page with the table’s columns will display. De-select columns if needed.

5. Next, you’ll define the table’s Replication Method. Click the **Table Settings** button.

6. In the **Table Settings** page:

   1. Define the table’s **Replication Method**.

   2. If using [Key-based Incremental Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/key-based-incremental), select a [Replication Key](https://help.qlik.com/en-US/stitch/replication/replication-keys).

   3. When finished, click **Update Settings**.

7. Repeat this process for every table you want to replicate.

8. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections.

Setting a database view to replicate is similar to selecting a table, with a few differences. Refer to the [Replicating Database Views guide](https://help.qlik.com/en-US/stitch/replication/replicating-database-views) for detailed instructions.

At a high level, you’ll need to complete the following to select a database view:

1. [Verify the database user’s permissions](https://help.qlik.com/en-US/stitch/replication/replicating-database-views#step--verify-database-user-permissions)
2. [Select the view](https://help.qlik.com/en-US/stitch/replication/replicating-database-views#step--select-view-in-stitch)
3. **Optional**: [Define the view’s Primary Key](https://help.qlik.com/en-US/stitch/replication/replicating-database-views#step--define-view-primary-key)
4. [Define the view’s Replication Method](https://help.qlik.com/en-US/stitch/replication/replicating-database-views#step--define-view-replication-method)
5. [Save the view’s settings](https://help.qlik.com/en-US/stitch/replication/replicating-database-views#step--save-view-settings)

### Initial and historical replication jobs

After you finish setting up Heroku, its **Sync Status** may show as **Pending** on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a **Pending** status indicates that Stitch is in the process of scheduling the initial replication job for the integration. **This may take some time to complete.**

Information note

**Initial replication jobs with Anchor Scheduling**

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) documentation for more information.

#### Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage.