Active Query Builder Web API

Features and Details

A Web API to create, analyze and modify complex SQL queries

Active Query Builder is a powerful component intended to parse, analyze and create SQL queries programmatically, as well as to build them visually. Today, a part of its application programming interface is available as a web service. You can use this API in any programming environment that can send HTTP post requests. Ready-to-use clients are available for most popular programming environments, such as PHP, Python, Ruby, JavaScript (NodeJS), Java, etc. Clients for other environments can be instantly generated using the Swagger (OpenAPI) specification.

Prerequisites

Supported programming environments and platforms

Active Query Builder Web API was built with the Swagger framework (OpenAPI Specification), so you can instantly get the client source code for any of programming environments supported by Swagger:

We have compiled and tested the clients for most popular platforms and have uploaded them to official package repositories where possible. Currently, you can review the code samples and download clients for the following languages and platforms:

  • .NET
  • Java
  • Python
  • JavaScript
  • Ruby
  • PHP
  • Perl

Supported database servers

Active Query Builder, on which this API is based, supports lots of SQL dialects. It generates correct SQL queries of any complexity for the specified database server and takes into account the peculiarities of respective SQL dialects.

For servers that aren't directly supported by Active Query Builder, but are generally compatible with some of the ANSI SQL standards, Active Query Builder is capable of generating ANSI-compatible queries.

Supported database servers:

  • MS SQL Server (including Azure and Compact editions)
  • Oracle
  • MySQL (including MariaDB, Amazon Aurora and Cloud SQL)
  • PostgreSQL (including Redshift, EnterpriseDB and Heroku)
  • Sybase ASA & ASE
  • IBM DB2
  • Informix
  • Advantage DB
  • SQLite
  • Firebird
  • InterBase
  • MS Access (MS Jet engine)
  • Netezza
  • Teradata
  • Vista DB

Servers with which you can work using the general ANSI SQL syntax include, but aren't limited to the following:

  • Amazon Aurora
  • Pervasive
  • Progress OpenEdge
  • Mimer SQL
  • NuoDB
  • Ingres
  • Some of the NoSQL databases which have SQL driver

User account

Active Query Builder Web API needs information about the database schema to perform SQL query analysis and modification. This information is required to create joins in queries according to foreign keys, to determine the list of query output columns for queries which have the asterisk symbol in the SELECT list ("SELECT * FROM Table") and for other purposes. As this information is quite “heavy”, it’s unreasonable to send it along with each API request, so we've designed a secure dashboard where users can upload their database schema and get a unique identifier to specify database schema while sending queries to the API.

Downloads