com.toolsverse.etl.parser

Interface SqlParser

All Superinterfaces:

Serializable

All Known Implementing Classes:

GenericSqlParser

public interface SqlParser
extends Serializable

The sql grammar parser.

Since:

1.0

Version:

2.0

Method Summary

Modifier and Type	Method and Description
Variable	getVariable(String name, Driver driver) Creates a variable using given name and a driver.
boolean	isCallable(String sql) Checks if sql statement is callable.
String	parseParams(String sql, Map<String,Object> params, Map<String,List<Integer>> paramMap, List<String> outputParams, Driver driver) Parses the sql, updates params, paramMap and outputParams.
String	removeChars(String sql) Removes chars prohibited in the sql.
void	setBindVariables(PreparedStatement st, Map<String,Object> properties, Map<String,List<Integer>> paramMap, List<String> outpurParams, Driver driver) Sets the bind variables for the given prepared statement, including registering output parameters if any exist.
String	setBindVariables(String sql, Map<String,Object> properties) Sets the bind variables using given properties.
String[]	split(String sql) Splits given sql on multiple sql statements using ";" as a separator.
String	stripComments(String sql) Strip comments.

Method Detail

getVariable

Variable getVariable(String name,
                     Driver driver)

Creates a variable using given name and a driver. The variable is used to register output parameter for the callable sql statement.

The expected format: out_type_name.

Examples:

out_number_abc

out_cursor_xyz

Parameters:

name - the name

driver - the driver

Returns:

the variable

isCallable

boolean isCallable(String sql)

Checks if sql statement is callable. The callable statement is an anonymous sql block, function or a procedure.

Parameters:

sql - the sql

Returns:

true, if sql statement is callable

parseParams

String parseParams(String sql,
                   Map<String,Object> params,
                   Map<String,List<Integer>> paramMap,
                   List<String> outputParams,
                   Driver driver)

Parses the sql, updates params, paramMap and outputParams.

Parameters:

sql - the sql

params - the bind variables.

paramMap - the map containing bind variable name name as key and a list of parameter indexes as a value.

For example:

     select * from abc
     where xyz = :xyz and mmm = :xyz
 

the map will contain "xyz" as a key and a list {1,2} as a value.

outputParams - the output params

driver - the driver

Returns:

the string

removeChars

String removeChars(String sql)

Removes chars prohibited in the sql.

Parameters:

sql - the sql

Returns:

the sql

setBindVariables

void setBindVariables(PreparedStatement st,
                      Map<String,Object> properties,
                      Map<String,List<Integer>> paramMap,
                      List<String> outpurParams,
                      Driver driver)
               throws Exception

Sets the bind variables for the given prepared statement, including registering output parameters if any exist. Properties is a map containing variable name\value pairs.

Parameters:

st - the prepared statement

properties - the properties

paramMap - the map containing bind variable name name as key and a list of parameter indexes as a value.

For example:

     select * from abc
     where xyz = :xyz and mmm = :xyz
 

the map will contain "xyz" as a key and a list {1,2} as a value.

outpurParams - the list of output parameters, if any exist

driver - the driver

Throws:

Exception - in case of any error

setBindVariables

String setBindVariables(String sql,
                        Map<String,Object> properties)

Sets the bind variables using given properties. The bind variable can be defined inside sql as :name. Example: :abc Properties is a map containing variable name\value pairs. Ignores ":name" in comments and parameters.

Parameters:

sql - the sql

properties - the properties

Returns:

the original sql with bind variables substituted on vales.

split

String[] split(String sql)

Splits given sql on multiple sql statements using ";" as a separator. Ignores ";" in comments and parameters.

Parameters:

sql - the sql

Returns:

the sql statements

stripComments

String stripComments(String sql)

Strip comments.

Parameters:

sql - the sql

Returns:

the string