Skip to main content

WsSQL is an add-on service that provides an SQL interface into HPCC Systems. The web service accepts a subset of prepared and standard SQL queries. It provides access to most HPCC data and published queries.

The WsSQL service maps HPCC logical files to RDBMS tables and HPCC Published Queries are exposed as RDBMS Stored Procedures. The WsSQL service also provides convenient methods to obtain system information, metadata, and results from previously executed queries.

This service is intended to be used in a programmatic fashion (for example, via database drivers), but can also be used in an interactive fashion by users who are more comfortable using SQL than ECL. This makes it possible to submit ad-hoc queries without learning ECL.


  • Submit SQL queries directly to HPCC via SOAP
  • Access HPCC data files and Published queries
  • Analyze HPCC data using familiar SQL syntax
  • Supports SQL SELECT or CALL syntax
    • Access HPCC data files as DB Tables
    • Access published queries as DB Stored Procedures
  • Supports SQL Create and Load Syntax
  • Harnesses the full power of HPCC under the covers
    • Submitted SQL request generates ECL code which is submitted, compiled, and executed on your target cluster
    • Automatic Index fetching capabilities for quicker data fetches
  • Creates entry-point for programmatic data access
  • Leverage HPCC data without need to learn and write ECL!
    • Opens the door for non ECL programmers to access HPCC data.
Release Notes WsSQL 6.4.0-1
BuildPackaging                      | WSSQL-144 Added support to WsSQL for CentOS7
ESPService                          | WSSQL-147 WsSQL is executing outdated published queries due to a caching issue
ECLEngine                           | WSSQL-152 Fixed published query parameter quoting
ECLEngine                           | WSSQL-155 Fixed ECL generation error while joining more than 2 tables
ECLEngine, ESPService               | WSSQL-166 Prepared queries are given a name, and SQL is aligned
ESPService                          | WSSQL-148 Improve ad-hock query caching
ESPService                          | WSSQL-156 Necessary changes to build vs HPCC 6.4
ESPService                          | WSSQL-165 Do not attempt to parameterize prepared queries
SQLParser                           | WSSQL-151 Fixed issue where cached queries were erroneously executed
SQLParser                           | WSSQL-70 Provide String Wildcard support

Known limitations for 6.4.0-1 release ========================================================================================== - You must restart the HPCC ESP component after installing WsSQL - HPCC Platform 6.4.0 required - WSSQL-115 - Performing an outer join using the same target file, and assigning aliases to both references of the file can cause an internal runtime error - WSSQL-112 - WsSQL does not support files that contain ‘.’ characters in the file name. - WSSQL-120 - Multiple non-unique entries in SELECT list are not processed correctly, Workaround is to utilize aliases. - WSSQL-83 - Legacy Index files might cause WsSQL errors See the HPCC Systems Redbook for details. - WSSQL-74 - Nested select statements not supported - WSSQL-71 - Join can cause merge of non-uniquely named fields - WSSQL-57 - HPCC files can contain SQL-illegal characters ‘::’ which denote HPCC scopes. Client might be required to quote the entire file name - WSSQL-37 - Stored Procedures (Published Query names) with invalid names are not filtered from GetDBMetaData results. The workaround is to ensure your jobname is not an SQL reserved word. These are listed in the manual. - WSSQL-27 - ECL identifiers cannot use SQL reserved words. These are listed in the manual. - WSSQL-139 - Complex SQL Queries don't fully utilize indexes (Keyed JOINs) - WSSQL-168 - Failed query (due to target cluster timeout) are cached Workaround is to set the “ignore cache” flag in request


SQL Interface for HPCC
Release Size* Version  
WsSQL Centos6
Release Date: 08/03/2017
Centos 64bit
1.9MB 6.4.0
WsSQL Centos7
Release Date: 08/03/2017
Centos 64bit
1.9MB 6.4.0
WsSQL Ubuntu 14.04
Release Date: 08/03/2017
Ubuntu 64bit
1.8MB 6.4.0
WsSQL Ubuntu 16.04
Release Date: 08/03/2017
Ubuntu 64bit
1.7MB 6.4.0
WsSQL Ubuntu 16.10
Release Date: 08/03/2017
Ubuntu 64bit
1.7MB 6.4.0
WsSQL Ubuntu 17.04
Release Date: 08/03/2017
Ubuntu 64bit
1.7MB 6.4.0

* sizes are approximate