Skip to content

Commit f6c3453

Browse files
authored
12700 update dynamodb readme (#368)
* update README with current DynamoDB functionality
1 parent 62720e1 commit f6c3453

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

iterate_dynamodb/README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,14 @@ First of all, you must connect your Tinybird Workspace with your Git repository
44

55
### Create a DynamoDB Data Source
66

7-
- Create the DynamoDB Connection in your main Tinybird Workspace using Tinybird CLI, as explain in the [iteration documentation](https://www.tinybird.co/docs/ingest/dynamodb). Connections reside always in the main Branch.
7+
- Create the DynamoDB Connection in your main Tinybird Workspace using Tinybird CLI, as explained in the [iteration section](https://www.tinybird.co/docs/ingest/dynamodb). Connections reside always in the main Tinybird Branch.
88
- Create a new git branch
9-
- Create a new DynamoDB .datasource data file in the branch, as in the example PR. You shouldn't need fixtures as the Data Source will be populated from the Connection, but you can add fixtures and/or tests if needed.
10-
- For information about DynamoDB options read the [connector documentation](https://www.tinybird.co/docs/ingest/dynamodb)
9+
- Create a new DynamoDB .datasource Datafile in the git branch, as in the example PR. You can use fixtures and tests as the Data Source won't be populated from the Connection.
10+
- For information about DynamoDB options and recommendations read the [connector documentation](https://www.tinybird.co/docs/ingest/dynamodb)
1111
- Commit your code and create a new PR/MR from the branch to `main`
1212
- Wait for CI to finish.
13-
- Check that everything is working as expected in the temporary Tinybird Branch, CI will automatically create it and name it like `tmp_ci_{PRid}`).
14-
- You can travel to this Branch through UI and check that the Data Source is working
15-
- You'll need wait for the initial synchronization job to end, check the job status in the dashboard and the logs in the Data Source `log` tab
16-
- You can add/update/delete items in your DynamoDB table and check that the changes reproduce in the Data Source.
13+
- Check that everything is created as expected in the temporary Tinybird Branch, CI will automatically create it and name it like `tmp_ci_{PRid}`).
14+
- You can travel to this Branch through UI and check that the Data Source is created and Schema is correct.
1715
- If everything is fine, merge and wait for CD. Now you should have your Data Source in the main Workspace, using the Connection, and the temporary CI Branch will be deleted.
1816

1917
[Example Pull Request](https://github.com/tinybirdco/use-case-examples/pull/364)
@@ -22,24 +20,22 @@ First of all, you must connect your Tinybird Workspace with your Git repository
2220
### Update DynamoDB Data Source with a new column, with same Connection
2321

2422
- Create another git branch
25-
- Add the new column to the schema and query
23+
- Add the new column to the schema and query in the Datafile
2624
- Commit your code and create a new PR from the branch to `main`
2725
- Wait for CI to finish.
28-
- Check that everything is working as expected in the temporary branch, CI will automatically create it and name it like `tmp_ci_{PRid}`).
29-
- You can travel to the Branch through UI and check that the Data Source has the changes applied
30-
- You can add/update/delete items in your DynamoDB table and check that the changes reproduce in the Data Source.
26+
- Check that everything is updated as expected in the temporary branch, CI will automatically create it and name it like `tmp_ci_{PRid}`).
3127
- Merge and wait for CD. Now you should have your Data Source updated in the main Workspace, using the Connection, and the temporary CI Branch will be deleted.
3228

3329
[Example Pull Request](https://github.com/tinybirdco/use-case-examples/pull/365)
3430

3531
### Delete a DynamoDB Data Source
3632

3733
- Create another git branch
38-
- Remove the .datasource data file
34+
- Remove the .datasource Datafile
3935
- If the Data Source has dependencies they must be deleted too, to the workflow to work
4036
- Commit your code and create a new PR from the branch to `main`
4137
- Wait for CI to finish.
42-
- Check that everything is working as expected in the temporary Branch, CI will automatically create it and name it like `tmp_ci_{PRid}`).
43-
- Merge and wait for CD. Now you should have your Data Source deleted in the main Workspace, using the Connection, and the temporary CI Branch will be deleted.
38+
- Check that the Data Source has been deleted in the temporary Branch, CI will automatically create it and name it like `tmp_ci_{PRid}`).
39+
- Merge and wait for CD. Now you should have your Data Source deleted in the main Workspace, and the temporary CI Branch will be deleted.
4440
- If the Connection isn't being used by any other Data Sources, you can remove it directly using CLI.
4541

0 commit comments

Comments
 (0)