Edit

Share via

Troubleshoot the installation of Data API builder for Azure databases

  • Article

Data API builder is distributed as a NuGet package and can be installed using a .NET tool. This article provides solutions to common issues that might occur when you install Data API builder.

.NET 8 isn't installed

Data API builder requires .NET 8 to be installed on your machine. If you don't have .NET 8 installed, you can install it by following the instructions in Install .NET on Windows, Linux, and macOS or Download .NET 8.0.

Issue when installing .NET 8 on Ubuntu 22

Installing .NET 8 on Ubuntu 22 can be tricky as the .NET package is available in both the Ubuntu repository and Microsoft repository, which can lead to conflicts or errors.

For example, when you execute the dotnet command on Linux, you might receive an error like the following example:

A fatal error occurred. The folder [/usr/share/dotnet/host/fxr] does not exist.

To ensure you can install .NET 8 on Ubuntu successfully, review the installation instructions in the Overview of .NET on Ubuntu.

Issue when installing Data API builder using a .NET tool

Data API builder is distributed as a NuGet package and can be installed using the dotnet tool command. If you have issues using the dotnet tool command, troubleshoot .NET tool usage issues.

Data API builder command-line interface issue

After you install Data API builder, you might experience an issue where the dab command can't be found when running the Data API builder command-line interface (CLI).

To resolve this issue, make sure that the PATH environment variable on your machine contains the folder where the .NET tool stores the downloaded package. For more information, see Global tools.

To check the PATH environment variable, use the following command:

($env:PATH).Split(";")

References

Next step

If you're unsable to find a solution to your issue in this article, provide feedback or report bugs at the azure/data-api-builder GitHub repository.

Contact us for help

If you have questions or need help, create a support request, or ask Azure community support. You can also submit product feedback to Azure feedback community.