Skip to content

Add validation to the mapping for each entity on bootstrap #425

Open
@aaronburtle

Description

@aaronburtle

Background

Mappings define what names we want to be externally usable in order to access underlying database object associated with a given entity.

Reminder, the entity mapping section is used as follows per https://learn.microsoft.com/en-us/azure/data-api-builder/reference-configuration#format-49

"mappings": {
        "<field-1-name>" : "<field-1-alias>",
        "<field-2-name>" : "<field-2-alias>",
        "<field-3-name>" : "<field-3-alias>"
      }

Validation

  • Don't allow multiple column names to map to the same exposed name
  • Don't allow multiple exposed names to map to the same backing column.

Examples

For example,

  • Entity Book with fields id, title, and author
SELECT id, title, author FROM dbo.book
id title author
1 MyBook Me!
2 MyMystery You!

Mappings

mappings: {
 "title" : "author"
}

We can no longer have a request like the following return the "expected" value of the author field (also unclear how the GraphQL Schema generator deals with this and what fields are actually present on the request:

query bookQuery {
books {
id
title
author
}

The `author` is un-reachable because the unmapped backing column "author" is not mapped and is overridden by the mapping for "title" .

### Expectation
In this case we should return a warning to the user that they have conflicts in their mapping. Either during startup? or request time?

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions