[DO NOT MERGE] Partitioned ID Mode

hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/param/HistorySearchDateRangeParam.java

@@ -22,6 +22,18 @@
 import java.util.Map;
 
 public class HistorySearchDateRangeParam extends DateRangeParam {
+	/**
+	 * Constructor
+	 *
+	 * @since 8.0.0
+	 */
+	public HistorySearchDateRangeParam() {
+		this(Map.of(), new DateRangeParam(), null);
+	}
+
+	/**
+	 * Constructor
+	 */
 	public HistorySearchDateRangeParam(
 			Map<String, String[]> theParameters, DateRangeParam theDateRange, Integer theOffset) {
 		super(theDateRange);

hapi-fhir-base/src/main/java/ca/uhn/fhir/util/FileUtil.java

@@ -19,6 +19,13 @@
  */
 package ca.uhn.fhir.util;
 
+import ca.uhn.fhir.rest.server.exceptions.InternalErrorException;
+import org.apache.commons.io.IOUtils;
+
+import java.io.File;
+import java.io.FileReader;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 import java.text.DecimalFormat;
 
 public class FileUtil {
@@ -33,4 +40,17 @@ public static String formatFileSize(long theBytes) {
 		digitGroups = Math.min(digitGroups, UNITS.length - 1);
 		return new DecimalFormat("###0.#").format(theBytes / Math.pow(1024, digitGroups)) + " " + UNITS[digitGroups];
 	}
+
+	/**
+	 * Loads the contents of a File as a UTF-8 encoded string, and wraps any exceptions in an unchecked exception
+	 *
+	 * @throws InternalErrorException If any IOException occurs
+	 */
+	public static String loadFileAsString(File theFile) throws InternalErrorException {
+		try (FileReader fr = new FileReader(theFile, StandardCharsets.UTF_8)) {
+			return IOUtils.toString(fr);
+		} catch (IOException e) {
+			throw new InternalErrorException(e);
+		}
+	}
 }

hapi-fhir-cli/hapi-fhir-cli-api/src/test/java/ca/uhn/fhir/cli/ReindexTerminologyCommandTest.java

@@ -2,12 +2,14 @@
 
 import ca.uhn.fhir.context.FhirContext;
 import ca.uhn.fhir.jpa.provider.BaseJpaSystemProvider;
+import ca.uhn.fhir.rest.server.exceptions.InternalErrorException;
 import ca.uhn.fhir.system.HapiSystemProperties;
 import ca.uhn.fhir.test.utilities.RestServerR4Helper;
 import ca.uhn.fhir.test.utilities.TlsAuthenticationTestHelper;
 import ca.uhn.fhir.util.ParametersUtil;
 import ca.uhn.test.util.LogbackTestExtension;
 import ca.uhn.test.util.LogbackTestExtensionAssert;
+import ch.qos.logback.classic.Level;
 import ch.qos.logback.classic.Logger;
 import org.hl7.fhir.instance.model.api.IBaseParameters;
 import org.junit.jupiter.api.BeforeEach;
@@ -40,9 +42,8 @@ class ReindexTerminologyCommandTest {
 	public final RestServerR4Helper myRestServerR4Helper = RestServerR4Helper.newInitialized();
 	@RegisterExtension
 	public TlsAuthenticationTestHelper myTlsAuthenticationTestHelper = new TlsAuthenticationTestHelper();
-
-	// Deliberately not registered - we manually run this later because App startup resets the logging.
-	LogbackTestExtension myAppLogCapture;
+	@RegisterExtension
+	public LogbackTestExtension myLogbackTestExtension = new LogbackTestExtension(BaseApp.ourLog);
 
 	static {
 		HapiSystemProperties.enableTestMode();
@@ -69,7 +70,7 @@ public void testProviderMethodInvoked(boolean theIncludeTls) {
 		);
 		runAppWithStartupHook(args, getLoggingStartupHook());
 
-		LogbackTestExtensionAssert.assertThat(myAppLogCapture).doesNotHaveMessage(FAILURE_MESSAGE);
+		LogbackTestExtensionAssert.assertThat(myLogbackTestExtension).doesNotHaveMessage(FAILURE_MESSAGE);
 	}
 
 	@ParameterizedTest
@@ -131,7 +132,7 @@ public void testHandleUnexpectedResponse(boolean theIncludeTls) {
 		);
 		runAppWithStartupHook(args, getLoggingStartupHook());
 
-		LogbackTestExtensionAssert.assertThat(myAppLogCapture)
+		LogbackTestExtensionAssert.assertThat(myLogbackTestExtension)
 			.hasMessage(FAILURE_MESSAGE)
 			.hasMessage("Internal error. Command result unknown. Check system logs for details");
 	}
@@ -156,7 +157,7 @@ public void testHandleServiceError(boolean theIncludeTls) {
 		);
 		runAppWithStartupHook(args, getLoggingStartupHook());
 
-		LogbackTestExtensionAssert.assertThat(myAppLogCapture)
+		LogbackTestExtensionAssert.assertThat(myLogbackTestExtension)
 			.hasMessage(FAILURE_MESSAGE)
 			.hasMessage("Freetext service is not configured. Operation didn't run.");
 	}
@@ -176,8 +177,11 @@ static void runAppWithStartupHook(String[] args, Consumer<BaseApp> startupHook)
 	 */
 	Consumer<BaseApp> getLoggingStartupHook() {
 		return (unused) -> {
-			myAppLogCapture = new LogbackTestExtension((Logger) BaseApp.ourLog);
-			myAppLogCapture.setUp();
+			try {
+				myLogbackTestExtension.reRegister();
+			} catch (Exception e) {
+				throw new InternalErrorException(e);
+			}
 		};
 	}
 }

hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/files.properties

@@ -82,6 +82,7 @@ page.server_jpa_partitioning.partitioning=Partitioning and Multitenancy
 page.server_jpa_partitioning.partition_interceptor_examples=Partition Interceptor Examples
 page.server_jpa_partitioning.partitioning_management_operations=Partitioning Management Operations
 page.server_jpa_partitioning.enabling_in_hapi_fhir=Enabling Partitioning in HAPI FHIR
+page.server_jpa.partitioning.partitioned_id_mode=Partitioned ID Mode
 
 section.server_jpa_batch.title=JPA Server: Batch Processing
 page.server_jpa_batch.introduction=Batch Introduction

hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/server_jpa_partitioning/partitioned_id_mode.md

@@ -0,0 +1,20 @@
+# Partitioned ID Mode Introduction --EXPERIMENTAL--
+
+HAPI FHIR 5.0.0 introduced partitioning to the JPA server. In the current partitioning design, each resource-specific table (i.e. each table in the database schema where each row pertains to a single FHIR resource) has two new columns: `PARTITION_ID`, and `PARTITION_DATE`.
+
+The `PARTITION_DATE` column may be set by user code, but it otherwise untouched by HAPI FHIR. The `PARTITION_ID` column is the main partitioning mechanism. It uses an arbitrary Integer value to demote the partition associated with an individual resource.
+
+### Limitations of the Original Design
+
+The Partition ID was added as a column to the end of many of the default HAPI FHIR database indexes, meaning that searches could take advantage of partition IDs if they were present, but would also perform well if partitioning was not being used. 
+
+The original partitioning design also introduced the concept of the _Default Partition_, which is a partition used to store infrastructure resources that are not inherently partitionable. The ID fot eh default partition is configurable, but is set by default to _NULL_.
+
+Although this new partitioning mode unlocked a number of great use cases for HAPI FHIR users (including multitenancy, better scalability, data segmentation, etc.) several fundamental limitations in the design have become apparent over time:
+
+* The Partition ID is not actually a part of the row identities (ie. the Primary Key and Foreign Key )
+
+# Partitioned ID Mode
+
+The HAPI FHIR 8.0.0 JPA server introduces a new experimental mode called Partitioned ID Mode.
+

hapi-fhir-jpa-hibernate-services/pom.xml

@@ -0,0 +1,40 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+			xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>ca.uhn.hapi.fhir</groupId>
+		<artifactId>hapi-fhir</artifactId>
+		<version>7.7.0-SNAPSHOT</version>
+	</parent>
+
+	<artifactId>hapi-fhir-jpa-hibernate-services</artifactId>
+
+	<packaging>jar</packaging>
+
+	<name>HAPI FHIR JPA Hibernate Services</name>
+
+
+	<dependencies>
+		<dependency>
+			<groupId>ca.uhn.hapi.fhir</groupId>
+			<artifactId>hapi-fhir-base</artifactId>
+			<version>${project.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>org.slf4j</groupId>
+			<artifactId>slf4j-api</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.hibernate.orm</groupId>
+			<artifactId>hibernate-core</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>com.google.guava</groupId>
+			<artifactId>guava</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>jakarta.annotation</groupId>
+			<artifactId>jakarta.annotation-api</artifactId>
+		</dependency>
+	</dependencies>
+</project>

hapi-fhir-jpa-hibernate-services/src/main/java/ca/uhn/hapi/fhir/sql/hibernatesvc/HapiHibernateDialectSettingsService.java

@@ -0,0 +1,19 @@
+package ca.uhn.hapi.fhir.sql.hibernatesvc;
+
+import org.hibernate.service.Service;
+
+/**
+ * A hibernate {@link Service} which provides the HAPI FHIR Storage Settings.
+ */
+public class HapiHibernateDialectSettingsService implements Service {
+
+	private boolean myTrimConditionalIdsFromPrimaryKeys;
+
+	public boolean isTrimConditionalIdsFromPrimaryKeys() {
+		return myTrimConditionalIdsFromPrimaryKeys;
+	}
+
+	public void setTrimConditionalIdsFromPrimaryKeys(boolean theTrimConditionalIdsFromPrimaryKeys) {
+		myTrimConditionalIdsFromPrimaryKeys = theTrimConditionalIdsFromPrimaryKeys;
+	}
+}