Skip to content

Improved JDBCInputFormat (FLINK-3750), fixed test Exceptions in the #1884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
+302 −131
Closed

Improved JDBCInputFormat (FLINK-3750), fixed test Exceptions in the #1884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions ...tch-connectors/flink-jdbc/src/main/java/org/apache/flink/api/java/io/RangeInputSplit.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.flink.api.java.io;

import org.apache.flink.annotation.Public;
import org.apache.flink.core.io.InputSplit;

/**
* A range input split provides information about a particular range of keys, each with a min and a max value.
*/
@Public
public class RangeInputSplit implements InputSplit{

private static final long serialVersionUID = 4310893817447171721L;

private long min;
private long max;

/** The number of the split. */
private final int splitNumber;

public RangeInputSplit(int splitNumber, long min, long max){
this.min = min;
this.max = max;
this.splitNumber = splitNumber;
}

@Override
public int getSplitNumber() {
return splitNumber;
}

public long getMin() {
return min;
}

public long getMax() {
return max;
}


}
158 changes: 124 additions & 34 deletions ...onnectors/flink-jdbc/src/main/java/org/apache/flink/api/java/io/jdbc/JDBCInputFormat.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,12 @@
import java.sql.SQLException;
import java.sql.Statement;

import org.apache.flink.api.common.io.NonParallelInput;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.apache.flink.api.common.io.DefaultInputSplitAssigner;
import org.apache.flink.api.common.io.RichInputFormat;
import org.apache.flink.api.common.io.statistics.BaseStatistics;
import org.apache.flink.api.java.io.RangeInputSplit;
import org.apache.flink.api.java.tuple.Tuple;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.core.io.GenericInputSplit;
Expand All @@ -44,28 +43,38 @@
* InputFormat to read data from a database and generate tuples.
* The InputFormat has to be configured using the supplied InputFormatBuilder.
*
* Remark: split (if set) works only if the split column is numeric
*
* @param <OUT>
* @see Tuple
* @see DriverManager
*/
public class JDBCInputFormat<OUT extends Tuple> extends RichInputFormat<OUT, InputSplit> implements NonParallelInput {
private static final long serialVersionUID = 1L;
public class JDBCInputFormat<OUT extends Tuple> extends RichInputFormat<OUT, InputSplit> {

private static final long serialVersionUID = 1L;
private static final Logger LOG = LoggerFactory.getLogger(JDBCInputFormat.class);

private String username;
private String password;
private String drivername;
private String dbURL;
private String query;
private String queryTemplate;
private int resultSetType;
private int resultSetConcurrency;

private transient Connection dbConn;
private transient Statement statement;
private transient ResultSet resultSet;

private int[] columnTypes;

private int[] columnTypes = null;
private String splitColumnName;
private long max;
private long min;
private long fetchSize;

private static final String BETWEEN = "(%s BETWEEN %s AND %s)";
public static final String CONDITIONS = "$CONDITIONS";

public JDBCInputFormat() {
}
Expand All @@ -81,19 +90,34 @@ public void configure(Configuration parameters) {
* @throws IOException
*/
@Override
public void open(InputSplit ignored) throws IOException {
public void open(InputSplit inputSplit) throws IOException {
try {
//TODO is this performed once per Task Manager..?
establishConnection();
statement = dbConn.createStatement(resultSetType, resultSetConcurrency);
String query = queryTemplate;
if(isSplitConfigured()){
RangeInputSplit jdbcInputSplit = (RangeInputSplit) inputSplit;
long start = jdbcInputSplit.getMin();
long end = jdbcInputSplit.getMax();
if(isSplitConfigured()){
query = queryTemplate.replace(CONDITIONS, String.format(BETWEEN, splitColumnName, start, end));
}
}
LOG.debug(query);
resultSet = statement.executeQuery(query);
} catch (SQLException se) {
close();
//close(); already closed by the caller
throw new IllegalArgumentException("open() failed." + se.getMessage(), se);
} catch (ClassNotFoundException cnfe) {
throw new IllegalArgumentException("JDBC-Class not found. - " + cnfe.getMessage(), cnfe);
}
}

private boolean isSplitConfigured() {
return splitColumnName!=null;
}

private void establishConnection() throws SQLException, ClassNotFoundException {
Class.forName(drivername);
if (username == null) {
Expand Down Expand Up @@ -139,13 +163,10 @@ public void close() throws IOException {
@Override
public boolean reachedEnd() throws IOException {
try {
if (resultSet.isLast()) {
close();
return true;
}
return false;
return !resultSet.next();
} catch (SQLException se) {
throw new IOException("Couldn't evaluate reachedEnd() - " + se.getMessage(), se);
//close();already closed by the caller
throw new IOException("ResultSet error during next() - " + se.getMessage(), se);
}
}

Expand All @@ -159,17 +180,16 @@ public boolean reachedEnd() throws IOException {
@Override
public OUT nextRecord(OUT tuple) throws IOException {
try {
resultSet.next();
if (columnTypes == null) {
extractTypes(tuple);
}
addValue(tuple);
return tuple;
} catch (SQLException se) {
close();
//close();already closed by the caller
throw new IOException("Couldn't read data - " + se.getMessage(), se);
} catch (NullPointerException npe) {
close();
//close();already closed by the caller
throw new IOException("Couldn't access resultSet", npe);
}
}
Expand All @@ -178,8 +198,8 @@ private void extractTypes(OUT tuple) throws SQLException, IOException {
ResultSetMetaData resultSetMetaData = resultSet.getMetaData();
columnTypes = new int[resultSetMetaData.getColumnCount()];
if (tuple.getArity() != columnTypes.length) {
close();
throw new IOException("Tuple size does not match columncount");
//close();already closed by the caller
throw new IOException("Tuple size does not match column count");
}
for (int pos = 0; pos < columnTypes.length; pos++) {
columnTypes[pos] = resultSetMetaData.getColumnType(pos + 1);
Expand All @@ -193,6 +213,8 @@ private void extractTypes(OUT tuple) throws SQLException, IOException {
*/
private void addValue(OUT reuse) throws IOException, SQLException {
for (int pos = 0; pos < columnTypes.length; pos++) {
//TODO what if null?? use strings for now. Maybe use Row for JDBC??
Object o = resultSet.getObject(pos + 1);
try {
switch (columnTypes[pos]) {
case java.sql.Types.NULL:
Expand All @@ -211,7 +233,8 @@ private void addValue(OUT reuse) throws IOException, SQLException {
reuse.setField(resultSet.getString(pos + 1), pos);
break;
case java.sql.Types.VARCHAR:
reuse.setField(resultSet.getString(pos + 1), pos);
//TODO manage null fields
reuse.setField(o == null ? "" :resultSet.getString(pos + 1), pos);
break;
case java.sql.Types.LONGVARCHAR:
reuse.setField(resultSet.getString(pos + 1), pos);
Expand All @@ -232,7 +255,7 @@ private void addValue(OUT reuse) throws IOException, SQLException {
reuse.setField(resultSet.getInt(pos + 1), pos);
break;
case java.sql.Types.FLOAT:
reuse.setField(resultSet.getDouble(pos + 1), pos);
reuse.setField(resultSet.getFloat(pos + 1), pos);
break;
case java.sql.Types.REAL:
reuse.setField(resultSet.getFloat(pos + 1), pos);
Expand All @@ -241,10 +264,29 @@ private void addValue(OUT reuse) throws IOException, SQLException {
reuse.setField(resultSet.getDouble(pos + 1), pos);
break;
case java.sql.Types.DECIMAL:
reuse.setField(resultSet.getBigDecimal(pos + 1).doubleValue(), pos);
break;
//TODO manage null fields
try {
if (o == null)
reuse.setField("", pos);
else
reuse.setField(resultSet.getBigDecimal(pos + 1).toPlainString(), pos);
} catch (SQLException e) {
System.err.println("error reading at position " + pos + " setting blank field!");
reuse.setField("", pos);
// throw e;
}
case java.sql.Types.NUMERIC:
reuse.setField(resultSet.getBigDecimal(pos + 1).doubleValue(), pos);
//TODO manage null fields
try {
if (o == null)
reuse.setField("", pos);
else
reuse.setField(resultSet.getBigDecimal(pos + 1).toPlainString(), pos);
} catch (SQLException e) {
System.err.println("error reading at position " + pos + " setting blank field!");
reuse.setField("", pos);
// throw e;
}
break;
case java.sql.Types.DATE:
reuse.setField(resultSet.getDate(pos + 1).toString(), pos);
Expand All @@ -253,7 +295,11 @@ private void addValue(OUT reuse) throws IOException, SQLException {
reuse.setField(resultSet.getTime(pos + 1).getTime(), pos);
break;
case java.sql.Types.TIMESTAMP:
reuse.setField(resultSet.getTimestamp(pos + 1).toString(), pos);
//TODO manage null fields
if (o == null)
reuse.setField("", pos + 1);
else
reuse.setField(resultSet.getTimestamp(pos + 1).toString(), pos);
break;
case java.sql.Types.SQLXML:
reuse.setField(resultSet.getSQLXML(pos + 1).toString(), pos);
Expand Down Expand Up @@ -289,17 +335,38 @@ public BaseStatistics getStatistics(BaseStatistics cachedStatistics) throws IOEx

@Override
public InputSplit[] createInputSplits(int minNumSplits) throws IOException {
GenericInputSplit[] split = {
new GenericInputSplit(0, 1)
};
return split;
if(!isSplitConfigured()){
GenericInputSplit[] split = {
new GenericInputSplit(0, 1)
};
return split;
}

double maxEelemCount = (max - min) +1;
if(min==0)
maxEelemCount = max + 1;
int size = new Double(Math.ceil( maxEelemCount / fetchSize)).intValue();
if(minNumSplits > size){
size = minNumSplits;
fetchSize = new Double(Math.ceil( maxEelemCount / minNumSplits)).intValue();
}
RangeInputSplit[] ret = new RangeInputSplit[size];
int count = 0;
for (long i = min; i < max; i += fetchSize, count++) {
long currentLimit = i + fetchSize - 1;
ret[count] = new RangeInputSplit(count, i, currentLimit);
if (currentLimit + 1 + fetchSize > max) {
ret[count+1] = new RangeInputSplit(count, currentLimit + 1, max);
break;
}
}
return ret;
}

@Override
public InputSplitAssigner getInputSplitAssigner(InputSplit[] inputSplits) {
return new DefaultInputSplitAssigner(inputSplits);
}


/**
* A builder used to set parameters to the output format's configuration in a fluent way.
Expand All @@ -310,8 +377,9 @@ public static JDBCInputFormatBuilder buildJDBCInputFormat() {
}

public static class JDBCInputFormatBuilder {
private final JDBCInputFormat format;
private final JDBCInputFormat<?> format;

@SuppressWarnings("rawtypes")
public JDBCInputFormatBuilder() {
this.format = new JDBCInputFormat();
this.format.resultSetType = ResultSet.TYPE_FORWARD_ONLY;
Expand Down Expand Up @@ -339,7 +407,7 @@ public JDBCInputFormatBuilder setDBUrl(String dbURL) {
}

public JDBCInputFormatBuilder setQuery(String query) {
format.query = query;
format.queryTemplate = query;
return this;
}

Expand All @@ -352,8 +420,15 @@ public JDBCInputFormatBuilder setResultSetConcurrency(int resultSetConcurrency)
format.resultSetConcurrency = resultSetConcurrency;
return this;
}
public JDBCInputFormatBuilder setSplitConfig(String splitColumnName,long fetchSize, long min, long max) {
format.splitColumnName = splitColumnName;
format.fetchSize = fetchSize;
format.min = min;
format.max = max;
return this;
}

public JDBCInputFormat finish() {
public JDBCInputFormat<?> finish() {
if (format.username == null) {
LOG.info("Username was not supplied separately.");
}
Expand All @@ -363,14 +438,29 @@ public JDBCInputFormat finish() {
if (format.dbURL == null) {
throw new IllegalArgumentException("No database URL supplied");
}
if (format.query == null) {
if (format.queryTemplate == null) {
throw new IllegalArgumentException("No query supplied");
}
if (format.drivername == null) {
throw new IllegalArgumentException("No driver supplied");
}
adjustQueryTemplateIfNecessary();
return format;
}

/** Try to add $CONDITIONS token automatically (at least for straightforward cases) */
private void adjustQueryTemplateIfNecessary() {
if(!format.isSplitConfigured())
return;
if(!format.queryTemplate.toLowerCase().contains("where")){
if(format.queryTemplate.contains(";"))
format.queryTemplate = format.queryTemplate.replace(";", "");
format.queryTemplate += " WHERE "+CONDITIONS;
}else if(!format.queryTemplate.contains(CONDITIONS)){
//if not simple query and no $CONDITIONS avoid dangerous heuristics
throw new IllegalArgumentException("Usage of splits requires to specify "+CONDITIONS+" in the query for their generation");
}
}
}

}
1 change: 0 additions & 1 deletion ...atch-connectors/flink-jdbc/src/test/java/org/apache/flink/api/java/io/jdbc/DerbyUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@

import java.io.OutputStream;

@SuppressWarnings("unused")
/**
* Utility class to disable derby logging
*/
Expand Down
Loading