y0lk/sqldumper

SQL dump utility

SQLDumper

, _(*1)

SQLDumper is a small library designed to easily create customized SQL dumps., _(*2)

Installation

Via Composer, _(*3)

$ composer require y0lk/sqldumper

Usage

The concept is that you can select tables and set certain "dump parameters" for each table, made so you can chain a bunch of calls to quickly create a customized dump., _(*4)

use Y0lk\SQLDumper\SQLDumper;

//Init the dumper with your DB info
$dumper = new SQLDumper('localhost', 'dbname', 'root', '');

//Set all tables to dump without data and without DROP statement
$dumper->allTables()
    ->withData(false)
    ->withDrop(false);

//Set table1 to dump with data
$dumper->table('table1')
    ->withData(true);

//Set table2 and table3 to dump without structure (data only), and table3 with where condition
$dumper->listTables([
        'table2',
        'table3'
    ])
    ->withStructure(false)
    ->table('table3')
        ->where('id=2 OR foo="bar"');

//This will group DROP statements and put them at the beginning of the dump
$dumper->groupDrops(true);

//This will group INSERT statements and put them at the end of the dump
$dumper->groupInserts(true);

$dumper->save('dump.sql');

Dumper options

groupDrops(bool $group)

When set to TRUE, this will group DROP statements and put them at the beginning of the dump, _(*5)

groupInserts(bool $group)

When set to TRUE, this will group INSERT statements and put them at the end of the dump, _(*6)

Table selection

There are 3 basic methods to select tables. When a table or a list of tables are selected, they are returned as TableDumper objects on which you can set options for the dump., _(*7)

allTables()

Selects all the tables in the DB, _(*8)

table(string|Table $table)

Select by table's name (string) or a Table object, _(*9)

listTables(array $listTables)

Select by a list of table names (string) or Table object, _(*10)

Table options

This is the list of methods available on each each TableDumper, _(*11)

withStructure(bool $withStructure)

Whether to dump the table CREATE structure, _(*12)

withData(bool $withData)

Whether to dump table data (INSERT statement), _(*13)

withDrop(bool $withDrop)

Wheter to include the DROP statement (before CREATE), _(*14)

where(string $where_string)

WHERE query string as regular SQL, _(*15)

Output

dump(resource $stream)

This the main dump function, outputs the dump to a stream., _(*16)

save(string $filename)

Saves the dump to a file, _(*17)

License

The MIT License (MIT). Please see License File for more information., _(*18)