UBOS Community: Oleksii

Робота з mongoDB

Oleksii — Sat, 03 Dec 2022 11:11:40 +0000

Зміст

Вступ
Підготовка
Post запит
Get запит
Update запит
Delete запит

Вступ

Створімо базовий CRUD з використанням бази даних MongoDB. Для прикладу ми будемо працювати з сутністю book з такими полями:

id - унікальний автоматично згенерований ідентифікатор
name - назва книги
genre - жанр
author - автор
deleted - поле, по котрому перевірятимемо чи книга не видалена

Підготовка

Перш за все ми повинні встановити інструменти для роботи з MongoDB. Для цього відкрийте меню в правому верхньому кутку та оберіть пункт Manage palette.

У вікні, що з'явиться, відкрийте вкладку Install та знайдіть пункт з назвою "node-red-node-mongodb", Уважно перевірте, чи ви встановлюєте правильні вузли, і натисніть на кнопку install.

Після завантаження у нас з'являться нові вузли.

Тепер під'єднаймо базу даних MongoDB до Node-red. Про те як створити базу даних MongoDB читайте тут. Винесіть вузол mongoDB на робочу область та двічі клацніть по ньому. В результаті у нас з'явиться вікно з налаштуванням вузла. Натисніть на кнопку з олівчиком, щоб створити нову конфігурацію для бази даних.

У меню Services натисніть на поле DATA SOURCE, а потім на назву вашої бази даних, щоб отримати інформацію про неї.

Цю інформацію нам потрібно внести в конфігурацію, де:
Host - Host
Port - залишаємо без змін(27017)
Database - Name
Username - User Name
Password - Password
Name - Назва конфігурації, тут можна писати яку забажаєте
Connect options - Connect options
Після заповнення натисніть кнопку Add

Тепер потрібно зберегти наші зміни за допомогою кнопки Deploy.
Якщо ми все зробили правильно, то під вузлом з'явиться зелений квадратик з надписом connected. В іншому випадку там був би червоний квадратик з надписом eror.

Тепер ми зможемо підключатись до нашої бази даних за допомогою створених нами конфігурацій, для цього просто оберіть пункт з її назвою в налаштуваннях вузла.

Post запит

Зробімо ендпоінт для створення запису про нову книгу. Для цього нам знадобляться такі вузли, як http in, function, mongodb out, http responce.

Потрібно налаштувати всі вузли. Щоб відкрити вікно з налаштуванням кожного вузла - двічі клацніть по ньому мишкою.

http in - Оберіть метод POST та придумайте адресу по котрій можна буде звернутись до ендпоінту. Після цього натисніть Done

Function - тут лише потрібно до даних, що прийдуть ззовні, додати нове поле deleted

msg.payload.deleted = false;
return msg;

Mongodb out - Оберіть раніше створений сервер, додайте назву колекції та оберіть операцію insert. Також потрібно поставити галочку біля опції Only store msg.payload object. -Вузол http response залишаємо без змін, він потрібен, щоб отримати відповідь

Тепер потрібно з'єднати всі вузли, після чого наш перший ендпоїнт готовий. Збережіть зміни за допомогою кнопки Deploy.

Протестуймо наш ендпоїнт. Для цього я скористаюсь програмою postman, але можна використати і UI Editor. Для того, щоб скопіювати посилання Node-red наведіть на поле з його назвою в меню Services та натисніть на значок з аркушем.

Передаємо відповідні поля в тіло запиту і натискаємо Send. Якщо ми отримуємо статус код 200 значить все виконано успішно.

Таким самим чином я створю ще 2 записи в базі даних для того, щоб з ними працювати потім.

Get запит

Тут нам знадобляться такі вузли, як http in, function, mongodb in, http response.
-http in - оберіть метод GET і введіть адрес по якому можна буде звернутись до ендпоінту.

-function - шукаємо тільки записи, котрі не були видалені

msg.payload = {
    deleted: false
}
return msg;

-mongodb in - потрібно ввести назву колекції та обрати операцію find

Цей flow матиме такий вигляд

Зберігаємо зміни та повертаємось в postman. Метод Get повертає список всіх наших книг

Update запит

Нам знадобляться такі вузли, як http in, function, mongodb out, http response.
-http in - Обираємо метод PUT і вводимо адрес

-function - Оскільки ми будемо працювати з id об'єкту, нам знадобиться objectid. Щоб його додати, відкрийте вкладку setup, натисніть кнопку add і введіть потрібне значення. Потім поверніться у вкладку On message. Оскільки id для кожного елементу унікальний, його потрібно видалити перед оператором оновлення($set).

msg.query = {"_id": objectid(msg.payload._id)}
delete msg.payload._id
msg.payload={
    $set: msg.payload
}
return msg;

-mongodb out - Введіть назву колекції та оберіть операцію update

Flow матиме такий вигляд

Повертаємось у postman. Тут нам потрібно передати цілий об'єкт, який хочемо замінити, тому тіло запиту буде таке саме як при POST запиті, за виключенням поля _id яке потрібне, щоб ідентифікувати об'єкт який ми міняємо. Також виконаємо Get запит, щоб перевірити результат. Як результат, книга по id була змінена.

Delete запит

Загалом, операція видалення буде такою самою як update, за виключенням того, що ми не будемо передавати ніякі дані окрім id, та встановимо полю deleted значення true. Це означає, що ми не будемо безпосередньо видаляти запис з бази даних.

-http in - оберіть метод delete та вкажіть адрес

-function - додайте objectid так, як ми це робили раніше. В розділі On message введіть наступний код

msg.query = { "_id": objectid(msg.payload._id) }
delete msg.payload._id
msg.payload = {
    $set: {"deleted" : true}
}
return msg;

-mongodb out - введіть назву колекції та оберіть операцію update

Flow матиме такий вигляд

Зберігаємо зміни та перевіряємо все у postman. Тут ми передамо в тіло запиту id запису, котрий будемо видаляти. Видаляємо книгу з назвою "example". Після виконання знову викличемо Get запит для перевірки. Цієї книги більше немає в списку.

Створення бази даних MySQL

Oleksii — Sat, 03 Dec 2022 11:11:29 +0000

Щоб створити базу даних, у меню Services(в лівому верхньому кутку екрана) натисніть на + біля надпису DATA SOURCE

Після цього з'явиться модальне вікно зі створенням бази даних, заповніть відповідні поля, в полі Type Data Source оберіть mysql. Натисніть на кнопку Create Database для того, щоб створити базу даних.

Після створення ми можемо побачити базу даних натиснувши на рядок "DATA SOURCE" в меню Services. Ми побачимо назву нашої бази даних в списку. Якщо у нас вже була створена інша база даних і список баз був відкритим, то щоб в цьому списку з'явилась наша потрібно його згорнути та знову розгорнути.

Якщо натиснути на назву бази, то з'явиться модальне вікно з інформацією про цю базу даних.

Ця інформація знадобиться для подальшого використання в середовищі Node Red.

Створення бази даних MongoDB

Oleksii — Sat, 03 Dec 2022 11:11:19 +0000

Щоб створити базу даних, у меню Services(в лівому верхньому кутку екрана) натисніть на + біля надпису DATA SOURCE.

Після цього з'явиться модальне вікно зі створенням бази даних, заповніть відповідні поля, в полі Type Data Source оберіть mongo. Натисніть на кнопку Create Database для того, щоб створити базу даних.

Після створення ми можемо побачити базу даних натиснувши на рядок DATA SOURCE в меню Services. Ми побачимо її назву в списку.

Якщо натиснути на назву бази, то з'явиться модальне вікно з інформацією про неї.

Ця інформація знадобиться для подальшого використання в середовищі Node Red. Один з прикладів ви можете побачити тут

Підняття UI Editor

Oleksii — Sat, 03 Dec 2022 11:11:04 +0000

Щоб створити новий UI Editor, в меню Services в лівому верхньому кутку, натискаємо на + навпроти надпису UI Editor

У вікні котре з'явиться вводимо назву для нового UI editor та натискаємо Create UI

Далі потрібно зачекати доки editor завантажиться(повинен зникнути анімований логотип UBOS). Після завершення завантаження відкриється пустий UI editor.

Також, цей UI можна буде відкрити в майбутньому за допомогою кнопки з його назвою на панелі Services. Для цього потрібно натиснути на надпис UI EDITOR, і в випадаючому списку що з'явиться натиснути на назву нашого editor.

Для того, щоб зберегти внесені зміни та розвернути додаток потрібно натиснути кнопку DEPLOY в правому верхньому кутку

Після цього з'явиться модальне вікно з пропозицією переглянути розвернутий додаток. Для того, щоб погодитись натисніть кнопку View Application, або ж на хрестик, щоб закрити модальне вікно

Підняття середовища Node-red

Oleksii — Sat, 03 Dec 2022 11:10:45 +0000

Натисніть на кнопку зі + у меню Services, в лівому верхньому кутку (навпроти надпису FLOW BUILDER).

У модальному вікні, яке з'явиться введіть назву проєкту та натисніть кнопку create NodeRed.

Якщо назва проєкту написана сірим, то він успішно піднятий.

Після того як едітор завантажиться node-red запропонує нам створити новий проєкт, або ж клонувати наявний. При потребі ми можемо виконати цю дію пізніше, натиснувши кнопку "Not right now", однак в нашому випадку натискаємо Create project.

Введіть своє ім'я користувача та електронну пошту у відповідні поля і натисніть Next.

Далі потрібно ввести назву проєкту, а також за потреби його опис. В нашому випадку ми пропустимо створення опису та натиснемо кнопку Next.

В наступному вікні просто знову натискаємо Next.

Тут ми можемо увімкнути шифрування в нашому проєкті, однак нам це не потрібно, тому вибираємо опцію Disable encryprion та натискаємо Create project.

Наш проєкт успішно створений, натискаємо кнопку Done і можемо починати працювати в Flow builder.

Для того, щоб зберегти внесені зміни натисніть кнопку Deploy в правому верхньому кутку.