Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
[CONJ-705] parameter metadata get parameter count even when query can…
…not be prepared
  • Loading branch information
rusher committed May 15, 2020
1 parent ceb2b5e commit 12af84f
Show file tree
Hide file tree
Showing 7 changed files with 263 additions and 29 deletions.
Expand Up @@ -514,11 +514,8 @@ private void loadParametersData() throws SQLSyntaxErrorException {
exceptionFactory)) {
resultSetMetaData = ssps.getMetaData();
parameterMetaData = ssps.getParameterMetaData();
} catch (SQLSyntaxErrorException sqlSyntaxErrorException) {
// if error is due to wrong SQL syntax, better to throw exception immediately
throw sqlSyntaxErrorException;
} catch (SQLException sqle) {
// eat
} catch (Exception exception) {
parameterMetaData = new SimpleParameterMetaData(prepareResult.getParamCount());
}
}

Expand Down
5 changes: 4 additions & 1 deletion src/main/java/org/mariadb/jdbc/MariaDbResultSetMetaData.java
Expand Up @@ -47,7 +47,10 @@ public class MariaDbResultSetMetaData implements ResultSetMetaData {
* @param updatable is column updatable
*/
public MariaDbResultSetMetaData(
final ColumnDefinition[] fieldPackets, final Options options, final boolean forceAlias, final boolean updatable) {
final ColumnDefinition[] fieldPackets,
final Options options,
final boolean forceAlias,
final boolean updatable) {
this.fieldPackets = fieldPackets;
this.options = options;
this.forceAlias = forceAlias;
Expand Down
187 changes: 187 additions & 0 deletions src/main/java/org/mariadb/jdbc/SimpleParameterMetaData.java
@@ -0,0 +1,187 @@
/*
*
* MariaDB Client for Java
*
* Copyright (c) 2012-2014 Monty Program Ab.
* Copyright (c) 2015-2020 MariaDB Corporation Ab.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License along
* with this library; if not, write to Monty Program Ab info@montyprogram.com.
*
* This particular MariaDB Client for Java file is work
* derived from a Drizzle-JDBC. Drizzle-JDBC file which is covered by subject to
* the following copyright and notice provisions:
*
* Copyright (c) 2009-2011, Marcus Eriksson
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list
* of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice, this
* list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
*
* Neither the name of the driver nor the names of its contributors may not be
* used to endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*
*/

package org.mariadb.jdbc;

import java.sql.ParameterMetaData;
import java.sql.SQLException;
import org.mariadb.jdbc.internal.util.exceptions.ExceptionFactory;

/** Very basic info about the parameterized query, only reliable method is getParameterCount(). */
public class SimpleParameterMetaData implements ParameterMetaData {

private final int parameterCount;

public SimpleParameterMetaData(int parameterCount) {
this.parameterCount = parameterCount;
}

@Override
public int getParameterCount() throws SQLException {
return parameterCount;
}

@Override
public int isNullable(final int param) throws SQLException {
if (param < 1 || param > parameterCount) {
throw ExceptionFactory.INSTANCE.create(
String.format(
"Parameter metadata out of range : param was %s and must be in range 1 - %s",
param, parameterCount),
"07009");
}
return ParameterMetaData.parameterNullableUnknown;
}

@Override
public boolean isSigned(int param) throws SQLException {
if (param < 1 || param > parameterCount) {
throw ExceptionFactory.INSTANCE.create(
String.format(
"Parameter metadata out of range : param was %s and must be in range 1 - %s",
param, parameterCount),
"07009");
}
return true;
}

@Override
public int getPrecision(int param) throws SQLException {
if (param < 1 || param > parameterCount) {
throw ExceptionFactory.INSTANCE.create(
String.format(
"Parameter metadata out of range : param was %s and must be in range 1 - %s",
param, parameterCount),
"07009");
}
throw ExceptionFactory.INSTANCE.create("Unknown parameter metadata precision");
}

@Override
public int getScale(int param) throws SQLException {
if (param < 1 || param > parameterCount) {
throw ExceptionFactory.INSTANCE.create(
String.format(
"Parameter metadata out of range : param was %s and must be in range 1 - %s",
param, parameterCount),
"07009");
}
throw ExceptionFactory.INSTANCE.create("Unknown parameter metadata scale");
}

/**
* Parameter type are not sent by server. See https://jira.mariadb.org/browse/CONJ-568 and
* https://jira.mariadb.org/browse/MDEV-15031
*
* @param param parameter number
* @return SQL type from java.sql.Types
* @throws SQLException a feature not supported, since server doesn't sent the right information
*/
@Override
public int getParameterType(int param) throws SQLException {
if (param < 1 || param > parameterCount) {
throw ExceptionFactory.INSTANCE.create(
String.format(
"Parameter metadata out of range : param was %s and must be in range 1 - %s",
param, parameterCount),
"07009");
}
throw ExceptionFactory.INSTANCE.notSupported(
"Getting parameter type metadata are not supported");
}

@Override
public String getParameterTypeName(int param) throws SQLException {
if (param < 1 || param > parameterCount) {
throw ExceptionFactory.INSTANCE.create(
String.format(
"Parameter metadata out of range : param was %s and must be in range 1 - %s",
param, parameterCount),
"07009");
}
throw ExceptionFactory.INSTANCE.create("Unknown parameter metadata type name");
}

@Override
public String getParameterClassName(int param) throws SQLException {
if (param < 1 || param > parameterCount) {
throw ExceptionFactory.INSTANCE.create(
String.format(
"Parameter metadata out of range : param was %s and must be in range 1 - %s",
param, parameterCount),
"07009");
}
throw ExceptionFactory.INSTANCE.create("Unknown parameter metadata class name");
}

@Override
public int getParameterMode(int param) {
return parameterModeIn;
}

@Override
public <T> T unwrap(final Class<T> iface) throws SQLException {
try {
if (isWrapperFor(iface)) {
return iface.cast(this);
} else {
throw new SQLException("The receiver is not a wrapper for " + iface.getName());
}
} catch (Exception e) {
throw new SQLException("The receiver is not a wrapper and does not implement the interface");
}
}

public boolean isWrapperFor(final Class<?> iface) throws SQLException {
return iface.isInstance(this);
}
}
Expand Up @@ -261,12 +261,7 @@ public void executeBatchOneByOne() throws SQLException {
@Test
public void metaDataForWrongQuery() throws SQLException {
PreparedStatement preparedStatement = sharedConnection.prepareStatement("WRONG QUERY");
try {
preparedStatement.getMetaData();
fail();
} catch (SQLSyntaxErrorException e) {
assertTrue(e.getMessage().contains("You have an error in your SQL syntax"));
}
assertNull(preparedStatement.getMetaData());
}

@Test
Expand Down
1 change: 0 additions & 1 deletion src/test/java/org/mariadb/jdbc/ConnectionTest.java
Expand Up @@ -1006,5 +1006,4 @@ public void readOnly() throws SQLException {
connection.setReadOnly(false);
stmt.execute("DROP TABLE testReadOnly");
}

}
18 changes: 4 additions & 14 deletions src/test/java/org/mariadb/jdbc/DriverTest.java
Expand Up @@ -241,13 +241,8 @@ public void parameterMetaDataNotPreparable() throws SQLException {
// statement that cannot be prepared
try (PreparedStatement pstmt =
sharedConnection.prepareStatement("select TMP.field1 from (select ? from dual) TMP")) {
try {
pstmt.getParameterMetaData();
fail();
} catch (SQLException sqle) {
assertEquals("42S22", sqle.getSQLState());
assertTrue(sqle.getMessage().contains("Unknown column"));
}
ParameterMetaData meta = pstmt.getParameterMetaData();
assertEquals(1, meta.getParameterCount());
}
Map<String, Integer> endingValues = loadVariables(stmt);
assertEquals(initValues.get("Prepared_stmt_count"), endingValues.get("Prepared_stmt_count"));
Expand All @@ -261,13 +256,8 @@ public void parameterMetaDataReturnException() throws SQLException {
// statement that cannot be prepared
try (PreparedStatement preparedStatement =
sharedConnection.prepareStatement("selec1t 2 from dual")) {
try {
preparedStatement.getParameterMetaData();
fail();
} catch (SQLException sqle) {
assertEquals("42000", sqle.getSQLState());
assertTrue(sqle.getMessage().contains(" You have an error in your SQL syntax"));
}
ParameterMetaData meta = preparedStatement.getParameterMetaData();
assertEquals(0, meta.getParameterCount());
}
}

Expand Down
67 changes: 65 additions & 2 deletions src/test/java/org/mariadb/jdbc/MariaDbDatabaseMetaDataTest.java
Expand Up @@ -95,8 +95,71 @@ private void checkResults(Connection connection, boolean yearAsDate, boolean tin
public void metadataNullWhenNotPossible() throws SQLException {
try (PreparedStatement preparedStatement =
sharedConnection.prepareStatement(
"LOAD DATA LOCAL INFILE 'dummy.tsv' INTO TABLE LocalInfileInputStreamTest (id, test)")) {
assertNull(preparedStatement.getParameterMetaData());
"LOAD DATA LOCAL INFILE 'dummy.tsv' INTO TABLE LocalInfileInputStreamTest (id, ?)")) {
assertNull(preparedStatement.getMetaData());
ParameterMetaData parameterMetaData = preparedStatement.getParameterMetaData();
assertEquals(1, parameterMetaData.getParameterCount());
try {
parameterMetaData.getParameterType(1);
fail("must have throw error");
} catch (SQLException sqle) {
assertTrue(sqle.getMessage().contains("not supported"));
}
try {
parameterMetaData.getParameterClassName(1);
fail("must have throw error");
} catch (SQLException sqle) {
assertTrue(sqle.getMessage().contains("Unknown parameter metadata class name"));
}
try {
parameterMetaData.getParameterTypeName(1);
fail("must have throw error");
} catch (SQLException sqle) {
assertTrue(sqle.getMessage().contains("Unknown parameter metadata type name"));
}
try {
parameterMetaData.getPrecision(1);
fail("must have throw error");
} catch (SQLException sqle) {
assertTrue(sqle.getMessage().contains("Unknown parameter metadata precision"));
}
try {
parameterMetaData.getScale(1);
fail("must have throw error");
} catch (SQLException sqle) {
assertTrue(sqle.getMessage().contains("Unknown parameter metadata scale"));
}

try {
parameterMetaData.getParameterType(1000);
fail("must have throw error");
} catch (SQLException sqle) {
assertTrue(sqle.getMessage().contains("param was 1000 and must be in range 1 - 1"));
}
try {
parameterMetaData.getParameterClassName(1000);
fail("must have throw error");
} catch (SQLException sqle) {
assertTrue(sqle.getMessage().contains("param was 1000 and must be in range 1 - 1"));
}
try {
parameterMetaData.getParameterTypeName(1000);
fail("must have throw error");
} catch (SQLException sqle) {
assertTrue(sqle.getMessage().contains("param was 1000 and must be in range 1 - 1"));
}
try {
parameterMetaData.getPrecision(1000);
fail("must have throw error");
} catch (SQLException sqle) {
assertTrue(sqle.getMessage().contains("param was 1000 and must be in range 1 - 1"));
}
try {
parameterMetaData.getScale(1000);
fail("must have throw error");
} catch (SQLException sqle) {
assertTrue(sqle.getMessage().contains("param was 1000 and must be in range 1 - 1"));
}
}
}
}

0 comments on commit 12af84f

Please sign in to comment.