MongoDB
Back-end API
Схема используется для обеспечения работы сервисов компонентов Back-end
Account
Список компаний на инстансе
Название | Тип | Описание |
---|---|---|
_id | String | Уникальный идентификатор компании |
accessPolicy.expiredAt | Date | |
accessPolicy.items | Array | Связь: User |
accessPolicy.items.$ | String | Связь: User |
accessPolicy.requests | Array | |
accessPolicy.requests.author | String | Связь: User |
accessPolicy.requests.handledAt | Date | |
accessPolicy.requests.handledBy | String | Связь: User |
accessPolicy.requests.incomingDate | Date | |
accessPolicy.requests.reason | String | |
accessPolicy.requests.status | String | По-умолчанию: waiting Одно из: [waiting, accepted, rejected] |
accessPolicy.requests.text | String | |
accessPolicy.type | String | По-умолчанию: only Одно из: [none, any, only, except] |
bank | String | Наименование банка корреспондента компании |
bik | String | Номер БИК банка |
Number | Последняя версия полученная из блокчейнаУстаревшее | |
contactPerson | String | Имя контактного лица компании |
correspondentAccount | String | Счет корреспондент |
createdAt | Date | Дата создания компании |
String | Контактный email компании | |
inn | String | Номер ИНН компании |
kpp | String | Номер КПП компании |
legalAddress | String | Юридический адрес компании |
legalName | String | Юридическое наименование компании |
members | Array | Ссылки на пользователей, участников компании |
name | String | Имя компании |
number | Number | Порядковый номер компании |
ogrn | String | Номер ОГРН компании |
owner | String | Id пользователя владельца компании Связь: User |
paymentAccount | String | Номер платежного аккаунта |
phone | String | Контактный телефон компании |
postAddress | String | Почтовый адрес компании |
providerDescription | String | Описание провайдера |
providerName | String | Id компании владельца инстанса |
representativePerson | String | Имя пользователя, представителя компании |
role | String | Роль компании в инстансе По-умолчанию: advertiser Одно из: [advertiser, data_provider, external_data_provider, agency] |
site | String | Сайт компании |
updatedAt | Date | Дата обновления информации о компании |
usersRoles | Array | Доступные роли пользователей |
ActivityLog
Коллекция содержит информацию об истории действий выполняемых пользователями на инстансе
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Уникальный идентификатор запроса |
account | String | Id компании пользователя |
action | String | Выполненное действие |
createdAt | Date | Дата создания запроса |
error | String | Ошибка которая была при выполнении |
modelAfter | Mixed | Состояние модели после исполнения метода |
modelBefore | Mixed | Состояние модели до исполнения метода |
modelId | String | Идентификатор сущности, с которой была произведена какая-то операция |
modelType | String | Тип изменяемой модели |
operation | String | Операция выполненная пользователем |
path | String | Путь исполненного класса |
requestArgs | Mixed | Список аргументов запроса |
requestBody | Mixed | Тело запроса на back-end |
requestId | String | Id запроса на исполнение |
updatedAt | Date | Дата последнего обновления документа |
user | String | Id пользователя совершившего действие |
Counter
Служебная коллекция, содержит в себе инкрементальные значения порядковых номеров основных сущностей платформы
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Id счетчика |
name | String | Имя счетчика |
value | Number | Текущее значение По-умолчанию: 1 |
DataLabVM
Виртуальные машины DataLab зарегистрированные/запущенные в системе
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Пользователь создавший ВМ |
createdAt | Date | Дата создания ВМ |
internalUUID | String | UUID ВМ (внутренний идентификатор DeployController -а) |
name | String | Наименование ВМ |
number | Number | Порядковый номер ВМ |
owner | String | Владелец ВМ Связь: Account |
pendingProcessesCount | Number | Количество ожидающих/не_завершённых процессов на ВМ |
project | ObjectID | Идентификатор проекта к которому принадлежит ВМ Связь: Project |
startedAt | Date | Дата запуска ВМ |
status | String | Статус ВМ По-умолчанию: new Одно из: [new, creating, is_running, running, stopped, done, error] |
stoppedAt | Date | Дата остановки ВМ |
updatedAt | Date | Дата обновления информации о ВМ |
userCreated | String | Пользователь создавший ВМ Связь: User |
DatasetMatchingGroup
Группы матчинга датасетов
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Id записи в MongoDB |
access.begin | Date | Дата начала периода доступности к выгрузке данных |
access.end | Date | Дата окончания периода доступности к выгрузке данных |
baseDataset | String | Id базового датасета группы матчинга |
baseDatasetRequest | ObjectID | Ссылка на запрос на данные базового датасета Связь: DatasetRequest |
createdAt | Date | Дата создания записи |
datasets | Array | Список не базовых датасетов группы матчинга |
features | Array | Список полей запрашиваемые в базовом датасете |
filters | Array | Фильтры применяемые к базовому датасету |
hidden | Boolean | Признак необходимости отображения группы матчинга (soft-delete) |
name | String | Наименование модели |
number | Number | Номер группы матчинга |
operations | Array | Операции, доступные при работе с этой группой датасетов Одно из: [matching, uploadFeatures, dryRun, cleanroom] |
owner | String | Пользователь создавший группу матчинга Связь: Account |
project | ObjectID | Проект в который добавлена группа матчинга, если она добавлена в проект Связь: Project |
result.counts.agreement | Number | Количество строк с согласиями |
result.counts.matched | Number | Количество совпадений между датасетами в группе |
result.counts.total | Number | Количество строк всего |
result.errorMessage | Mixed | Сообщение об ошибке в случае, если какая-то из операций при работе с этой группой, завершилась неудачно |
result.finishedAt | Date | Дата завершения выгрузки на VM |
result.startedAt | Date | Дата начала выгрузки на VM |
result.status | String | Статус выполнения операции с этой группой По-умолчанию: new Одно из: [new, in_process, queued, error, done] |
status | String | Статус группы матчинга По-умолчанию: draft Одно из: [draft, new, ordered, ready, queued, preparing, done, aborted, error] |
updatedAt | Date | Дата обновления записи |
uploadFinishedAt | Date | Дата завершения загрузки на VM |
uploadStartedAt | Date | Дата завершения загрузки на VM |
uploadToVMs | Array | Id ВМ на которую была загружена группа матчинга Связь: DataLabVM |
uploadedToVMsBy | String | Загружено на виртуальную машину пользователем Связь: User |
userCreated | String | Id пользователя создавшего группу матчинга Связь: User |
DatasetRequest
Коллекция содержит в себе информацию о всех запросах на данные которые относятся к инстансу
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Идентификатор документа |
access.begin | Date | |
access.end | Date | Дата с которой доступен запрос на данные |
comment | String | Комментарий к отказу на передачу данных |
createdAt | Date | Дата создания записи |
dataAccessToken | String | |
dataset | String | |
datasetMatchingGroup | ObjectID | Id группы матчинга Связь: DatasetMatchingGroup |
enclaveArgs | Mixed | |
enclaveRequestId | String | |
errorMessage | String | |
filters | Array | |
module | String | По-умолчанию: datalab Одно из: [datalab, p2p] |
name | String | |
number | Number | Порядковый номер запроса на данные |
operations | Array | |
owner | String | Id инстанса создавшего запрос Связь: Account |
ownerInfo.name | String | Денормализованное название владельца (Account ) документа |
project | ObjectID | Идентификатор проекта в который были запрошены данные Связь: Project |
projections | Array | |
providerInstance | String | Id инстанса запросившего данные |
reviewedAt | Date | Дата подтверждения передачи данных |
reviewer | String | Id пользователя который подтвердил передачу данных Связь: User |
status | String | Статус запроса на данные По-умолчанию: new Одно из: [new, review, approved, rejected, queued, preparing, ready, error] |
updatedAt | Date | Дата обновления записи |
uploadToVMs | Array | Id VM на которые была произведена выгрузка датасета Связь: DataLabVM |
uploadedToVMsBy | String | Связь: User |
userCreated | String | Id пользователя создавшего запрос Связь: User |
EnclaveTask
Коллекция содержит информацию о всех задачах которые были поставлены анклаву, такие как матчинг и выгрузка на VM.
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Id запуска скрипта |
args | Array | Аргументы запуска скрипта |
createdAt | Date | Дата создания записи |
entity.id | ObjectID | Id сущности над котрой ведет работу скрипт |
entity.type | String | Тип сущности над котрой ведет работу скрипт Одно из: [datasetMatchingGroup] |
errorMessage | Mixed | Сообщение об ошибке |
funcName | String | Имя функции скрипта |
script | String | Имя выполняемого скрипта |
status | String | Статус исполнения скрипта По-умолчанию: queued Одно из: [queued, processing, error, done, aborted] |
updatedAt | Date | Дата обновления записи |
Job
Коллекция хранит в себе информацию о запусках моделей
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Идентификатор документа |
abortedBy | String | Связь: User |
createdAt | Date | Дата создания Job -а |
dryRun | Boolean | По-умолчанию: true |
executableFilePath | String | Файл, который был запущен в рамках этого Job -а |
finishedAt | Date | Дата завершения джобы |
input.datasetMatchingGroup | ObjectID | Группа матчинга использованная при обработке |
jobSetting | ObjectID | JobSetting к которому относится данная сущностьСвязь: JobSetting |
name | String | Имя модели |
number | Number | Номер запуска модели |
output | String | |
owner | String | Id Инстанса владельца запуска Связь: Account |
project | ObjectID | Идентификатор проекта в котором осуществлялся запуск модели Связь: Project |
schedule | Embedded | Расписание исполнения модели |
schedule.cron | String | Строка конфигурации расписания в cron-формате |
schedule.time | Date | |
script | ObjectID | Id скрипта запущенного в CleanRoom Связь: Script |
source.branch | String | Ссылка на ветку модели в GitLab |
source.commit | String | Ссылка на коммит в модели в GitLab |
source.repository | String | Ссылка на локальный репозиторий в GitLab |
source.tag | String | Ссылка на тег модели в Gitlab |
startedAt | Date | Дата запуска модели |
status | String | Статус модели По-умолчанию: in_progress Одно из: [done, error, in_progress, aborted] |
token | String | |
updatedAt | Date | Дата последнего обновления документа |
userCreated | String | Пользователь, который создал этот документ Связь: User |
JobSetting
Коллекция описывает модели CleanRoom
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Идентификатор документа |
createdAt | Date | Дата создания JobSetting -а |
input.datasetMatchingGroup | ObjectID | Ссылка на группу матчинга |
name | String | Наименование Модели |
number | Number | Номер модели |
owner | String | Владелец (Account ) данного документаСвязь: Account |
project | ObjectID | Идентификатор проекта к которому принадлежит данный JobSetting Связь: Project |
schedule | Embedded | Массив описывающий расписание модели По-умолчанию: {'{"isEnabled":false}'} |
schedule.cron | String | Описание расписания исполнения модели в формате cron-выполнения |
schedule.from | Date | Дата начала действия расписания |
schedule.isEnabled | Boolean | Признак активности расписания |
schedule.scheduledAt | Date | Дата установки расписания |
schedule.to | Date | Дата окончания действия расписания |
script | ObjectID | Ссылка на исполняемый скрипт Связь: Script |
status | String | Статус модели По-умолчанию: new Одно из: [approved, rejected, ready4review, waiting, debug, new] |
updatedAt | Date | Дата последнего обновления документа |
userCreated | String | Пользователь, который создал этот документ Связь: User |
Notification
Содержит в себе информацию о всех нотификациях конечных пользователей и статусе (прочитано/не прочитано)
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Уникальный идентификатор нотификации |
account | String | Компания получатель нотификации Связь: Account |
archivedAt | Date | Дата архивирования нотификации |
createdAt | Date | Дата создания нотификации |
data | Mixed | Информация нотификации |
entity | String | Сущность на которую надо перенаправить пользователя после клика на нотификацию Одно из: [script, order, datasetrequest, datasetmatchinggroup, job, jobsetting] |
header.en | String | Текст заголовка нотификации на английском |
header.ru | String | Текст заголовка нотификации на русском |
message.en | String | Текст сообщения нотификации на Английском |
message.ru | String | Текст сообщения нотификации на русском |
meta | Mixed | Мета информация нотификации |
readAt | Date | Дата прочтения нотификации |
reference | String | |
status | String | Статус нотификации По-умолчанию: unread Одно из: [unread, read, archived] |
type | String | Тип нотификации |
updatedAt | Date | Дата обновления нотификации |
userReceiver | String | Ссылка на пользователя получателя нотификации Связь: User |
Project
Коллекция хранит основную информацию о сущности проект DataLab
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Внутренний id проекта |
createdAt | Date | Дата создания проекта |
datasetRequestsStatuses.approved | Embedded | Признак статуса запроса на данные |
datasetRequestsStatuses.approved.hasAttribute | Boolean | Признак статуса запроса на данные |
datasetRequestsStatuses.approved.updatedAt | Date | Дата изменения статуса проекта |
datasetRequestsStatuses.error | Embedded | Признак статуса запроса на данные |
datasetRequestsStatuses.error.hasAttribute | Boolean | Признак статуса запроса на данные |
datasetRequestsStatuses.error.updatedAt | Date | Дата изменения статуса проекта |
datasetRequestsStatuses.new | Embedded | Признак статуса запроса на данные |
datasetRequestsStatuses.new.hasAttribute | Boolean | Признак статуса запроса на данные |
datasetRequestsStatuses.new.updatedAt | Date | Дата изменения статуса проекта |
datasetRequestsStatuses.preparing | Embedded | Признак статуса запроса на данные |
datasetRequestsStatuses.preparing.hasAttribute | Boolean | Признак статуса запроса на данные |
datasetRequestsStatuses.preparing.updatedAt | Date | Дата изменения статуса проекта |
datasetRequestsStatuses.queued | Embedded | Признак статуса запроса на данные |
datasetRequestsStatuses.queued.hasAttribute | Boolean | Признак статуса запроса на данные |
datasetRequestsStatuses.queued.updatedAt | Date | Дата изменения статуса проекта |
datasetRequestsStatuses.ready | Embedded | Признак статуса запроса на данные |
datasetRequestsStatuses.ready.hasAttribute | Boolean | Признак статуса запроса на данные |
datasetRequestsStatuses.ready.updatedAt | Date | Дата изменения статуса проекта |
datasetRequestsStatuses.rejected | Embedded | Признак статуса запроса на данные |
datasetRequestsStatuses.rejected.hasAttribute | Boolean | Признак статуса запроса на данные |
datasetRequestsStatuses.rejected.updatedAt | Date | Дата изменения статуса проекта |
datasetRequestsStatuses.review | Embedded | Признак статуса запроса на данные |
datasetRequestsStatuses.review.hasAttribute | Boolean | Признак статуса запроса на данные |
datasetRequestsStatuses.review.updatedAt | Date | Дата изменения статуса проекта |
description | String | Описание проекта |
externalId | String | Внешний id проекта |
members | Array | Список участников проекта Связь: User |
name | String | Наименование проекта |
number | Number | Порядковый номер проекта |
originProviderInstance | String | Идентификатор инстанса владельца проекта |
owner | String | Идентификатор компании владельца проекта Связь: Account |
ownerInfo.name | String | Имя владельца проекта |
status | String | Статус проекта По-умолчанию: new Одно из: [new, in_progress, done, cancelled, archived] |
target | String | Бизнес-цель проекта |
updatedAt | Date | Дата обновления информации в проекте |
userCreated | String | Id пользователя создавшего проект Связь: User |
ProviderConfig
Хранит конфигурации разных компонентов, которые можно перенастроить "на лету"
Название | Тип | Описание |
---|---|---|
createdAt | Date | Дата создания записи |
emailSettings.microsoft | Embedded | Параметры отправки писем через Microsoft Exchange |
emailSettings.microsoft.clientId | String | ClientId используемый при отправке писем |
emailSettings.microsoft.clientSecret | String | Параметры авторизации при отправке писем |
emailSettings.microsoft.from | String | Адрес электронной почты отправителя |
emailSettings.microsoft.pass | String | Пароль используемый при отправке писем |
emailSettings.microsoft.user | String | Логин используемый при отправке писем |
emailSettings.smtp | Embedded | Параметры отправки писем через SMTP |
emailSettings.smtp.auth | Embedded | Параметры авторизации при отправке писем |
emailSettings.smtp.auth.pass | String | Пароль используемый при отправке писем |
emailSettings.smtp.auth.user | String | Логин используемый при отправке писем |
emailSettings.smtp.from | String | Адрес электронной почты отправителя |
emailSettings.smtp.host | String | Адрес почтового сервера |
emailSettings.smtp.port | Number | Порт почтового сервера |
emailSettings.smtp.secure | Boolean | Использовать или не использовать TLS |
emailSettings.smtp.senderName | String | Имя отправителя писем |
emailSettings.smtp.tls | Embedded | Параметры работы с TLS По-умолчанию: {'{"rejectUnauthorized":false}'} |
emailSettings.smtp.tls.rejectUnauthorized | Boolean | Вкл/выкл отклонение не валидных сертификатов TLS |
emailSettings.transport | String | Транспортный (сетевой) протокол, используемый при отправке писем По-умолчанию: smtp Одно из: [smtp, microsoft] |
supportEmail | String | |
updatedAt | Date | Дата последнего обновления документа |
Script
Скрипты, созданные в системе
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Идентификатор документа |
createdAt | Date | Дата создания скрипта |
executableFilePath | String | Путь до исполняемого файла в репозитории |
jobSetting | ObjectID | JobSetting к которому относится данная сущностьСвязь: JobSetting |
name | String | Название скрипта |
number | Number | Порядковый номер скрипта |
originProviderInstance | String | Идентификатор инстанса происхождения данного документа |
owner | String | Владелец (Account ) данного документаСвязь: Account |
ownerInfo.name | String | Денормализованное название владельца (Account ) документа |
project | ObjectID | Идентификатор проекта к которому принадлежит данный скрипт Связь: Project |
reviews | Array | |
source.branch | String | Ветка в источнике скрипта, если есть |
source.commit | String | Идентификатор коммита в источнике скрипта, если есть |
source.repository | String | Репозиторий источника скрипта, если есть |
source.tag | String | Тег в источнике скрипта, если есть |
status | String | Статус скрипа По-умолчанию: draft Одно из: [draft, ready4review, rejected, approved] |
updatedAt | Date | Дата последнего обновления документа |
userCreated | String | Пользователь, который создал этот документ Связь: User |
TermBookmark
Коллекция содержит в себе информацию о терминах добавленных в закладки
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Идентификатор документа |
accountId | String | Id компании пользователя добавившего бизнес-термин в закладки Связь: Account |
createdAt | Date | Дата создания строки |
termId | String | Id термина добавленного в закладки |
updatedAt | Date | Дата обновления строки |
userId | String | Id пользователя добавившего бизнес-термин в закладки Связь: User |
User
Пользователи системы
Название | Тип | Описание |
---|---|---|
_id | String | Уникальный идентификатор пользователя инстанса |
auth.hashParams | String | Параметры хеширования пароля |
auth.passwordHash | String | Хеш пароля |
auth.salt | String | Соль, используемая при хешировании пароля |
Number | Версия документа в блокчейнеУстаревшее | |
contactEmail | String | Email пользователя |
createdAt | Date | Дата создания пользователя |
firstName | String | Имя пользователя |
isApproved | Boolean | Признак подтвержденности пользователя |
isEmailNotifying | Boolean | Разрешил ли пользователь отправлять ему уведомления по электронной почте По-умолчанию: true |
language | String | Язык системы выбранный пользователем Одно из: [ru, en] |
lastName | String | Фамилия пользователя |
login | String | Логин пользователя |
middleName | String | Отчество / среднее имя пользователя |
passwordResetCode | String | Временный код для сбрасывания пароля |
passwordResetCodeExpiration | Date | Время действия временного кода для сбрасывания пароля |
phone | String | Номер телефона пользователя |
position | String | Должность пользователя |
skype | String | Skype пользователя |
telegram | String | Telegram пользователя |
updatedAt | Date | Дата обновления информации о пользователе |
String | WhatsApp пользователя |
DataService
Схема используется для обеспечения работы сервисов DataService
DataState
Служебная таблица для синхронизации с Blockchain
Название | Тип | Описание |
---|---|---|
createdAt | Date | Дата создания строки |
key | String | Наименование курсора |
updatedAt | Date | Дата обновления строки |
value | Mixed | Справочник значений курсора |
Dataset
Название | Тип | Описание |
---|---|---|
_id | ObjectID | |
bcVersion | Number | По-умолчанию: 1 |
clientAudienceSource | Boolean | |
confidentiality | String | |
createdAt | Date | |
database | Embedded | |
database.isEnabled | Boolean | По-умолчанию: true |
database.name | String | |
database.qualifiedName | String | |
database.sourceName | String | |
description | Array | |
detailing | String | |
displayName | Array | |
fields | Array | |
globalId | String | |
instanceGlobalId | String | |
instanceQualifiedName | String | |
isEnabled | Boolean | По-умолчанию: true |
isMatchable | Boolean | |
owner | String | |
published | Boolean | |
qualifiedName | String | |
schemaVersion | Number | |
table | Embedded | |
table.isEnabled | Boolean | По-умолчанию: true |
table.name | String | |
table.qualifiedName | String | |
table.size | Number | |
table.sourceName | String | |
table.updateFrequency | String | |
table.updatedAt | String | |
term | String | |
updateFrequency | String | |
updatedAt | Date | |
visibilityArea | String |
DatasetLog
Хранит в себе информацию о том какие датасеты, кем, когда, с какой целью запрашивались с инстанса для дальнейшего отображения на Frontend
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Id записи в MongoDB |
businessGoal | String | Бизнес цель проекта в котором выполнялись действия над датасетом |
dataset | String | Id датасета над которым выполнялись действия |
downloadedAt | Date | Дата выполнения запроса на получение данных из датасета |
operation | String | Тип запроса датасета Одно из: [matching, upload, cleanroom] |
project | String | Id проекта в котором выполнялись действия над датасетом |
providedBy | String | Id инстанса запросившего датасет |
providedTo | String | Id инстанса владельца датасета |
Glossary
Хранит в себе информацию о всех глоссариях Каталога данных
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Уникальный идентификатор глоссария в MongoDB |
bcVersion | Number | Версия глоссария в Blockchain По-умолчанию: 1 |
createdAt | Date | Дата создания записи |
globalId | String | Глобальный Id глоссария |
isEnabled | Boolean | Признак активности глоссария По-умолчанию: true |
name | String | Наименование глоссария для отображения |
owner | String | Идентификатор инстанса организации владельца |
qualifiedName | String | Уникальное текстовое наименование из Каталога данных |
schemaVersion | Number | Версия схемы данных |
updatedAt | Date | Дата обновления записи |
GlossaryTerm
Хранит в себе информацию о всех бизнес-терминах
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Уникальный идентификатор записи в MongoDB |
aggregationMethodology | String | Методология аггрегации |
attributeType | String | Тип термина |
bcVersion | Number | Версия записи в Blockchain По-умолчанию: 1 |
calculationMethod | String | Методология расчета значений характеризующимися терминами |
children | Array | Ссылки на дочерние бизнес-термины |
confidentiality | String | Признак конфиденциальности термина Одно из: [unclassified, strictly_confidential, confidential] |
createdAt | Date | Дата создания записи |
globalId | String | Глобальный Id бизнес-термина |
glossaryGlobalId | String | Id глоссария к которому принадлежит термин |
isEnabled | Boolean | Признак активности бизнес-термина По-умолчанию: true |
longDescription | String | Описание бизнес-термина |
matchingAttribute | String | Атрибут матчинга термина |
measurementUnit | String | Единица измерения |
minimalCut | String | Минимальный разрез |
name | String | Наименование бизнес-термина для отображения |
nameEn | String | Наименование термина на Английском |
owner | String | Id инстанса владельца датасета |
parents | Array | Ссылки на родительские бизнес-термины |
published | Boolean | Признак опубликованности бизнес-термина |
qualifiedName | String | Уникальное текстовое наименование из Каталога данных |
schemaVersion | Number | Номер версии схемы |
status | String | Статус термина |
subjectArea | String | Предметная область |
synonyms | Array | Ссылки на бизнес-термины синонимы |
String | Тип сущности Каталог данных Устаревшее | |
updatedAt | Date | Дата обновления записи |
visibilityArea | String | Область видимости термина Одно из: [private, group_internal] |
Instance
Хранит в себе информацию об инстансах ClickHouse используемые в Каталоге данных
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Уникальный идентификатор записи в MongoDB |
createdAt | Date | Дата создания записи |
globalId | String | Идентификатор инстанса |
hostname | String | Название хоста инстанса |
isEnabled | Boolean | Признак активности инстанса По-умолчанию: true |
name | String | Наименование инстанса для отображения |
password | String | Пароль пользователя для подключения к инстансу |
port | Number | Порт для подключения к инстансу |
qualifiedName | String | Уникальное текстовое наименование из Каталога данных |
rdbmsType | String | Тип БД на инстансе |
schemaVersion | Number | Версия схемы данных |
sourceName | String | Наименование инстанса используемое при обращении к инстансу |
updatedAt | Date | Дата обновления записи |
username | String | Имя пользователя для подключения к инстансу |
Token
Коллекция содержит в себе токены доступа к данным
Название | Тип | Описание |
---|---|---|
_id | ObjectID | Уникальный внутренний идентификатор токена в MongoDB |
confirmed | Number | Количество подтвержденных выгрузок |
createdAt | Date | Дата создания записи |
expireAt | Date | Дата истечения токена |
failed | Number | Количество неудачных попыток использования токена |
payload.entity.id | String | Идентификатор сущности для выгрузки |
payload.entity.type | String | Тип сущности для выгрузки По-умолчанию: DATASET Одно из: [PROJECT, DATASET_REQUEST, DATASET] |
payload.kind | String | Тип доступа к данным по токену, одноразовый или многоразовый По-умолчанию: ONE_OFF Одно из: [REUSABLE, ONE_OFF] |
payload.meta | Mixed | Произвольная, дополнительная информация |
payload.operation | String | Указатель типа операции в которой может быть использован токен Одно из: [cleanroom, upload, matching] |
payload.providedBy | String | Id инстанса компании кем выпущен токен |
payload.providedTo | String | Id инстанса компании для кого выпущен токен |
payload.tokenId | String | Идентификатор токена |
success | Number | Количество успешных выгрузок по токену |
updatedAt | Date | Дата обновления записи |