Представления базы данных в API GraphQL

Представления поддерживаются в качестве альтернативы таблицам в построителе API данных (DAB). Представление можно предоставлять с помощью конечных точек GraphQL с минимальной конфигурацией.

Конфигурация

Чтобы отобразить вид, выполните следующие действия.

  • Установите source.type на "view"
  • Задайте source.object полное имя представления
  • Чтобы определить строку уникально, определите key-fields
  • Предоставьте разрешение с помощью "read" действия (при необходимости"create", "update""delete"если представление обновляется)

Пример интерфейса командной строки

dab add BookDetail \
  --source dbo.vw_books_details \
  --source.type "view" \
  --fields.name "id" \
  --fields.primary-key "true" \
  --permissions "anonymous:read"

Пример конфигурации

"BookDetail": {
  "source": {
    "type": "view",
    "object": "dbo.vw_books_details",
    "key-fields": [ "id" ]
  },
  "permissions": [
    {
      "role": "anonymous",
      "actions": [ "read" ]
    }
  ]
}

Поведение GraphQL

  • Представление отображается как тип GraphQL
  • Запросы всегда поддерживаются
  • Изменения поддерживаются только в том случае, если представление является обновляемым
  • Соответствует стандартной структуре схемы DAB GraphQL

Пример запроса

{
  bookDetails {
    items {
      id
      title
      authorName
    }
  }
}

Разрешения

  • Использование действия read для представлений только для чтения
  • Использование create, updateи delete только если представление является обновляемым

Ограничения

  • key-fields обязательны
  • Представления не поддерживают связи
  • Разбиение на страницы, фильтрация и сортировка поддерживаются, если представление работает как таблица