Skip to content

Commit d0d3835

Browse files
committed
adjust readme
1 parent af36f1b commit d0d3835

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

Diff for: README.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33

44
This plugin adds a CakePHP command to easily generate SQL dumps of your configured datasources
55

6-
Currently only MySQL/MariaDB exports are supported but PostgreSQL and SQLite shouldn't be that hard to integrate along the way.
6+
Currently the following DBMS are integrated:
7+
- MySQL/MariaDB
8+
- SQLite
9+
- PostgreSQL
710

811
## Installation
912

@@ -25,19 +28,29 @@ bin/cake plugin load CakeDumpSql
2528
public function bootstrap(): void
2629
{
2730
parent::bootstrap();
28-
31+
2932
// Other plugins
3033
$this->addPlugin('CakeDumpSql');
3134
}
3235
```
3336

3437

38+
## Requirements
39+
40+
For each DBMS you need to have its respective dump tool installed.
41+
42+
- MySQL/MariaDB => `mysqldump`
43+
- SQLite => `sqlite3`
44+
- PostgreSQL => `pg_dump`
45+
46+
⚠️ For `pg_dump` it is especially important that you have a compatible version installed. So e.g. if you have a **PostgreSQL 14 server** you need a **pg_dump version 14** ⚠️
47+
3548
## How to use
3649

3750
After installing the plugin you now have a new command available to you:
3851

3952
```
40-
bin/cake dump_sql
53+
bin/cake dump_sql
4154
```
4255

4356
After executing that command you should see a SQL representation of your `default` datasource inside your console.
@@ -68,4 +81,4 @@ bin/cake dump_sql --gzip > dump.sql.gz
6881

6982
```
7083
bin/cake dump_sql --data-only > data.sql
71-
```
84+
```

0 commit comments

Comments
 (0)