Quick Start with DBGate

Quick Start on Windows

1. Download the DBGate package.
2. Unzip it to any folder on a local drive.
3. Run dbgate.exe in the dbgate subfolder.

You have to see the following console app:

If you do not see the console, download and install the Hosting Bundle, which includes the .NET Core Runtime and IIS support, at

• https://dotnet.microsoft.com/en-us/download/dotnet/3.1 for DBGate 1.x
• https://dotnet.microsoft.com/en-us/download/dotnet/6.0 for DBGate 2.x

When you see the console app, open the URL: http://localhost:5003

You have to see the index page:

You can play with samples. DBGate loads data from an online SQL Server database.

For example, below is a screenshot for the s02.cashbook table:

Then add a connection string into the appsettings.Production.json file using the mssql connection as a template:

  "ConnectionStrings": {
    "mssql": {
      "ProviderName": "System.Data.SqlClient",
      "ConnectionString": "Data Source=mssql.savetodb.com;Initial Catalog=AzureDemo100;User ID=user;Pwd=pass"
    },

You can add a connection string for an SQL Server, Oracle Database, MySQL, MariaDB, PostgreSQL, DB2, or NuoDB database.

For example, you can add a test connection string:

    "test": {
      "ProviderName": "System.Data.SqlClient",
      "ConnectionString": "Data Source=.\SQLEXPRESS;Initial Catalog=TestDatabase;User ID=user;Pwd=pass"
    },

Close and open the console dbgate.exe app when you add a new connection.

Try to connect to your database.

For example, if you have created the 'test' connection string, open the link like http://localhost:5003/edit/test/<schema>/<name>.

That's all. You have created a working sample.

Now you can install DBGate under IIS.

Quick Start on Linux

1. Download the DBGate package.
2. Unzip it and copy the dbgate folder to the /var/www folder.
3. Go to the /var/www/dbgate folder and run: dotnet dbgate.dll

You have to see the following response:

If DBGate cannot start, install the ASP.NET Core Runtime using instructions at

• https://dotnet.microsoft.com/en-us/download/dotnet/3.1 for DBGate 1.x
• https://dotnet.microsoft.com/en-us/download/dotnet/6.0 for DBGate 2.x

When you start DBGate, try to get data using a command like this:

curl http://localhost:5003/api/mssql-201/s20/accounts

You have to see data from an online SQL Server database.

That's all for now. Press Ctrl-C to close the app. See how to install DBGate on Linux.