Using ODataDB

Using ODataDB

What is ODataDB

ODataDB is a cross-platform ASP.NET Core 3 application and a JavaScript OData client.

You can install it on Windows with IIS, on Linux with Apache, or Linux with Nginx.

The server-side part creates OData 4.0 endpoints on-the-fly for all connection strings specified in the application settings file.

ODataDB supports SQL Server, Oracle, MySQL, MariaDB, PostgreSQL, DB2, and NuoDB.

You can consume data in any client that supports OData, including Microsoft Excel, Power BI, and Qlik.

ODataDB includes a built-in JavaScript OData client that allows viewing and editing data.

You can try online samples at odatadb.savetodb.com.

The built-in client looks like this:

ODataDB Samples - s02.cashbook

How it works

ODataDB reads connection strings from the app settings file and creates OData endpoints for every string.

Here is a sample of a connection string:

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

In this case, ODataDB creates the 'mssql' endpoint for the AzureDemo90 database on the mssql.savetodb.com server:

The 'user' and 'pass' are placeholders to turn on the authentication.

Also, you can use the built-in JavaScript OData client to view and edit data:

You can test this sample with the following credentials:

Username: sample02_user3
Password: Usr_2011#_Xls4168

See more details about ODataDB endpoints.

How to use ODataDB

ODataDB supports the following use-cases, all at once:

  • OData service with third-party OData clients
  • Web viewer and editor for database data
  • Web page embedded data

We recommend taking the following steps to start using ODataDB:

  1. Playing with online samples at odatadb.savetodb.com (10-15 minutes)
  2. Testing ODataDB using the QuickStart steps (5-10 minutes)
  3. Installing ODataDB (10-20 minutes)

Less in an hour, you will have an OData service and a web editor for your databases.

Note that ODataDB is free for two users (identified by logins).

So, you can use it for development purposes and yourself for free.

Activate the trial version when you are ready to try it for a large number of users.

How to configure OData models

ODataDB creates OData models reading the database metadata under the user's credentials.

So, every user gets a model based on available objects only.

ODataDB analyses SQL definitions of views and stored procedures and adds a lot of features automatically.

However, you can customize the following features using a database-side SaveToDB Framework:

  • FunctionImport EntitySets
  • Dynamic EntityContainers
  • The way to save changes to a database
  • Cell change handlers
  • Value lists for column dropdowns and parameters
  • Data translation

See more details at Configuring OData Model.

Notes for SaveToDB and DBEdit customers

ODataDB uses the same data layer as DBEdit and SaveToDB add-in for Microsoft Excel.

So, you might get almost the same application features with the built-in JavaScript OData client.