Skip to content

Speedup database startup #70

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

Open
trbar wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Speedup database startup #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
324b0d9
add exclude-unlisted-classes to prevent scanning entire classpath on …
scope3aiadmin Dec 2, 2025
d6b6cb1
[feat]: add persistence.xml caching and preloading entity classes bef…
trbar Dec 3, 2025
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
158 changes: 158 additions & 0 deletions olca-core/src/main/java/org/openlca/core/database/DbUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,56 @@
package org.openlca.core.database;

import java.io.InputStream;

import org.openlca.core.model.Actor;
import org.openlca.core.model.AllocationFactor;
import org.openlca.core.model.AnalysisGroup;
import org.openlca.core.model.Category;
import org.openlca.core.model.Currency;
import org.openlca.core.model.Exchange;
import org.openlca.core.model.Flow;
import org.openlca.core.model.FlowProperty;
import org.openlca.core.model.FlowPropertyFactor;
import org.openlca.core.model.ImpactCategory;
import org.openlca.core.model.ImpactFactor;
import org.openlca.core.model.ImpactMethod;
import org.openlca.core.model.Location;
import org.openlca.core.model.NwSet;
import org.openlca.core.model.NwFactor;
import org.openlca.core.model.Parameter;
import org.openlca.core.model.ParameterRedef;
import org.openlca.core.model.ParameterRedefSet;
import org.openlca.core.model.Process;
import org.openlca.core.model.ProcessGroupSet;
import org.openlca.core.model.ProcessLink;
import org.openlca.core.model.ProductSystem;
import org.openlca.core.model.Project;
import org.openlca.core.model.ProjectVariant;
import org.openlca.core.model.SocialAspect;
import org.openlca.core.model.Source;
import org.openlca.core.model.Unit;
import org.openlca.core.model.UnitGroup;
import org.openlca.core.model.SocialIndicator;
import org.openlca.core.model.DQSystem;
import org.openlca.core.model.DQIndicator;
import org.openlca.core.model.DQScore;
import org.openlca.core.model.MappingFile;
import org.openlca.core.model.Result;
import org.openlca.core.model.FlowResult;
import org.openlca.core.model.ImpactResult;
import org.openlca.core.model.Epd;
import org.openlca.core.model.EpdModule;
import org.openlca.core.model.doc.ProcessDoc;
import org.openlca.core.model.doc.ComplianceDeclaration;
import org.openlca.core.model.doc.Review;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

class DbUtils {

private static final String PERSISTENCE_XML_PATH = "/META-INF/persistence.xml";
private static volatile byte[] cachedPersistenceXml;

private DbUtils() {
}

Expand All @@ -26,4 +72,116 @@ static int getVersion(IDatabase database) {
return -1;
}
}

/**
* Caches the persistence.xml resource to avoid repeated classpath scanning
* and resource resolution overhead. This warms up the classloader's resource
* cache, making subsequent reads by EclipseLink faster.
*/
static void cachePersistenceXml() {
Logger log = LoggerFactory.getLogger(DbUtils.class);
// Use double-checked locking pattern for thread-safe lazy initialization
if (cachedPersistenceXml != null) {
return; // Already cached
}
synchronized (DbUtils.class) {
if (cachedPersistenceXml != null) {
return; // Another thread cached it
}
log.trace("Caching persistence.xml resource");
try {
// Pre-read persistence.xml from classpath to warm up resource cache
InputStream stream = DbUtils.class.getResourceAsStream(PERSISTENCE_XML_PATH);
if (stream != null) {
try {
cachedPersistenceXml = stream.readAllBytes();
log.trace("Cached persistence.xml ({} bytes)", cachedPersistenceXml.length);
} finally {
stream.close();
}
} else {
log.warn("Could not find persistence.xml at {}", PERSISTENCE_XML_PATH);
}
} catch (Exception e) {
log.warn("Failed to cache persistence.xml", e);
// Don't throw - caching is an optimization, not required
}
}
}

/**
* Preloads all entity classes before EntityManagerFactory creation to reduce
* startup time. This helps avoid the expensive class loading and annotation
* processing that occurs during the initialization phase.
*/
static void preloadEntityClasses() {
Logger log = LoggerFactory.getLogger(DbUtils.class);
log.trace("Preloading entity classes");
try {
// Load all entity classes listed in persistence.xml
// This triggers class loading and annotation processing upfront
Class<?>[] entities = {
Actor.class,
AllocationFactor.class,
AnalysisGroup.class,
Category.class,
Currency.class,
Exchange.class,
Flow.class,
FlowProperty.class,
FlowPropertyFactor.class,
ImpactCategory.class,
ImpactFactor.class,
ImpactMethod.class,
Location.class,
NwSet.class,
NwFactor.class,
Parameter.class,
ParameterRedef.class,
ParameterRedefSet.class,
Process.class,
ProcessDoc.class,
ProcessGroupSet.class,
ProcessLink.class,
ProductSystem.class,
Project.class,
ProjectVariant.class,
SocialAspect.class,
Source.class,
Unit.class,
UnitGroup.class,
SocialIndicator.class,
DQSystem.class,
DQIndicator.class,
DQScore.class,
MappingFile.class,
Result.class,
FlowResult.class,
ImpactResult.class,
Epd.class,
EpdModule.class,
ComplianceDeclaration.class,
Review.class,
};

// Touch each class to trigger loading
for (Class<?> entity : entities) {
entity.getName(); // Trigger class loading
}
log.trace("Preloaded {} entity classes", entities.length);
} catch (Exception e) {
log.warn("Failed to preload some entity classes", e);
// Don't throw - preloading is an optimization, not required
}
}

/**
* Performs all pre-initialization optimizations before EntityManagerFactory
* creation. This includes caching persistence.xml and preloading entity classes.
* Should be called before createEntityManagerFactory() to reduce startup time.
*/
static void preInitialize() {
cachePersistenceXml();
preloadEntityClasses();
}
}
2 changes: 2 additions & 0 deletions olca-core/src/main/java/org/openlca/core/database/Derby.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,8 @@ public void setFileStorageLocation(File fileStorageLocation) {
private void connect() {

log.trace("connect to database: {}", url);
// Pre-initialize (cache persistence.xml and preload entity classes) to reduce startup time
DbUtils.preInitialize();
Map<Object, Object> map = new HashMap<>();
map.put("jakarta.persistence.jdbc.url", url);
map.put("jakarta.persistence.jdbc.driver", DRIVER);
Expand Down
3 changes: 3 additions & 0 deletions olca-core/src/main/java/org/openlca/core/database/MySQL.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ private MySQL(Config config) {
this.name = config.database;
var url = config.jdbcUrl();

// Pre-initialize (cache persistence.xml and preload entity classes) to reduce startup time
DbUtils.preInitialize();

// create the JPA persistence manager
var jpaConfig = new HashMap<>();
jpaConfig.put("jakarta.persistence.jdbc.url", url);
Expand Down
3 changes: 2 additions & 1 deletion olca-core/src/main/resources/META-INF/persistence.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@
<shared-cache-mode>ALL</shared-cache-mode>

<properties>
<property name="eclipselink.logging.level" value="WARNING" />
<property name="eclipselink.logging.level" value="FINE" />
<property name="eclipselink.logging.level.metamodel" value="FINE" />
<!-- enable SQL logging etc.
<property name="eclipselink.logging.level" value="ALL"/>
<property name="eclipselink.logging.level.sql" value="FINE"/>
Expand Down