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 a LocalEntityConnectionProvider.

Field Summary

Fields inherited from interface is.codion.framework.db.EntityConnectionProvider

CLIENT_CONNECTION_TYPE, CLIENT_DOMAIN_TYPE, CONNECTION_TYPE_HTTP, CONNECTION_TYPE_LOCAL, CONNECTION_TYPE_REMOTE

Method Summary

Modifier and Type	Method	Description
static LocalEntityConnectionProvider.Builder	builder()	Instantiates a new builder instance.
LocalEntityConnection	connection()	Provides a EntityConnection object, is responsible for returning a healthy EntityConnection object, that is, it must reconnect an invalid connection whether remotely or locally
Database	database()
int	defaultQueryTimeout()
Domain	domain()

Methods inherited from interface is.codion.framework.db.EntityConnectionProvider

clientId, clientType, clientVersion, close, connected, connectionType, connectionValid, description, domainType, entities, user

Method Details

domain

Domain domain()

Returns:

the underlying domain model

database

Database database()

Returns:

the underlying Database instance

connection

LocalEntityConnection connection()

Description copied from interface: EntityConnectionProvider

Provides a EntityConnection object, is responsible for returning a healthy EntityConnection object, that is, it must reconnect an invalid connection whether remotely or locally

Specified by:

connection in interface EntityConnectionProvider

Returns:

a EntityConnection instance

defaultQueryTimeout

int defaultQueryTimeout()

Returns:

the default query timeout being used

builder

static LocalEntityConnectionProvider.Builder builder()

Instantiates a new builder instance.

Returns:

a new builder