Skip to content

Updating public docs with Reverse-ETL DB2 source setup guide #7664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from

Conversation

gilsegment
Copy link
Contributor

@gilsegment gilsegment commented Jun 6, 2025

Ticket

https://twilio-engineering.atlassian.net/browse/RETL-1858

Proposed changes

Adding new DB2 source to Reverse-ETL

Merge timing

TBD

@gilsegment gilsegment marked this pull request as ready for review June 6, 2025 21:00
@gilsegment gilsegment requested a review from a team as a code owner June 6, 2025 21:00
@gilsegment gilsegment requested a review from pwseg June 6, 2025 21:00
Copy link

netlify bot commented Jun 6, 2025

Deploy Preview for segment-docs ready!

Name Link
🔨 Latest commit 9f68558
🔍 Latest deploy log https://app.netlify.com/projects/segment-docs/deploys/6846e9ebc1a09e0008d45080
😎 Deploy Preview https://deploy-preview-7664--segment-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@gilsegment gilsegment changed the title Db2 source setup Updating public docs with Reverse-ETL DB2 source setup guide Jun 9, 2025
prayansh
prayansh previously approved these changes Jun 10, 2025
@prayansh prayansh requested a review from Copilot June 10, 2025 16:10
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds official documentation for configuring DB2 as a Reverse ETL source.

  • Adds a link to the new DB2 setup guide in the main Reverse ETL setup page
  • Introduces db2-setup.md with required permissions and step-by-step instructions
  • Updates the sidebar navigation to include the DB2 guide

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
src/connections/reverse-etl/setup.md Added a link to the DB2 Reverse ETL setup guide
src/connections/reverse-etl/reverse-etl-source-setup-guides/db2-setup.md Created the DB2 Reverse ETL setup guide
src/_data/sidenav/main.yml Inserted the DB2 Reverse ETL entry in the sidebar
Comments suppressed due to low confidence (2)

src/connections/reverse-etl/reverse-etl-source-setup-guides/db2-setup.md:29

  • The empty info directive lacks a title and may not render correctly; either supply a descriptive title or remove the empty info block.
> info ""

src/connections/reverse-etl/reverse-etl-source-setup-guides/db2-setup.md:5

  • [nitpick] Consider adding the supported DB2 server versions or required driver versions at the top of this guide to help users verify compatibility.
Set up DB2 as your Reverse ETL source.


## Required permissions

In order to run a Reverse ETL sync in a DB2 warehouse, Segment needs the following permissions:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In order to run a Reverse ETL sync in a DB2 warehouse, Segment needs the following permissions:
In order to run a Reverse ETL sync in your Db2 warehouse, you'll create a user with the following permissions:


In order to run a Reverse ETL sync in a DB2 warehouse, Segment needs the following permissions:

* **Permission to read from all tables used in the model** (i.e., the tables included in your SELECT query).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **Permission to read from all tables used in the model** (i.e., the tables included in your SELECT query).
* **Permission to read from all tables used in the model**: The user must be able to access all tables included in your SELECT query.

2. Open [your Segment workspace](https://app.segment.com/workspaces){:target="_blank"}.
3. Navigate to **Connections > Sources** then select the **Reverse ETL** tab.
4. Click **+ Add Reverse ETL source**.
5. Select **DB2** and click **Add Source**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this DB2 or Db2 in the UI?

Suggested change
5. Select **DB2** and click **Add Source**.
5. Select **Db2** and click **Add Source**.

3. Navigate to **Connections > Sources** then select the **Reverse ETL** tab.
4. Click **+ Add Reverse ETL source**.
5. Select **DB2** and click **Add Source**.
6. Fill in the DB2 connection settings:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
6. Fill in the DB2 connection settings:
6. Fill in the following Db2 connection settings:

7. Click **Test Connection** to validate the setup.
8. If the connection is successful, click **Add source**.

After successfully adding your DB2 source, [add a model](/docs/connections/reverse-etl/setup/#step-2-add-a-model) and follow the rest of the steps in the Reverse ETL setup guide.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After successfully adding your DB2 source, [add a model](/docs/connections/reverse-etl/setup/#step-2-add-a-model) and follow the rest of the steps in the Reverse ETL setup guide.
After successfully adding your Db2 source, [add a model](/docs/connections/reverse-etl/setup/#step-2-add-a-model) and follow the rest of the steps in the Reverse ETL setup guide.

@@ -28,6 +28,7 @@ To add your warehouse as a source:
- [Azure Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/azure-setup)
- [BigQuery Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/bigquery-setup)
- [Databricks Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/databricks-setup)
- [DB2 Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/db2-setup)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [DB2 Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/db2-setup)
- [Db2 Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/db2-setup)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants