Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lordsimal/cakephp-dump-sql

A CakePHP plugin to export SQL
https://github.com/lordsimal/cakephp-dump-sql

Last synced: 4 months ago
JSON representation

A CakePHP plugin to export SQL

Host: GitHub
URL: https://github.com/lordsimal/cakephp-dump-sql
Owner: LordSimal
License: mit
Created: 2022-12-27T19:44:42.000Z (about 2 years ago)
Default Branch: 2.x
Last Pushed: 2024-10-23T19:19:04.000Z (4 months ago)
Last Synced: 2024-10-25T20:15:23.239Z (4 months ago)
Language: PHP
Homepage:
Size: 68.4 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        
# CakePHP Dump SQL plugin

[![Latest Stable Version](https://poser.pugx.org/lordsimal/cakephp-dump-sql/v)](https://packagist.org/packages/lordsimal/cakephp-dump-sql) [![Total Downloads](https://poser.pugx.org/lordsimal/cakephp-dump-sql/downloads)](https://packagist.org/packages/lordsimal/cakephp-dump-sql) [![Latest Unstable Version](https://poser.pugx.org/lordsimal/cakephp-dump-sql/v/unstable)](https://packagist.org/packages/lordsimal/cakephp-dump-sql) [![License](https://poser.pugx.org/lordsimal/cakephp-dump-sql/license)](https://packagist.org/packages/lordsimal/cakephp-dump-sql) [![PHP Version Require](https://poser.pugx.org/lordsimal/cakephp-dump-sql/require/php)](https://packagist.org/packages/lordsimal/cakephp-dump-sql) [![codecov](https://codecov.io/github/LordSimal/cakephp-dump-sql/branch/main/graph/badge.svg?token=S4JKN84SWY)](https://codecov.io/github/LordSimal/cakephp-dump-sql)

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

Currently the following DBMS are integrated:

- MySQL/MariaDB

- SQLite

- PostgreSQL

## Version table

|     | PHP              | CakePHP |

|-----|------------------|---------|

| 1.x | `^7.4 \|\| ^8.0` | `^4.4`  |

| 2.x | `^8.1`           | `^5.0`  |

## Installation

The recommended way to install this plugin via [composer](https://getcomposer.org) is:

```

composer require lordsimal/cakephp-dump-sql --dev

```

Then execute

```

bin/cake plugin load CakeDumpSql

```

**or** add this to your `src/Application.php` manually

```

public function bootstrap(): void

{

    parent::bootstrap();

    // Other plugins

    $this->addPlugin('CakeDumpSql');

}

```

## Requirements

For each DBMS you need to have its respective dump tool installed.

- MySQL/MariaDB => `mysqldump`

- SQLite => `sqlite3`

- PostgreSQL => `pg_dump`

⚠️ 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** ⚠️

## How to use

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

```

bin/cake dump_sql

```

After executing that command you should see a SQL representation of your `default` datasource inside your console.

So if you want to save it into a file you should do

```

bin/cake dump_sql > dump.sql

```

### Dump different datasource

You can specify which datasource you want to export via the first argument

```

bin/cake dump_sql test > test_dump.sql

```

### GZIP compressed dump

ℹ️ The following feature requires you have the **PHP zlib extension** installed and active ℹ️

```

bin/cake dump_sql --gzip > dump.sql.gz

```

### Data only dump

```

bin/cake dump_sql --data-only > data.sql

```