Package io.micronaut.data.annotation

Annotation Interface EntityRepresentation

@Retention(RUNTIME)
@Target({TYPE,METHOD})
@Documented
@Inherited
public @interface EntityRepresentation

Defines entity representation for database operations. Is type is TABULAR it means default entity representation and COLUMN will mean result will contain single column with the value of given type.

Since:

4.0.0

Author:

radovanradic

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EntityRepresentation.ColumnType	The column type.
static enum	EntityRepresentation.Type	Supported entity representation types.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
EntityRepresentation.Type	type

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	column
EntityRepresentation.ColumnType	columnType
JsonDataType	jsonDataType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_COLUMN	The default column name for the JSON data.

Field Details

DEFAULT_COLUMN

static final String DEFAULT_COLUMN

The default column name for the JSON data.

See Also:

• Constant Field Values

Element Details

type

EntityRepresentation.Type type

Returns:

The query result type

columnType

EntityRepresentation.ColumnType columnType

Returns:

the column type if type is EntityRepresentation.Type.COLUMN

Default:

JSON

column

String column

Returns:

The column containing result if type is EntityRepresentation.Type.COLUMN

Default:

"DATA"

jsonDataType

JsonDataType jsonDataType

Returns:

The JSON data type that resulting column will hold if type is EntityRepresentation.Type.COLUMN and columnType is EntityRepresentation.ColumnType.JSON. It helps to pick proper column reader based on result data type

Default:

DEFAULT