webapi_active_query_builder

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.

Python 2.7 and 3.4+

Getting Started

Please follow the installation procedure and then run the following:

import time
import webapi_active_query_builder as webapi
from pprint import pprint
# create an instance of the API class
api = webapi.ActiveQueryBuilderApi()
sql = "Select customer_id, first_name From customer"
metadataGuid = "b3207f4f-b1f4-4dc2-979b-7724ed2d0221"

query = webapi.SqlQuery() # SqlQuery | Information about SQL query and it's context.
query.guid = metadataGuid
query.text = sql

columns = api.get_query_columns_post(query)
print('API called successfully. Returned columns: ', columns)

transform = webapi.Transform()
transform.guid = metadataGuid
transform.sql = sql

filter = webapi.ConditionGroup()

condition = webapi.Condition()
condition.field = "customer_id"
condition.condition_operator = "Greater"
condition.values = [10]

filter.conditions = [condition]

page = webapi.Pagination()
page.skip = 2
page.take = 3

order = webapi.Sorting()
order.field = "customer_id"
order.order = "asc"

transform.filter = filter
transform.pagination = page
transform.sortings = [order]

result = api.transform_sql_post(transform)
print('API called successfully. Returned result: ', result)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ActiveQueryBuilderApi	get_query_columns_post	POST /getQueryColumns
ActiveQueryBuilderApi	transform_sql_post	POST /transformSQL

Documentation For Models

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

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-python