SQL Invoker is designed to invoke stored procedure and/or stored function. In this moment, the service supports only:
- Stored procedures that does not return result sets and consequently:
- performs database side effects
- get results from
In future releases, the service will support:
- Stored procedures that returns result sets
- Stored functions that returns result sets
The service will read configuration files contained within the directory specified in the
The variables to be set are the following:
HTTP_PORT: The port exposed by the service
PROFILE_FILES_PATH: The dir in which are located the stored procedures/functions
DB_USER: The database username
DB_PASSWORD: The database password
DB_URI: JDBC uri specifying also the schema at the end. Ex:
DB_DRIVER: The JDBC driver class name. Example for MariaDB:
Stored functions/procedures file structure
Files contained within the
PROFILE_FILES_PATH have the following format:
name: The name of schema and the stored procedure/function concatenated with a dot, as you would invoke it using SQL.
parameters: An array containing objects describing parameters, as described below:
name: The parameter name
dataType: The SQL data type of the parameter
parameterType: One of
The service will read each file contained in the
PROFILE_FILES_PATH directory and will expose for each one and endpoint.
The endpoint name corresponds to the property
name of the file.
For example the file described in the paragraph above will expose the
REST API live documentation
The service offers an interactive documentation of the API via Swagger,
at the route
/documentation of the running SQL Invoker.