Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Exclude declared generated key columns from SimpleJdbcInsert #37014

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

Open
junhyeong9812 wants to merge 1 commit into
base: main
Choose a base branch
from
+131 −3
Open

Exclude declared generated key columns from SimpleJdbcInsert #37014

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
12 changes: 9 additions & 3 deletions spring-jdbc/src/main/java/org/springframework/jdbc/core/metadata/TableMetaDataContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,13 +205,19 @@ protected List<String> reconcileColumnsToUse(List<String> declaredColumns, Strin
if (generatedKeyNames.length > 0) {
this.generatedKeyColumnsUsed = true;
}
if (!declaredColumns.isEmpty()) {
return new ArrayList<>(declaredColumns);
}
Set<String> keys = CollectionUtils.newLinkedHashSet(generatedKeyNames.length);
for (String key : generatedKeyNames) {
keys.add(key.toUpperCase(Locale.ROOT));
}
if (!declaredColumns.isEmpty()) {
List<String> columns = new ArrayList<>();
for (String column : declaredColumns) {
if (!keys.contains(column.toUpperCase(Locale.ROOT))) {
columns.add(column);
}
}
return columns;
}
List<String> columns = new ArrayList<>();
for (TableParameterMetaData meta : obtainMetaDataProvider().getTableParameterMetaData()) {
if (!keys.contains(meta.getParameterName().toUpperCase(Locale.ROOT))) {
Expand Down
122 changes: 122 additions & 0 deletions ...ng-jdbc/src/test/java/org/springframework/jdbc/core/simple/TableMetaDataContextTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,4 +153,126 @@ void tableWithSingleColumnGeneratedKey() throws Exception {
verify(columnsResultSet).close();
}

@Test
void declaredColumnsIncludingGeneratedKeyAreExcluded() throws Exception {
final String TABLE = "customers";
final String USER = "me";

ResultSet metaDataResultSet = mock();
given(metaDataResultSet.next()).willReturn(true, false);
given(metaDataResultSet.getString("TABLE_SCHEM")).willReturn(USER);
given(metaDataResultSet.getString("TABLE_NAME")).willReturn(TABLE);
given(metaDataResultSet.getString("TABLE_TYPE")).willReturn("TABLE");

ResultSet columnsResultSet = mock();
given(columnsResultSet.next()).willReturn(true, true, false);
given(columnsResultSet.getString("COLUMN_NAME")).willReturn("id", "name");
given(columnsResultSet.getInt("DATA_TYPE")).willReturn(Types.INTEGER, Types.VARCHAR);
given(columnsResultSet.getBoolean("NULLABLE")).willReturn(false, true);

given(databaseMetaData.getDatabaseProductName()).willReturn("MyDB");
given(databaseMetaData.getDatabaseProductVersion()).willReturn("1.0");
given(databaseMetaData.getUserName()).willReturn(USER);
given(databaseMetaData.storesLowerCaseIdentifiers()).willReturn(true);
given(databaseMetaData.getTables(null, null, TABLE, null)).willReturn(metaDataResultSet);
given(databaseMetaData.getColumns(null, USER, TABLE, null)).willReturn(columnsResultSet);

MapSqlParameterSource map = new MapSqlParameterSource();
map.addValue("id", 1);
map.addValue("name", "Sven");
String[] keyCols = new String[] { "id" };
context.setTableName(TABLE);
context.processMetaData(dataSource, List.of("id", "name"), keyCols);
List<Object> values = context.matchInParameterValuesWithInsertColumns(map);
String insertString = context.createInsertString(keyCols);
int[] insertTypes = context.createInsertTypes();

assertThat(insertString).as("insert string should exclude the declared generated key column")
.isEqualTo("INSERT INTO customers (name) VALUES(?)");
assertThat(values).as("values should exclude the declared generated key column").containsExactly("Sven");
assertThat(insertTypes.length).as("types array must match the number of placeholders").isEqualTo(1);
verify(metaDataResultSet, atLeastOnce()).next();
verify(columnsResultSet, atLeastOnce()).next();
verify(metaDataResultSet).close();
verify(columnsResultSet).close();
}

@Test
void declaredColumnsMatchingGeneratedKeysProduceEmptyInsert() throws Exception {
final String TABLE = "customers";
final String USER = "me";

ResultSet metaDataResultSet = mock();
given(metaDataResultSet.next()).willReturn(true, false);
given(metaDataResultSet.getString("TABLE_SCHEM")).willReturn(USER);
given(metaDataResultSet.getString("TABLE_NAME")).willReturn(TABLE);
given(metaDataResultSet.getString("TABLE_TYPE")).willReturn("TABLE");

ResultSet columnsResultSet = mock();
given(columnsResultSet.next()).willReturn(true, false);
given(columnsResultSet.getString("COLUMN_NAME")).willReturn("id");
given(columnsResultSet.getInt("DATA_TYPE")).willReturn(Types.INTEGER);
given(columnsResultSet.getBoolean("NULLABLE")).willReturn(false);

given(databaseMetaData.getDatabaseProductName()).willReturn("MyDB");
given(databaseMetaData.getDatabaseProductVersion()).willReturn("1.0");
given(databaseMetaData.getUserName()).willReturn(USER);
given(databaseMetaData.storesLowerCaseIdentifiers()).willReturn(true);
given(databaseMetaData.getTables(null, null, TABLE, null)).willReturn(metaDataResultSet);
given(databaseMetaData.getColumns(null, USER, TABLE, null)).willReturn(columnsResultSet);

MapSqlParameterSource map = new MapSqlParameterSource();
map.addValue("id", 1);
String[] keyCols = new String[] { "id" };
context.setTableName(TABLE);
context.processMetaData(dataSource, List.of("id"), keyCols);
List<Object> values = context.matchInParameterValuesWithInsertColumns(map);
String insertString = context.createInsertString(keyCols);
int[] insertTypes = context.createInsertTypes();

assertThat(insertString).as("empty insert not generated correctly")
.isEqualTo("INSERT INTO customers () VALUES()");
assertThat(values).as("no values should remain once the only declared column is the generated key").isEmpty();
assertThat(insertTypes).as("no types should remain once the only declared column is the generated key").isEmpty();
}

@Test
void declaredColumnsExcludeGeneratedKeyRegardlessOfCase() throws Exception {
final String TABLE = "customers";
final String USER = "me";

ResultSet metaDataResultSet = mock();
given(metaDataResultSet.next()).willReturn(true, false);
given(metaDataResultSet.getString("TABLE_SCHEM")).willReturn(USER);
given(metaDataResultSet.getString("TABLE_NAME")).willReturn(TABLE);
given(metaDataResultSet.getString("TABLE_TYPE")).willReturn("TABLE");

ResultSet columnsResultSet = mock();
given(columnsResultSet.next()).willReturn(true, true, false);
given(columnsResultSet.getString("COLUMN_NAME")).willReturn("id", "name");
given(columnsResultSet.getInt("DATA_TYPE")).willReturn(Types.INTEGER, Types.VARCHAR);
given(columnsResultSet.getBoolean("NULLABLE")).willReturn(false, true);

given(databaseMetaData.getDatabaseProductName()).willReturn("MyDB");
given(databaseMetaData.getDatabaseProductVersion()).willReturn("1.0");
given(databaseMetaData.getUserName()).willReturn(USER);
given(databaseMetaData.storesLowerCaseIdentifiers()).willReturn(true);
given(databaseMetaData.getTables(null, null, TABLE, null)).willReturn(metaDataResultSet);
given(databaseMetaData.getColumns(null, USER, TABLE, null)).willReturn(columnsResultSet);

MapSqlParameterSource map = new MapSqlParameterSource();
map.addValue("ID", 1);
map.addValue("name", "Sven");
String[] keyCols = new String[] { "id" };
context.setTableName(TABLE);
context.processMetaData(dataSource, List.of("ID", "name"), keyCols);
List<Object> values = context.matchInParameterValuesWithInsertColumns(map);
String insertString = context.createInsertString(keyCols);

assertThat(insertString).as("insert string should exclude the declared generated key column regardless of case")
.isEqualTo("INSERT INTO customers (name) VALUES(?)");
assertThat(values).as("values should exclude the declared generated key column regardless of case")
.containsExactly("Sven");
}

}