Skip to content

HBX-3208: Improve the implementation of the 'dialect' classes #5753

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

Merged
merged 1 commit into from
Nov 5, 2025
Merged

HBX-3208: Improve the implementation of the 'dialect' classes #5753

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
322 changes: 165 additions & 157 deletions orm/src/main/java/org/hibernate/tool/internal/reveng/dialect/AbstractMetaDataDialect.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,161 +41,169 @@
*/
public abstract class AbstractMetaDataDialect implements RevengDialect {

protected final Logger log = Logger.getLogger(this.getClass());

private Connection connection;
private DatabaseMetaData metaData;

private ConnectionProvider connectionProvider = null;

public void configure(
ConnectionProvider connectionProvider) {
this.connectionProvider = connectionProvider;
}

public void close() {
metaData = null;
if(connection != null) {
try {
connectionProvider.closeConnection(connection);
}
catch (SQLException e) {
throw new RuntimeException("Problem while closing connection", e);
} finally {
connection = null;
}
}
connectionProvider = null;
}

protected DatabaseMetaData getMetaData() {
if (metaData == null) {
try {
metaData = getConnection().getMetaData();
}
catch (SQLException e) {
throw new RuntimeException("Getting database metadata", e);
}
}
return metaData;
}

protected String getDatabaseStructure(String catalog, String schema) {
ResultSet schemaRs = null;
ResultSet catalogRs = null;
String nl = System.lineSeparator();
StringBuilder sb = new StringBuilder(nl);
// Let's give the user some feedback. The exception
// is probably related to incorrect schema configuration.
sb.append("Configured schema:").append(schema).append(nl);
sb.append("Configured catalog:").append(catalog ).append(nl);

try {
schemaRs = getMetaData().getSchemas();
sb.append("Available schemas:").append(nl);
while (schemaRs.next() ) {
sb.append(" ").append(schemaRs.getString("TABLE_SCHEM") ).append(nl);
}
}
catch (SQLException e2) {
log.warn("Could not get schemas", e2);
sb.append(" <SQLException while getting schemas>").append(nl);
}
finally {
try {
if (schemaRs != null) {
schemaRs.close();
}
}
catch (Exception ignore) {
}
}

try {
catalogRs = getMetaData().getCatalogs();
sb.append("Available catalogs:").append(nl);
while (catalogRs.next() ) {
sb.append(" ").append(catalogRs.getString("TABLE_CAT") ).append(nl);
}
}
catch (SQLException e2) {
log.warn("Could not get catalogs", e2);
sb.append(" <SQLException while getting catalogs>").append(nl);
}
finally {
try {
if (catalogRs != null) {
catalogRs.close();
}
}
catch (Exception ignore) {
}
}
return sb.toString();
}

protected Connection getConnection() throws SQLException {
if(connection==null) {
connection = connectionProvider.getConnection();
}
return connection;
}

public void close(Iterator<?> iterator) {
if(iterator instanceof ResultSetIterator) {
((ResultSetIterator)iterator).close();
}
}

public boolean needQuote(String name) {

if(name==null) return false;

// TODO: use jdbc metadata to decide on this. but for now we just handle the most typical cases.
if(name.indexOf('-')>0) return true;
if(name.indexOf(' ')>0) return true;
return name.indexOf( '.' ) > 0;
}

protected String caseForSearch(String value) throws SQLException {
// TODO: handle quoted requests (just strip it ?)
if(needQuote(value)) {
if ( getMetaData().storesMixedCaseQuotedIdentifiers() ) {
return value;
} else if ( getMetaData().storesUpperCaseQuotedIdentifiers() ) {
return toUpperCase( value );
} else if( getMetaData().storesLowerCaseQuotedIdentifiers() ) {
return toLowerCase( value );
} else {
return value;
}
} else if ( getMetaData().storesMixedCaseQuotedIdentifiers() ) {
return value;
} else if ( getMetaData().storesUpperCaseIdentifiers() ) {
return toUpperCase( value );
} else if( getMetaData().storesLowerCaseIdentifiers() ) {
return toLowerCase( value );
} else {
return value;
}
}

private String toUpperCase(String str) {
return str==null ? null : str.toUpperCase();
}

private String toLowerCase(String str) {
return str == null ? null : str.toLowerCase(Locale.ENGLISH);
}

public Iterator<Map<String, Object>> getSuggestedPrimaryKeyStrategyName(String catalog, String schema, String table) {
Map<String, Object> m = new HashMap<String, Object>();
m.put( "TABLE_CAT", catalog );
m.put( "TABLE_SCHEMA", schema );
m.put( "TABLE_NAME", table );
m.put( "HIBERNATE_STRATEGY", null );
List<Map<String, Object>> l = new ArrayList<Map<String, Object>>();
l.add(m);
return l.iterator();
}
protected final Logger log = Logger.getLogger(this.getClass());

private Connection connection;
private DatabaseMetaData metaData;

private ConnectionProvider connectionProvider = null;

public void configure(
ConnectionProvider connectionProvider) {
this.connectionProvider = connectionProvider;
}

public void close() {
metaData = null;
if(connection != null) {
try {
connectionProvider.closeConnection(connection);
}
catch (SQLException e) {
throw new RuntimeException("Problem while closing connection", e);
}
finally {
connection = null;
}
}
connectionProvider = null;
}

protected DatabaseMetaData getMetaData() {
if (metaData == null) {
try {
metaData = getConnection().getMetaData();
}
catch (SQLException e) {
throw new RuntimeException("Getting database metadata", e);
}
}
return metaData;
}

protected String getDatabaseStructure(String catalog, String schema) {
ResultSet schemaRs = null;
ResultSet catalogRs = null;
String nl = System.lineSeparator();
StringBuilder sb = new StringBuilder(nl);
// Let's give the user some feedback. The exception
// is probably related to incorrect schema configuration.
sb.append("Configured schema:").append(schema).append(nl);
sb.append("Configured catalog:").append(catalog ).append(nl);

try {
schemaRs = getMetaData().getSchemas();
sb.append("Available schemas:").append(nl);
while (schemaRs.next() ) {
sb.append(" ").append(schemaRs.getString("TABLE_SCHEM") ).append(nl);
}
}
catch (SQLException e2) {
log.warn("Could not get schemas", e2);
sb.append(" <SQLException while getting schemas>").append(nl);
}
finally {
try {
if (schemaRs != null) {
schemaRs.close();
}
}
catch (Exception ignore) {
}
}

try {
catalogRs = getMetaData().getCatalogs();
sb.append("Available catalogs:").append(nl);
while (catalogRs.next() ) {
sb.append(" ").append(catalogRs.getString("TABLE_CAT") ).append(nl);
}
}
catch (SQLException e2) {
log.warn("Could not get catalogs", e2);
sb.append(" <SQLException while getting catalogs>").append(nl);
}
finally {
try {
if (catalogRs != null) {
catalogRs.close();
}
}
catch (Exception ignore) {
}
}
return sb.toString();
}

protected Connection getConnection() throws SQLException {
if(connection==null) {
connection = connectionProvider.getConnection();
}
return connection;
}

public void close(Iterator<?> iterator) {
if(iterator instanceof ResultSetIterator) {
((ResultSetIterator)iterator).close();
}
}

public boolean needQuote(String name) {

if(name==null) return false;

// TODO: use jdbc metadata to decide on this. but for now we just handle the most typical cases.
if(name.indexOf('-')>0) return true;
if(name.indexOf(' ')>0) return true;
return name.indexOf( '.' ) > 0;
}

protected String caseForSearch(String value) throws SQLException {
// TODO: handle quoted requests (just strip it ?)
if(needQuote(value)) {
if ( getMetaData().storesMixedCaseQuotedIdentifiers() ) {
return value;
}
else if ( getMetaData().storesUpperCaseQuotedIdentifiers() ) {
return toUpperCase( value );
}
else if( getMetaData().storesLowerCaseQuotedIdentifiers() ) {
return toLowerCase( value );
}
else {
return value;
}
}
else if ( getMetaData().storesMixedCaseQuotedIdentifiers() ) {
return value;
}
else if ( getMetaData().storesUpperCaseIdentifiers() ) {
return toUpperCase( value );
}
else if( getMetaData().storesLowerCaseIdentifiers() ) {
return toLowerCase( value );
}
else {
return value;
}
}

private String toUpperCase(String str) {
return str==null ? null : str.toUpperCase();
}

private String toLowerCase(String str) {
return str == null ? null : str.toLowerCase(Locale.ENGLISH);
}

public Iterator<Map<String, Object>> getSuggestedPrimaryKeyStrategyName(String catalog, String schema, String table) {
Map<String, Object> m = new HashMap<>();
m.put( "TABLE_CAT", catalog );
m.put( "TABLE_SCHEMA", schema );
m.put( "TABLE_NAME", table );
m.put( "HIBERNATE_STRATEGY", null );
List<Map<String, Object>> l = new ArrayList<>();
l.add(m);
return l.iterator();
}
}
Loading