File tree Expand file tree Collapse file tree 2 files changed +50
-3
lines changed
Expand file tree Collapse file tree 2 files changed +50
-3
lines changed Original file line number Diff line number Diff line change 3838## Description of ` parameters `
3939
4040- ` db ` : DynamoDB instance connection options
41- - ` endpoint ` : https://your-dynamodb-instance.com/
41+ - ` endpoint ` : ` https://your-dynamodb-instance.com/ `
4242 - ` accessKeyId ` : Access key id
4343 - ` #secretAccessKey ` : Secret access key (will be encrypted)
4444 - ` regionName ` : Region
5555 - ` value ` : date string from which date value will be created (e.g. ` -2 days ` )
5656 - ` limit ` (optional): how many documents you want to export
5757 - ` mapping ` : how to map fields in document to CSV columns
58+
59+
60+ ### ` dateFilter ` and its fields
61+
62+ tbd
63+
64+ ### ` mapping ` and its fields
65+
66+ tbd
67+
68+ ## General filtering options
69+
70+ tbd
71+
72+ ## Links
Original file line number Diff line number Diff line change @@ -13,11 +13,43 @@ Sample configuration and its description can be found [here](/config.md).
1313
1414## Output
1515
16- tbd
16+ After successful extraction there are several CSV files which contains exported data. First output
17+ file is named after ` name ` parameter in export configuration. Other files are named after destination
18+ parameter in mapping section.
19+
20+ Also, there is manifest file for each of the export.
1721
1822## Development
1923
20- tbd
24+ Requirements:
25+
26+ - Docker Engine: ` ~1.12 `
27+ - Docker Compose: ` ~1.8 `
28+
29+ Application is prepared for run in container, you can start development same way:
30+
31+ 1 . Clone this repository: ` git clone git@github.com:keboola/dynamodb-extractor.git `
32+ 2 . Change directory: ` cd dynamodb-extractor `
33+ 3 . Build services: ` docker-compose build `
34+ 4 . Run tests ` docker-compose run --rm app-tests ` (runs ` ./tests.sh ` script)
35+
36+ After seeing all tests green, continue:
37+
38+ 1 . Run service: ` docker-compose run --rm app ` (starts container with ` bash ` )
39+ 2 . Load sample data: ` php loadSampleData.php `
40+ 3 . Write tests and code
41+ 4 . Run tests: ` ./tests.sh `
42+
43+ To simulate real run:
44+
45+ 1 . Create data dir: ` mkdir -p data `
46+ 2 . Follow configuration sample and create ` config.json ` file and place it to your data directory (` data/config.json ` )
47+ 3 . Simulate real run (with entrypoint command): ` php ./src/app.php run ./data `
48+
49+ ### Tests
50+
51+ - all in one: ` ./tests.sh `
52+ - or separately, just check ` tests.sh ` file contents
2153
2254## License
2355
You can’t perform that action at this time.
0 commit comments