https://github.com/thecodingmachine/dbfaker
Easy test data in your database !
https://github.com/thecodingmachine/dbfaker
database dbal fake-data php php7 test-data-generator
Last synced: 7 months ago
JSON representation
Easy test data in your database !
- Host: GitHub
- URL: https://github.com/thecodingmachine/dbfaker
- Owner: thecodingmachine
- Created: 2017-07-13T22:08:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-12-30T11:24:51.000Z (almost 6 years ago)
- Last Synced: 2025-04-11T18:59:46.799Z (7 months ago)
- Topics: database, dbal, fake-data, php, php7, test-data-generator
- Language: PHP
- Size: 96.7 KB
- Stars: 3
- Watchers: 7
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://packagist.org/packages/thecodingmachine/DBFaker)
[](https://packagist.org/packages/thecodingmachine/DBFaker)
[](https://packagist.org/packages/thecodingmachine/DBFaker)
[](https://packagist.org/packages/thecodingmachine/DBFaker)
[](https://scrutinizer-ci.com/g/thecodingmachine/DBFaker/?branch=master)
[](https://travis-ci.org/thecodingmachine/DBFaker)
[](https://coveralls.io/github/thecodingmachine/DBFaker?branch=master)
# DBFakeFiller
An easy to use tool to popuplate your database with fake data. Based on [doctrine/dbal](https://github.com/doctrine/dbal) so it should me cross plateforme. Fake data are generated using [fzaninotto/faker](https://github.com/fzaninotto/Faker).
This tool will parse your database schema, generate fake data and insert it inside your database. In order to generate the most valuable data, it will look into:
* columns' types (INT, VARCHAR, TEXT, TIMESTAMP, etc.)
* columns' attributes (precision, scale, nullable, unsigned, etc.)
* tables' relations to create valid relation ships (obvious, else the constraints would break)
> **WARNING :** Always backup your database **before** running the DBFaker in case it breaks !
## Install
`composer require thecodingmachine/DBFaker`
## Minimalist usage
```php
//instanciate the DBAL connectioin
$connectionParams = [
"host" => "localhost",
"user" => "DBU USER",
"password" => "DB HOST",
"port" => null,
"dbname" => "YOUR DB NAME",
"charset" => "utf8",
"driverOptions" => array(
1002 =>"SET NAMES utf8"
)
];
$conn = new \Doctrine\DBAL\Connection($connectionParams, new Doctrine\DBAL\Driver\PDOMySql\Driver(), null, new \Doctrine\Common\EventManager());
$faker = new \DBFaker\DBFaker($conn);
//say what tables should be filled (other tables will be considered as reference table or at least already filled)
$faker->setFakeTableRowNumbers([
"table1" => 300, //generate 300 lines for table 1
"table2" => 20,
//...
]);
$faker->fakeDB();
```
... now have a look at you database :) nice isn't it ?
## Advanced usage
### Custom data generators
By default, fake data is generated regarding the information retrieved about the column. You can pass a ```GeneratorFactory``` instance to DBFaker's
constructor in order to specify a custom ```FakeDataGeneratorInterface```.
```php
$generatorFactory = new \DBFaker\Generators\GeneratorFactory();
/*
Don't hesitate to use the Faker package to generate random data,
there is plenty of data types available (IBAN, address, country code, ...).
You can evenpass the locale to generate localized data !
*/
$generator = \Faker\Factory::create();
//... add your custom generators ...
//... and injectc the Generator Factory
$faker = new \DBFaker\DBFaker($conn, $generatorFactory);
);
```
#### Customize for column
You may use the ```GeneratorFactory::setGeneratorForColumn()``` to set a specific generator for a given column :
```php
// address.postal_code column is a varchar, so default generated data will be text. Here we want a postal code :
$generatorFactory->setGeneratorForColumn(
"address", "postal_code", function() use ($generator){ return $generator->postcode; }
);
```
```setGeneratorForColumn``` takes 3 arguments : ```string $tableName``` and ```string $ColumnName``` to specify which the column and the third argument
can be either :
* a ```callable``` that takes the ```\Doctrine\DBAL\Schema\Column $column``` as input parameter,
* a ```DBFaker\Generators\FakeDataGeneratorInterface``` instance
### Customize by condition
For more flexible customization, you can use ```GeneratorFactory::setGeneratorForColumn()```.
```php
// all columns that end with "_email" or are named exactly "email" should be emails
$generatorFactory->setGenerator(
function(\Doctrine\DBAL\Schema\Column $column){
return preg_match("/([(.*_)|_|]|^)email$/", $column->getName()) === 1;
}, function() use ($generator){
return $generator->email;
}
);
```
This time, first argument is a ```callable``` that takes the ```\Doctrine\DBAL\Schema\Column $column``` as input parameter and should return a
```boolean``` (```true``` if override should happend). The Second argument is the same as for the previous ```setGeneratorForColumn``` function.
### Set null probability