Azure / Azure/data-api-builder

[Enh]: For auto-config entities support `views`

Open
#3,225 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

2.x auto-config
Dominant language
C#
Stars
1.5k
Forks
372
Avg merge
3d 22h
Merged PRs (30d)
9

Description

What?

Support views as well as tables in autoentities.

[!NOTE]
This feature supports only read-only views.

Why?

Because many customers, especial with MCP, prefer views.

How?

This is tricky because views do not have keys, which we currently require. The only viable solution without adding significant complexity is to include views as read-only entities. However, we currently don't have this concept. But it is coming!

  • #2791

This prerequisite task introduces read-only views and enables this feature.

Configuration
{
  "autoentities": {
    "default": {
      "source-type": [ "view" ] // default: [ table ]
    }
  }
}

An autoentity can include more than one type.

Command line
dab auto-config <name> --source-type "table,view"

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the autoentities configuration and the dab auto-config command described in the issue, then read prerequisite issue #2791 about read-only views. The work is complete when autoentities accepts source-type values including view and the command supports --source-type "table,view" for read-only views.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
backend-api-design, cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.