service

addCron

Додає планувальник

Параметри

Параметр	Тип	Опис
func	Object	Функція, яка буде викликатись планувальником
interval	String / Number	Інтервал часу між запусками
autoInit	Number	Опційний параметр

Приклад

addCron(require('./util/controller/importOvd'), '08:00', funcs);

redis

getOpt

Функція призначена для отримання опцій (налаштувань) за токеном. Повертає json.

Параметри

Параметр	Тип	Опис
token	String	Токен

Приклад

await getOpt(query.id);

setOpt

Функція призначена для збереження опцій (налаштувань) в базі даних Redis. Повертає токен за вхідними параметрами

Параметри

Параметр	Тип	Опис
params	Object / String	Параметри для збереження.

Якщо параметри представлені у вигляді об'єкта, вони конвертуються в JSON-рядок перед обчисленням хешу. Якщо параметри представлені у вигляді рядка, вони використовуються напряму для обчислення хешу

Приклад

  await setOpt(opt);

addHook

Функція використовується для додавання хуків (функцій-обробників) до списку хуків.

Параметри

Параметр	Тип	Опис
name	string	Назва хука, до якого буде доданий обробник
fn	function	Функція-обробник, яку потрібно додати до хука

Приклад

addHook('preTemplate', require('./addEdateUidColumnHook'));

applyHook

Функція призначена для виклику хуків (функцій-обробників) з певним ім'ям та передачі їм даних та додаткових аргументів.

Параметри

Параметр	Тип	Опис
name	string	Назва хука, який потрібно викликати
data	object	Дані, які будуть передані кожному обробнику хука
args	object	Додаткові аргументи, які будуть додані до об'єкта data перед передачею обробнику

Приклад

  await funcs.applyHook('preTemplate', { payload: docList[name], type });

getPK

Функція призначена для отримання первинного ключа (PK) таблиці з бази даних PostgreSQL.

Параметри

Параметр	Тип	Опис
table	string	Назва таблиці, для якої потрібно отримати первинний ключ
pg1	object, optional	Об'єкт з'єднання з базою даних PostgreSQL. Якщо не вказано, використовується основне з'єднання pg

• Якщо первинний ключ для даної таблиці вже був отриманий раніше, результат буде збережений у кеші, та повторний запит буде повертати збережений результат.

• Якщо вказано db.pk[table], то значення з цього об'єкта буде використано як первинний ключ, і функція поверне його.

• Якщо таблиця визначена у db.progrid і має належність до схеми бази даних, то виконується запит до бази даних для отримання первинного ключа.

Приклад

const pk = await funcs.getPK('data_parcel_orenda.lease');

getPG

Функція створює та повертає об'єкт для взаємодії з базою даних PostgreSQL. Використовується для отримання екземпляру підключення до бази даних.

Параметри

Параметр	Тип	Опис
args	object	Об'єкт параметрів, які визначають базу даних (args.db.db / args.db / args.dbname / args)

Приклад

  const pg1 = funcs.getPG({ db: 'geo_atu' });

getDBParam

Функція використовується для отримання параметрів конфігурації бази даних. Вона визначає параметри бази даних, яку слід використовувати для програми.

Параметри

Параметр	Тип	Опис
db	object	Об'єкт конфігурації бази даних

Приклад

 getDB('postgres:postgres@192.168.3.160:5433/geo_admin_dabi');

getRedis

Функція визначає та повертає об'єкт з п'ятьма клієнтами Redis, які можна використовувати для взаємодії з базою даних Redis у програмі.

Функція не приймає жодних параметрів.

Приклад

const { rclient1, rclient2 } = funcs.getRedis();

getConfig

Функція призначена для отримання конфігураційних даних, пов'язаних з сервером. Вона об'єднує різноманітні конфігураційні об'єкти, щоб забезпечити повний набір параметрів для використання в програмі.

Параметри

Параметр	Тип	Опис
db	object	Об'єкт конфігурації бази даних

const { configServer } = funcs.getConfig();