| 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.
dab add Product --source dbo.Products --permissions "anonymous:read"
dab add ProductSummary --source dbo.vw_ProductSummary --source.type view --source.key-fields "ProductId" --permissions "anonymous:read"
dab add GetProducts --source dbo.usp_GetProducts --source.type stored-procedure --permissions "authenticated:execute" --graphql.operation query
dab update
Update existing entity.
dab update Product --permissions "admin:*"
dab update Category --relationship "products" --cardinality many --target.entity Product --relationship.fields "CategoryId:CategoryId"
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
dab add ProductSummary --source dbo.vw_ProductSummary --source.type view --permissions "anonymous:read"
dab add ProductSummary --source dbo.vw_ProductSummary --source.type view --source.key-fields "ProductId" --permissions "anonymous:read"
Stored procedure permission type
dab add RunReport --source dbo.usp_RunReport --source.type stored-procedure --permissions "authenticated:read"
dab add RunReport --source dbo.usp_RunReport --source.type stored-procedure --permissions "authenticated:execute"
Policy syntax must be OData, not SQL
dab update Order --policy-database "Status = 'Active'"
dab update Order --policy-database "@item.Status eq 'Active'"
--map replaces all mappings
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
