Interface JpaPersistenceUnitConfig

All Superinterfaces:

Prototype.Api, SqlConfig

All Known Implementing Classes:

JpaPersistenceUnitConfig.BuilderBase.JpaPersistenceUnitConfigImpl

public interface JpaPersistenceUnitConfig
extends Prototype.Api, SqlConfig

Configuration of Helidon Data for Jakarta Persistence.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JpaPersistenceUnitConfig.Builder	Fluent API builder for JpaPersistenceUnitConfig.
static class	JpaPersistenceUnitConfig.BuilderBase<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig>	Fluent API builder base for JpaPersistenceUnitConfig.

Method Summary

Modifier and Type	Method	Description
static JpaPersistenceUnitConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static JpaPersistenceUnitConfig.Builder	builder(JpaPersistenceUnitConfig instance)	Create a new fluent API builder from an existing instance.
static JpaPersistenceUnitConfig	create()	Create a new instance with default values.
static JpaPersistenceUnitConfig	create(Config config)	Create a new instance from configuration.
Optional<Path>	dropScript()	Path to database cleanup script on classpath.
Optional<Path>	initScript()	Path to database initialization script on classpath.
Set<Class>	managedClasses()	Managed persistence entities.
String	name()	Name of this persistence unit.
Map<String,String>	properties()	Additional persistence unit or connection properties.
Optional<String>	providerClassName()	Persistence provider class name.

Methods inherited from interface SqlConfig

connection, dataSource, dataSourceName

Modifier and Type	Method	Description
Optional<ConnectionConfig>	connection()	Direct JDBC connection properties.
default Optional<DataSource>	dataSource()	Existing DataSource owned by the application.
Optional<String>	dataSourceName()	Name of the registered DataSource to use.

Method Details

builder

static JpaPersistenceUnitConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static JpaPersistenceUnitConfig.Builder builder(JpaPersistenceUnitConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static JpaPersistenceUnitConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static JpaPersistenceUnitConfig create()

Create a new instance with default values.

Returns:

a new instance

name

String name()

Name of this persistence unit.

Returns:

the persistence unit name

providerClassName

Optional<String> providerClassName()

Persistence provider class name. Implementation of jakarta.persistence.spi.PersistenceProvider, e.g. org.eclipse.persistence.jpa.PersistenceProvider Allows proper persistence provider selection when multiple providers are available.

Returns:

fully qualified name of the persistence provider class

initScript

Optional<Path> initScript()

Path to database initialization script on classpath.

Returns:

database initialization script path

dropScript

Optional<Path> dropScript()

Path to database cleanup script on classpath.

Returns:

database cleanup script path

properties

Map<String,String> properties()

Additional persistence unit or connection properties.

Returns:

the properties

managedClasses

Set<Class> managedClasses()

Managed persistence entities.

Returns:

the entities list