QueryInfo (aws-mysql-jdbc 1.1.14 API)

java.lang.Object
- com.mysql.cj.QueryInfo

```
public class QueryInfo
extends java.lang.Object
```
Represents the "parsed" state of a prepared query, with the statement broken up into its static and dynamic (where parameters are bound) parts.

Constructor Summary

Constructors
Constructor and Description
`QueryInfo(java.lang.String sql, Session session, java.lang.String encoding)` Constructs a `QueryInfo` object for the given query or multi-query.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`static boolean`	`containsOnDuplicateKeyUpdateClause(java.lang.String sql, boolean noBackslashEscapes)` Checks whether the specified SQL contains or not an ON DUPLICATE KEY UPDATE clause.
`static char`	`firstCharOfStatementUc(java.lang.String sql, boolean noBackslashEscapes)` Finds and returns the first non-whitespace character from the specified SQL, skipping comments and quoted text.
`char`	`getFirstStmtChar()` Returns the first character of the statement from the query used to build this `QueryInfo`.
`int`	`getNumberOfQueries()` Returns the number of queries identified in the original SQL string.
`QueryInfo`	`getQueryInfoForBatch(int count)` Returns a `QueryInfo` for a multi-values INSERT/REPLACE assembled for the specified batch count, without re-parsing.
`QueryReturnType`	`getQueryReturnType()` Returns the return type of the parsed query.
`static QueryReturnType`	`getQueryReturnType(java.lang.String sql, boolean noBackslashEscapes)` Returns the type of return that can be expected from executing the given query.
`java.lang.String`	`getSqlForBatch()` Returns a preparable query for the batch count of this `QueryInfo`.
`java.lang.String`	`getSqlForBatch(int count)` Returns a preparable query for the specified batch count.
`byte[][]`	`getStaticSqlParts()` Returns the static sections of the parsed query, as byte arrays, split by the places where the placeholders were located.
`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.
`static int`	`indexOfStatementKeyword(java.lang.String sql, boolean noBackslashEscapes)` Finds and returns the position of the first non-whitespace character from the specified SQL, skipping comments and quoted text.
`static boolean`	`isReadOnlySafeQuery(java.lang.String sql, boolean noBackslashEscapes)` Checks whether the given query is safe to run in a read-only session.
`boolean`	`isRewritableWithMultiValuesClause()` Can this query be rewritten as a multi-values clause?

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QueryInfo
```
public QueryInfo(java.lang.String sql,
                 Session session,
                 java.lang.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 - the query SQL string to parse and analyze
    
    session - the Session under which the query analysis must be done.
    
    encoding - the characters encoding to use when extracting the query static parts as byte arrays.
- Method Detail
  - getNumberOfQueries
```
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:
    
    the number of queries identified in the original SQL string
  - getQueryReturnType
```
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:
    
    the return type of the parsed query
  - getFirstStmtChar
```
public char getFirstStmtChar()
```
    Returns the first character of the statement from the query used to build this QueryInfo.
    
    Returns:
    
    the first character of the statement
  - getValuesClauseLength
```
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:
    
    the length of the parsed VALUES clause section, including the placeholder characters themselves, otherwise returns -1
  - containsOnDuplicateKeyUpdate
```
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:
    
    true if the query or any of the original queries contain an ON DUPLICATE KEY UPDATE clause.
  - getStaticSqlParts
```
public byte[][] getStaticSqlParts()
```
    Returns the static sections of the parsed query, as byte arrays, split by the places where the placeholders were located.
    
    Returns:
    
    the static sections of the parsed query, as byte arrays, split by the places where the placeholders were located
  - isRewritableWithMultiValuesClause
```
public boolean isRewritableWithMultiValuesClause()
```
    Can this query be rewritten as a multi-values clause?
    
    Returns:
    
    true if the query can be rewritten as a multi-values query.
  - getQueryInfoForBatch
```
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 - the number of parameter batches
    
    Returns:
    
    QueryInfo
  - getSqlForBatch
```
public java.lang.String getSqlForBatch()
```
    Returns a preparable query for the batch count of this QueryInfo.
    
    Returns:
    
    a preparable query string with the appropriate number of placeholders
  - getSqlForBatch
```
public java.lang.String getSqlForBatch(int count)
```
    Returns a preparable query for the specified batch count.
    
    Parameters:
    
    count - number of parameter batches
    
    Returns:
    
    a preparable query string with the appropriate number of placeholders
  - indexOfStatementKeyword
```
public static int indexOfStatementKeyword(java.lang.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 - the query to search
    
    noBackslashEscapes - whether backslash escapes are disabled or not
    
    Returns:
    
    the position of the first character of the query
  - firstCharOfStatementUc
```
public static char firstCharOfStatementUc(java.lang.String sql,
                                          boolean noBackslashEscapes)
```
    Finds and returns the first non-whitespace character from the specified SQL, skipping comments and quoted text.
    
    Parameters:
    
    sql - the query to search
    
    noBackslashEscapes - whether backslash escapes are disabled or not
    
    Returns:
    
    the first character of the query, in upper case
  - isReadOnlySafeQuery
```
public static boolean isReadOnlySafeQuery(java.lang.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 - the query to check
    
    noBackslashEscapes - whether backslash escapes are disabled or not
    
    Returns:
    
    true if the query is read-only safe, false otherwise.
  - getQueryReturnType
```
public static QueryReturnType getQueryReturnType(java.lang.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 - the query to check
    
    noBackslashEscapes - whether backslash escapes are disabled or not
    
    Returns:
    
    the return type that can be expected from the given query, one of the elements of QueryReturnType.
  - containsOnDuplicateKeyUpdateClause
```
public static boolean containsOnDuplicateKeyUpdateClause(java.lang.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 - the query to search
    
    noBackslashEscapes - whether backslash escapes are disabled or not.
    
    Returns:
    
    true if the query contains an ON DUPLICATE KEY UPDATE clause, false otherwise

Class QueryInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueryInfo

Method Detail

getNumberOfQueries

getQueryReturnType

getFirstStmtChar

getValuesClauseLength

containsOnDuplicateKeyUpdate

getStaticSqlParts

isRewritableWithMultiValuesClause

getQueryInfoForBatch

getSqlForBatch

getSqlForBatch

indexOfStatementKeyword

firstCharOfStatementUc

isReadOnlySafeQuery

getQueryReturnType

containsOnDuplicateKeyUpdateClause