activedbsoft/webapi-active-query-builder

1.1.8 2016-11-03 13:02 UTC

README

Active Query Builder Web API lets create, analyze and modify SQL queries for different database servers using RESTful HTTP requests to a cloud-based service. It requires SQL execution context (information about database schema and used database server) to be stored under the registered account at https://webapi.activequerybuilder.com/.

Requirements

PHP 5.4.0 and later

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/WebApiActiveQueryBuilder/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api = new WebApiActiveQueryBuilder\ActiveQueryBuilderApi();
$metadataGuid= "b3207f4f-b1f4-4dc2-979b-7724ed2d0221";
$sql = "Select customer_id, first_name From customer";

$query = new WebApiActiveQueryBuilder\SqlQuery(); // \WebApiActiveQueryBuilder\SqlQuery | Information about SQL query and it's context.
$query->setGuid($metadataGuid);
$query->setText($sql);

$columns = $api->getQueryColumnsPost($query);
print_r($columns);

$transform = new WebApiActiveQueryBuilder\Transform();
$transform->setGuid($metadataGuid);
$transform->setSql($sql);	

$filter = new WebApiActiveQueryBuilder\ConditionGroup();

$condition = new WebApiActiveQueryBuilder\Condition();
$condition->setField('customer_id');
$condition->setConditionOperator('Greater');
$condition->setValues(array(10));

$filter->setConditions(array($condition));

$page = new WebApiActiveQueryBuilder\Pagination();
$page->setSkip(10);
$page->setTake(5);
	
$order = new WebApiActiveQueryBuilder\Sorting();
$order->setField('customer_id');
$order->setOrder('asc');

$transform->setFilter($filter);
$transform->setPagination($page);
$transform->setSortings(array($order));

$result = $api->transformSqlPost($transform);
print_r($result);
?>

Documentation for API Endpoints

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

Class Method HTTP request Description
ActiveQueryBuilderApi getQueryColumnsPost POST /getQueryColumns
ActiveQueryBuilderApi transformSQLPost POST /transformSQL

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

support@activedbsoft.com

Source code

Full source code of all clients for Active Query Builder Web API is available on GitHub. Get the source code of javascript here: https://github.com/ActiveDbSoft/webapi-active-query-builder-php