Zobrazení databáze v rozhraní GraphQL API

Zobrazení jsou podporována jako alternativy k tabulkám v aplikaci Data API Builder (DAB). Zobrazení je možné zpřístupnit prostřednictvím koncových bodů GraphQL s minimální konfigurací.

Konfigurace

Zpřístupnit zobrazení:

  • Nastavte source.type na hodnotu "view".
  • Nastavit source.object na plně kvalifikovaný název zobrazení
  • Pokud chcete řádek identifikovat jedinečně, definujte key-fields
  • Udělení oprávnění pomocí "read" akce (a volitelně "create""update", "delete" pokud je zobrazení aktualizovatelné)

Příklad rozhraní příkazového řádku

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

Příklad konfigurace

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

Chování GraphQL

  • Zobrazení se objeví jako typ GraphQL.
  • Dotazy jsou vždy podporovány.
  • Změny jsou podporovány pouze v případě, že je zobrazení aktualizovatelné.
  • Řídí se standardní strukturou schématu DAB GraphQL.

Příklad dotazu

{
  bookDetails {
    items {
      id
      title
      authorName
    }
  }
}

Povolení

  • Použijte akci read pro zobrazení jen pro čtení
  • Použití create, updatea delete pouze v případě, že je zobrazení aktualizovatelné

Omezení

  • key-fields je vyžadováno
  • Zobrazení nepodporují relace
  • Stránkování, filtrování a řazení se podporuje, pokud se zobrazení chová jako tabulka.

Související obsah

  • Last updated on