From efdfd875b4d9c9c5ffb5d8d62c1f1292c265d3fb Mon Sep 17 00:00:00 2001 From: Kirill Volokh Date: Sat, 9 Dec 2023 17:23:31 +0300 Subject: [PATCH] =?UTF-8?q?=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2=D0=B8=D0=BB=20re?= =?UTF-8?q?adme.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- readme.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 2cfa0c2..2d3de5b 100644 --- a/readme.md +++ b/readme.md @@ -5,7 +5,7 @@ За координацию всего этого отвечает сервис Control. В его ответственность входит: 1. Получение запросов на обработку 2. Сообщение о результатах обработки -3. Управление конвейерами обработки данных[storage.sql](sql%2Fstorage.sql) +3. Управление конвейерами обработки данных Конвейеры обработки данных (pipelines) состоят из более мелких частей -- пайп (pipes). Пайпы выстраиваются в цепочку, и образуется пайплан. Например, конвейер сначала разбивает данные на токены, удаляет знаки препинания, приводит все символы к нижнему регистру, отправляет результат в модель для анализа, получает результат и возвращает его вызывающему коду (то есть сервису Control). @@ -20,7 +20,20 @@ 1. Создать базу данных "log_analysis" 2. В созданной базе данных создать таблицу "pipelines" -После этого можно запускать сервис Control. При запуске необходимо указать параметры. Список этих параметров можно посмотреть в коде либо запустить сервис без указания аргументов. +После этого можно запускать сервис Control. При запуске необходимо указать параметры. Список этих параметров можно посмотреть в коде, либо запустить сервис без указания аргументов. Сервис готов к работе после вывода надписи "server is running" К сервису можно подключиться с помощью ConsoleClient (директория services/console_client). При запуске также нужно указать параметры. + +#### Команды +##### Получение пайп +Возвращает список доступных пайп. Этот список формируется при запуске сервиса и в дальнейшем не изменяется. + +##### Получение пайплайнов +Возвращает список доступных пайплайнов. Список может быть дополнен пользовательскими пайпланами. + +##### Создание пайплайна +Создаёт пайплайн из указанных пайп. Пайпы должны соответствовать друг другу (то есть выход предыдущего пайпа должен соответстовать входу следующего) + +##### Запуск пайплайна +Запускает пайплайн для обработки указанной строки. Возвращает результат обработки