johndpope / loopback-connector-dynamodb Goto Github PK

DynamoDB connector for loopback-datasource-juggler. Because Dynamo doesn't get enough love.

• Installation
• Creating a DynamoDB data source
  • Properties
• Using the DynamoDB connector
  • Local development with DynamoDB Local

In your application root directory, enter:

$ npm install loopback-connector-dynamodb --save

This will install the module from npm and add it as a depenency to the application's package.json file.

Use the Datasource generator to add a DynamoDB data source to your application. The entry in the application's /server/datasources.json will look like this:

"mydb": {
  "name": "mydb",
  "connector": "dynamodb"
}

Edit datasources.json to add other properties to enable you to connect the data source to a DynamoDB database.

For example:

Example datasources.json file

{
  "dynamo_dev": {
    "name": "dynamo_dev",
    "connector": "dynamodb",
    "region": "local",
    "credentials": "shared",
    "profile": "localdev",
    "port": 4567
  },
  "dynamo_qa": {
    "name": "dynamo_qa",
    "connector": "dynamodb",
    "region": "us-west-2",
    "credentials": "iamrole"
  }
}

⚠️ You can't specify aws_access_key_id and aws_secret_access_key directly in your datasources.json file. This is intentional. Putting credentials like that into a file are A Very Bad Thing. Quit trying to do that.

• Handle queries that include an "order" property better. Should either throw an error if there is not a rangeKey for the ordered key, or just throw an error entirely. Additionally, if there is a rangeKey for the order, it should make sure a query is possible.
• Handle declaring local and global secondary indexes better. The current support is rudimentary.
• Add better documentation for rudimentary local and global secondary indexes.
• Look into figuring out how to force the older version of should so less modifications to copied tests are required.
• Do a better job implementing addConitionToExpression to handle values which contain characters that cannot be in expression keys.