diff --git a/bin/templates/README.md_ b/bin/templates/README.md_ index 7b5f6dd..1687e2a 100644 --- a/bin/templates/README.md_ +++ b/bin/templates/README.md_ @@ -2,19 +2,15 @@ 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 +1. 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 +2. 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 +3. 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: +Before starting CRUD operations, with a direct connection to the DB, you must specify the transport through which the exchange will take place (not necessary for GRPC, NRPC) using the command: InitCrudTransport_DB() -InitCrudTransport_GRPC() -InitCrudTransport_NRPC() from module "gitlab.aescorp.ru/dsp_dev/claim/sync_service/pkg/crud_starter" @@ -37,7 +33,7 @@ Also, to get started, the environment variables must be filled in: BUS_LOCAL_HOST= BUS_LOCAL_PORT= -For NRPC (GRPC) it is advisable to connect there first and disconnect at the end +For NRPC (and 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. \ No newline at end of file diff --git a/bin/templates/readme.rus_ b/bin/templates/readme.rus_ index 16e970d..b06dbc4 100644 --- a/bin/templates/readme.rus_ +++ b/bin/templates/readme.rus_ @@ -2,19 +2,16 @@ Сервис для обмена данными с БД Postgres SQL Обмен данными сделано разными методами: -1. Команды в NATS по чтению, изменению и др. -2. DB CRUD операции - прямой обмен с БД +1. DB CRUD операции - прямой обмен с БД (в каждой модели таблицы есть методы Read(), Update(), Create(), Save(), Delete(), Restore()) -3. GRPC - обмен с БД по протоколу GRPC +2. GRPC - обмен с БД по протоколу GRPC (сервис клиент которому надо обмениваться с БД подключается к сервису серверу sync_exchange, последний обменивается с БД) -4. NRPC - обмен с БД по протоколу NRPC +3. NRPC - обмен с БД по протоколу NRPC (сервис клиент которому надо обмениваться с БД подключается к сервису NATS, который передаёт команды серверу sync_exchange, последний обменивается с БД) -Перед началом выполнения CRUD операций надо указать транспорт по которому будет происходить обмен (CRUD, GRPC, NRPC) -с помощью одной из команд: +Перед началом выполнения CRUD операций, при прямом соединении с БД, надо указать транспорт по которому будет происходить обмен (не надо для GRPC, NRPC) +с помощью команды: InitCrudTransport_DB() -InitCrudTransport_GRPC() -InitCrudTransport_NRPC() из модуля "gitlab.aescorp.ru/dsp_dev/claim/sync_service/pkg/crud_starter" @@ -22,22 +19,22 @@ InitCrudTransport_NRPC() (в файле .env) 1) для DB CRUD: - DB_HOST="10.1.9.23" - DB_NAME="claim" - DB_SCHEME="public" - DB_PORT="5432" - DB_USER="" - DB_PASSWORD="" + DB_HOST= + DB_NAME= + DB_SCHEME= + DB_PORT= + DB_USER= + DB_PASSWORD= 2) для GRPC: - SYNC_SERVICE_HOST=10.1.9.150 - SYNC_SERVICE_PORT=30031 + SYNC_SERVICE_HOST= + SYNC_SERVICE_PORT= 3) для NRPC: - BUS_LOCAL_HOST="10.1.9.150" - BUS_LOCAL_PORT=30222 + BUS_LOCAL_HOST= + BUS_LOCAL_PORT= -Для NRPC (GRPC) желательно сначала подключиться туда и в конце отключиться +Для NRPC (и GRPC) желательно сначала подключиться туда и в конце отключиться nrpc_client.Connect() defer nrpc_client.CloseConnection() иначе код всё равно туда подключится, и не отключится в конце работы микросервиса. diff --git a/readme.rus b/readme.rus index 5aaed86..085bf9f 100644 --- a/readme.rus +++ b/readme.rus @@ -44,6 +44,7 @@ в папке bin появится файл crud_generator 2. Заполнить найстройки в файле bin/templates/configs_/settings.txt +(или .env) - подключения к вашей базе данных - имя вашего нового сервиса - URL вашего нового сервиса