Skip to content

Commit 0e82b99

Browse files
committed
Warehouse doc improvements
1 parent 90cf4d5 commit 0e82b99

File tree

4 files changed

+26
-3
lines changed

4 files changed

+26
-3
lines changed

src/_includes/content/how-a-sync-works.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
When Segment loads data into your warehouse, each sync goes through the following steps:
2-
1. **Ping:** Segment servers connect to your warehouse. For Redshift warehouses, Segment also runs a query to determine how many slices a cluster has. <br/>Common reasons a sync would fail at this step include a blocked VPN/IP, a warehouse that isn't publicly available, and user permission/credential errors.
2+
1. **Ping:** Segment servers connect to your warehouse. For Redshift warehouses, Segment also runs a query to determine how many slices a cluster has.
33
2. **Scan:** Segment finds new events in AWS S3 and updated objects in Dynamo.
44
3. **Download:** Segment pulls the events and objects into a staging area.
55
4. **Process:** The raw Segment event and object archive files are transformed into database-specific formats. The [warehouse schema](/docs/connections/storage/warehouses/schema/) is also defined in this step.

src/connections/storage/warehouses/faq.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,31 @@ After a source is created, you can enable or disable a warehouse sync within the
9595

9696
## Can I be notified on warehouse sync failures?
9797

98+
You will recieve notifications in the Segment app for warehouse sync failiures.
99+
100+
To view the notifications:
101+
1.
102+
98103
## How is my data formatted in my warehouse?
99104

105+
Data in your warehouse is formatted into **schemas**, which involve a detailed description of database elements (tables, views, indexes, synonyms, etc.) and the relationships that exist between elements. Segment's schemas use the following template: <br/>`<source>.<collection>.<property>`, for example, `segment-engineering.tracks.userId`, where Source refers to the source or project name (segment-engineering), collection refers to the event (tracks), and the property refers to the data being collected (userId). For more information about Warehouse Schemas, see the [Warehouse Schemas](/docs/connections/storage/warehouses/schema) page.
106+
100107
## If my syncs fail and get fixed, will I need to ask for a backfill?
101108

102-
Yes! If your syncs fail, you will need to ask for a backfill, as this is a manual process.
109+
If your syncs fail, you will need to reach out to [Segment Support](https://segment.com/help/) to ask for a backfill. Be sure to include the following information in your request:
110+
- The warehouse that requires the backfill
111+
- What sources you need information from
112+
- The timeframe of data that requires a backfill
103113

104114
## Can I change my schema names once they've been created?
115+
116+
If you'd like to change the name of your schema:
117+
118+
1. Open the Segment app.
119+
2. Select your warehouse from the Sources tab.
120+
3. On the source's overview page, select "Settings."
121+
4. Under the "Enable Source" section, disable your warehouse and click "Save Changes."
122+
5. Select the "SQL Settings" tab.
123+
6. Update the "Schema Name" field with your intended schema name and click "Save Changes."
124+
7. On the source's overview page, select "Basic."
125+
8. Under the "Enable Source" section, disable your warehouse and click "Save Changes."

src/connections/storage/warehouses/schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Schemas of warehouse data are organized into the following template: <br/>
88
`<source>.<collection>.<property>` eg. `segment-engineering.tracks.userId`, where Source refers to the source or project name (segment-engineering), collection refers to the event (tracks), and the property refers to the data being collected (userId).
99

1010
> note "Data warehouse column creation"
11-
> **Note:** Segment creates tables for each of your custom events, and columns for each event's custom properties. Segment does not allow unbounded `event` or `property` spaces in your data. Instead of recording events like "Ordered Product 15", use a single property of "Product Number" or similar.
11+
> **Note:** Segment creates tables for each of your custom events in your warehouse, with columns for each event's custom properties. Segment does not allow unbounded `event` or `property` spaces in your data. Instead of recording events like "Ordered Product 15", use a single property of "Product Number" or similar.
1212
1313
## Warehouse tables
1414

src/connections/storage/warehouses/warehouse-syncs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Warehouses sync with all data coming from your source.
1515

1616
## Sync Frequency
1717

18+
Your plan determines how frequently data is synced to your warehouse.
19+
1820
| Plan | Frequency |
1921
| -------- | ----------- |
2022
| Free | Once a day |

0 commit comments

Comments
 (0)