Använda vyer i Data API Builder

Vyer stöds som alternativ till tabeller i DAB. En vy kan exponeras via REST- eller GraphQL-slutpunkter med minimal konfiguration.

Konfiguration

Så här visar du en vy:

• Ställ in source.type på "view"
• Ange source.object till det fullständigt kvalificerade vynamnet
• Definiera key-fields för att identifiera en rad unikt
• Bevilja behörighet med hjälp av "read" åtgärden (och eventuellt "create", "update""delete" om vyn är uppdaterad)

CLI-exempel

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

Konfigurationsexempel

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

REST-stöd

• Stöder alla REST-verb: GET, POST, PUT, , PATCHDELETE
• Standardbeteendet är identiskt med tabellbaserade entiteter
• Åtgärderna lyckas endast om vyn är uppdaterad och lämpliga behörigheter har angetts

Exempel på begäran

GET /api/BookDetail/42

Returnerar raden från vw_books_details med id = 42.

Stöd för GraphQL

• Vyn visas som en typ av GraphQL
• Frågor stöds alltid
• Mutationer stöds endast om vyn är uppdaterad
• Följer standardschemastrukturen för DAB GraphQL

Behörigheter

• Använd åtgärden read för skrivskyddade vyer
• Använd create, updateoch delete endast om vyn är uppdaterad

Begränsningar

• key-fields krävs
• Vyer stöder inte relationer
• Sidnumrering, filtrering och sortering stöds om vyn fungerar som en tabell