Skip to content

Commit

Permalink
apacheGH-38737: [Java] Fix JDBC caching of SqlInfo values (apache#38739)
Browse files Browse the repository at this point in the history
### Rationale for this change
The cache of SqlInfo properties that ArrowDatabaseMetaData maintains isn't populated in a thread-safe way. This can cause JDBC applications trying to retrieve several properties from DatabaseMetaData to encounter missing properties when they shouldn't.

### What changes are included in this PR?
- Changed the checking for the cache being populated to be based on an AtomicBoolean marking that the cache is fully populated, rather than just checking if the cache is empty.
- Avoid having multiple threads call getSqlInfo() if they see that the cache is empty concurrently.

### Are these changes tested?
Verified existing unit tests.

### Are there any user-facing changes?
No.
* Closes: apache#38737

Authored-by: James Duong <[email protected]>
Signed-off-by: David Li <[email protected]>
  • Loading branch information
jduo authored Nov 16, 2023
1 parent 3e0ca5b commit 5583dbe
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Arrays;
import java.util.Collections;
import java.util.EnumMap;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

Expand Down Expand Up @@ -145,8 +145,8 @@ public class ArrowDatabaseMetadata extends AvaticaDatabaseMetaData {
Field.notNullable("IS_AUTOINCREMENT", Types.MinorType.VARCHAR.getType()),
Field.notNullable("IS_GENERATEDCOLUMN", Types.MinorType.VARCHAR.getType())
));
private final Map<SqlInfo, Object> cachedSqlInfo =
Collections.synchronizedMap(new EnumMap<>(SqlInfo.class));
private final AtomicBoolean isCachePopulated = new AtomicBoolean(false);
private final Map<SqlInfo, Object> cachedSqlInfo = new EnumMap<>(SqlInfo.class);
private static final Map<Integer, Integer> sqlTypesToFlightEnumConvertTypes = new HashMap<>();

static {
Expand Down Expand Up @@ -729,10 +729,15 @@ private <T> T getSqlInfoAndCacheIfCacheIsEmpty(final SqlInfo sqlInfoCommand,
final Class<T> desiredType)
throws SQLException {
final ArrowFlightConnection connection = getConnection();
if (cachedSqlInfo.isEmpty()) {
final FlightInfo sqlInfo = connection.getClientHandler().getSqlInfo();
if (!isCachePopulated.get()) {
// Lock-and-populate the cache. Only issue the call to getSqlInfo() once,
// populate the cache, then mark it as populated.
// Note that multiple callers from separate threads can see that the cache is not populated, but only
// one thread will try to populate the cache. Other threads will see the cache is non-empty when acquiring
// the lock on the cache and skip population.
synchronized (cachedSqlInfo) {
if (cachedSqlInfo.isEmpty()) {
final FlightInfo sqlInfo = connection.getClientHandler().getSqlInfo();
try (final ResultSet resultSet =
ArrowFlightJdbcFlightStreamResultSet.fromFlightInfo(
connection, sqlInfo, null)) {
Expand All @@ -741,6 +746,7 @@ private <T> T getSqlInfoAndCacheIfCacheIsEmpty(final SqlInfo sqlInfoCommand,
resultSet.getObject("value"));
}
}
isCachePopulated.set(true);
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ public final class MockFlightSqlProducer implements FlightSqlProducer {

private final Map<String, Integer> actionTypeCounter = new HashMap<>();

private static FlightInfo getFightInfoExportedAndImportedKeys(final Message message,
final FlightDescriptor descriptor) {
private static FlightInfo getFlightInfoExportedAndImportedKeys(final Message message,
final FlightDescriptor descriptor) {
return getFlightInfo(message, Schemas.GET_IMPORTED_KEYS_SCHEMA, descriptor);
}

Expand Down Expand Up @@ -529,22 +529,22 @@ public void getStreamPrimaryKeys(final CommandGetPrimaryKeys commandGetPrimaryKe
public FlightInfo getFlightInfoExportedKeys(final CommandGetExportedKeys commandGetExportedKeys,
final CallContext callContext,
final FlightDescriptor flightDescriptor) {
return getFightInfoExportedAndImportedKeys(commandGetExportedKeys, flightDescriptor);
return getFlightInfoExportedAndImportedKeys(commandGetExportedKeys, flightDescriptor);
}

@Override
public FlightInfo getFlightInfoImportedKeys(final CommandGetImportedKeys commandGetImportedKeys,
final CallContext callContext,
final FlightDescriptor flightDescriptor) {
return getFightInfoExportedAndImportedKeys(commandGetImportedKeys, flightDescriptor);
return getFlightInfoExportedAndImportedKeys(commandGetImportedKeys, flightDescriptor);
}

@Override
public FlightInfo getFlightInfoCrossReference(
final CommandGetCrossReference commandGetCrossReference,
final CallContext callContext,
final FlightDescriptor flightDescriptor) {
return getFightInfoExportedAndImportedKeys(commandGetCrossReference, flightDescriptor);
return getFlightInfoExportedAndImportedKeys(commandGetCrossReference, flightDescriptor);
}

@Override
Expand Down

0 comments on commit 5583dbe

Please sign in to comment.