com.jamonapi.proxy

Class SQLDeArger

java.lang.Object

com.jamonapi.proxy.SQLDeArger

public class SQLDeArger
extends Object

SQLDeArger takes a sql statement and 1) replaces argument values ('souza', "souza", 'souza''s', 100, 100.5, 0xff, 10e9) with question marks It makes full sql statements look more like a prepared statement. 2) Returns a sql type which is simply the first word of the command (typically 'select', 'update' etc. 3) Returns any specified keywords that are in the parsed sql. This is a good way to return table names.

A normal sql statement with argument values would generate too much data for JAMon and wouldn't be very good for understanding how your query performed. Coneceptually the following queries are the same: 1) select * from table where name='steve', 2) select * from table where name='mindy'. However, if you passed both strings to jamon the 'sameness' wouldn't show up in the stats as each is a different string. However by putting question marks in place of the values this problem can be resolved (i.e. select * from table where name=?). One issue with the way this is done at this point is numbers or strings in other places can be replaced too. This shouldn't affect monitoring however. For example This "select abs(200) from table", would be parsed to "select abs(?) from table".

However, numbers of the format 100.00, really are multiple tokens. And will appear in the returned strings as ?.?.

The class name SQLDeArger refers to the fact that argument values are removed from SQL statements.

This class is also useful for logging sql statements.

Constructor Summary

Constructors

Constructor and Description
SQLDeArger(String sql) Accepts string to parse
SQLDeArger(String sql, List matchStrings) Accepts strings to parse and a List of strings to check to see if they are in the sql statement.
SQLDeArger(String sql, List matchStrings, int sqlMaxSize) This constructor will truncate any sql statements longer than sqlMaxSize before the JAMon label is created

Method Summary

Modifier and Type	Method and Description
void	addMatchString(String matchString) Add string to see if it matches in the query
String[]	getMatches() Returns an array of Strings that matched the Strings specified in the matches arraylist.
int	getNumMatches() Returns the number of matches or 0 if there were none
String	getParsedSQL() Return sql with original argument values replaced with '?'.
String	getSQLToParse() Get sql that was passed in to parse.
String	getSQLType() Return the first word from the sql command.
boolean	hasMatches() Returns true if there were any matches against the match Strings
static void	putSQLType(String type) SQL types are the first word that is in a sql statement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SQLDeArger

public SQLDeArger(String sql)

Accepts string to parse

SQLDeArger

public SQLDeArger(String sql,
                  List matchStrings)

Accepts strings to parse and a List of strings to check to see if they are in the sql statement. A good use for this is to pass table names into the constructor. After the constructor is called the sql will already have been parsed

Parameters:

sql -

matchStrings -

SQLDeArger

public SQLDeArger(String sql,
                  List matchStrings,
                  int sqlMaxSize)

This constructor will truncate any sql statements longer than sqlMaxSize before the JAMon label is created

Parameters:

sql -

matchStrings -

sqlMaxSize -

Method Detail

getParsedSQL

public String getParsedSQL()

Return sql with original argument values replaced with '?'. For example: select * from table where name=?

getSQLToParse

public String getSQLToParse()

Get sql that was passed in to parse.

getSQLType

public String getSQLType()

Return the first word from the sql command. These would include: select, update, delete, create, insert, commit,... If the word is not recognized then 'other' is returned.

getMatches

public String[] getMatches()

Returns an array of Strings that matched the Strings specified in the matches arraylist. Note that the matches are performed after arg values have been replaced on the sql with '?'.

hasMatches

public boolean hasMatches()

Returns true if there were any matches against the match Strings

getNumMatches

public int getNumMatches()

Returns the number of matches or 0 if there were none

addMatchString

public void addMatchString(String matchString)

Add string to see if it matches in the query

putSQLType

public static void putSQLType(String type)

SQL types are the first word that is in a sql statement. Examples are insert, delete, update, and select. However, any word that you add by calling this method will be detected as a sql type. Note the JDBCMonProxy uses this info to add a monitor for whenever a select, insert etc are executed. This gives the number of times and performances of the sql types. A list of all the default sql types follows: select, update, delete, insert, truncate, exec, create, drop, alter commit, rollback, grant, revoke, save. Any value that isn't on the list will return 'other'. The getSQLType method returns the SQL type value in the sql statement passed to the constructor.

Parameters:

type -