MySQL Connector/J 9.2.0 · com.mysql.cj.QueryInfo · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final String	AS_CLAUSE
private QueryInfo	baseQueryInfo
private int	batchCount
private static final String	CLOSING_MARKERS
private boolean	containsOnDuplicateKeyUpdate
private String	encoding
private static final String	INSERT_STATEMENT
private boolean	isRewritableWithMultiValuesClause
private static final String	LAST_INSERT_ID_FUNC
private static final String	LIMIT_CLAUSE
private static final String	MULTIPLE_QUERIES_TAG
private int	numberOfPlaceholders
private int	numberOfQueries
private static final String[]	ODKU_CLAUSE
private static final String	OFFSET_CLAUSE
private static final String	OPENING_MARKERS
private static final String	OVERRIDING_MARKERS
private List<PlaceholderPurpose>	placeholderPurposes
private int	queryLength
private QueryReturnType	queryReturnType
private int	queryStartPos
private static final String	REPLACE_STATEMENT
private static final String	SELECT_STATEMENT
private String	sql
private char	statementFirstChar
private String	statementKeyword
private byte[][]	staticSqlParts
private static final String	TABLE_STATEMENT
private static final String	VALUE_CLAUSE
private int	valuesClauseLength
private ArrayList<Integer>	valuesEndpoints

Access	Constructor and Description
public	QueryInfo(String the query SQL string to parse and analyze sql, Session the `Session` under which the query analysis must be done. session, String the characters encoding to use when extracting the query static parts as byte arrays. encoding) Constructs a `QueryInfo` object for the given query or multi-query.
private	QueryInfo(QueryInfo the `QueryInfo` instance that provides the query static parts used to create the new instance now augmented to accommodate the extra number of parameters baseQueryInfo, int the number of batches, i.e., the number of times the VALUES clause needs to be repeated inside the new query batchCount) Constructs a `QueryInfo` object with a multi-value clause for the specified batch count, that stems from the specified baseQueryInfo.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the query or any of the original queries contain an ON DUPLICATE KEY UPDATE clause. containsOnDuplicateKeyUpdate() Does this query info represent a query that contains an ON DUPLICATE KEY UPDATE clause?
public static boolean	Returns: `true` if the query contains an ON DUPLICATE KEY UPDATE clause, `false` otherwise containsOnDuplicateKeyUpdateClause(String the query to search sql, boolean whether backslash escapes are disabled or not. noBackslashEscapes) Checks whether the specified SQL contains or not an ON DUPLICATE KEY UPDATE clause.
public static char	Returns: the first character of the query, in upper case firstCharOfStatementUc(String the query to search sql, boolean whether backslash escapes are disabled or not noBackslashEscapes) Finds and returns the first non-whitespace character from the specified SQL, skipping comments and quoted text.
private static String	Returns: the context of the WITH statement or null if failed to find it getContextForWithStatement(String the query to search sql, boolean whether backslash escapes are disabled or not noBackslashEscapes) Returns the context of the WITH statement.
public char	Returns: the first character of the statement getFirstStmtChar() Returns the first character of the statement from the query used to build this `QueryInfo`.
public int	Returns: the number of placeholders in the query getNumberOfPlaceholders() Returns the number of placeholders found in the query.
public int	Returns: the number of queries identified in the original SQL string getNumberOfQueries() Returns the number of queries identified in the original SQL string.
public List<PlaceholderPurpose>	Returns: the list of the placeholders purposes. getPlaceholderPurposes() Returns a list containing the purpose of each one of the placeholders found according to their positional ordering.
public QueryInfo	Returns: `QueryInfo` getQueryInfoForBatch(int the number of parameter batches count) Returns a `QueryInfo` for a multi-values INSERT/REPLACE assembled for the specified batch count, without re-parsing.
public QueryReturnType	Returns: the return type of the parsed query getQueryReturnType() Returns the return type of the parsed query.
public static QueryReturnType	Returns: the return type that can be expected from the given query, one of the elements of `QueryReturnType`. getQueryReturnType(String the query to check sql, boolean whether backslash escapes are disabled or not noBackslashEscapes) Returns the type of return that can be expected from executing the given query.
public String	Returns: a preparable query string with the appropriate number of placeholders getSqlForBatch() Returns a preparable query for the batch count of this `QueryInfo`.
public String	Returns: a preparable query string with the appropriate number of placeholders getSqlForBatch(int number of parameter batches count) Returns a preparable query for the specified batch count.
public String	Returns: the statement keyword getStatementKeyword() Returns the statement keyword from the query used to build this `QueryInfo`.
public static String	Returns: the statement keyword of the query getStatementKeyword(String the query to search sql, boolean whether backslash escapes are disabled or not noBackslashEscapes) Finds and returns the statement keyword from the specified SQL, skipping comments and quoted text.
public byte[][]	Returns: the static sections of the parsed query, as byte arrays, split by the places where the placeholders were located getStaticSqlParts() Returns the static sections of the parsed query, as byte arrays, split by the places where the placeholders were located.
public int	Returns: the length of the parsed VALUES clause section, including the placeholder characters themselves, otherwise returns -1 getValuesClauseLength() If this object represents a query that is re-writable as a multi-values statement and if rewriting batched statements is enabled, then returns the length of the parsed VALUES clause section, including the placeholder characters themselves, otherwise returns -1.
public static int	Returns: the position of the first character of the query indexOfStatementKeyword(String the query to search sql, boolean whether backslash escapes are disabled or not noBackslashEscapes) Finds and returns the position of the first non-whitespace character from the specified SQL, skipping comments and quoted text.
public static boolean	Returns: `true` if the query is read-only safe, `false` otherwise. isReadOnlySafeQuery(String the query to check sql, boolean whether backslash escapes are disabled or not noBackslashEscapes) Checks whether the given query is safe to run in a read-only session.
public boolean	Returns: `true` if the query can be rewritten as a multi-values query. isRewritableWithMultiValuesClause() Can this query be rewritten as a multi-values clause?

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

AS_CLAUSE	back to summary
private static final String AS_CLAUSE

baseQueryInfo	back to summary
private QueryInfo baseQueryInfo

batchCount	back to summary
private int batchCount

CLOSING_MARKERS	back to summary
private static final String CLOSING_MARKERS

containsOnDuplicateKeyUpdate	back to summary
private boolean containsOnDuplicateKeyUpdate

encoding	back to summary
private String encoding

INSERT_STATEMENT	back to summary
private static final String INSERT_STATEMENT

isRewritableWithMultiValuesClause	back to summary
private boolean isRewritableWithMultiValuesClause

LAST_INSERT_ID_FUNC	back to summary
private static final String LAST_INSERT_ID_FUNC

LIMIT_CLAUSE	back to summary
private static final String LIMIT_CLAUSE

MULTIPLE_QUERIES_TAG	back to summary
private static final String MULTIPLE_QUERIES_TAG

numberOfPlaceholders	back to summary
private int numberOfPlaceholders

numberOfQueries	back to summary
private int numberOfQueries

ODKU_CLAUSE	back to summary
private static final String[] ODKU_CLAUSE

OFFSET_CLAUSE	back to summary
private static final String OFFSET_CLAUSE

OPENING_MARKERS	back to summary
private static final String OPENING_MARKERS

OVERRIDING_MARKERS	back to summary
private static final String OVERRIDING_MARKERS

placeholderPurposes	back to summary
private List<PlaceholderPurpose> placeholderPurposes

queryLength	back to summary
private int queryLength

queryReturnType	back to summary
private QueryReturnType queryReturnType

queryStartPos	back to summary
private int queryStartPos

REPLACE_STATEMENT	back to summary
private static final String REPLACE_STATEMENT

SELECT_STATEMENT	back to summary
private static final String SELECT_STATEMENT

sql	back to summary
private String sql

statementFirstChar	back to summary
private char statementFirstChar

statementKeyword	back to summary
private String statementKeyword

staticSqlParts	back to summary
private byte[][] staticSqlParts

TABLE_STATEMENT	back to summary
private static final String TABLE_STATEMENT

VALUE_CLAUSE	back to summary
private static final String VALUE_CLAUSE

valuesClauseLength	back to summary
private int valuesClauseLength

valuesEndpoints	back to summary
private ArrayList<Integer> valuesEndpoints

Constructor Detail

QueryInfo back to summary

QueryInfo	back to summary
public QueryInfo(String sql, Session session, String encoding) Constructs a `QueryInfo` object for the given query or multi-query. The parsed result of this query allows to determine the location of the placeholders, the query static parts and whether this query can be rewritten as a multi-values clause query. Parameters sql:String the query SQL string to parse and analyze session:Session the `Session` under which the query analysis must be done. encoding:String the characters encoding to use when extracting the query static parts as byte arrays.

public QueryInfo(String sql, Session session, String encoding)

Constructs a QueryInfo object for the given query or multi-query. The parsed result of this query allows to determine the location of the placeholders, the query static parts and whether this query can be rewritten as a multi-values clause query.

Parameters

sql:String: the query SQL string to parse and analyze
session:Session: the Session under which the query analysis must be done.
encoding:String: the characters encoding to use when extracting the query static parts as byte arrays.

QueryInfo back to summary

QueryInfo	back to summary
private QueryInfo(QueryInfo baseQueryInfo, int batchCount) Constructs a `QueryInfo` object with a multi-value clause for the specified batch count, that stems from the specified baseQueryInfo. Parameters baseQueryInfo:QueryInfo the `QueryInfo` instance that provides the query static parts used to create the new instance now augmented to accommodate the extra number of parameters batchCount:int the number of batches, i.e., the number of times the VALUES clause needs to be repeated inside the new query

private QueryInfo(QueryInfo baseQueryInfo, int batchCount)

Constructs a QueryInfo object with a multi-value clause for the specified batch count, that stems from the specified baseQueryInfo.

Parameters

baseQueryInfo:QueryInfo: the QueryInfo instance that provides the query static parts used to create the new instance now augmented to accommodate the extra number of parameters
batchCount:int: the number of batches, i.e., the number of times the VALUES clause needs to be repeated inside the new query

Method Detail

containsOnDuplicateKeyUpdate back to summary

containsOnDuplicateKeyUpdate	back to summary
public boolean containsOnDuplicateKeyUpdate() Does this query info represent a query that contains an ON DUPLICATE KEY UPDATE clause? This operation does not take into consideration the multiplicity of queries in the original SQL. Checking whether the original query contains an ON DUPLICATE KEY UPDATE clause is conditional to how the connection properties 'dontCheckOnDuplicateKeyUpdateInSQL' and 'rewriteBatchedStatements' are set, with 'rewriteBatchedStatements=true' implicitly disabling 'dontCheckOnDuplicateKeyUpdateInSQL'. Returns:boolean `true` if the query or any of the original queries contain an ON DUPLICATE KEY UPDATE clause.

public boolean containsOnDuplicateKeyUpdate()

Does this query info represent a query that contains an ON DUPLICATE KEY UPDATE clause? This operation does not take into consideration the multiplicity of queries in the original SQL. Checking whether the original query contains an ON DUPLICATE KEY UPDATE clause is conditional to how the connection properties 'dontCheckOnDuplicateKeyUpdateInSQL' and 'rewriteBatchedStatements' are set, with 'rewriteBatchedStatements=true' implicitly disabling 'dontCheckOnDuplicateKeyUpdateInSQL'.

Returns:boolean: true if the query or any of the original queries contain an ON DUPLICATE KEY UPDATE clause.

containsOnDuplicateKeyUpdateClause back to summary

containsOnDuplicateKeyUpdateClause	back to summary
public static boolean containsOnDuplicateKeyUpdateClause(String sql, boolean noBackslashEscapes) Checks whether the specified SQL contains or not an ON DUPLICATE KEY UPDATE clause. This operation does not take into consideration the multiplicity of queries in the specified SQL. Parameters sql:String the query to search noBackslashEscapes:boolean whether backslash escapes are disabled or not. Returns:boolean `true` if the query contains an ON DUPLICATE KEY UPDATE clause, `false` otherwise

public static boolean containsOnDuplicateKeyUpdateClause(String sql, boolean noBackslashEscapes)

Checks whether the specified SQL contains or not an ON DUPLICATE KEY UPDATE clause. This operation does not take into consideration the multiplicity of queries in the specified SQL.

Parameters

sql:String: the query to search
noBackslashEscapes:boolean: whether backslash escapes are disabled or not.

Returns:boolean

true if the query contains an ON DUPLICATE KEY UPDATE clause, false otherwise

firstCharOfStatementUc	back to summary
public static char firstCharOfStatementUc(String sql, boolean noBackslashEscapes) Finds and returns the first non-whitespace character from the specified SQL, skipping comments and quoted text. Parameters sql:String the query to search noBackslashEscapes:boolean whether backslash escapes are disabled or not Returns:char the first character of the query, in upper case

firstCharOfStatementUc

back to summary

public static char firstCharOfStatementUc(String sql, boolean noBackslashEscapes)

Finds and returns the first non-whitespace character from the specified SQL, skipping comments and quoted text.

Parameters

sql:String: the query to search
noBackslashEscapes:boolean: whether backslash escapes are disabled or not

Returns:char

the first character of the query, in upper case

getContextForWithStatement	back to summary
private static String getContextForWithStatement(String sql, boolean noBackslashEscapes) Returns the context of the WITH statement. The context can be: SELECT, TABLE, VALUES, UPDATE or DELETE. This operation does not take into consideration the multiplicity of queries in the specified SQL. Parameters sql:String the query to search noBackslashEscapes:boolean whether backslash escapes are disabled or not Returns:String the context of the WITH statement or null if failed to find it

getContextForWithStatement

back to summary

private static String getContextForWithStatement(String sql, boolean noBackslashEscapes)

Returns the context of the WITH statement. The context can be: SELECT, TABLE, VALUES, UPDATE or DELETE. This operation does not take into consideration the multiplicity of queries in the specified SQL.

Parameters

sql:String: the query to search
noBackslashEscapes:boolean: whether backslash escapes are disabled or not

Returns:String

the context of the WITH statement or null if failed to find it

getFirstStmtChar back to summary

getFirstStmtChar	back to summary
public char getFirstStmtChar() Returns the first character of the statement from the query used to build this `QueryInfo`. Returns:char the first character of the statement

public char getFirstStmtChar()

Returns the first character of the statement from the query used to build this QueryInfo.

Returns:char: the first character of the statement

getNumberOfPlaceholders	back to summary
public int getNumberOfPlaceholders() Returns the number of placeholders found in the query. Returns:int the number of placeholders in the query

getNumberOfPlaceholders

back to summary

public int getNumberOfPlaceholders()

Returns the number of placeholders found in the query.

Returns:int: the number of placeholders in the query

getNumberOfQueries	back to summary
public int getNumberOfQueries() Returns the number of queries identified in the original SQL string. Different queries are identified by the presence of the query delimiter character, i.e., a semicolon. Returns:int the number of queries identified in the original SQL string

getNumberOfQueries

back to summary

public int getNumberOfQueries()

Returns the number of queries identified in the original SQL string. Different queries are identified by the presence of the query delimiter character, i.e., a semicolon.

Returns:int: the number of queries identified in the original SQL string

getPlaceholderPurposes	back to summary
public List<PlaceholderPurpose> getPlaceholderPurposes() Returns a list containing the purpose of each one of the placeholders found according to their positional ordering. Returns:List<PlaceholderPurpose> the list of the placeholders purposes.

getPlaceholderPurposes

back to summary

public List<PlaceholderPurpose> getPlaceholderPurposes()

Returns a list containing the purpose of each one of the placeholders found according to their positional ordering.

Returns:List<PlaceholderPurpose>: the list of the placeholders purposes.

getQueryInfoForBatch back to summary

getQueryInfoForBatch	back to summary
public QueryInfo getQueryInfoForBatch(int count) Returns a `QueryInfo` for a multi-values INSERT/REPLACE assembled for the specified batch count, without re-parsing. Parameters count:int the number of parameter batches Returns:QueryInfo `QueryInfo`

public QueryInfo getQueryInfoForBatch(int count)

Returns a QueryInfo for a multi-values INSERT/REPLACE assembled for the specified batch count, without re-parsing.

Parameters

count:int: the number of parameter batches

Returns:QueryInfo

QueryInfo

getQueryReturnType	back to summary
public QueryReturnType getQueryReturnType() Returns the return type of the parsed query. This operation does not take into consideration the multiplicity of queries in the specified SQL. Returns:QueryReturnType the return type of the parsed query

getQueryReturnType

back to summary

public QueryReturnType getQueryReturnType()

Returns the return type of the parsed query. This operation does not take into consideration the multiplicity of queries in the specified SQL.

Returns:QueryReturnType: the return type of the parsed query

getQueryReturnType back to summary

getQueryReturnType	back to summary
public static QueryReturnType getQueryReturnType(String sql, boolean noBackslashEscapes) Returns the type of return that can be expected from executing the given query. This operation does not take into consideration the multiplicity of queries in the specified SQL. Parameters sql:String the query to check noBackslashEscapes:boolean whether backslash escapes are disabled or not Returns:QueryReturnType the return type that can be expected from the given query, one of the elements of `QueryReturnType`.

public static QueryReturnType getQueryReturnType(String sql, boolean noBackslashEscapes)

Returns the type of return that can be expected from executing the given query. This operation does not take into consideration the multiplicity of queries in the specified SQL.

Parameters

sql:String: the query to check
noBackslashEscapes:boolean: whether backslash escapes are disabled or not

Returns:QueryReturnType

the return type that can be expected from the given query, one of the elements of QueryReturnType.

getSqlForBatch back to summary

getSqlForBatch	back to summary
public String getSqlForBatch() Returns a preparable query for the batch count of this `QueryInfo`. Returns:String a preparable query string with the appropriate number of placeholders

public String getSqlForBatch()

Returns a preparable query for the batch count of this QueryInfo.

Returns:String: a preparable query string with the appropriate number of placeholders

getSqlForBatch	back to summary
public String getSqlForBatch(int count) Returns a preparable query for the specified batch count. Parameters count:int number of parameter batches Returns:String a preparable query string with the appropriate number of placeholders

getSqlForBatch

back to summary

public String getSqlForBatch(int count)

Returns a preparable query for the specified batch count.

Parameters

count:int: number of parameter batches

Returns:String

a preparable query string with the appropriate number of placeholders

getStatementKeyword back to summary

getStatementKeyword	back to summary
public String getStatementKeyword() Returns the statement keyword from the query used to build this `QueryInfo`. Returns:String the statement keyword

public String getStatementKeyword()

Returns the statement keyword from the query used to build this QueryInfo.

Returns:String: the statement keyword

getStatementKeyword

back to summary

public static String getStatementKeyword(String sql, boolean noBackslashEscapes)

Finds and returns the statement keyword from the specified SQL, skipping comments and quoted text.

Parameters

sql:String: the query to search
noBackslashEscapes:boolean: whether backslash escapes are disabled or not

Returns:String

the statement keyword of the query

getStaticSqlParts

back to summary

public byte[][] getStaticSqlParts()

Returns the static sections of the parsed query, as byte arrays, split by the places where the placeholders were located.

Returns:byte[][]: the static sections of the parsed query, as byte arrays, split by the places where the placeholders were located

getValuesClauseLength

back to summary

public int getValuesClauseLength()

If this object represents a query that is re-writable as a multi-values statement and if rewriting batched statements is enabled, then returns the length of the parsed VALUES clause section, including the placeholder characters themselves, otherwise returns -1.

Returns:int: the length of the parsed VALUES clause section, including the placeholder characters themselves, otherwise returns -1

indexOfStatementKeyword

back to summary

public static int indexOfStatementKeyword(String sql, boolean noBackslashEscapes)

Finds and returns the position of the first non-whitespace character from the specified SQL, skipping comments and quoted text.

Parameters

sql:String: the query to search
noBackslashEscapes:boolean: whether backslash escapes are disabled or not

Returns:int

the position of the first character of the query

isReadOnlySafeQuery back to summary

public static boolean isReadOnlySafeQuery(String sql, boolean noBackslashEscapes)

Checks whether the given query is safe to run in a read-only session. In case of doubt it is assumed to be safe. This operation does not take into consideration the multiplicity of queries in the specified SQL.

Parameters

sql:String: the query to check
noBackslashEscapes:boolean: whether backslash escapes are disabled or not

Returns:boolean

true if the query is read-only safe, false otherwise.

isRewritableWithMultiValuesClause back to summary

public boolean isRewritableWithMultiValuesClause()

Can this query be rewritten as a multi-values clause?

Returns:boolean: true if the query can be rewritten as a multi-values query.

public Class QueryInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail