Package io.micronaut.data.connection.annotation

Annotation Interface Connectable

@Target({ANNOTATION_TYPE,METHOD,TYPE})
@Retention(RUNTIME)
@InterceptorBinding(kind=AROUND)
public @interface Connectable

The annotation is similar to "jakarta.transaction.Transactional", allowing to create a new data source connection.

Since:

4.0.0

Author:

Denis Stepanov

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	connectionManager	A qualifier name value for the connection manager.
ConnectionDefinition.Propagation	propagation	The connection propagation type.
boolean	readOnly	true if the connection is read-only.
int	timeout	The timeout for this connection (in seconds).
String	value	Alias for connectionManager().

Element Details

value

@AliasFor(member="connectionManager")
String value

Alias for connectionManager().

Returns:

The connection manager

See Also:

• connectionManager()

Default:

""

connectionManager

@AliasFor(member="value")
String connectionManager

A qualifier name value for the connection manager.

Returns:

The connection manager name

See Also:

• value()

Default:

""

propagation

ConnectionDefinition.Propagation propagation

The connection propagation type.

Defaults to ConnectionDefinition.Propagation.REQUIRED.

Returns:

The propagation

Default:

REQUIRED

timeout

int timeout

The timeout for this connection (in seconds).

Defaults to the default timeout of the underlying connection system.

Returns:

The timeout

Default:

-1

readOnly

boolean readOnly

true if the connection is read-only.

Defaults to false.

This just serves as a hint for the actual connection subsystem; it will not necessarily cause failure of write access attempts. A connection manager which cannot interpret the read-only hint will not throw an exception when asked for a read-only connection but rather silently ignore the hint.

Returns:

Whether is read-only connection

Default:

false