From aabca9d3396146dc5011a0c751b0f79312cbaff7 Mon Sep 17 00:00:00 2001 From: Kurt Niemi Date: Mon, 20 Mar 2023 16:51:31 -0400 Subject: [PATCH 1/5] 1110 - Prepare branch --- pom.xml | 2 +- spring-data-jdbc-distribution/pom.xml | 2 +- spring-data-jdbc/pom.xml | 4 ++-- spring-data-r2dbc/pom.xml | 4 ++-- spring-data-relational/pom.xml | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/pom.xml b/pom.xml index 4f4dd91922..2c4b644a48 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ org.springframework.data spring-data-relational-parent - 3.1.0-SNAPSHOT + 3.1.0-1110-SNAPSHOT pom Spring Data Relational Parent diff --git a/spring-data-jdbc-distribution/pom.xml b/spring-data-jdbc-distribution/pom.xml index 6e018ca17d..acf427335c 100644 --- a/spring-data-jdbc-distribution/pom.xml +++ b/spring-data-jdbc-distribution/pom.xml @@ -14,7 +14,7 @@ org.springframework.data spring-data-relational-parent - 3.1.0-SNAPSHOT + 3.1.0-1110-SNAPSHOT ../pom.xml diff --git a/spring-data-jdbc/pom.xml b/spring-data-jdbc/pom.xml index aa6936d760..4958d898df 100644 --- a/spring-data-jdbc/pom.xml +++ b/spring-data-jdbc/pom.xml @@ -6,7 +6,7 @@ 4.0.0 spring-data-jdbc - 3.1.0-SNAPSHOT + 3.1.0-1110-SNAPSHOT Spring Data JDBC Spring Data module for JDBC repositories. @@ -15,7 +15,7 @@ org.springframework.data spring-data-relational-parent - 3.1.0-SNAPSHOT + 3.1.0-1110-SNAPSHOT diff --git a/spring-data-r2dbc/pom.xml b/spring-data-r2dbc/pom.xml index 1b6e105406..28815833c8 100644 --- a/spring-data-r2dbc/pom.xml +++ b/spring-data-r2dbc/pom.xml @@ -6,7 +6,7 @@ 4.0.0 spring-data-r2dbc - 3.1.0-SNAPSHOT + 3.1.0-1110-SNAPSHOT Spring Data R2DBC Spring Data module for R2DBC @@ -15,7 +15,7 @@ org.springframework.data spring-data-relational-parent - 3.1.0-SNAPSHOT + 3.1.0-1110-SNAPSHOT diff --git a/spring-data-relational/pom.xml b/spring-data-relational/pom.xml index 71d009990b..77d7074308 100644 --- a/spring-data-relational/pom.xml +++ b/spring-data-relational/pom.xml @@ -6,7 +6,7 @@ 4.0.0 spring-data-relational - 3.1.0-SNAPSHOT + 3.1.0-1110-SNAPSHOT Spring Data Relational Spring Data Relational support @@ -14,7 +14,7 @@ org.springframework.data spring-data-relational-parent - 3.1.0-SNAPSHOT + 3.1.0-1110-SNAPSHOT From 3ca3d7164e4a52c784acbef6c686e955f66e6000 Mon Sep 17 00:00:00 2001 From: Kurt Niemi Date: Mon, 20 Mar 2023 18:27:02 -0400 Subject: [PATCH 2/5] Deprecate redundant getReference(IdentifierProcessing) method The method also fixed the bug of this method not honoring the IdentifierProcessing parameter, so the functionality is now identical to the toSql(IdentifierProcessing) method. Closes spring-projects#1110 --- .../relational/core/mapping/DerivedSqlIdentifier.java | 3 ++- .../data/relational/core/sql/CompositeSqlIdentifier.java | 1 + .../data/relational/core/sql/DefaultSqlIdentifier.java | 5 +++-- .../data/relational/core/sql/SqlIdentifier.java | 8 ++++++-- 4 files changed, 12 insertions(+), 5 deletions(-) diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifier.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifier.java index 8ca7789990..7f482de7b8 100644 --- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifier.java +++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifier.java @@ -65,8 +65,9 @@ public String toSql(IdentifierProcessing processing) { } @Override + @Deprecated(since="3.0.5", forRemoval = false) public String getReference(IdentifierProcessing processing) { - return this.name; + return toSql(processing); } @Override diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/CompositeSqlIdentifier.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/CompositeSqlIdentifier.java index 7fda0ff6f4..891c24da09 100644 --- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/CompositeSqlIdentifier.java +++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/CompositeSqlIdentifier.java @@ -66,6 +66,7 @@ public String toSql(IdentifierProcessing processing) { } @Override + @Deprecated(since="3.0.5", forRemoval = false) public String getReference(IdentifierProcessing processing) { throw new UnsupportedOperationException("Composite SQL Identifiers can't be used for reference name retrieval"); } diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DefaultSqlIdentifier.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DefaultSqlIdentifier.java index 962f130c6d..3f913990b6 100644 --- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DefaultSqlIdentifier.java +++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DefaultSqlIdentifier.java @@ -57,12 +57,13 @@ public SqlIdentifier transform(UnaryOperator transformationFunction) { @Override public String toSql(IdentifierProcessing processing) { - return quoted ? processing.quote(getReference(processing)) : getReference(processing); + return quoted ? processing.quote(name) : name; } @Override + @Deprecated(since="3.0.5", forRemoval = false) public String getReference(IdentifierProcessing processing) { - return name; + return toSql(processing); } @Override diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SqlIdentifier.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SqlIdentifier.java index d0cb6f78da..ac011487eb 100644 --- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SqlIdentifier.java +++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SqlIdentifier.java @@ -26,7 +26,7 @@ * from a {@link String name} with specifying whether the name should be quoted or unquoted. *

* {@link SqlIdentifier} renders its name using {@link IdentifierProcessing} rules. Use - * {@link #getReference(IdentifierProcessing)} to refer to an object using the identifier when e.g. obtaining values + * {@link #getReference()} to refer to an object using the identifier when e.g. obtaining values * from a result or providing values for a prepared statement. {@link #toSql(IdentifierProcessing)} renders the * identifier for SQL statement usage. *

@@ -39,6 +39,7 @@ * * @author Jens Schauder * @author Mark Paluch + * @author Kurt Niemi * @since 2.0 */ public interface SqlIdentifier extends Streamable { @@ -77,9 +78,12 @@ public String toString() { * Return the reference name after applying {@link IdentifierProcessing} rules. The reference name is used for * programmatic access to the object identified by this {@link SqlIdentifier}. * + * @deprecated Use the toSql(IdentifierProcessing processing) method instead. + * * @param processing identifier processing rules. * @return */ + @Deprecated(since="3.0.5", forRemoval = false) String getReference(IdentifierProcessing processing); /** @@ -90,7 +94,7 @@ public String toString() { * @see IdentifierProcessing#NONE */ default String getReference() { - return getReference(IdentifierProcessing.NONE); + return toSql(IdentifierProcessing.NONE); } /** From e1c76b723d66af0a169bd08b9f562446b7ac7710 Mon Sep 17 00:00:00 2001 From: Kurt Niemi Date: Mon, 20 Mar 2023 18:33:21 -0400 Subject: [PATCH 3/5] Unit Test changes --- .../core/mapping/DerivedSqlIdentifierUnitTests.java | 6 ++++-- .../data/relational/core/sql/SqlIdentifierUnitTests.java | 4 +++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/spring-data-relational/src/test/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifierUnitTests.java b/spring-data-relational/src/test/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifierUnitTests.java index 7e04d24613..8cc20c9835 100644 --- a/spring-data-relational/src/test/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifierUnitTests.java +++ b/spring-data-relational/src/test/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifierUnitTests.java @@ -41,7 +41,8 @@ public void quotedSimpleObjectIdentifierWithAdjustableLetterCasing() { SqlIdentifier identifier = new DerivedSqlIdentifier("someName", true); assertThat(identifier.toSql(BRACKETS_LOWER_CASE)).isEqualTo("[somename]"); - assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("someName"); + assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("[somename]"); + assertThat(identifier.getReference()).isEqualTo("someName"); } @@ -52,7 +53,8 @@ public void unquotedSimpleObjectIdentifierWithAdjustableLetterCasing() { String sql = identifier.toSql(BRACKETS_LOWER_CASE); assertThat(sql).isEqualTo("somename"); - assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("someName"); + assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("somename"); + assertThat(identifier.getReference()).isEqualTo("someName"); } @Test // DATAJDBC-386 diff --git a/spring-data-relational/src/test/java/org/springframework/data/relational/core/sql/SqlIdentifierUnitTests.java b/spring-data-relational/src/test/java/org/springframework/data/relational/core/sql/SqlIdentifierUnitTests.java index d072544904..efc6461d88 100644 --- a/spring-data-relational/src/test/java/org/springframework/data/relational/core/sql/SqlIdentifierUnitTests.java +++ b/spring-data-relational/src/test/java/org/springframework/data/relational/core/sql/SqlIdentifierUnitTests.java @@ -40,7 +40,8 @@ public void quotedSimpleObjectIdentifier() { SqlIdentifier identifier = quoted("someName"); assertThat(identifier.toSql(BRACKETS_LOWER_CASE)).isEqualTo("[someName]"); - assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("someName"); + assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("[someName]"); + assertThat(identifier.getReference()).isEqualTo("someName"); } @Test // DATAJDBC-386 @@ -51,6 +52,7 @@ public void unquotedSimpleObjectIdentifier() { assertThat(sql).isEqualTo("someName"); assertThat(identifier.getReference(BRACKETS_LOWER_CASE)).isEqualTo("someName"); + assertThat(identifier.getReference()).isEqualTo("someName"); } @Test // DATAJDBC-386 From a92b0e449684706bb6cdcaa47269da07b3b7ff4c Mon Sep 17 00:00:00 2001 From: Kurt Niemi Date: Mon, 20 Mar 2023 18:35:44 -0400 Subject: [PATCH 4/5] Changes to not use deprecated method. To avoid breaking existing usages of getReference(identifierProcessing) as it did not do identifier processing, we call the getReference() method which does not do any. --- .../jdbc/core/convert/IdGeneratingBatchInsertStrategy.java | 4 ++-- .../data/jdbc/core/convert/IdGeneratingInsertStrategy.java | 4 ++-- .../core/convert/JdbcBackReferencePropertyValueProvider.java | 2 +- .../data/jdbc/core/convert/JdbcPropertyValueProvider.java | 2 +- .../data/jdbc/core/convert/MapEntityRowMapper.java | 2 +- .../springframework/data/jdbc/core/convert/SqlGenerator.java | 2 +- .../data/jdbc/core/convert/SqlIdentifierParameterSource.java | 4 ++-- .../org/springframework/data/r2dbc/dialect/H2Dialect.java | 2 +- .../org/springframework/data/r2dbc/dialect/MySqlDialect.java | 2 +- .../data/relational/core/mapping/NamingStrategy.java | 2 +- .../core/mapping/PersistentPropertyPathExtension.java | 2 +- 11 files changed, 14 insertions(+), 14 deletions(-) diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingBatchInsertStrategy.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingBatchInsertStrategy.java index b0407c2870..29d5a0bb08 100644 --- a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingBatchInsertStrategy.java +++ b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingBatchInsertStrategy.java @@ -79,7 +79,7 @@ public Object[] execute(String sql, SqlParameterSource[] sqlParameterSources) { Map keys = keyList.get(i); if (keys.size() > 1) { if (idColumn != null) { - ids[i] = keys.get(idColumn.getReference(dialect.getIdentifierProcessing())); + ids[i] = keys.get(idColumn.getReference()); } } else { ids[i] = keys.entrySet().stream().findFirst() // @@ -93,7 +93,7 @@ public Object[] execute(String sql, SqlParameterSource[] sqlParameterSources) { private String[] getKeyColumnNames() { return Optional.ofNullable(idColumn) - .map(idColumn -> new String[] { idColumn.getReference(dialect.getIdentifierProcessing()) }) + .map(idColumn -> new String[] { idColumn.getReference() }) .orElse(new String[0]); } } diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingInsertStrategy.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingInsertStrategy.java index de081d4ea7..9f77183a37 100644 --- a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingInsertStrategy.java +++ b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingInsertStrategy.java @@ -79,13 +79,13 @@ public Object execute(String sql, SqlParameterSource sqlParameterSource) { return null; } - return keys.get(idColumn.getReference(dialect.getIdentifierProcessing())); + return keys.get(idColumn.getReference()); } } private String[] getKeyColumnNames() { return Optional.ofNullable(idColumn) - .map(idColumn -> new String[] { idColumn.getReference(dialect.getIdentifierProcessing()) }) + .map(idColumn -> new String[] { idColumn.getReference() }) .orElse(new String[0]); } } diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/JdbcBackReferencePropertyValueProvider.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/JdbcBackReferencePropertyValueProvider.java index 76b3cacd10..24a61b507d 100644 --- a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/JdbcBackReferencePropertyValueProvider.java +++ b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/JdbcBackReferencePropertyValueProvider.java @@ -50,7 +50,7 @@ class JdbcBackReferencePropertyValueProvider implements PropertyValueProvider T getPropertyValue(RelationalPersistentProperty property) { return (T) resultSet - .getObject(basePath.extendBy(property).getReverseColumnNameAlias().getReference(identifierProcessing)); + .getObject(basePath.extendBy(property).getReverseColumnNameAlias().getReference()); } public JdbcBackReferencePropertyValueProvider extendBy(RelationalPersistentProperty property) { diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/JdbcPropertyValueProvider.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/JdbcPropertyValueProvider.java index 3d051183e6..56d9d5a43e 100644 --- a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/JdbcPropertyValueProvider.java +++ b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/JdbcPropertyValueProvider.java @@ -62,7 +62,7 @@ public boolean hasProperty(RelationalPersistentProperty property) { } private String getColumnName(RelationalPersistentProperty property) { - return basePath.extendBy(property).getColumnAlias().getReference(identifierProcessing); + return basePath.extendBy(property).getColumnAlias().getReference(); } public JdbcPropertyValueProvider extendBy(RelationalPersistentProperty property) { diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/MapEntityRowMapper.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/MapEntityRowMapper.java index 70e687c52f..218327b579 100644 --- a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/MapEntityRowMapper.java +++ b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/MapEntityRowMapper.java @@ -53,7 +53,7 @@ class MapEntityRowMapper implements RowMapper> { @Override public Map.Entry mapRow(ResultSet rs, int rowNum) throws SQLException { - Object key = rs.getObject(keyColumn.getReference(identifierProcessing)); + Object key = rs.getObject(keyColumn.getReference()); return new HashMap.SimpleEntry<>(key, mapEntity(rs, key)); } diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlGenerator.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlGenerator.java index ecc2acc4bc..7f4a4ddaf1 100644 --- a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlGenerator.java +++ b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlGenerator.java @@ -772,7 +772,7 @@ private Column getVersionColumn() { } private String renderReference(SqlIdentifier identifier) { - return identifier.getReference(renderContext.getIdentifierProcessing()); + return identifier.getReference(); } private List extractOrderByFields(Sort sort) { diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlIdentifierParameterSource.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlIdentifierParameterSource.java index 8a8e142bd7..11d834bdde 100644 --- a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlIdentifierParameterSource.java +++ b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlIdentifierParameterSource.java @@ -68,7 +68,7 @@ void addValue(SqlIdentifier name, Object value) { void addValue(SqlIdentifier identifier, Object value, int sqlType) { identifiers.add(identifier); - String name = BindParameterNameSanitizer.sanitize(identifier.getReference(identifierProcessing)); + String name = BindParameterNameSanitizer.sanitize(identifier.getReference()); namesToValues.put(name, value); registerSqlType(name, sqlType); } @@ -77,7 +77,7 @@ void addAll(SqlIdentifierParameterSource others) { for (SqlIdentifier identifier : others.getIdentifiers()) { - String name = identifier.getReference(identifierProcessing); + String name = identifier.getReference(); addValue(identifier, others.getValue(name), others.getSqlType(name)); } } diff --git a/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/dialect/H2Dialect.java b/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/dialect/H2Dialect.java index da401a05a1..59db0e2fc7 100644 --- a/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/dialect/H2Dialect.java +++ b/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/dialect/H2Dialect.java @@ -47,7 +47,7 @@ public BindMarkersFactory getBindMarkersFactory() { @Override public String renderForGeneratedValues(SqlIdentifier identifier) { - return identifier.getReference(getIdentifierProcessing()); + return identifier.getReference(); } @Override diff --git a/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/dialect/MySqlDialect.java b/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/dialect/MySqlDialect.java index 1daacdff17..e6c9cdf07b 100644 --- a/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/dialect/MySqlDialect.java +++ b/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/dialect/MySqlDialect.java @@ -95,7 +95,7 @@ public Boolean convert(Byte s) { @Override public String renderForGeneratedValues(SqlIdentifier identifier) { - return identifier.getReference(getIdentifierProcessing()); + return identifier.getReference(); } /** diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/NamingStrategy.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/NamingStrategy.java index 12186a4515..736a1841a5 100644 --- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/NamingStrategy.java +++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/NamingStrategy.java @@ -84,7 +84,7 @@ default String getReverseColumnName(RelationalPersistentProperty property) { Assert.notNull(property, "Property must not be null"); - return property.getOwner().getTableName().getReference(IdentifierProcessing.NONE); + return property.getOwner().getTableName().getReference(); } default String getReverseColumnName(PersistentPropertyPathExtension path) { diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/PersistentPropertyPathExtension.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/PersistentPropertyPathExtension.java index 79a2a26e25..13b24486eb 100644 --- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/PersistentPropertyPathExtension.java +++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/PersistentPropertyPathExtension.java @@ -482,7 +482,7 @@ private SqlIdentifier prefixWithTableAlias(SqlIdentifier columnName) { SqlIdentifier tableAlias = getTableAlias(); return tableAlias == null ? columnName - : columnName.transform(name -> tableAlias.getReference(IdentifierProcessing.NONE) + "_" + name); + : columnName.transform(name -> tableAlias.getReference() + "_" + name); } @Override From 6dbb99c9ed47481a983a671a403f9b7930b6cbba Mon Sep 17 00:00:00 2001 From: Kurt Niemi Date: Tue, 21 Mar 2023 14:12:24 -0400 Subject: [PATCH 5/5] Address review comments --- .../core/mapping/DerivedSqlIdentifier.java | 2 +- .../core/sql/CompositeSqlIdentifier.java | 2 +- .../relational/core/sql/DefaultSqlIdentifier.java | 2 +- .../data/relational/core/sql/SqlIdentifier.java | 14 +++++++------- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifier.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifier.java index 7f482de7b8..6a283877ac 100644 --- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifier.java +++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/DerivedSqlIdentifier.java @@ -65,7 +65,7 @@ public String toSql(IdentifierProcessing processing) { } @Override - @Deprecated(since="3.0.5", forRemoval = false) + @Deprecated(since="3.1", forRemoval = true) public String getReference(IdentifierProcessing processing) { return toSql(processing); } diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/CompositeSqlIdentifier.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/CompositeSqlIdentifier.java index 891c24da09..94ce8bb253 100644 --- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/CompositeSqlIdentifier.java +++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/CompositeSqlIdentifier.java @@ -66,7 +66,7 @@ public String toSql(IdentifierProcessing processing) { } @Override - @Deprecated(since="3.0.5", forRemoval = false) + @Deprecated(since="3.1", forRemoval = true) public String getReference(IdentifierProcessing processing) { throw new UnsupportedOperationException("Composite SQL Identifiers can't be used for reference name retrieval"); } diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DefaultSqlIdentifier.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DefaultSqlIdentifier.java index 3f913990b6..1204dc2b26 100644 --- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DefaultSqlIdentifier.java +++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DefaultSqlIdentifier.java @@ -61,7 +61,7 @@ public String toSql(IdentifierProcessing processing) { } @Override - @Deprecated(since="3.0.5", forRemoval = false) + @Deprecated(since="3.1", forRemoval = true) public String getReference(IdentifierProcessing processing) { return toSql(processing); } diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SqlIdentifier.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SqlIdentifier.java index ac011487eb..1bd4067102 100644 --- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SqlIdentifier.java +++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SqlIdentifier.java @@ -78,17 +78,16 @@ public String toString() { * Return the reference name after applying {@link IdentifierProcessing} rules. The reference name is used for * programmatic access to the object identified by this {@link SqlIdentifier}. * - * @deprecated Use the toSql(IdentifierProcessing processing) method instead. - * * @param processing identifier processing rules. * @return + * @deprecated since 3.1, use the #getReference() method instead. */ - @Deprecated(since="3.0.5", forRemoval = false) + @Deprecated(since="3.1", forRemoval = true) String getReference(IdentifierProcessing processing); /** - * Return the reference name without any further transformation. The reference name is used for programmatic access to - * the object identified by this {@link SqlIdentifier}. + * Use this method whenever accessing a column in a ResultSet and we do not want any quoting applied. The + * reference name is used for programmatic access to the object identified by this {@link SqlIdentifier}. * * @return * @see IdentifierProcessing#NONE @@ -98,8 +97,9 @@ default String getReference() { } /** - * Return the identifier for SQL usage after applying {@link IdentifierProcessing} rules. The identifier name is used - * to construct SQL statements. + * Use this method when rendering an identifier in SQL statements as in: + * 

select yourColumn from someTable
+ * {@link IdentifierProcessing} rules are applied to the identifier. * * @param processing identifier processing rules. * @return