FilesExpand file tree

 main

/

index.yml

Copy path

BlameMore file actions

BlameMore file actions

Latest commit

 

History

History

History

272 lines (268 loc) · 10.2 KB

 main

/

index.yml

Top

File metadata and controls

• Code
• Blame

272 lines (268 loc) · 10.2 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

### YamlMime:Landing

title: Data API builder documentation

summary: Data API builder (DAB) provides a REST API over a database. It also provides a GraphQL API. It supports not just SQL Server, but Azure SQL Database, Azure Cosmos DB, PostgreSQL, MySQL, and SQL Data Warehouse. DAB runs in any cloud or on-premises, and it's open source and free to use. It's secure, feature-rich, and a foundational component of Microsoft Fabric—which is another way of saying it's high-performance and capable of handling massive data operations.

metadata:

title: Data API builder documentation

description: With Data API builder, database objects can be exposed via REST or GraphQL endpoints so that your data can be accessed using modern techniques on any platform, any language, and any device.

author: seesharprun

ms.author: sidandrews

ms.reviewer: jerrynixon

ms.service: data-api-builder

ms.topic: landing-page

ms.date: 07/24/2025

# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | sample | tutorial | video | whats-new

landingContent:

- title: About Data API builder

linkLists:

- linkListType: overview

links:

- text: What is Data API builder?

url: overview.md

- text: Feature availability

url: feature-availability.md

- text: Frequently asked questions

url: faq.yml

- linkListType: whats-new

links:

- text: Version 1.7

url: whats-new/version-1-7.md

- text: Version 1.6

url: whats-new/version-1-6.md

- text: Version 1.5

url: whats-new/version-1-5.md

- text: Version 1.4

url: whats-new/version-1-4.md

- text: Version 1.3

url: whats-new/version-1-3.md

- text: All versions

url: whats-new/index.yml

- linkListType: learn

links:

- text: SQL Learning Path

url: https://aka.ms/sql/dev/path

- title: Get started

linkLists:

- linkListType: quickstart

links:

- text: DAB with SQL Server

url: quickstart/mssql.md

- text: DAB with Azure SQL

url: quickstart/azure-sql.md

- text: DAB with Azure Cosmos DB for NoSQL

url: quickstart/azure-cosmos-db-nosql.md

- linkListType: quickstart

links:

- text: DAB with PostgreSQL

url: quickstart/postgresql.md

- text: DAB with MySQL

url: quickstart/mysql.md

- linkListType: video

links:

- text: DAB basics 101

url: https://youtu.be/xAlaoDQolLw

- text: DAB system walkthrough

url: https://youtu.be/YadKjVk-q0k

- text: The DAB VS Code Extension

url: https://youtu.be/KcFFRbITAAI

- text: DAB and the CQRS pattern

url: https://youtu.be/pSuMIvXRM1Q

- text: DAB and how it works

url: https://youtu.be/kxy4hA2YoME

- text: DAB and .NET Aspire

url: https://youtu.be/ww5UUP4ur3M

- title: Open Source

linkLists:

- linkListType: download

links:

- text: NuGet package

url: https://www.nuget.org/packages/Microsoft.DataApiBuilder

- text: MCR container

url: https://aka.ms/dab/registry

- text: VS Code extension

url: https://marketplace.visualstudio.com/items?itemName=jerry-nixon.omnibus-data-api-builder

- linkListType: reference

links:

- text: Code Repository

url: https://aka.ms/dab/repo

- text: Open Issues

url: https://aka.ms/dab/issues

- text: Feature Backlog

url: https://aka.ms/dab/backlog

- text: OSS License

url: https://github.com/Azure/data-api-builder/blob/main/LICENSE.txt

- text: Discussions

url: https://github.com/Azure/data-api-builder/discussions

- linkListType: sample

links:

- text: Samples

url: https://github.com/Azure-Samples/data-api-builder

- title: Developer Reference

linkLists:

- linkListType: reference

links:

- text: Configuration syntax

url: configuration/index.md

- text: Feature availability

url: feature-availability.md

- text: Code Policies

url: reference-policies.md

- text: Aggregate data with GraphQL

url: how-to/aggregate-data.md

- linkListType: how-to-guide

links:

- text: Set up Azure Cosmos DB

url: how-to/set-up-cosmosdb.md

- linkListType: sample

links:

- text: Library app sample with Data API builder, SQL Server, and Blazor

url: /samples/azure-samples/azure-sql-library-app-blazor/azure-sql-library-app-blazor

- text: Todo app sample with Data API builder and Azure SQL

url: /samples/azure-samples/dab-swa-todo/sample

- text: Library app sample with Data API builder and Azure SQL

url: /samples/azure-samples/dab-swa-library-demo/sample

- text: Sample devcontainer for Data API builder and Azure SQL Database

url: /samples/microsoft/vscode-remote-try-dab/devcontainer

- linkListType: deploy

links:

- text: Azure Container Instances

url: deployment/how-to-publish-container-instances.md

- text: Azure Container Apps

url: deployment/how-to-publish-container-apps.md

- title: REST API

linkLists:

- linkListType: concept

links:

- text: REST endpoints

url: concept/api/rest.md

- text: OpenAPI documents

url: concept/api/openapi.md

- linkListType: how-to-guide

links:

- text: If-Match Header

url: concept/api/http-if-match.md

- text: Location Header

url: concept/api/http-location.md

- text: Cache-Control Header

url: concept/cache/http-headers.md

- linkListType: reference

links:

- text: Field projection

url: keywords/select-rest.md

- text: Pagination

url: keywords/after-rest.md

- text: Record filtering

url: keywords/filter-rest.md

- title: GraphQL API

linkLists:

- linkListType: concept

links:

- text: GraphQL endpoints

url: concept/api/graphql.md

- text: OpenAPI documents

url: concept/api/openapi.md

- linkListType: reference

links:

- text: Field projection

url: keywords/select-graphql.md

- text: Pagination

url: keywords/after-graphql.md

- text: Record filtering

url: keywords/filter-graphql.md

- title: Configuration File

linkLists:

- linkListType: concept

links:

- text: Schema Reference

url: configuration/index.md

- text: File Environments

url: concept/config/environments.md

- text: Env() Function

url: concept/config/env-function.md

- text: Multiple Data Sources

url: concept/config/multi-data-source.md

- text: Best Practices

url: deployment/best-practices-configuration.md

- title: Command Line

linkLists:

- linkListType: concept

links:

- text: Overview

url: command-line/index.yml

- linkListType: how-to-guide

links:

- text: Installation

url: command-line/install.md

- linkListType: reference

links:

- text: dab add

url: command-line/dab-add.md

- text: dab configure

url: command-line/dab-configure.md

- text: dab export

url: command-line/dab-export.md

- text: dab init

url: command-line/dab-init.md

- text: dab start

url: command-line/dab-start.md

- text: dab update

url: command-line/dab-update.md

- text: dab validate

url: command-line/dab-validate.md

- title: Database Objects

linkLists:

- linkListType: concept

links:

- text: Database Views

url: concept/database/views.md

- text: Stored Procedures

url: concept/database/stored-procedures.md

- text: Table Relationships

url: concept/database/relationships.md

- title: Logs and Monitoring

linkLists:

- linkListType: concept

links:

- text: Application Insights

url: concept/monitor/application-insights.md

- text: Health Checks

url: concept/monitor/health-checks.md

- text: Log Levels

url: concept/monitor/log-levels.md

- text: OpenTelemetry

url: concept/monitor/open-telemetry.md

- title: API-level Security

linkLists:

- linkListType: concept

links:

- text: Security Overview

url: concept/security/index.md

- text: Authorization and roles

url: concept/security/authorization.md

- linkListType: how-to-guide

links:

- text: Configure Entra ID authentication

url: concept/security/how-to-authenticate-entra.md

- text: Configure custom JWT (Okta/Auth0)

url: concept/security/how-to-authenticate-custom.md

- text: Configure App Service authentication

url: concept/security/how-to-authenticate-app-service.md

- text: Configure Simulator for testing

url: concept/security/how-to-authenticate-simulator.md

- text: Implement row-level security

url: concept/security/row-level-security.md

- linkListType: reference

links:

- text: Security best practices

url: deployment/best-practices-security.md

- title: Data Caching

linkLists:

- linkListType: concept

links:

- text: Level 1 Cache

url: concept/cache/level-1.md

- text: Level 2 Cache

url: concept/cache/level-2.md

- linkListType: reference

links:

- text: Cache HTTP headers

url: concept/cache/http-headers.md