go/crud_generator
1
0
Fork 0
mirror of https://github.com/ManyakRus/crud_generator.git synced 2024-12-22 00:36:41 +02:00
Code Issues Releases Activity

сделал README.md

Browse Source
This commit is contained in:
Nikitin Aleksandr 2024-03-22 16:26:01 +03:00
parent 830ea6bba5
commit 115c3fa3aa
2 changed files with 86 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
bin/templates/README.md Normal file
View File

@ -0,0 +1,42 @@
The service implements synchronous data exchange.
Service for exchanging data with Postgres SQL database
Data exchange is done using different methods:
1. Commands in NATS for reading, changing, etc.
2. DB CRUD operations - direct exchange with the database
(each table model has methods Read(), Update(), Create(), Save(), Delete(), Restore())
3. GRPC - exchange with the database using the GRPC protocol
(the client service that needs to exchange with the database connects to the sync_exchange server service, the latter exchanges with the database)
4. NRPC - exchange with the database using the NRPC protocol
(the client service that needs to exchange with the database connects to the NATS service, which sends commands to the sync_exchange server, the latter exchanges with the database)
Before starting CRUD operations, you must specify the transport over which the exchange will take place (CRUD, GRPC, NRPC)
using one of the commands:
InitCrudTransport_DB()
InitCrudTransport_GRPC()
InitCrudTransport_NRPC()
from module
"gitlab.aescorp.ru/dsp_dev/claim/sync_service/pkg/crud_starter"
Also, to get started, the environment variables must be filled in:
1) for DB CRUD:
DB_HOST="10.1.9.23"
DB_NAME="claim"
DB_SCHEME="public"
DB_PORT="5432"
DB_USER=""
DB_PASSWORD=""
2) for GRPC:
SYNC_SERVICE_HOST=10.1.9.150
SYNC_SERVICE_PORT=30031
3) for NRPC:
BUS_LOCAL_HOST="10.1.9.150"
BUS_LOCAL_PORT=30222
For NRPC (GRPC) it is advisable to connect there first and disconnect at the end
nrpc_client.Connect()
defer nrpc_client.CloseConnection()
otherwise, the code will still connect there and will not disconnect at the end of the microservice.

44
bin/templates/readme.rus Normal file
View File

@ -0,0 +1,44 @@
Сервис реализует синхронный обмен данными.
Сервис для обмена данными с БД Postgres SQL
Обмен данными сделано разными методами:
1. Команды в NATS по чтению, изменению и др.
2. DB CRUD операции - прямой обмен с БД
(в каждой модели таблицы есть методы Read(), Update(), Create(), Save(), Delete(), Restore())
3. GRPC - обмен с БД по протоколу GRPC
(сервис клиент которому надо обмениваться с БД подключается к сервису серверу sync_exchange, последний обменивается с БД)
4. NRPC - обмен с БД по протоколу NRPC
(сервис клиент которому надо обмениваться с БД подключается к сервису NATS, который передаёт команды серверу sync_exchange, последний обменивается с БД)
Перед началом выполнения CRUD операций надо указать транспорт по которому будет происходить обмен (CRUD, GRPC, NRPC)
с помощью одной из команд:
InitCrudTransport_DB()
InitCrudTransport_GRPC()
InitCrudTransport_NRPC()
из модуля
"gitlab.aescorp.ru/dsp_dev/claim/sync_service/pkg/crud_starter"
Также для начала работы должны быть заполнены переменные окружения:
1) для DB CRUD:
DB_HOST="10.1.9.23"
DB_NAME="claim"
DB_SCHEME="public"
DB_PORT="5432"
DB_USER=""
DB_PASSWORD=""
2) для GRPC:
SYNC_SERVICE_HOST=10.1.9.150
SYNC_SERVICE_PORT=30031
3) для NRPC:
BUS_LOCAL_HOST="10.1.9.150"
BUS_LOCAL_PORT=30222
Для NRPC (GRPC) желательно сначала подключиться туда и в конце отключиться
nrpc_client.Connect()
defer nrpc_client.CloseConnection()
иначе код всё равно туда подключится, и не отключится в конце работы микросервиса.