Skip to content

Commit

Permalink
Issue #1922 - updates for old query builder to work with new tables
Browse files Browse the repository at this point in the history 
Signed-off-by: Mike Schroeder <mschroed@us.ibm.com>
  • Loading branch information
@michaelwschroeder
michaelwschroeder committed Jun 23, 2021
1 parent d5131be commit 1b06d61
Show file tree
Hide file tree
Showing 5 changed files with 264 additions and 12 deletions.
4 changes: 4 additions & 0 deletions fhir-persistence-jdbc/src/main/java/com/ibm/fhir/persistence/jdbc/dao/EraseResourceDAO.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -305,9 +305,13 @@ public void deleteFromAllParametersTables(String tablePrefix, long logicalResour
deleteFromParameterTable(tablePrefix + "_latlng_values", logicalResourceId);
deleteFromParameterTable(tablePrefix + "_resource_token_refs", logicalResourceId);
deleteFromParameterTable(tablePrefix + "_quantity_values", logicalResourceId);
deleteFromParameterTable(tablePrefix + "_profiles", logicalResourceId);
deleteFromParameterTable(tablePrefix + "_tags", logicalResourceId);
deleteFromParameterTable("str_values", logicalResourceId);
deleteFromParameterTable("date_values", logicalResourceId);
deleteFromParameterTable("resource_token_refs", logicalResourceId);
deleteFromParameterTable("logical_resource_profiles", logicalResourceId);
deleteFromParameterTable("logical_resource_tags", logicalResourceId);
LOG.exiting(CLASSNAME, method);
}

Expand Down
228 changes: 223 additions & 5 deletions fhir-persistence-jdbc/src/main/java/com/ibm/fhir/persistence/jdbc/util/JDBCQueryBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,23 @@
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.ESCAPE_UNDERSCORE;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.EXISTS;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.FROM;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.GTE;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.IN;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.IS_DELETED_NO;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.JOIN;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.LEFT_PAREN;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.LIKE;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.LOGICAL_ID;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.LOGICAL_RESOURCE_ID;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.LT;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.NOT;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.ON;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.OR;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.PARAMETER_NAME_ID;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.PARAMETER_TABLE_ALIAS;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.PARAMETER_TABLE_NAME_PLACEHOLDER;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.PARAM_NAME_PROFILE;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.PARAM_NAME_TAG;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.PERCENT_WILDCARD;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.RESOURCE_ID;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.RIGHT_PAREN;
Expand Down Expand Up @@ -71,6 +75,7 @@
import com.ibm.fhir.persistence.jdbc.dao.api.JDBCIdentityCache;
import com.ibm.fhir.persistence.jdbc.dao.api.ParameterDAO;
import com.ibm.fhir.persistence.jdbc.dao.api.ResourceDAO;
import com.ibm.fhir.persistence.jdbc.dao.impl.ResourceProfileRec;
import com.ibm.fhir.persistence.jdbc.exception.FHIRPersistenceDBConnectException;
import com.ibm.fhir.persistence.jdbc.exception.FHIRPersistenceDataAccessException;
import com.ibm.fhir.persistence.jdbc.util.type.DateParmBehaviorUtil;
Expand Down Expand Up @@ -399,7 +404,11 @@ protected SqlQueryData buildQueryParm(Class<?> resourceType, QueryParameter quer
databaseQueryParm = this.processDateParm(resourceType, queryParm, paramTableAlias);
break;
case TOKEN:
databaseQueryParm = this.processTokenParm(resourceType, queryParm, paramTableAlias, logicalRsrcTableAlias, endOfChain);
if (PARAM_NAME_TAG.equals(queryParm.getCode())) {
databaseQueryParm = this.processTagParm(resourceType, queryParm, paramTableAlias, logicalRsrcTableAlias, endOfChain);
} else {
databaseQueryParm = this.processTokenParm(resourceType, queryParm, paramTableAlias, logicalRsrcTableAlias, endOfChain);
}
break;
case NUMBER:
databaseQueryParm = this.processNumberParm(resourceType, queryParm, paramTableAlias);
Expand All @@ -408,7 +417,11 @@ protected SqlQueryData buildQueryParm(Class<?> resourceType, QueryParameter quer
databaseQueryParm = this.processQuantityParm(resourceType, queryParm, paramTableAlias);
break;
case URI:
databaseQueryParm = this.processUriParm(queryParm, paramTableAlias);
if (PARAM_NAME_PROFILE.equals(queryParm.getCode())) {
databaseQueryParm = this.processProfileParm(resourceType, queryParm, paramTableAlias);
} else {
databaseQueryParm = this.processUriParm(queryParm, paramTableAlias);
}
break;
case COMPOSITE:
databaseQueryParm = this.processCompositeParm(resourceType, queryParm, paramTableAlias, logicalRsrcTableAlias);
Expand Down Expand Up @@ -1607,9 +1620,16 @@ private SqlQueryData processMissingParm(Class<?> resourceType, QueryParameter qu
String valuesTable = !ModelSupport.isAbstract(resourceType) ? QuerySegmentAggregator.tableName(resourceType.getSimpleName(), queryParm) : PARAMETER_TABLE_NAME_PLACEHOLDER;
String subqueryTableAlias = endOfChain ? (paramTableAlias + "_param0") : paramTableAlias;
whereClauseSegment.append("(SELECT 1 FROM " + valuesTable + AS + subqueryTableAlias + WHERE);
this.populateNameIdSubSegment(whereClauseSegment, queryParm.getCode(), subqueryTableAlias);
whereClauseSegment.append(AND).append(subqueryTableAlias).append(".LOGICAL_RESOURCE_ID = ").append(logicalRsrcTableAlias).append(".LOGICAL_RESOURCE_ID"); // correlate the [NOT] EXISTS subquery
whereClauseSegment.append(RIGHT_PAREN).append(RIGHT_PAREN);
if (!PARAM_NAME_PROFILE.equals(queryParm.getCode()) && !PARAM_NAME_TAG.equals(queryParm.getCode())) {
this.populateNameIdSubSegment(whereClauseSegment, queryParm.getCode(), subqueryTableAlias);
whereClauseSegment.append(AND).append(subqueryTableAlias).append(".LOGICAL_RESOURCE_ID = ")
.append(logicalRsrcTableAlias).append(".LOGICAL_RESOURCE_ID"); // correlate the [NOT] EXISTS subquery
whereClauseSegment.append(RIGHT_PAREN);
} else {
whereClauseSegment.append(subqueryTableAlias).append(".LOGICAL_RESOURCE_ID = ")
.append(logicalRsrcTableAlias).append(".LOGICAL_RESOURCE_ID"); // correlate the [NOT] EXISTS subquery
}
whereClauseSegment.append(RIGHT_PAREN);
}

SqlQueryData queryData = new SqlQueryData(whereClauseSegment.toString(), bindVariables);
Expand Down Expand Up @@ -2074,4 +2094,202 @@ private void populateCodesSubSegment(StringBuilder whereClauseSegment, Modifier
log.exiting(CLASSNAME, METHODNAME);
}

private SqlQueryData processProfileParm(Class<?> resourceType, QueryParameter queryParm, String tableAlias)
throws FHIRPersistenceException {
final String METHODNAME = "processProfileParm";
log.entering(CLASSNAME, METHODNAME, queryParm.toString());

// Join to the canonical parameter table...which in this case means the xx_profiles table
// because currently _profile is the only search parameter to be defined as a canonical

StringBuilder whereClauseSegment = new StringBuilder();
boolean parmValueProcessed = false;
SqlQueryData queryData;
List<Object> bindVariables = new ArrayList<>();

whereClauseSegment.append(LEFT_PAREN);
for (QueryParameterValue value : queryParm.getValues()) {
// If multiple values are present, we need to OR them together.
if (parmValueProcessed) {
whereClauseSegment.append(OR);
}

// Reuse the same CanonicalSupport code used for param extraction to parse the search value
ResourceProfileRec rpc = CanonicalSupport.makeResourceProfileRec(-1, resourceType.getSimpleName(), -1, -1,
value.getValueString(), false);
int canonicalId = identityCache.getCanonicalId(rpc.getCanonicalValue());
whereClauseSegment.append(tableAlias).append(DOT).append("CANONICAL_ID").append(EQ).append(canonicalId);

// TODO double-check semantics of ABOVE and BELOW in this context
if (rpc.getVersion() != null && !rpc.getVersion().isEmpty()) {
whereClauseSegment.append(AND).append(tableAlias).append(DOT).append("VERSION");
if (queryParm.getModifier() == Modifier.ABOVE) {
whereClauseSegment.append(GTE);
} else if (queryParm.getModifier() == Modifier.BELOW) {
whereClauseSegment.append(LT);
} else {
whereClauseSegment.append(EQ);
}
whereClauseSegment.append(BIND_VAR);
bindVariables.add(rpc.getVersion());
}

if (rpc.getFragment() != null && !rpc.getFragment().isEmpty()) {
whereClauseSegment.append(AND).append(tableAlias).append(DOT).append("FRAGMENT").append(EQ).append(BIND_VAR);
bindVariables.add(rpc.getFragment());
}

parmValueProcessed = true;
}
whereClauseSegment.append(RIGHT_PAREN);

queryData = new SqlQueryData(whereClauseSegment.toString(), bindVariables);
log.exiting(CLASSNAME, METHODNAME);
return queryData;
}

private SqlQueryData processTagParm(Class<?> resourceType, QueryParameter queryParm, String paramTableAlias, String logicalRsrcTableAlias, boolean endOfChain) throws FHIRPersistenceException {
final String METHODNAME = "processTagParm";
log.entering(CLASSNAME, METHODNAME, queryParm.toString());

StringBuilder whereClauseSegment = new StringBuilder();
String operator = this.getOperator(queryParm, EQ);
boolean parmValueProcessed = false;
boolean appendEscape;
SqlQueryData queryData;
List<Object> bindVariables = new ArrayList<>();
String tableAlias = paramTableAlias;
String queryParmCode = queryParm.getCode();

if (!QuerySegmentAggregator.ID.equals(queryParmCode)) {

// Append the suffix for :text modifier
if (Modifier.TEXT.equals(queryParm.getModifier())) {
queryParmCode += SearchConstants.TEXT_MODIFIER_SUFFIX;
}

// Only generate NOT EXISTS subquery if :not modifier is within chained query;
// when :not modifier is within non-chained query QuerySegmentAggregator.buildWhereClause generates the NOT EXISTS subquery
boolean surroundWithNotExistsSubquery = Modifier.NOT.equals(queryParm.getModifier()) && endOfChain;
if (surroundWithNotExistsSubquery) {
whereClauseSegment.append(NOT).append(EXISTS);

// PARAMETER_TABLE_NAME_PLACEHOLDER is replaced by the actual table name for the resource type by QuerySegmentAggregator.buildWhereClause(...)
String valuesTable = !ModelSupport.isAbstract(resourceType) ? QuerySegmentAggregator.tableName(resourceType.getSimpleName(), queryParm) : PARAMETER_TABLE_NAME_PLACEHOLDER;
tableAlias = paramTableAlias + "_param0";
whereClauseSegment.append("(SELECT 1 FROM " + valuesTable + AS + tableAlias + WHERE);
}

whereClauseSegment.append(LEFT_PAREN);
for (QueryParameterValue value : queryParm.getValues()) {
appendEscape = false;

// If multiple values are present, we need to OR them together.
if (parmValueProcessed) {
whereClauseSegment.append(OR);
}

whereClauseSegment.append(LEFT_PAREN);

if (Modifier.IN.equals(queryParm.getModifier()) || Modifier.NOT_IN.equals(queryParm.getModifier()) ||
Modifier.ABOVE.equals(queryParm.getModifier()) || Modifier.BELOW.equals(queryParm.getModifier())) {
populateCodesSubSegment(whereClauseSegment, queryParm.getModifier(), value, tableAlias);
} else {
final String system = value.getValueSystem() != null && !value.getValueSystem().isEmpty() ? value.getValueSystem() : null;
final String code = value.getValueCode() != null ? value.getValueCode() : null; // empty code is a valid value

// Determine code normalization based on code system case-sensitivity
String normalizedCode = null;
if (code != null) {
if (system != null) {
boolean codeSystemIsCaseSensitive = CodeSystemSupport.isCaseSensitive(system);
normalizedCode = SqlParameterEncoder.encode(codeSystemIsCaseSensitive ?
code : SearchUtil.normalizeForSearch(code));
} else {
normalizedCode = SqlParameterEncoder.encode(SearchUtil.normalizeForSearch(code));
}
}

// Include code
if (EQ.equals(operator) && code != null) {
if (system == null || system.equals("*")) {
// Even though we don't have a system, we can still use a list of
// common_token_value_ids matching the value-code, allowing a similar optimization
Set<Long> ctvs = new HashSet<>();
ctvs.addAll(identityCache.getCommonTokenValueIdList(SqlParameterEncoder.encode(code)));
ctvs.addAll(identityCache.getCommonTokenValueIdList(SqlParameterEncoder.encode(SearchUtil.normalizeForSearch(code))));
List<Long> ctvList = new ArrayList<>(ctvs);
if (ctvs.isEmpty()) {
// use -1...resulting in no data
whereClauseSegment.append(tableAlias).append(DOT).append(COMMON_TOKEN_VALUE_ID).append(EQ)
.append(-1);
} else if (ctvs.size() == 1) {
whereClauseSegment.append(tableAlias).append(DOT).append(COMMON_TOKEN_VALUE_ID).append(EQ)
.append(ctvList.get(0));
} else {
whereClauseSegment.append(tableAlias).append(DOT).append(COMMON_TOKEN_VALUE_ID).append(IN)
.append(LEFT_PAREN)
.append(ctvList.stream().map(c -> c.toString()).collect(Collectors.joining(",")))
.append(RIGHT_PAREN);
}
} else {
Long commonTokenValueId = getCommonTokenValueId(system, normalizedCode);
whereClauseSegment.append(tableAlias).append(DOT).append(COMMON_TOKEN_VALUE_ID).append(EQ)
.append(commonTokenValueId != null ? commonTokenValueId : -1);
}
} else {
// Traditional approach, using a join to xx_TOKEN_VALUES_V

// Include code if present
if (code != null) {
whereClauseSegment.append(tableAlias).append(DOT).append(TOKEN_VALUE).append(operator).append(BIND_VAR);
if (LIKE.equals(operator)) {
// Must escape special wildcard characters _ and % in the parameter value string.
String textSearchString = normalizedCode
.replace(PERCENT_WILDCARD, ESCAPE_PERCENT)
.replace(UNDERSCORE_WILDCARD, ESCAPE_UNDERSCORE)
.replace("+", "++")+ PERCENT_WILDCARD;
bindVariables.add(SearchUtil.normalizeForSearch(textSearchString));
appendEscape = true;

} else {
bindVariables.add(normalizedCode);
}
}

// Include system if present
if (system != null) {
if (code != null) {
whereClauseSegment.append(AND);
}

// Filter on the code system for the given parameter
whereClauseSegment.append(tableAlias).append(DOT).append(CODE_SYSTEM_ID).append(EQ)
.append(nullCheck(identityCache.getCodeSystemId(system)));
}
}
}

// Build this piece: ESCAPE '+'
if (appendEscape) {
whereClauseSegment.append(ESCAPE_EXPR);
}

whereClauseSegment.append(RIGHT_PAREN);
parmValueProcessed = true;
}

whereClauseSegment.append(RIGHT_PAREN);

if (surroundWithNotExistsSubquery) {
whereClauseSegment.append(AND).append(tableAlias).append(".LOGICAL_RESOURCE_ID = ").append(logicalRsrcTableAlias).append(".LOGICAL_RESOURCE_ID");
whereClauseSegment.append(RIGHT_PAREN);
}
}
queryData = new SqlQueryData(whereClauseSegment.toString(), bindVariables);

log.exiting(CLASSNAME, METHODNAME);
return queryData;
}

}
10 changes: 10 additions & 0 deletions ...istence-jdbc/src/main/java/com/ibm/fhir/persistence/jdbc/util/QuerySegmentAggregator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.ON;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.PARAMETER_TABLE_ALIAS;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.PARAMETER_TABLE_NAME_PLACEHOLDER;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.PARAM_NAME_PROFILE;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.PARAM_NAME_TAG;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.RIGHT_PAREN;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.ROWS;
import static com.ibm.fhir.persistence.jdbc.JDBCConstants.ROWS_ONLY;
Expand Down Expand Up @@ -655,6 +657,12 @@ public static String tableName(String resourceType, QueryParameter param) {
StringBuilder name = new StringBuilder(resourceType);
switch (param.getType()) {
case URI:
if (PARAM_NAME_PROFILE.equals(param.getCode())) {
name.append("_PROFILES ");
} else {
name.append("_STR_VALUES ");
}
break;
case STRING:
case NUMBER:
case QUANTITY:
Expand All @@ -666,6 +674,8 @@ public static String tableName(String resourceType, QueryParameter param) {
case TOKEN:
if (param.isReverseChained()) {
name.append("_LOGICAL_RESOURCES");
} else if (PARAM_NAME_TAG.equals(param.getCode())) {
name.append("_TAGS ");
} else {
name.append("_TOKEN_VALUES_V "); // uses view to hide new issue #1366 schema
}
Expand Down
Loading

0 comments on commit 1b06d61

Please sign in to comment.