Перейти к содержимому
omnismith docs

Атрибуты

Атрибуты — это базовые определения полей данных в Omnismith. Они задают, какая информация может храниться в записях сущностей, как валидируются данные и как метрики отслеживаются во времени.

1. Типы атрибутов (Функциональная классификация)

Заголовок раздела «1. Типы атрибутов (Функциональная классификация)»

При создании атрибута вы выбираете один из четырех основных функциональных типов:

Тип атрибутаОписаниеОсновной сценарийПоведение хранения и аналитики
Измерение (Dimension)Дискретные свойства и описательный текст.Имена, артикулы, категории, описания.Хранится в реляционных таблицах с ведением Журнала аудита, фиксирующего все правки во времени.
Метрика (Metric)Числовые значения, изменяющиеся во времени.Загрузка CPU, баланс счета, задержка, объем хранилища.Хранится в высокопроизводительных таблицах TimescaleDB. Поддерживает функции агрегации (min, max, avg, sum).
Список (List)Поля с предопределенным набором значений.Приоритет (Низкий, Средний, Высокий), Статус (Открыт, В работе, Закрыт).Элементы управляются динамически. Полезно для строгой валидации форм и чипов фильтрации.
Ссылка (Reference)Ссылочные указатели, связывающие сущности.Заявка → Клиент, Заказ → Продукт.Устанавливает реляционные связи между записями с отображением целевого атрибута.

2. Поддерживаемые типы данных

Заголовок раздела «2. Поддерживаемые типы данных»

Каждый атрибут указывает тип данных, обеспечивающий строгую валидацию при вводе в UI или через API:

  • String: Стандартные текстовые строки UTF-8 (например, Hostname, Имя клиента).
  • Number: Целые или дробные числа (например, Цена, Температура, Количество).
  • Boolean: Двоичные флаги (true / false), отражающие переключатели (например, Активен, VIP).
  • Date: Календарная дата в формате ГГГГ-ММ-ДД (например, Срок годности, Дата рождения).
  • DateTime: Точная метка времени по ISO 8601 (например, 2026-07-20T20:15:00Z).
  • File: Ссылка на прикрепленный документ (PDF, таблицы).
  • Image: Ссылка на прикрепленное медиа-изображение (PNG, JPEG).

3. Создание и управление атрибутами в UI

Заголовок раздела «3. Создание и управление атрибутами в UI»
  1. Перейдите в Моделирование данных → Атрибуты в боковом меню.
  2. Нажмите + Создать атрибут (или выберите существующий для редактирования).
  3. Настройте основные параметры:
    • Название: Понятный заголовок поля (например, Задержка отклика).
    • Тип атрибута: Выберите Измерение, Метрика, Список или Ссылка.
    • Тип данных: Выберите тип значения (String, Number, Boolean, Date, DateTime, File, Image).
  4. Специфичные настройки типа:
    • Для Списка: Добавьте элементы вариантов с пользовательскими метками и значениями.
    • Для Ссылки: Выберите Целевой шаблон и Целевой отображаемый атрибут, используемый для отрисовки связанных записей.
  5. Нажмите Сохранить изменения.

Экран настройки атрибута с выбором типа и типа данных

💡 Примечание для разработчиков

Заголовок раздела «💡 Примечание для разработчиков»

[!NOTE] Переиспользование схем и производительность: Атрибуты глобальны для всего Проекта. Один и тот же атрибут (например, Статус или Дата создания) может быть прикреплен к нескольким Шаблонам без дублирования объявлений полей.

  • Измерения: Индексируются стандартными индексами поиска.
  • Метрики: Партиционируются в гипертаблицах для выполнения аналитических запросов за миллисекунды.
  • OpenAPI: Атрибуты автоматически доступны для запросов через конечную точку /api/v1/attribute.

Следующие шаги

Заголовок раздела «Следующие шаги»

[!TIP]