1
0
mirror of https://github.com/ManyakRus/crud_generator.git synced 2025-01-17 08:56:48 +02:00

сделал readme

This commit is contained in:
Nikitin Aleksandr 2024-03-15 16:30:07 +03:00
parent 529886e8e1
commit fc5b3a63c0
2 changed files with 23 additions and 9 deletions

View File

@ -3,7 +3,12 @@ in golang language to perform CRUD operations.
A completely ready-made microservice is created that can be launched immediately. A completely ready-made microservice is created that can be launched immediately.
For each table in the Postgres SQL database, files will be created to perform crud operations: For each table in the Postgres SQL database, files will be created to perform crud operations:
create, read, update, save, delete (or delete + restore) - Create(), Read(), Update(), Delete() (or Delete() + Restore(), if there is an is_deleted field)
- Save() - creating a new record when ID=0, or updating a record when ID<>0
- ReadFromCache() - reading from cache or database
- Update_ColumnName() - changing only one column with the name ColumnName,
separate function for each column of each table
files are generated: files are generated:
1. table - struct structure with all fields from the database, and gorm + json annotations 1. table - struct structure with all fields from the database, and gorm + json annotations
Tables with fields in the database must be created manually in advance. Tables with fields in the database must be created manually in advance.
@ -45,11 +50,13 @@ the crud_generator file will appear in the bin folder
- URL of your new service - URL of your new service
- and etc. - and etc.
3. Launch crud_generator 3. Tables in the database must be created in advance, manually.
4. Launch crud_generator
A new folder with the name of your service will appear in the bin folder, A new folder with the name of your service will appear in the bin folder,
with subfolders and finished files inside. with subfolders and finished files inside.
4. Fill in the configuration parameters in the .env file 5. Fill in the configuration parameters in the .env file
Start microservice: Start microservice:
make run make run

View File

@ -3,7 +3,12 @@
Создаётся полностью готовый микросервис, который можно сразу запустить. Создаётся полностью готовый микросервис, который можно сразу запустить.
Для каждой таблицы в базе данных Postgres SQL будут сделаны файлы для выполнения crud операций: Для каждой таблицы в базе данных Postgres SQL будут сделаны файлы для выполнения crud операций:
create, read, update, save, delete (или delete + restore) - Create(), Read(), Update(), Delete() (или Delete() + Restore() если есть поле is_deleted)
- Save() - создание новой записи при ID=0, или обновление записи при ID<>0
- ReadFromCache() - чтение из кэша или базы данных
- Update_ColumnName() - изменение только одной колонки с именем ColumnName,
отдельная функция для каждой колонки каждой таблицы.
генерируются файлы: генерируются файлы:
1. table - структура struct со всеми полями из БД, и аннотациями gorm + json 1. table - структура struct со всеми полями из БД, и аннотациями gorm + json
Таблицы с полями в базе данных должны быть созданы заранее вручную. Таблицы с полями в базе данных должны быть созданы заранее вручную.
@ -22,7 +27,7 @@ create, read, update, save, delete (или delete + restore)
7. crud_starter - файл с функциями переключения на нужный протокол db или grpc или nrpc 7. crud_starter - файл с функциями переключения на нужный протокол db или grpc или nrpc
8. main.go и другие .go файлы 8. main.go и другие .go файлы
9. Makefile - файл настройки запуска скриптов 9. Makefile - файл настройки запуска скриптов
10. .env - файл для зазполнения конфигурации микросервиса (параметры подключения к БД и др.) 10. .env - файл для заполнения конфигурации микросервиса (параметры подключения к БД и др.)
Шаблоны кода хранятся в папке bin/templates. Шаблоны кода хранятся в папке bin/templates.
@ -35,7 +40,7 @@ create, read, update, save, delete (или delete + restore)
Порядок установки: Порядок установки:
1. Скомпилировать этот репозиторий 1. Скомпилировать этот репозиторий
make build >make build
в папке bin появится файл crud_generator в папке bin появится файл crud_generator
2. Заполнить найстройки в файле bin/templates/configs_/settings.txt 2. Заполнить найстройки в файле bin/templates/configs_/settings.txt
@ -44,13 +49,15 @@ make build
- URL вашего нового сервиса - URL вашего нового сервиса
- и др. - и др.
3. Запустить crud_generator 3. Таблицы в базе данных должны быть сделаны заранее, вручную.
4. Запустить crud_generator
В папке bin появится новая папка с именем вашего сервиса, В папке bin появится новая папка с именем вашего сервиса,
с подпапками и готовыми файлами внутри. с подпапками и готовыми файлами внутри.
4. Заполнить параметры конфигурации в файле .env 5. Заполнить параметры конфигурации в файле .env
Запустить микросервис: Запустить микросервис:
make run >make run