Weergaven gebruiken in Data API Builder

Weergaven worden ondersteund als alternatieven voor tabellen in DAB. Een weergave kan worden weergegeven via REST- of GraphQL-eindpunten met minimale configuratie.

Configuratie

Een weergave beschikbaar maken:

• Stel source.type in op "view"
• Instellen source.object op de volledig gekwalificeerde weergavenaam
• Definiëren key-fields om een rij uniek te identificeren
• Machtigingen verlenen met behulp van de "read" actie (en optioneel"create", "update""delete" als de weergave kan worden bijgewerkt)

CLI-voorbeeld

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

Configuratievoorbeeld

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

REST-ondersteuning

• Ondersteunt alle REST-werkwoorden: GET, POST, PUT, PATCHDELETE
• Standaardgedrag is identiek aan entiteiten met tabelsteun
• Bewerkingen slagen alleen als de weergave kan worden bijgewerkt en de juiste machtigingen zijn ingesteld

Voorbeeld van aanvraag

GET /api/BookDetail/42

Retourneert de rij van vw_books_details met id = 42.

GraphQL-ondersteuning

• De view verschijnt als een GraphQL-type
• Vragen worden altijd ondersteund
• Mutaties worden alleen ondersteund als de weergave kan worden bijgewerkt
• Volgt de standaard-DAB GraphQL-schemastructuur

Machtigingen

• Gebruik de read actie voor alleen-lezen weergaven
• Gebruik create, updateen delete alleen als de weergave kan worden bijgewerkt

Beperkingen

• key-fields zijn vereist
• Weergaven bieden geen ondersteuning voor relaties
• Paginering, filteren en sorteren worden ondersteund als de weergave zich gedraagt als een tabel