Merge pull request #27 from boyney123/catalog-cli-adding-dynamodb-res…

…ource

adding new ddb resource on creation of catalog

.changeset/mean-files-prove.md

@@ -0,0 +1,5 @@
+---
+"@cloudcatalog/create-catalog": patch
+---
+
+adding new ddb resource on creation of catalog

examples/default/data/resources/dynamodb/user-payments.md

@@ -38,16 +38,13 @@ The user-payments table is an integral component of our payment service, designe
 ### Retrieve User Transaction History
 - **Use Case**: Fetch all transactions made by a specific user.
 - **Query Pattern**: Query the table using the userId as the partition key. This returns all items with the matching userId, sorted by transactionId.
-- **Example Query**: `SELECT * FROM user-payments WHERE userId = :userId`
 
 ### Lookup Specific Transaction
 
 - **Use Case**: Retrieve details of a specific transaction for a user.
 - **Query Pattern**: Use both userId (partition key) and transactionId (sort key) to get the specific transaction record.
-- **Example Query**: `SELECT * FROM user-payments WHERE userId = :userId AND transactionId = :transactionId`
 
 ### Query Transactions Based on Status
 
 - **Use Case**: Identify transactions that are pending, successful, or failed.
 - **Implementation**: This may require the use of a Global Secondary Index (GSI) with status as the key if frequent queries are made based on the transaction status.
-- **Example Query**: `SELECT * FROM user-payments-index-status WHERE status = :status`

packages/create-cloudcatalog/templates/default/data/resources/dynamodb/user-payments.md

@@ -38,16 +38,13 @@ The user-payments table is an integral component of our payment service, designe
 ### Retrieve User Transaction History
 - **Use Case**: Fetch all transactions made by a specific user.
 - **Query Pattern**: Query the table using the userId as the partition key. This returns all items with the matching userId, sorted by transactionId.
-- **Example Query**: `SELECT * FROM user-payments WHERE userId = :userId`
 
 ### Lookup Specific Transaction
 
 - **Use Case**: Retrieve details of a specific transaction for a user.
 - **Query Pattern**: Use both userId (partition key) and transactionId (sort key) to get the specific transaction record.
-- **Example Query**: `SELECT * FROM user-payments WHERE userId = :userId AND transactionId = :transactionId`
 
 ### Query Transactions Based on Status
 
 - **Use Case**: Identify transactions that are pending, successful, or failed.
 - **Implementation**: This may require the use of a Global Secondary Index (GSI) with status as the key if frequent queries are made based on the transaction status.
-- **Example Query**: `SELECT * FROM user-payments-index-status WHERE status = :status`

packages/create-cloudcatalog/templates/default/data/resources/dynamodb/users.md

@@ -0,0 +1,45 @@
+---
+name: users
+description: Table for storing user information
+service: user-service
+owners:
+  - dboyne
+  - user-team
+AWS:
+  Arn: arn:aws:dynamodb:us-west-2:123456789123:table/user-payments
+  TableName: user-payments
+  CreationDateTime: '2022-09-15T09:56:47.097Z'
+  DeletionProtectionEnabled: false
+  TableStatus: ACTIVE
+  TableSizeBytes: 762
+  StreamSpecification:
+    StreamEnabled: true
+    StreamViewType: NEW_AND_OLD_IMAGES
+  ProvisionedThroughput:
+    ReadCapacityUnits: 1
+    WriteCapacityUnits: 1
+  AttributeDefinitions:
+    - AttributeName: id
+      AttributeType: S
+  Service: dynamodb
+  AccountId: 123456789123
+catalog:
+  updatedAt: '2024-01-10T07:48:19.106Z'
+  parent: dynamodb
+  path: users
+---
+
+## About this table
+
+The users table is an integral part of our infrastructure, serving as the backbone for managing user data. This table is tailored to support various user-related functionalities across our applications, including authentication, profile management, and user activity tracking. It is optimized for high performance and scalability to handle our growing user base.
+
+## Access patterns
+
+### User Authentication:
+- Primary access pattern involves querying by `userID` or `email` to retrieve credentials and perform authentication checks.
+- Example Query: Retrieve user details by `email` for login purposes.
+
+### Profile Information Retrieval:
+
+- Frequently accessed for displaying user profile information.
+- Example Query: Fetch complete user details by `userID` for profile viewing or editing.