docs: write table definition in README

vvatanabe · Oct 19, 2023 · 4ecdbd8 · 4ecdbd8
1 parent 5efed05
commit 4ecdbd8
Showing 1 changed file with 19 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -9,4 +9,22 @@ This project is actively under development, but it is currently in version 0. Pl
 
 ## State Machine
 
-![State Machine](https://cacoo.com/diagrams/DjoA2pSKnhCghTYM-452C2.png) 
+![State Machine](https://cacoo.com/diagrams/DjoA2pSKnhCghTYM-452C2.png) 
+
+## Table Definition
+
+| Key     | Attributes               | Type   | Example Value                |
+|---------|--------------------------|--------|-----------------------------|
+| PK      | id                       | string | A-101                       |
+|         | data                     | any    | any                         |
+|         | status                   | string | PENDING                     |
+|         | receive_count            | number | 1                           |
+| GSI2PK  | queued                   | number | 1                           |
+| GSI3PK  | DLQ                      | number | 1                           |
+|         | version                  | number | 1                           |
+|         | creation_timestamp       | string | 2023-12-01T12:00:00Z00:00   |
+| SK      | last_updated_timestamp   | string | 2023-12-01T12:00:00Z00:00   |
+| GSI2SK  | queue_add_timestamp      | string | 2023-12-01T12:00:00Z00:00   |
+|         | queue_peek_timestamp     | string | 2023-12-01T12:00:00Z00:00   |
+|         | queue_complete_timestamp | string | 2023-12-01T12:00:00Z00:00   |
+| GSI3SK  | dlq_add_timestamp        | string | 2023-12-01T12:00:00Z00:00   |