Skip to content

Commit 96b37c6

Browse files
committed
chore(docs): added README with basic info
1 parent 127bda3 commit 96b37c6

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

README.md

+35-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
1-
# mysql-to-jsonl
2-
Export/Import JSONL files as data for MySQL tables
1+
# 🚀 Blazingly fast **mysql2jsonl** 🚀
2+
3+
## Purpose:
4+
The `mysql2jsonl` tool provides an efficient way to export data from a MySQL database to JSONL (JSON Lines) files and to import data back into a database from these files.
5+
It is highly configurable and optimized for performance with concurrency and batching in mind!
6+
7+
8+
## **Key Features**:
9+
- Export and Import Commands
10+
- `mysql2jsonl export`: Exports MySQL database table data into JSONL files.
11+
- `mysql2jsonl import`: Imports JSONL files back into the MySQL database tables.
12+
13+
- Complex rules for excluding/including tables into the export
14+
- No compromise on performance!
15+
- JSONSchema for configuration validation, no more guessing when editing config file.
16+
17+
18+
## Installation
19+
20+
### Composer
21+
22+
```bash
23+
composer require ecomdev/mysql2jsonl
24+
```
25+
26+
### Phar
27+
28+
Download pre-bundled application from [Releases](https://github.com/EcomDev/mysql-to-jsonl/releases)
29+
30+
31+
## 📜 License
32+
33+
This project is licensed under the MIT License.
34+
35+
See the [LICENSE](LICENSE) file for more details.

0 commit comments

Comments
 (0)