Skip to content

Latest commit

 

History

History
200 lines (143 loc) · 5.59 KB

README.md

File metadata and controls

200 lines (143 loc) · 5.59 KB
Raw
Localhost Databases

Amazon DynamoDB is a fully managed NoSQL database service.

About • Disclaimer • Getting Started • Download • How To Use

About

Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB local is a downloadable version of Amazon DynamoDB, you can develop and test applications without accessing the DynamoDB web service.

Disclaimer

Important

Localhost Databases is not affiliated with the databases' developers/owners and is not an official product.

Localhost Databases has been developed to run databases in a local Docker environment. To install a production instance, read the databases' respective installation guides.

Getting Started

You will need to make sure your system meets the following prerequisites:

  • Docker Engine >= 20.10.0

This repository utilizes Docker to run the DynamoDB sample. So, before using the DynamoDB, make sure you have Docker installed on your system.

Download

To use DynamoDB, you can clone the latest version of Localhost Databases repository for macOS, Linux and Windows.

# Clone this repository.
$ git clone git@github.com:luisaveiro/localhost-databases.git --branch main --single-branch

You can locate the DynamoDB Docker configuration in the databases directory.

# Navigate to the DynamoDB folder.
$ cd localhost-databases/databases/dynamodb

How To Use

There are a few steps you need to follow before you can have an DynamoDB database set up and running in Docker container. I have outline the steps you would need to take to get started.

1. Environment Variables

Before you start a database in a Docker container, you will need to create a DotEnv file. The DotEnv file will allow you to configure your database's credentials and map a container's port.

Localhost Databases includes a .env.example file for DynamoDB Database. You can run the following command in the terminal to create your DotEnv file.

# Navigate to a database.
$ cd databases/dynamodb

# Create .env from .env.example.
$ cp .env.example .env

The DynamoDB Docker Compose file uses the follow variables from the DotEnv file.

#--------------------------------------------------------------------------
# Docker env
#--------------------------------------------------------------------------

# The project name. | default: dynamodb
APP_NAME="dynamodb"

#--------------------------------------------------------------------------
# Database (DynamoDB) env
#--------------------------------------------------------------------------

# The DynamoDB database container name. | default: dynamodb
DB_CONTAINER_NAME="${APP_NAME}"

#--------------------------------------------------------------------------
# Network env
#--------------------------------------------------------------------------

# Map the database container exposed port to the host port. | default: 8000
DB_PORT=8000

# The Docker network for the containers. | default: local_dbs_network
NETWORK_NAME="local_dbs_network"

#--------------------------------------------------------------------------
# Volume env
#--------------------------------------------------------------------------

# The database container data volume. | default: dynamodb_data
DB_VOLUME_DATA_NAME="${DB_CONTAINER_NAME}_data"

2. Start Docker container

To start the DynamoDB Local container, you can run the following command:

# Navigate to DynamoDB database.
$ cd databases/dynamodb

# Run Docker Compose command.
$ docker compose up -d
Expected result

To check the DynamoDB container is running and the port mapping is configured correctly, you can run the following command:

# List containers
$ docker ps

You should see a similar output.

CONTAINER ID   IMAGE                          COMMAND                  CREATED         STATUS              PORTS                    NAMES
54800a208fc1   amazon/dynamodb-local:latest   "java -jar DynamoDBL…"   2 minutes ago   Up About a minute   0.0.0.0:8000->8000/tcp   dynamodb

3. Stop Docker container

To stop the DynamoDB container, you can run the following command:

$ docker compose down

4. Connect to Database

Note

TablePlus currently doesn't support DynamoDB. You can use NoSQL Workbench.

To connect to your DynamoDB container from your database client, you will need to provide the following settings:

HOST=localhost
PORT="${DB_PORT}"
Expected result

Below is a screenshot of the settings used in NoSQL Workbench:

NoSQL Workbench settings for DynamoDB Local
NoSQL Workbench settings for DynamoDB Local.

GitHub • LinkedIn • Twitter