github/ebean
4
0
Fork 0
mirror of https://github.com/ebean-orm/ebean.git synced 2024-04-21 10:51:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3264 from ebean-orm/feature/DatabaseBuilder_Settings

Browse Source 
Fix to return DataSourceBuilder.Settings for getDataSourceConfig() an…
This commit is contained in:
Rob Bygrave
2023-11-06 12:50:37 +13:00
committed by GitHub
parent bcf7bd17be a2551ce718
commit e794f5e916
8 changed files with 54 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ebean-api/src/main/java/io/ebean/DatabaseBuilder.java
+25 -2
View File
@@ -20,10 +20,16 @@ import jakarta.persistence.EnumType;
import javax.sql.DataSource;
import java.time.Clock;
import java.util.*;
import java.util.function.BooleanSupplier;
import java.util.function.Consumer;
import java.util.function.Function;
/**
* Build a Database instance.
* <p>
* Note that {@link #settings()} provides access to read the builder configuration
* (the getters). The DatabaseBuilder only has the methods to set builder configuration
* (the setters) so use {@link #settings()} to access to everything.
*
* <pre>{@code
*
@@ -64,6 +70,23 @@ public interface DatabaseBuilder {
*/
Settings settings();
/**
* Apply configuration to this builder using a lambda.
*/
DatabaseBuilder apply(Consumer<DatabaseBuilder.Settings> applyConfiguration);
/**
* Conditionally apply configuration to this builder via a lambda.
*
* @param predicate The condition to apply configuration when true.
* @param apply The configuration to apply to this builder.
*/
default DatabaseBuilder alsoIf(BooleanSupplier predicate, Consumer<DatabaseBuilder.Settings> apply) {
if (predicate.getAsBoolean()) {
apply(apply);
}
return this;
}
/**
* Set the name of the Database.
*/
@@ -2598,7 +2621,7 @@ public interface DatabaseBuilder {
* Return the configuration to build a DataSource using Ebean's own DataSource
* implementation.
*/
DataSourceBuilder getDataSourceConfig();
DataSourceBuilder.Settings getDataSourceConfig();
/**
* Return true if Ebean should create a DataSource for use with implicit read only transactions.
@@ -2614,7 +2637,7 @@ public interface DatabaseBuilder {
* set on this configuration. This means there is actually no need to set any configuration here and we only
* set configuration for url, username and password etc if it is different from the main DataSource.
*/
DataSourceBuilder getReadOnlyDataSourceConfig();
DataSourceBuilder.Settings getReadOnlyDataSourceConfig();
/**
* Return a value used to represent TRUE in the database.
ebean-api/src/main/java/io/ebean/config/DatabaseConfig.java
+15 -8
View File
@@ -27,6 +27,7 @@ import java.time.Clock;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.util.*;
import java.util.function.Consumer;
import java.util.function.Function;
/**
@@ -316,7 +317,7 @@ public class DatabaseConfig implements DatabaseBuilder.Settings {
/**
* The data source config.
*/
private DataSourceBuilder dataSourceConfig = DataSourceBuilder.create();
private DataSourceBuilder.Settings dataSourceConfig = DataSourceBuilder.create().settings();
/**
* When true create a read only DataSource using readOnlyDataSourceConfig defaulting values from dataSourceConfig.
@@ -329,7 +330,7 @@ public class DatabaseConfig implements DatabaseBuilder.Settings {
/**
* Optional configuration for a read only data source.
*/
private DataSourceBuilder readOnlyDataSourceConfig = DataSourceBuilder.create();
private DataSourceBuilder.Settings readOnlyDataSourceConfig = DataSourceBuilder.create().settings();
/**
* Optional - the database schema that should be used to own the tables etc.
@@ -560,6 +561,12 @@ public class DatabaseConfig implements DatabaseBuilder.Settings {
return this;
}
@Override
public DatabaseBuilder apply(Consumer<DatabaseBuilder.Settings> applyConfiguration) {
applyConfiguration.accept(this);
return this;
}
@Override
public Clock getClock() {
return clock;
@@ -1359,13 +1366,13 @@ public class DatabaseConfig implements DatabaseBuilder.Settings {
}
@Override
public DataSourceBuilder getDataSourceConfig() {
public DataSourceBuilder.Settings getDataSourceConfig() {
return dataSourceConfig;
}
@Override
public DatabaseConfig setDataSourceConfig(DataSourceBuilder dataSourceConfig) {
this.dataSourceConfig = dataSourceConfig;
this.dataSourceConfig = dataSourceConfig.settings();
return this;
}
@@ -1381,13 +1388,13 @@ public class DatabaseConfig implements DatabaseBuilder.Settings {
}
@Override
public DataSourceBuilder getReadOnlyDataSourceConfig() {
public DataSourceBuilder.Settings getReadOnlyDataSourceConfig() {
return readOnlyDataSourceConfig;
}
@Override
public DatabaseConfig setReadOnlyDataSourceConfig(DataSourceBuilder readOnlyDataSourceConfig) {
this.readOnlyDataSourceConfig = readOnlyDataSourceConfig;
public DatabaseConfig setReadOnlyDataSourceConfig(DataSourceBuilder readOnly) {
this.readOnlyDataSourceConfig = readOnly == null ? null : readOnly.settings();
return this;
}
@@ -2098,7 +2105,7 @@ public class DatabaseConfig implements DatabaseBuilder.Settings {
loadAutoTuneSettings(p);
if (dataSourceConfig == null) {
dataSourceConfig = DataSourceBuilder.create();
dataSourceConfig = DataSourceBuilder.create().settings();
}
loadDataSourceSettings(p);
ebean-core/src/main/java/io/ebeaninternal/server/core/DatabasePlatformFactory.java
+1 -1
View File
@@ -48,7 +48,7 @@ public class DatabasePlatformFactory {
// choose based on dbName
return byDatabaseName(config.getDatabasePlatformName());
}
if (config.getDataSourceConfig().settings().isOffline()) {
if (config.getDataSourceConfig().isOffline()) {
throw new PersistenceException("DatabasePlatformName must be specified with offline mode");
}
// guess using meta data from driver
ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultContainer.java
+1 -1
View File
@@ -243,7 +243,7 @@ public final class DefaultContainer implements SpiContainer {
return false;
}
if (config.getDataSource() == null) {
if (config.getDataSourceConfig().settings().isOffline()) {
if (config.getDataSourceConfig().isOffline()) {
// this is ok - offline DDL generation etc
return false;
}
ebean-core/src/main/java/io/ebeaninternal/server/core/InitDataSource.java
+8 -10
View File
@@ -49,18 +49,17 @@ final class InitDataSource {
return roConfig == null ? null : createFromConfig(roConfig, true);
}
DataSourceBuilder readOnlyConfig() {
DataSourceBuilder.Settings readOnlyConfig() {
var roConfig = config.getReadOnlyDataSourceConfig();
if (roConfig == null) {
// it has explicitly been set to null, not expected but ok
return null;
}
var roSettings = roConfig.settings();
if (urlSet(roSettings.getUrl())) {
if (urlSet(roConfig.getUrl())) {
return roConfig;
}
// convenient alternate place to set the read-only url
final String readOnlyUrl = config.getDataSourceConfig().settings().getReadOnlyUrl();
final String readOnlyUrl = config.getDataSourceConfig().getReadOnlyUrl();
if (urlSet(readOnlyUrl)) {
roConfig.url(readOnlyUrl);
return roConfig;
@@ -77,23 +76,22 @@ final class InitDataSource {
return url != null && !"none".equalsIgnoreCase(url) && !url.trim().isEmpty();
}
private DataSource createFromConfig(DataSourceBuilder dsConfig, boolean readOnly) {
private DataSource createFromConfig(DataSourceBuilder.Settings dsConfig, boolean readOnly) {
if (dsConfig == null) {
throw new PersistenceException("No DataSourceBuilder defined for " + config.getName());
}
var dsSettings = dsConfig.settings();
if (dsSettings.isOffline()) {
if (dsConfig.isOffline()) {
if (config.getDatabasePlatformName() == null) {
throw new PersistenceException("You MUST specify a DatabasePlatformName on DatabaseConfig when offline");
}
}
attachAlert(dsSettings);
attachListener(dsSettings);
attachAlert(dsConfig);
attachListener(dsConfig);
if (readOnly) {
// setup to use AutoCommit such that we skip explicit commit
var mainSettings = config.getDataSourceConfig().settings();
var mainSettings = config.getDataSourceConfig();
dsConfig.autoCommit(true);
dsConfig.readOnly(true);
dsConfig.setDefaults(mainSettings);
ebean-core/src/test/java/io/ebeaninternal/server/core/InitDataSourceTest.java
+1 -1
View File
@@ -127,7 +127,7 @@ public class InitDataSourceTest {
@Test
public void readOnlyConfig_when_urlSet_2() {
DatabaseConfig config = new DatabaseConfig();
config.settings().getReadOnlyDataSourceConfig().url("foo");
config.getReadOnlyDataSourceConfig().url("foo");
final DataSourceBuilder roConfig = new InitDataSource(config).readOnlyConfig();
assertNotNull(roConfig);
ebean-test/src/main/java/io/ebean/test/config/AutoConfigureForTesting.java
+2 -2
View File
@@ -71,11 +71,11 @@ public class AutoConfigureForTesting implements AutoConfigure {
}
}
private void makeV1Compatible(DataSourceBuilder ds) {
private void makeV1Compatible(DataSourceBuilder.Settings ds) {
if (ds == null) {
return;
}
String url = ds.settings().getUrl();
String url = ds.getUrl();
if (url == null || !url.startsWith("jdbc:h2:")) {
return;
}
pom.xml
+1 -1
View File
@@ -52,7 +52,7 @@
<ebean-migration-auto.version>1.2</ebean-migration-auto.version>
<ebean-migration.version>13.11.1</ebean-migration.version>
<ebean-test-containers.version>7.1</ebean-test-containers.version>
<ebean-datasource.version>8.8</ebean-datasource.version>
<ebean-datasource.version>8.9</ebean-datasource.version>
<ebean-agent.version>13.24.0</ebean-agent.version>
<ebean-maven-plugin.version>13.24.0</ebean-maven-plugin.version>
<surefire.useModulePath>false</surefire.useModulePath>