Azure / Azure/data-api-builder

Add validation to the mapping for each entity on bootstrap

Open
#425 4 comments 0 reactions 1 assignee Claimed by @aaronburtle View on GitHub
validation
Dominant language
C#
Stars
1.5k
Forks
370
Avg merge
3d 17h
Merged PRs (30d)
8

Description

## 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

```json
"mappings": {
"" : "",
"" : "",
"" : ""
}
```

### 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`

```tsql
SELECT id, title, author FROM dbo.book
```

| id | title | author |
|---|---|---|
| 1 | MyBook | Me! |
| 2 | MyMystery | You! |

Mappings
```json
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:

```graphql
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?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.