spawnflake 0.2.7

Generate pattern based random data for mysql
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

# ![a pixel fish](./assets/logo.png "fish") Spawnflake [![Rust](https://github.com/elasticrash/spawnflake/actions/workflows/rust.yml/badge.svg)](https://github.com/elasticrash/spawnflake/actions/workflows/rust.yml)

Spawnflake is a schema agnostic, random and/or patterns based data generator, for MySQL databases.

## what's new
See [CHANGELOG](CHANGELOG.md) for updates and new features.

## usage
This library works by providing a configuration file (config.json). The configuration is divided into two sections.
### connection properties (mandatory)
```json 
 "mysql_configuration": {
        "address": "localhost",
        "port": 3306,
        "user": "local",
        "password": "password",
        "schema": "test"
    }
```
### type patterns (optional)
```json
 "types": {
        "string": [
            {
                "name": "column_name",
                "rules": []
            }
        ],
        "integer": [
            {
                "name": "column_name",
                "rules":[]
            }
        ],
        "float": [
            {
                "name": "column_name",
                "rules":[]
            }
        ]
    }
```
### Rules
* Rules for numeric types and dates just desired ranges (from, to). **Important!!** the small values need to be first in the lists. 
* Rules for strings are combinatinatory, you provide collections that are mixed and matched.
i.e.

```json
   "rules": [
                    [
                        "Jo",
                        "Ni",
                        "Ste",
                        "Da",
                        "Sco",
                        "Ma"
                    ],
                    [
                        "ve",
                        "vi",
                        "pha",
                        "ro",
                        "na",
                        "ri"
                    ],
                    [
                        "n",
                        "ck",
                        "tt",
                        "d",
                        "than",
                        "na"
                    ]
                ]
```
This could create real names like `David` but also complete random combinations like `Jophack`

## known limitations
* When handling cyclic dependencies, keys are not currently updated retrospectively. This feature is planned for a future version
* If a foreign key is unique, fewer records will be inserted into that table. Unique foreign key values are not supported yet.
* In certain cases, number validation in the configuration is not performed, records assosiated with problematic talbes can be 
  * skipped
  * panic
  * use default values

## support 
### Database support 
#### MySQL
* supported data types and generators:

| Datastore   | Data type                | Random    | Pattern      | 
| ----------- | -----------              |-----------| -----------  | 
| Mysql       | varchar                  | ✔️         | ✔️            |
| Mysql       | int                      | ✔️         | ✔️            |
| Mysql       | unsigned int             | ✔️         | ✔️            |
| Mysql       | smallint                 | ✔️         | ✔️            |
| Mysql       | unsigned smallint        | ✔️         | ✔️            |
| Mysql       | tinyint/unsigned tinyint | ✔️         | ✔️            |
| Mysql       | mediumint                | ✔️         | ✔️            |
| Mysql       | bigint                   | ✔️         | ✔️            |
| Mysql       | unsigned bigint          | ✔️         | ✔️            |
| Mysql       | decimal                  | ✔️         | ✔️            |
| Mysql       | float                    | ✔️         | ✔️            |
| Mysql       | double                   | ✔️         | ✔️            |
| Mysql       | bit                      | ✔️         | ❌           |
| Mysql       | time                     | ✔️         | ❌           |
| Mysql       | timestamp                | ✔️         | ✔️            |
| Mysql       | date                     | ✔️         | ❌           |
| Mysql       | year                     | ✔️         | ❌           |
| Mysql       | char                     | ✔️         | ❌           |
| Mysql       | binary                   | ✔️         | ❌           |
| Mysql       | text                     | ✔️         | ❌           |
| Mysql       | longtext                 | ✔️         | ❌           |
| Mysql       | blob/longblob            | ✔️         | ❌           |
| Mysql       | enum                     | ❌        | ✔️            |

## CLI
The main project in this repository is a library, but there is also a [CLI version](https://crates.io/crates/spawnflake-cli) available published in crates.io.
The code for the CLI is available at `./cli`. Check [README](cli/readme.md) for usage and more information.

## Running the example
Running the example requires running `docker-compose` inside the `test` folder. Make sure you have 
* Docker
* An SQL client/ or a way to access the MySQL cli to view the generated records

To run the example execute

```bash
cargo run --example generate_mysql
```

## Contributing

You are more than welcome. All you need to do is a pull request