Skip to content

Commit ec3b469

Browse files
VineethReddy02billy-the-fishatovpeko
authored
Update S3 connector docs with GA status (#4604)
* Update S3 connector docs with GA status * chore: small updates for language and to match ui. * last updates * chore: small edit. --------- Signed-off-by: Iain Cox <iain@timescale.com> Co-authored-by: billy-the-fish <iain@tigerdata.com> Co-authored-by: Iain Cox <iain@timescale.com> Co-authored-by: atovpeko <anastasiatverdokhleb@gmail.com>
1 parent 732c072 commit ec3b469

File tree

1 file changed

+32
-8
lines changed

1 file changed

+32
-8
lines changed

migrate/livesync-for-s3.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ tags: [recovery, logical backup, replication]
88
---
99

1010
import PrereqCloud from "versionContent/_partials/_prereqs-cloud-only.mdx";
11-
import EarlyAccessNoRelease from "versionContent/_partials/_early_access.mdx";
1211
import NotSupportedAzure from "versionContent/_partials/_not-supported-for-azure.mdx";
1312

1413
# Sync data from S3
@@ -22,7 +21,7 @@ You can use the $S3_CONNECTOR to synchronize your existing and new data. Here's
2221
* Sync data from an S3 bucket instance to a $SERVICE_LONG:
2322
- Use glob patterns to identify the objects to sync.
2423
- Watch an S3 bucket for new files and import them automatically. It runs on a configurable schedule and tracks processed files.
25-
- **Important**: The connector processes files in [lexicographical order][lex-order]. It uses the name of the last file processed as a marker and fetches only files later in the alphabet in subsequent queries. Files added with names earlier in the alphabet than the marker are skipped and never synced. For example, if you add the file Bob when the marker is at Elephant, Bob is never processed.
24+
- **Important**: the connector processes files in [lexicographical order][lex-order]. It uses the name of the last file processed as a marker and fetches only files later in the alphabet in subsequent queries. Files added with names earlier in the alphabet than the marker are skipped and never synced. For example, if you add the file Bob when the marker is at Elephant, Bob is never processed.
2625
- For large backlogs, check every minute until caught up.
2726

2827
* Sync data from multiple file formats:
@@ -37,6 +36,9 @@ The $S3_CONNECTOR continuously imports data from an Amazon S3 bucket into your d
3736

3837
**Note**: the connector currently only syncs existing and new files—it does not support updating or deleting records based on updates and deletes from S3 to tables in a $SERVICE_LONG.
3938

39+
The $S3_CONNECTOR is **Generally Available** and production ready. If you have any questions or feedback, join us in
40+
the [$COMPANY community][livesync-tiger-community].
41+
4042
## Prerequisites
4143

4244
<PrereqCloud />
@@ -129,31 +131,52 @@ To sync data from your S3 bucket to your $SERVICE_LONG using $CONSOLE:
129131

130132
1. Choose `Create a new table for your data` or `Ingest data to an existing table`.
131133
1. Choose the `Data type` for each column, then click `Continue`.
132-
1. Choose the interval. This can be a minute, an hour, or use a [cron expression][cron-expression].
134+
1. Configure the insert behavior when there is a conflict, then click `Continue`.
135+
1. Choose the polling interval. This can be a minute, an hour, or a [cron expression][cron-expression].
133136
1. Click `Start Connector`.
134137

135138
$CONSOLE starts the connection between the source database and the target $SERVICE_SHORT and displays the progress.
136139

137140
1. **Monitor synchronization**
138141

139-
1. To view the amount of data replicated, click `Connectors`. The diagram in `Connector data flow` gives you an overview of the connectors you have created, their status, and how much data has been replicated.
142+
The $S3_CONNECTOR provides comprehensive observability that gives you maximum visibility on connector performance.
143+
This includes summarized insights into connector state, quick actions, filtering and search to easily find specific
144+
files, and detailed lifecycle tracking as each file is imported.
145+
146+
1. To view the amount of data replicated, click `Connectors`.
147+
148+
The diagram in `CONNECTOR DATA FLOW` shows the connectors you have created, their status, and how much data has been replicated.
140149

141150
![$CLOUD_LONG connectors overview](https://assets.timescale.com/docs/images/tiger-on-azure/tiger-console-connector-overview.png)
142151

143152
1. To view file import statistics and logs, click `Connectors` > `Source connectors`, then select the name of your connector in the table.
144153

145154
![S3 connector stats](https://assets.timescale.com/docs/images/tiger-on-azure/tiger-console-s3-connector-import-details.png)
146-
155+
156+
The connector dashboard displays all imports at a glance. Use this page to:
157+
- **Search by file name**: find specific files from the list of imports
158+
- **Filter by status**: filter files based on their current status:
159+
- `All statuses`: all files
160+
- `Cancelled`: files where import is aborted
161+
- `Failure`: files where an error occurred during import
162+
- `In Queue`: files that are awaiting processing
163+
- `Paused`: files where processing is on hold
164+
- `Pending Retry`: files that are re-queued for processing
165+
- `Running`: files currently being imported
166+
- `Success`: files that have been imported
167+
- **Bulk retry**: retry importing all files with the `Error` status
168+
- **Lifecycle history**: view detailed information for all imports, and time spent in each status
169+
- **Refresh every minute**: enable auto-refresh
147170

148171
1. **Manage the connector**
149172

150173
1. To pause the connector, click `Connectors` > `Source connectors`. Open the three-dot menu next to your connector in the table, then click `Pause`.
151174

152-
![Edit S3 connector](https://assets.timescale.com/docs/images/tiger-on-azure/tiger-console-s3-connector-pause.png)
175+
![Edit S3 connector](https://assets.timescale.com/docs/images/tiger-on-azure/tiger-console-s3-connector-pause.png)
153176

154-
1. To edit the connector, click `Connectors` > `Source connectors`. Open the three-dot menu next to your connector in the table, then click `Edit` and scroll down to `Modify your Connector`. You must pause the connector before editing it.
177+
1. To edit the connector, click `Connectors` > `Source connectors`. Open the three-dot menu next to your connector in the table, then click `Edit`. Select `Connector settings`. You must pause the connector before editing it.
155178

156-
![S3 connector change config](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-console-s3-connector-edit.png)
179+
![S3 connector change config](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-console-s3-connector-edit.png)
157180

158181
1. To pause or delete the connector, click `Connectors` > `Source connectors`, then open the three-dot menu on the right and select an option. You must pause the connector before deleting it.
159182

@@ -180,3 +203,4 @@ $SERVICE_LONG in real time.
180203
[cron-expression]: https://en.wikipedia.org/wiki/Cron#Cron_expression
181204
[confused-deputy-problem]: https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html
182205
[connection-project-service-id]: /integrations/:currentVersion:/find-connection-details/#find-your-project-and-service-id
206+
[livesync-tiger-community]: https://app.slack.com/client/T4GT3N2JK/C086NU9EZ88

0 commit comments

Comments
 (0)