Kettle JDBC driver
The thin Kettle JDBC driver allows a Java client to query a Kettle transformation remotely using JDBC and SQL.
As with most JDBC drivers, there is a server and a client component to the JDBC driver.
The server is designed to run as a Servlet on the Carte server, the Pentaho Data Integration server or Pentaho Business Analytics platform. At the time of writing only Carte is supported.
The client JDBC driver consists of the kettle-core.jar library (500kB) which has dependencies against Apache Commons HTTP Client (300kB) and Apache Commons VFS (300kB) only.
The carte configuration file accepts a <services> block that can contain <service> elements with the following sub-elements:
- name : The name of the service. Only alphanumeric characters are supported at the moment, no spaces.
- filename: The filename of the service transformation (.ktr) that will provide the data for the service
- service_step: the name of the step which will provide data during querying.
During execution of a query, 2 transformations will be executed on the server:
- A service transformation, of human design built in Spoon to provide the service data
- An automatically generated transformation to aggregate, sort and filter the data according to the SQL query
These 2 transformations will be visible on Carte or in Spoon in the slave server monitor and can be tracked, sniff tested, paused and stopped just like any other transformation. However, it will not be possible to restart them manually since both transformations are programatically linked.
The JDBC Client
The JDBC driver uses the following class:
The URL is in the following format:
The following standard options are available:
- webappname : the name of the web app (future feature to support running on the DI server)
- proxyhostname : the proxy server for the HTTP connection(s)
- proxyport : the port of the proxy server
- nonproxyhosts : the hosts (comma seperator) for which not to use a proxy
- debugtrans : the optional name of a file in which the generated transformation will be stored for debugging purposes (example: /tmp/debug.ktr)
Parameters for the service transformation can be set with the following format: PARAMETER_name=value (so with the option name prepended with "PARAMETER_")
Support for the SQL is minimal at the moment.
The following things are supported, please consider everything else unsupported:
- * is expanded to include all rows
- COUNT(DISTINCT field)
- IIF( condition, true-value or field, false-value or field)
- Aggregates: SUM, AVG, MIN, MAX
- Alias both with the "AS" keyword and with one or more spaces seperated, for example SUM(sales) AS "Total Sales" or SUM(sales) TotalSales
- NOTE: construct DISTINCT col1, col2, col3 is NOT yet suppored
- Strictly one service name, no alias
- nested brackets
- AND, OR, NOT if preceded by brackets, for example: NOT ( A = 5 OR C = 3 )
- precedence taken into account
- Literals (String, Integer)
- PARAMETER('parameter-name')='value' (always evaluates to TRUE in the condition)
- <=, =<
- >=, =>
- LIKE (standard % and ? wildcards are converted to .* and . regular expressions)
- REGEX (matches regular expression)
- IS NULL
- IS NOT NULL
- IN ( value, value, value )
- You can put a condition on the IIF expression or it's alias if one is used. (please use identical string literals for expressions)
- GROUP BY
- Group on fields, not IIF() function
- Conditions should be placed on the aggregate construct, not the alias
- Please use identical strings for the expressions, the algorithm is not yet that smart. In other words, if you use "COUNT " in the SELECT clause you should use the same "COUNT " expression in the HAVING clause, not "COUNT( * )" or any variant of it.
- ORDER BY
- You can order on any column in the result. (to be fixed later to allow you to also sort on non-selected columns in the service)
- Strings have single quotes around them, escaping quotes is not yet supported.
Dates have square brackets around them and the following formats are supported: [yyyy/MM/dd HH:mm:ss.SSS], [yyyy/MM/dd HH:mm:ss] and [yyyy/MM/dd]
- Number and BigNumber should have no grouping symbol and the decimal is . (example 123.45)
- Integers contain only digits
- Boolean values can be TRUE or FALSE