{"id":16899034,"url":"https://github.com/chrisguttandin/dynamo-db-local","last_synced_at":"2025-09-14T02:32:10.640Z","repository":{"id":33695333,"uuid":"37348292","full_name":"chrisguttandin/dynamo-db-local","owner":"chrisguttandin","description":"A wrapper around Amazon's DynamoDB Local to start and stop it from Node.js.","archived":false,"fork":false,"pushed_at":"2024-10-16T16:17:43.000Z","size":377365,"stargazers_count":13,"open_issues_count":1,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-24T12:12:42.481Z","etag":null,"topics":["aws","dynamodb","dynamodb-local"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrisguttandin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-06-12T22:49:58.000Z","updated_at":"2024-10-16T16:17:47.000Z","dependencies_parsed_at":"2024-01-16T21:04:13.359Z","dependency_job_id":"2b1bace3-da30-4e7d-90fc-b57f70da76da","html_url":"https://github.com/chrisguttandin/dynamo-db-local","commit_stats":{"total_commits":1054,"total_committers":8,"mean_commits":131.75,"dds":0.06356736242884253,"last_synced_commit":"b640deec81ea857977af62dee1cd8820269e5186"},"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisguttandin%2Fdynamo-db-local","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisguttandin%2Fdynamo-db-local/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisguttandin%2Fdynamo-db-local/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisguttandin%2Fdynamo-db-local/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrisguttandin","download_url":"https://codeload.github.com/chrisguttandin/dynamo-db-local/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232945100,"owners_count":18600587,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","dynamodb","dynamodb-local"],"created_at":"2024-10-13T17:47:02.349Z","updated_at":"2025-01-07T22:21:52.143Z","avatar_url":"https://github.com/chrisguttandin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dynamo-db-local\n\n**A wrapper around Amazon's DynamoDB Local to start and stop it from Node.js.**\n\n[![version](https://img.shields.io/npm/v/dynamo-db-local.svg?style=flat-square)](https://www.npmjs.com/package/dynamo-db-local)\n\nThis module wraps Amazon's [DynamoDB Local](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tools.DynamoDBLocal.html). It exposes one method called `spawn()` which calls [`child_process.spawn()`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options) internally and returns its result.\n\n```js\nconst dynamoDbLocalProcess = dynamoDbLocal.spawn();\n// ...\ndynamoDbLocalProcess.kill();\n```\n\n## Configuration\n\nThe `spawn()` function accecpts an optional options object.\n\n### command\n\nThe command property of that object can be used to run DynamoDB Local with Docker instead of using the bundled Java version.\n\n```js\nconst command = 'docker';\nconst dynamoDbLocalProcess = dynamoDbLocal.spawn({ command });\n// ...\ndynamoDbLocalProcess.kill();\n```\n\n### detached\n\nIn a CI/CD environment you might want to let DynamoDB Local to run in the background. In this case, you should use the `detached` property.\n\n```js\nconst dynamoDbLocalProcess = dynamoDbLocal.spawn({ detached: true, stdio: 'ignore' });\n// ...\ndynamoDbLocalProcess.unref();\n```\n\n### name\n\nA custom name may be used to indentify the Docker container by name.\n\n```js\nconst dynamoDbLocalProcess = dynamoDbLocal.spawn({ command: 'docker', name: 'a-unique-name' });\n// ...\ndynamoDbLocalProcess.kill();\n```\n\n### path\n\nThe options object can also be used to set an optional `path` property. If set, that path will be used to store the database file. If no path is specified the database will be kept in memory.\n\n```js\nconst path = 'somewhere/on/your/disk';\nconst dynamoDbLocalProcess = dynamoDbLocal.spawn({ path });\n// ...\ndynamoDbLocalProcess.kill();\n```\n\n### port\n\nAnother property the options object could have is `port`. It specifies the port number that the process will run on. In absence of the port property, 8000 is used as the port number.\n\n```js\nconst port = 8001;\nconst dynamoDbLocalProcess = dynamoDbLocal.spawn({ port });\n// ...\ndynamoDbLocalProcess.kill();\n```\n\n### sharedDb\n\nThe options object could also have a `sharedDb` property. If true, DynamoDB Local will use a single database file, instead of using separate files for each credential and region. The default of this option is false.\n\n```js\nconst dynamoDbLocalProcess = dynamoDbLocal.spawn({ sharedDb: true });\n// ...\ndynamoDbLocalProcess.kill();\n```\n\n### stdio\n\nFinally the options object can also be used to specify a custom `stdio` configuration.\n\n```js\nconst dynamoDbLocalProcess = dynamoDbLocal.spawn({ stdio: 'inherit' });\n// ...\ndynamoDbLocalProcess.kill();\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisguttandin%2Fdynamo-db-local","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrisguttandin%2Fdynamo-db-local","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisguttandin%2Fdynamo-db-local/lists"}