Skip to content

Commit 9a2c138

Browse files
committed
chore(docs): add an example of configuration JSON
Also I marked Phar file as recommended setup method
1 parent ddbfee5 commit 9a2c138

File tree

1 file changed

+45
-4
lines changed

1 file changed

+45
-4
lines changed

README.md

+45-4
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,60 @@ It is highly configurable and optimized for performance with concurrency and bat
1414
- No compromise on performance!
1515
- JSONSchema for configuration validation, no more guessing when editing config file.
1616

17+
## Configuration file example
18+
19+
If you want to export / import data from mysql server reachable via `db` hostname
20+
and exclude tables that match indexation patterns, you configuration file will look like this:
21+
```json
22+
{
23+
"$schema": "https://raw.githubusercontent.com/EcomDev/mysql-to-jsonl/main/schema.json",
24+
"config": {
25+
"connection": {
26+
"host": "db",
27+
"database": "magento",
28+
"user": "magento",
29+
"password": "magento"
30+
},
31+
"excludeTables": [
32+
{
33+
"endsWith": "_cl"
34+
},
35+
{
36+
"contains": "_tmp_"
37+
},
38+
{
39+
"contains": "_index_"
40+
},
41+
{
42+
"endsWith": "_index"
43+
},
44+
{
45+
"endsWith": "_replica"
46+
},
47+
{
48+
"regexp": "/^inventory_stock_\\d+$/"
49+
}
50+
],
51+
"concurrency": 12
52+
}
53+
}
54+
```
55+
56+
Notice the `$schema` in as the first element? Specifying it like this in your config files
57+
allows your favorite IDE's to auto-complete and validate configuration properties.
1758

1859
## Installation
1960

61+
### Phar (Recommended)
62+
63+
Download pre-bundled application from [Releases](https://github.com/EcomDev/mysql-to-jsonl/releases)
64+
2065
### Composer
2166

2267
```bash
2368
composer require ecomdev/mysql2jsonl
2469
```
2570

26-
### Phar
27-
28-
Download pre-bundled application from [Releases](https://github.com/EcomDev/mysql-to-jsonl/releases)
29-
3071

3172
## 📜 License
3273

0 commit comments

Comments
 (0)