Skip to content
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

Update Linked Events docs #5507

Merged
merged 4 commits into from
Oct 10, 2023
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
23 changes: 12 additions & 11 deletions src/unify/linked-profiles/linked-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,15 @@ Before getting started with Linked Events, you'll need:

The following Segment access [roles](/docs/segment-app/iam/roles/) apply to Linked Events:

**Entities Admin Access**: Full CRUD (create, read, access, and delete) access to all Entities within a workspace. You can also grant or revoke user permissions.
**Entities Admin Access**: Entities Admins have the ability to view and edit entity models and connection details.

**Entities Read-only Access**: Read-only access to all Entities models and destinations in a workspace.
**Entities Read-only Access**: Entities Read-only users have the ability to view entity models.

For Linked Events, you need the following roles:
- `Workspace Owner`
- `Entities Admin`
- `Source Admin`
To create models and enrich events in destinations, you need the following roles:
- `Workspace Owner` and `Entities Admin`

To use Connections with Linked Events:
- `Workspace Owner`
- `Unify Read-only or Admin`
OR:
- `Unify and Engage Admin`
- `Entities Admin`
- `Source Admin`

Expand All @@ -65,13 +62,17 @@ To get started, you'll need to connect a data warehouse. Linked Events supports

### Schema

For Linked Events, the sync destination is an internal Segment data store. To track the data you send to Segment, you can view deltas/diffs in tables within a single schema Segment creates called `_segment_reverse_etl`.
Linked Events uses Reverse ETL to compute the incremental changes to your data directly within your data warehouse. The Unique Identifier column detects data changes, such as new, updated, and deleted records.

For Segment to compute data changes in your warehouse, Segment requires both read and write permissions to the warehouse schema table. At a high level, the extract process requires read permissions for the query being executed. Segment tracks changes to the query results through tables that Segment manages in a dedicated schema (for example, `_segment_reverse_etl`), which requires some write permissions.

You can choose which database within your warehouse this data lives in.
> warning ""
> Only sync what you need for enrichment. There may be cost implications to having Segment query your warehouse tables.

> info ""
> Linked Events syncs data from your warehouse approximately once every hour.


### Supported data warehouses

The table below shows the data warehouses Linked Events supports. View the Segment docs for your warehouse, then carry out the corresponding steps.
Expand Down
8 changes: 4 additions & 4 deletions src/unify/linked-profiles/setup-guides/snowflake-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,18 @@ Enter and run the code below to create a virtual warehouse. Linked Events needs

## Create a new role

Enter and run the code below to create specific roles for Linked Events. All Snowflake access is specified through roles, which are then assigned to the user you’ll create later.
Enter and run the code below to create specific roles for Linked Profiles. All Snowflake access is specified through roles, which are then assigned to the user you’ll create later.

```ts
-- create role
GRANT ROLE segment_entities;
CREATE ROLE segment_entities;

-- warehouse access
GRANT USAGE ON WAREHOUSE segment_entities TO ROLE segment_entities;

-- database access
GRANT USAGE ON DATABASE segment_entities TO ROLE segment_entities;
GRANT CREATE SCHEMA ON DATABASE segment_entities TO ROLE segment_entities;
GRANT USAGE ON DATABASE <database-name> TO ROLE segment_entities;
GRANT CREATE SCHEMA ON DATABASE <database-name> TO ROLE segment_entities;
```

## Create a new user
Expand Down