|
| 1 | +# Synthetic Data Values Generator (SDVG) |
| 2 | + |
| 3 | +## Язык |
| 4 | + |
| 5 | +- [English](README.md) |
| 6 | +- **Русский** |
| 7 | + |
| 8 | +## Описание продукта |
| 9 | + |
| 10 | +SDVG (Synthetic Data Values Generator) — это инструмент для генерации синтетических данных. |
| 11 | +Он поддерживает различные форматы запуска, типы данных для генерации и форматы вывода. |
| 12 | + |
| 13 | +Форматы запуска: |
| 14 | + |
| 15 | +- CLI - генерация данных, создание конфигураций и их валидация через консоль; |
| 16 | +- HTTP сервер - принимает запросы на генерацию по HTTP API и отправляет/сохраняет их в указанное место. |
| 17 | + |
| 18 | +Типы данных: |
| 19 | + |
| 20 | +- строки (английские, русские); |
| 21 | +- целые и вещественные числа; |
| 22 | +- даты со временем; |
| 23 | +- UUID. |
| 24 | + |
| 25 | +Типы строк: |
| 26 | + |
| 27 | +- случайные; |
| 28 | +- тексты; |
| 29 | +- имена; |
| 30 | +- фамилии; |
| 31 | +- телефонные номера; |
| 32 | +- шаблоны. |
| 33 | + |
| 34 | +Каждый из типов данных можно генерировать со следующими опциями: |
| 35 | + |
| 36 | +- указание процента/количества уникальных значений на колонку; |
| 37 | +- упорядоченная генерация (sequence); |
| 38 | +- указание внешнего ключа; |
| 39 | +- идемпотентная генерация по seed числу; |
| 40 | +- генерация значений из диапазонов с процентным распределением значений. |
| 41 | + |
| 42 | +Форматы вывода: |
| 43 | + |
| 44 | +- devnull; |
| 45 | +- CSV файлы; |
| 46 | +- Parquet файлы; |
| 47 | +- HTTP API; |
| 48 | +- Tarantool Column Store HTTP API. |
| 49 | + |
| 50 | +## Быстрый старт |
| 51 | + |
| 52 | +Пример модели данных, которая генерирует 10 000 строк пользователей и записывает их в CSV-файл: |
| 53 | + |
| 54 | +```yaml |
| 55 | +output: |
| 56 | + type: csv |
| 57 | +models: |
| 58 | + user: |
| 59 | + rows_count: 10000 |
| 60 | + columns: |
| 61 | + - name: id |
| 62 | + type: uuid |
| 63 | + - name: name |
| 64 | + type: string |
| 65 | + type_params: |
| 66 | + logical_type: first_name |
| 67 | +``` |
| 68 | +
|
| 69 | +Сохраните это в файл `simple_model.yml`, затем выполните: |
| 70 | + |
| 71 | +```bash |
| 72 | +./sdvg generate simple_model.yml |
| 73 | +``` |
| 74 | + |
| 75 | +Это создаст CSV-файл с фейковыми пользовательскими данными, такими как `id` и `name`: |
| 76 | + |
| 77 | +```csv |
| 78 | +id,name |
| 79 | +c8a53cfd-1089-4154-9627-560fbbea2fef,Sutherlan |
| 80 | +b5c024f8-3f6f-43d3-b021-0bb2305cc680,Hilton |
| 81 | +5adf8218-7b53-41bb-873d-c5768ca6afa2,Craggy |
| 82 | +... |
| 83 | +``` |
| 84 | + |
| 85 | +Чтобы запустить генератор в интерактивном режиме: |
| 86 | + |
| 87 | +```bash |
| 88 | +./sdvg |
| 89 | +``` |
| 90 | + |
| 91 | +Чтобы посмотреть доступные команды и аргументы: |
| 92 | + |
| 93 | +```bash |
| 94 | +./sdvg -h |
| 95 | +./sdvg --help |
| 96 | +./sdvg generate -h |
| 97 | +``` |
| 98 | + |
| 99 | +Больше информации можно найти в [руководстве по эксплуатации](./doc/ru/usage.md). |
| 100 | + |
| 101 | +## Документация |
| 102 | + |
| 103 | +- [Руководство по эксплуатации](./doc/ru/usage.md) |
| 104 | +- [Руководство для разработчиков](./doc/ru/contributing.md) |
| 105 | +- [Цели и соответствие стандартам](./doc/ru/overview.md) |
| 106 | +- [Список изменений](./CHANGELOG.md) |
| 107 | +- [Лицензия](./LICENSE) |
| 108 | + |
| 109 | +## Разработчики |
| 110 | + |
| 111 | +- [@hackallcode](https://github.com/hackallcode) |
| 112 | +- [@ReverseTM](https://github.com/ReverseTM) |
| 113 | +- [@choseenonee](https://github.com/choseenonee) |
| 114 | +- [@Hoodie-Huuuuu](https://github.com/Hoodie-Huuuuu) |
0 commit comments