Module is.codion.framework.db.local
Package is.codion.framework.db.local
Interface LocalEntityConnectionProvider
-
- All Superinterfaces:
AutoCloseable
,EntityConnectionProvider
public interface LocalEntityConnectionProvider extends EntityConnectionProvider
A class responsible for managing a local EntityConnection.- See Also:
builder()
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
LocalEntityConnectionProvider.Builder
Builds aLocalEntityConnectionProvider
.
-
Field Summary
Fields Modifier and Type Field Description static PropertyValue<Boolean>
SHUTDOWN_EMBEDDED_DB_ON_DISCONNECT
Specifies whether an embedded database is shut down when disconnected from
Value type: Boolean
Default value: false-
Fields inherited from interface is.codion.framework.db.EntityConnectionProvider
CLIENT_CONNECTION_TYPE, CLIENT_DOMAIN_CLASS, CONNECTION_TYPE_HTTP, CONNECTION_TYPE_LOCAL, CONNECTION_TYPE_REMOTE
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static LocalEntityConnectionProvider.Builder
builder()
Instantiates a new builder instance.Database
database()
int
defaultQueryTimeout()
Domain
domain()
-
Methods inherited from interface is.codion.framework.db.EntityConnectionProvider
addOnConnectListener, clientId, clientTypeId, clientVersion, close, connection, connectionType, description, domainClassName, entities, isConnected, isConnectionValid, removeOnConnectListener, user
-
-
-
-
Field Detail
-
SHUTDOWN_EMBEDDED_DB_ON_DISCONNECT
static final PropertyValue<Boolean> SHUTDOWN_EMBEDDED_DB_ON_DISCONNECT
Specifies whether an embedded database is shut down when disconnected from
Value type: Boolean
Default value: false
-
-
Method Detail
-
domain
Domain domain()
- Returns:
- the underlying domain model
-
defaultQueryTimeout
int defaultQueryTimeout()
- Returns:
- the default query timeout being used
-
builder
static LocalEntityConnectionProvider.Builder builder()
Instantiates a new builder instance.- Returns:
- a new builder
- See Also:
EntityConnectionProvider.CLIENT_CONNECTION_TYPE
-
-