data-api-builder-cli

Estrelas0

Forks0

Atualizado31 de março de 2026 às 19:01

Use Data API Builder CLI to initialize, add/update entities, validate config, and run DAB. Use when asked to create or modify dab-config.json via CLI commands.

Instalação

Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.

Fonte

JerryNixon

JerryNixon/dab-quickstarts

Abrir repositório GitHub Ver repositórios do creator

Download

Ocupações relacionadasSOC

Baseado na classificação ocupacional SOC

Desenvolvedores de softwareInformática e Matemática·SOC 15-1252

SKILL.md

readonly

name	data-api-builder-cli
description	Use Data API Builder CLI to initialize, add/update entities, validate config, and run DAB. Use when asked to create or modify dab-config.json via CLI commands.
license	MIT

Data API Builder CLI

Use this skill for command-driven DAB setup and changes. Keep flows short: init → add/update → validate → start.

Companion config assets

Pair CLI commands with these examples from the config skill:

Auto-config note: CLI terminology uses auto-config while runtime JSON uses the autoentities section name.

When to use

Create a new dab-config.json
Add or modify entities from tables/views/stored procedures
Change runtime settings (REST/GraphQL/MCP/auth/CORS)
Validate and run DAB locally

Workflow

Initialize config: dab init
Add entities: dab add
Adjust entities/runtime: dab update / dab configure
Validate: dab validate
Run: dab start

Always recommend env vars for secrets with @env('VAR').

Command quick reference

`dab init`

Create/overwrite config.

dab init --database-type mssql --connection-string "@env('DATABASE_CONNECTION_STRING')"

`dab add`

Add table/view/stored procedure entity.

# table
dab add Product --source dbo.Products --permissions "anonymous:read"

# view (requires key fields)
dab add ProductSummary --source dbo.vw_ProductSummary --source.type view --source.key-fields "ProductId" --permissions "anonymous:read"

# stored procedure
dab add GetProducts --source dbo.usp_GetProducts --source.type stored-procedure --permissions "authenticated:execute" --graphql.operation query

`dab update`

Update existing entity.

# add role
dab update Product --permissions "admin:*"

# relationship
dab update Category --relationship "products" --cardinality many --target.entity Product --relationship.fields "CategoryId:CategoryId"

# field mapping (replaces existing mappings)
dab update Product --map "ProductName:name,UnitPrice:price"

`dab configure`

Change runtime/global settings.

dab configure --runtime.mcp.enabled true --runtime.mcp.path "/mcp"
dab configure --cors-origin "https://app.example.com"

`dab validate`

Validate config before running.

dab validate --config dab-config.json

`dab start`

Start DAB runtime.

dab start --config dab-config.json

Decision points

Entity change? use dab add/dab update
Runtime/global change? use dab configure
View source? require --source.key-fields
Stored procedure? use execute permission (not read)

Troubleshooting (syntax gotchas)

View entity missing key fields

# WRONG
dab add ProductSummary --source dbo.vw_ProductSummary --source.type view --permissions "anonymous:read"

# CORRECT
dab add ProductSummary --source dbo.vw_ProductSummary --source.type view --source.key-fields "ProductId" --permissions "anonymous:read"

Stored procedure permission type

# WRONG
dab add RunReport --source dbo.usp_RunReport --source.type stored-procedure --permissions "authenticated:read"

# CORRECT
dab add RunReport --source dbo.usp_RunReport --source.type stored-procedure --permissions "authenticated:execute"

Policy syntax must be OData, not SQL

# WRONG
dab update Order --policy-database "Status = 'Active'"

# CORRECT
dab update Order --policy-database "@item.Status eq 'Active'"

`--map` replaces all mappings

# Include all desired mappings every time
dab update Product --map "ProductName:name,UnitPrice:price,UnitsInStock:stock"

Consistency rules

Use @env(...) for secrets.
Run dab validate before dab start.
Keep .gitignore entries for .env, **\bin, **\obj.
For Azure, use custom image with embedded dab-config.json (no Azure Files mount).

Completion checks

Config exists and validates
Entities and permissions match user intent
Runtime endpoints enabled as requested
DAB starts and /health returns success

References

Mais deste repositório

mesmo repositório

aspire-sql-commander

JerryNixon/dab-quickstarts

Add SQL Commander to a .NET Aspire AppHost for browsing and querying SQL Server. Use when asked to add a SQL query tool, browse database tables, or configure SQL Commander in Aspire.

2026-07-010

azure-data-api-builder

JerryNixon/dab-quickstarts

Deploy Data API Builder to Azure Container Apps with Azure SQL, ACR, and azd. Use when asked to deploy DAB to Azure, create Bicep for DAB, or set up cloud API hosting.

2026-07-010

data-api-builder-demo

JerryNixon/dab-quickstarts

Build and maintain DAB quickstart demos with consistent structure, naming, deployment scripts, and validation checks.

2026-07-010

aspire-data-api-builder

JerryNixon/dab-quickstarts

Guide for .NET Aspire orchestration of SQL Server + Data API Builder + SQL Commander + MCP Inspector. Use when asked to create an Aspire-based DAB environment.

2026-05-290

docker-data-api-builder

JerryNixon/dab-quickstarts

Docker Compose orchestration of SQL Server, Data API Builder, SQL Commander, and MCP Inspector. Use when asked to create docker-compose.yml, set up local containers, or run DAB without Aspire.

2026-05-290

aspire-mcp-inspector

JerryNixon/dab-quickstarts

Add MCP Inspector to a .NET Aspire AppHost for debugging MCP servers such as Data API Builder.

2026-03-310

name	data-api-builder-cli
description	Use Data API Builder CLI to initialize, add/update entities, validate config, and run DAB. Use when asked to create or modify dab-config.json via CLI commands.
license	MIT

Data API Builder CLI

Use this skill for command-driven DAB setup and changes. Keep flows short: init → add/update → validate → start.

Companion config assets

Pair CLI commands with these examples from the config skill:

Auto-config note: CLI terminology uses auto-config while runtime JSON uses the autoentities section name.

When to use

Create a new dab-config.json
Add or modify entities from tables/views/stored procedures
Change runtime settings (REST/GraphQL/MCP/auth/CORS)
Validate and run DAB locally

Workflow

Initialize config: dab init
Add entities: dab add
Adjust entities/runtime: dab update / dab configure
Validate: dab validate
Run: dab start

Always recommend env vars for secrets with @env('VAR').

Command quick reference

`dab init`

Create/overwrite config.

dab init --database-type mssql --connection-string "@env('DATABASE_CONNECTION_STRING')"

`dab add`

Add table/view/stored procedure entity.

# table
dab add Product --source dbo.Products --permissions "anonymous:read"

# view (requires key fields)
dab add ProductSummary --source dbo.vw_ProductSummary --source.type view --source.key-fields "ProductId" --permissions "anonymous:read"

# stored procedure
dab add GetProducts --source dbo.usp_GetProducts --source.type stored-procedure --permissions "authenticated:execute" --graphql.operation query

`dab update`

Update existing entity.

# add role
dab update Product --permissions "admin:*"

# relationship
dab update Category --relationship "products" --cardinality many --target.entity Product --relationship.fields "CategoryId:CategoryId"

# field mapping (replaces existing mappings)
dab update Product --map "ProductName:name,UnitPrice:price"

`dab configure`

Change runtime/global settings.

dab configure --runtime.mcp.enabled true --runtime.mcp.path "/mcp"
dab configure --cors-origin "https://app.example.com"

`dab validate`

Validate config before running.

dab validate --config dab-config.json

`dab start`

Start DAB runtime.

dab start --config dab-config.json

Decision points

Entity change? use dab add/dab update
Runtime/global change? use dab configure
View source? require --source.key-fields
Stored procedure? use execute permission (not read)

Troubleshooting (syntax gotchas)

View entity missing key fields

# WRONG
dab add ProductSummary --source dbo.vw_ProductSummary --source.type view --permissions "anonymous:read"

# CORRECT
dab add ProductSummary --source dbo.vw_ProductSummary --source.type view --source.key-fields "ProductId" --permissions "anonymous:read"

Stored procedure permission type

# WRONG
dab add RunReport --source dbo.usp_RunReport --source.type stored-procedure --permissions "authenticated:read"

# CORRECT
dab add RunReport --source dbo.usp_RunReport --source.type stored-procedure --permissions "authenticated:execute"

Policy syntax must be OData, not SQL

# WRONG
dab update Order --policy-database "Status = 'Active'"

# CORRECT
dab update Order --policy-database "@item.Status eq 'Active'"

`--map` replaces all mappings

# Include all desired mappings every time
dab update Product --map "ProductName:name,UnitPrice:price,UnitsInStock:stock"

Consistency rules

Use @env(...) for secrets.
Run dab validate before dab start.
Keep .gitignore entries for .env, **\bin, **\obj.
For Azure, use custom image with embedded dab-config.json (no Azure Files mount).

Completion checks

Config exists and validates
Entities and permissions match user intent
Runtime endpoints enabled as requested
DAB starts and /health returns success

data-api-builder-cli

Data API Builder CLI

Companion config assets

When to use

Workflow

Command quick reference

dab init

dab add

dab update

dab configure

dab validate

dab start

Decision points

Troubleshooting (syntax gotchas)

View entity missing key fields

Stored procedure permission type

Policy syntax must be OData, not SQL

--map replaces all mappings

Consistency rules

Completion checks

References

Mais deste repositório

Mais deste repositório

Data API Builder CLI

Companion config assets

When to use

Workflow

Command quick reference

dab init

dab add

dab update

dab configure

dab validate

dab start

Decision points

Troubleshooting (syntax gotchas)

View entity missing key fields

Stored procedure permission type

Policy syntax must be OData, not SQL

--map replaces all mappings

Consistency rules

Completion checks

References

`dab init`

`dab add`

`dab update`

`dab configure`

`dab validate`

`dab start`

`--map` replaces all mappings

`dab init`

`dab add`

`dab update`

`dab configure`

`dab validate`

`dab start`

`--map` replaces all mappings