webapi-activequerybuilder

WebapiActivequerybuilder - JavaScript client for webapi-activequerybuilder Active Query Builder Web API lets create, analyze and modify SQL queries for different database servers using RESTful HTTP requests. Transforms the given SQL query according to the commands provided in this request. You can add constraints, hide some of the resultset columns, chang sorting or limit rows of resultset. All transformations are performed according to the SQL syntax and database schema provided through the registered account at https://webapi.activequerybuilder.com/ identified by the given unique identifier. All transformations can only lead to reorganization or limitation of the resultset data. This means that it's impossible to get transformed SQL that reveals any other data than the data retutned by original query.

Installation

For Node.js

npm

npm install webapi-activequerybuilder --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var WebapiActivequerybuilder = require('webapi-activequerybuilder');

var api = new WebapiActivequerybuilder.ActiveQueryBuilderApi()

var query = new WebapiActivequerybuilder.SqlQuery(); // {SqlQuery} Information about SQL query and it's context.

api.getQueryColumnsPost(query).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://webapi.activequerybuilder.com

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- WebapiActivequerybuilder.ActiveQueryBuilderApi | getQueryColumnsPost | POST /getQueryColumns | WebapiActivequerybuilder.ActiveQueryBuilderApi | transformSQLPost | POST /transformSQL |

Documentation for Models

• WebapiActivequerybuilder.Condition
• WebapiActivequerybuilder.ConditionGroup
• WebapiActivequerybuilder.HiddenColumn
• WebapiActivequerybuilder.Pagination
• WebapiActivequerybuilder.QueryColumn
• WebapiActivequerybuilder.Sorting
• WebapiActivequerybuilder.SqlQuery
• WebapiActivequerybuilder.Totals
• WebapiActivequerybuilder.Transform
• WebapiActivequerybuilder.TransformResult

Documentation for Authorization

All endpoints do not require authorization.