Blame: ruby/example_code/dynamodb/README.md - awsdocs/aws-doc-sdk-examples

awsdocs / aws-doc-sdk-examples UNCLAIMED

Welcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.

0 0 0 Java

Normal View History Raw

Update Ruby Service-level README's using Jinja2 Template (#3794) * new readmes * woops * fix * changes for Laren * fixes for Laren * fixes for Liz * fixes * fixes * fixes for Liz * fix * fixes * Fixes for Laren * new readmes * new readmes Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com> 2022-10-21 10:23:10 -06:00			`# DynamoDB code examples for the SDK for Ruby`
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00
Ruby DynamoDB MVP scenario and service action examples. 2022-03-02 16:17:28 -08:00			`## Overview`
update READMEs 2021-10-13 19:30:48 +01:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`Shows how to use the AWS SDK for Ruby to work with Amazon DynamoDB.`

			`<!--custom.overview.start-->`
			`<!--custom.overview.end-->`

Tools: WRITEME for ruby (#5846) 2024-01-04 13:25:48 -05:00			`_DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability._`
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00
			`## ⚠ Important`
Ruby DynamoDB MVP scenario and service action examples. 2022-03-02 16:17:28 -08:00
Tools: WRITEME for ruby (#5846) 2024-01-04 13:25:48 -05:00			`* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).`
Ruby DynamoDB MVP scenario and service action examples. 2022-03-02 16:17:28 -08:00			`* Running the tests might result in charges to your AWS account.`
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).`
Ruby DynamoDB MVP scenario and service action examples. 2022-03-02 16:17:28 -08:00			`* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).`

Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`<!--custom.important.start-->`
			`<!--custom.important.end-->`

Ruby DynamoDB MVP scenario and service action examples. 2022-03-02 16:17:28 -08:00			`## Code examples`

Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`### Prerequisites`

			For prerequisites, see the [README](../../README.md#Prerequisites) in the `ruby` folder.


			`<!--custom.prerequisites.start-->`
			`<!--custom.prerequisites.end-->`

Ruby & Python - Various services: Hello examples (#6588) 2024-07-09 11:47:20 -04:00			`### Get started`

			- [Hello DynamoDB](hello/hello_dynamodb.rb#L4) (`ListTables`)


SOS: Recategorize examples REQUIRES TANDEM INTERNAL MERGE (#6754) * Recategorize Scenarios as Basics where appropriate. * Remove titles from Basics examples. * Refactor SOS templates for recategorization. * Add basics to WRITEME code and templates. * Run WRITEME for recategorization. * Update validate-doc-metadata to tagged release. 2024-08-21 13:27:36 -07:00			`### Basics`

			`Code examples that show you how to perform the essential operations within a service.`

			`- [Learn the basics](scaffold.rb)`


Update Ruby Service-level README's using Jinja2 Template (#3794) * new readmes * woops * fix * changes for Laren * fixes for Laren * fixes for Liz * fixes * fixes * fixes for Liz * fix * fixes * Fixes for Laren * new readmes * new readmes Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com> 2022-10-21 10:23:10 -06:00			`### Single actions`
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00
Update Ruby Service-level README's using Jinja2 Template (#3794) * new readmes * woops * fix * changes for Laren * fixes for Laren * fixes for Liz * fixes * fixes * fixes for Liz * fix * fixes * Fixes for Laren * new readmes * new readmes Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com> 2022-10-21 10:23:10 -06:00			`Code excerpts that show you how to call individual service functions.`
Ruby DynamoDB MVP scenario and service action examples. 2022-03-02 16:17:28 -08:00
Ruby - Autoformatting from Rubocop (#6899) 2024-09-25 15:25:54 -04:00			`- [BatchExecuteStatement](partiql/partiql_batch.rb#L22)`
			`- [BatchWriteItem](scaffold.rb#L81)`
			`- [CreateTable](scaffold.rb#L53)`
			`- [DeleteItem](basics/dynamodb_basics.rb#L129)`
			`- [DeleteTable](scaffold.rb#L108)`
			`- [DescribeTable](scaffold.rb#L34)`
			`- [ExecuteStatement](partiql/partiql_single.rb#L22)`
Tools: Writeme canonical titles (#6382) * Fix some WRITEME issues and generate titles for Actions: * Open files with utf-8 encoding. * Case-insensitive README filename comparison. * Render titles for actions in READMEs. * Fixed WRITEME to check for combined language and version. * Remove case-insensitive README lookup, rename wrong case Readme.md to README.md. 2024-04-30 12:22:08 -07:00			`- [GetItem](basics/dynamodb_basics.rb#L40)`
Ruby - Autoformatting from Rubocop (#6899) 2024-09-25 15:25:54 -04:00			`- [ListTables](scaffold.rb#L34)`
			`- [PutItem](basics/dynamodb_basics.rb#L21)`
Tools: Writeme canonical titles (#6382) * Fix some WRITEME issues and generate titles for Actions: * Open files with utf-8 encoding. * Case-insensitive README filename comparison. * Render titles for actions in READMEs. * Fixed WRITEME to check for combined language and version. * Remove case-insensitive README lookup, rename wrong case Readme.md to README.md. 2024-04-30 12:22:08 -07:00			`- [Query](basics/dynamodb_basics.rb#L75)`
Ruby - Autoformatting from Rubocop (#6899) 2024-09-25 15:25:54 -04:00			`- [Scan](basics/dynamodb_basics.rb#L95)`
Tools: Writeme canonical titles (#6382) * Fix some WRITEME issues and generate titles for Actions: * Open files with utf-8 encoding. * Case-insensitive README filename comparison. * Render titles for actions in READMEs. * Fixed WRITEME to check for combined language and version. * Remove case-insensitive README lookup, rename wrong case Readme.md to README.md. 2024-04-30 12:22:08 -07:00			`- [UpdateItem](basics/dynamodb_basics.rb#L55)`
Create README.md 2021-01-27 13:29:19 -08:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`### Scenarios`
Create README.md 2021-01-27 13:29:19 -08:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`Code examples that show you how to accomplish a specific task by calling multiple`
			`functions within the same service.`
Create README.md 2021-01-27 13:29:19 -08:00
Tools: WRITEME for ruby (#5846) 2024-01-04 13:25:48 -05:00			`- [Query a table by using batches of PartiQL statements](partiql/scenario_partiql_batch.rb)`
			`- [Query a table using PartiQL](partiql/scenario_partiql_single.rb)`


			`<!--custom.examples.start-->`
			`<!--custom.examples.end-->`
Create README.md 2021-01-27 13:29:19 -08:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`## Run the examples`
Ruby DynamoDB MVP scenario and service action examples. 2022-03-02 16:17:28 -08:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`### Instructions`
Create README.md 2021-01-27 13:29:19 -08:00

Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`<!--custom.instructions.start-->`
			`<!--custom.instructions.end-->`
Ruby DynamoDB MVP scenario and service action examples. 2022-03-02 16:17:28 -08:00
Ruby & Python - Various services: Hello examples (#6588) 2024-07-09 11:47:20 -04:00			`#### Hello DynamoDB`

			`This example shows you how to get started using DynamoDB.`

			```
			`ruby hello/hello_dynamodb.rb`
			```
Ruby DynamoDB MVP scenario and service action examples. 2022-03-02 16:17:28 -08:00
SOS: Recategorize examples REQUIRES TANDEM INTERNAL MERGE (#6754) * Recategorize Scenarios as Basics where appropriate. * Remove titles from Basics examples. * Refactor SOS templates for recategorization. * Add basics to WRITEME code and templates. * Run WRITEME for recategorization. * Update validate-doc-metadata to tagged release. 2024-08-21 13:27:36 -07:00			`#### Learn the basics`
Create README.md 2021-01-27 13:29:19 -08:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`This example shows you how to do the following:`
DynamoDB PartiQL MVP 🚀 (plus refactoring on DynamoDB MVP) (#4455) * lots of refactoring * 99% done * add readme * edits for Liz * little fix * fixes * linting fixes and Laren's edits * yaml drama * yaml drama 2023-03-04 02:09:05 -06:00
Tools: WRITEME for ruby (#5846) 2024-01-04 13:25:48 -05:00			`- Create a table that can hold movie data.`
			`- Put, get, and update a single movie in the table.`
			`- Write movie data to the table from a sample JSON file.`
			`- Query for movies that were released in a given year.`
			`- Scan for movies that were released in a range of years.`
			`- Delete a movie from the table, then delete the table.`
DynamoDB PartiQL MVP 🚀 (plus refactoring on DynamoDB MVP) (#4455) * lots of refactoring * 99% done * add readme * edits for Liz * little fix * fixes * linting fixes and Laren's edits * yaml drama * yaml drama 2023-03-04 02:09:05 -06:00
SOS: Recategorize examples REQUIRES TANDEM INTERNAL MERGE (#6754) * Recategorize Scenarios as Basics where appropriate. * Remove titles from Basics examples. * Refactor SOS templates for recategorization. * Add basics to WRITEME code and templates. * Run WRITEME for recategorization. * Update validate-doc-metadata to tagged release. 2024-08-21 13:27:36 -07:00			`<!--custom.basic_prereqs.dynamodb_Scenario_GettingStartedMovies.start-->`
			`<!--custom.basic_prereqs.dynamodb_Scenario_GettingStartedMovies.end-->`
DynamoDB PartiQL MVP 🚀 (plus refactoring on DynamoDB MVP) (#4455) * lots of refactoring * 99% done * add readme * edits for Liz * little fix * fixes * linting fixes and Laren's edits * yaml drama * yaml drama 2023-03-04 02:09:05 -06:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`Start the example by running the following at a command prompt:`
DynamoDB PartiQL MVP 🚀 (plus refactoring on DynamoDB MVP) (#4455) * lots of refactoring * 99% done * add readme * edits for Liz * little fix * fixes * linting fixes and Laren's edits * yaml drama * yaml drama 2023-03-04 02:09:05 -06:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			```
			`ruby scaffold.rb`
			```
DynamoDB PartiQL MVP 🚀 (plus refactoring on DynamoDB MVP) (#4455) * lots of refactoring * 99% done * add readme * edits for Liz * little fix * fixes * linting fixes and Laren's edits * yaml drama * yaml drama 2023-03-04 02:09:05 -06:00
SOS: Recategorize examples REQUIRES TANDEM INTERNAL MERGE (#6754) * Recategorize Scenarios as Basics where appropriate. * Remove titles from Basics examples. * Refactor SOS templates for recategorization. * Add basics to WRITEME code and templates. * Run WRITEME for recategorization. * Update validate-doc-metadata to tagged release. 2024-08-21 13:27:36 -07:00			`<!--custom.basics.dynamodb_Scenario_GettingStartedMovies.start-->`
			`<!--custom.basics.dynamodb_Scenario_GettingStartedMovies.end-->`

Create README.md 2021-01-27 13:29:19 -08:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`#### Query a table by using batches of PartiQL statements`
Update Ruby Service-level README's using Jinja2 Template (#3794) * new readmes * woops * fix * changes for Laren * fixes for Laren * fixes for Liz * fixes * fixes * fixes for Liz * fix * fixes * Fixes for Laren * new readmes * new readmes Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com> 2022-10-21 10:23:10 -06:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`This example shows you how to do the following:`
Ruby DynamoDB MVP scenario and service action examples. 2022-03-02 16:17:28 -08:00
Tools: WRITEME for ruby (#5846) 2024-01-04 13:25:48 -05:00			`- Get a batch of items by running multiple SELECT statements.`
			`- Add a batch of items by running multiple INSERT statements.`
			`- Update a batch of items by running multiple UPDATE statements.`
			`- Delete a batch of items by running multiple DELETE statements.`
Ruby DynamoDB MVP scenario and service action examples. 2022-03-02 16:17:28 -08:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`<!--custom.scenario_prereqs.dynamodb_Scenario_PartiQLBatch.start-->`
			`<!--custom.scenario_prereqs.dynamodb_Scenario_PartiQLBatch.end-->`
Create README.md 2021-01-27 13:29:19 -08:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`Start the example by running the following at a command prompt:`
Ruby DynamoDB MVP scenario and service action examples. 2022-03-02 16:17:28 -08:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			```
			`ruby partiql/scenario_partiql_batch.rb`
			```
Update Ruby Service-level README's using Jinja2 Template (#3794) * new readmes * woops * fix * changes for Laren * fixes for Laren * fixes for Liz * fixes * fixes * fixes for Liz * fix * fixes * Fixes for Laren * new readmes * new readmes Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com> 2022-10-21 10:23:10 -06:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`<!--custom.scenarios.dynamodb_Scenario_PartiQLBatch.start-->`
			`<!--custom.scenarios.dynamodb_Scenario_PartiQLBatch.end-->`
Update Ruby Service-level README's using Jinja2 Template (#3794) * new readmes * woops * fix * changes for Laren * fixes for Laren * fixes for Liz * fixes * fixes * fixes for Liz * fix * fixes * Fixes for Laren * new readmes * new readmes Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com> 2022-10-21 10:23:10 -06:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`#### Query a table using PartiQL`
Update Ruby Service-level README's using Jinja2 Template (#3794) * new readmes * woops * fix * changes for Laren * fixes for Laren * fixes for Liz * fixes * fixes * fixes for Liz * fix * fixes * Fixes for Laren * new readmes * new readmes Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com> 2022-10-21 10:23:10 -06:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`This example shows you how to do the following:`

Tools: WRITEME for ruby (#5846) 2024-01-04 13:25:48 -05:00			`- Get an item by running a SELECT statement.`
			`- Add an item by running an INSERT statement.`
			`- Update an item by running an UPDATE statement.`
			`- Delete an item by running a DELETE statement.`
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00
			`<!--custom.scenario_prereqs.dynamodb_Scenario_PartiQLSingle.start-->`
			`<!--custom.scenario_prereqs.dynamodb_Scenario_PartiQLSingle.end-->`
Update Ruby Service-level README's using Jinja2 Template (#3794) * new readmes * woops * fix * changes for Laren * fixes for Laren * fixes for Liz * fixes * fixes * fixes for Liz * fix * fixes * Fixes for Laren * new readmes * new readmes Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com> 2022-10-21 10:23:10 -06:00
Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`Start the example by running the following at a command prompt:`

			```
			`ruby partiql/scenario_partiql_single.rb`
			```

			`<!--custom.scenarios.dynamodb_Scenario_PartiQLSingle.start-->`
			`<!--custom.scenarios.dynamodb_Scenario_PartiQLSingle.end-->`
Update Ruby Service-level README's using Jinja2 Template (#3794) * new readmes * woops * fix * changes for Laren * fixes for Laren * fixes for Liz * fixes * fixes * fixes for Liz * fix * fixes * Fixes for Laren * new readmes * new readmes Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com> 2022-10-21 10:23:10 -06:00
			`### Tests`

Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`⚠ Running tests might result in charges to your AWS account.`


			`To find instructions for running these tests, see the [README](../../README.md#Tests)`
			in the `ruby` folder.



			`<!--custom.tests.start-->`

			`## Contribute`
			`Code examples thrive on community contribution.`

			`To learn more about the contributing process, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).`
			`<!--custom.tests.end-->`
Update Ruby Service-level README's using Jinja2 Template (#3794) * new readmes * woops * fix * changes for Laren * fixes for Laren * fixes for Liz * fixes * fixes * fixes for Liz * fix * fixes * Fixes for Laren * new readmes * new readmes Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com> 2022-10-21 10:23:10 -06:00
			`## Additional resources`
Create README.md 2021-01-27 13:29:19 -08:00
Tools: WRITEME for ruby (#5846) 2024-01-04 13:25:48 -05:00			`- [DynamoDB Developer Guide](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html)`
			`- [DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/Welcome.html)`
			`- [SDK for Ruby DynamoDB reference](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Dynamodb.html)`

Update Ruby README's w/ WRITEME ✍️ (#4758) 2023-05-19 13:23:56 -06:00			`<!--custom.resources.start-->`
			`<!--custom.resources.end-->`

			`---`

			`Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.`

			`SPDX-License-Identifier: Apache-2.0`