com.avaje.ebean.config.dbplatform

Class DbType

java.lang.Object

com.avaje.ebean.config.dbplatform.DbType

Direct Known Subclasses:

MySqlBlob, MySqlClob

public class DbType
extends Object

Represents a DB type with name, length, precision, and scale.

The length is for VARCHAR types and precision/scale for DECIMAL types.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HSTORE Type to map Map content to Postgres HSTORE.
static int	JSON Type to map JSON content to Clob or Postgres JSON type.
static int	JSONB Type to map JSON content to Clob or Postgres JSONB type.
static int	JSONBlob Type to map JSON content to Blob.
static int	JSONClob Type to map JSON content to Clob.
static int	JSONVarchar Type to map JSON content to VARCHAR.
static int	UUID DB native UUID type (H2 and Postgres).

Constructor Summary

Constructors

Constructor and Description
DbType(String name) Construct with no length or scale.
DbType(String name, boolean canHaveLength) Use with canHaveLength=false for types that should never have a length.
DbType(String name, int defaultLength) Construct with a given length.
DbType(String name, int defaultPrecision, int defaultScale) Construct for Decimal with precision and scale.

Method Summary

Modifier and Type	Method and Description
String	renderType(int deployLength, int deployScale) Return the type for a specific property that incorporates the name, length, precision and scale.
String	renderType(int deployLength, int deployScale, boolean strict) Render the type defining strict mode.
DbType	withLength(int defaultLength) Create a copy of the type with a new default length.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UUID

public static final int UUID

DB native UUID type (H2 and Postgres).

See Also:

Constant Field Values

HSTORE

public static final int HSTORE

Type to map Map content to Postgres HSTORE.

See Also:

Constant Field Values

JSON

public static final int JSON

Type to map JSON content to Clob or Postgres JSON type.

See Also:

Constant Field Values

JSONB

public static final int JSONB

Type to map JSON content to Clob or Postgres JSONB type.

See Also:

Constant Field Values

JSONVarchar

public static final int JSONVarchar

Type to map JSON content to VARCHAR.

See Also:

Constant Field Values

JSONClob

public static final int JSONClob

Type to map JSON content to Clob.

See Also:

Constant Field Values

JSONBlob

public static final int JSONBlob

Type to map JSON content to Blob.

See Also:

Constant Field Values

Constructor Detail

DbType

public DbType(String name)

Construct with no length or scale.

DbType

public DbType(String name,
              int defaultLength)

Construct with a given length.

DbType

public DbType(String name,
              int defaultPrecision,
              int defaultScale)

Construct for Decimal with precision and scale.

DbType

public DbType(String name,
              boolean canHaveLength)

Use with canHaveLength=false for types that should never have a length.

Parameters:

name - the type name

canHaveLength - set this to false for type that should never have a length

Method Detail

renderType

public String renderType(int deployLength,
                         int deployScale)

Return the type for a specific property that incorporates the name, length, precision and scale.

The deployLength and deployScale are for the property we are rendering the DB type for.

Parameters:

deployLength - the length or precision defined by deployment on a specific property.

deployScale - the scale defined by deployment on a specific property.

renderType

public String renderType(int deployLength,
                         int deployScale,
                         boolean strict)

Render the type defining strict mode.

If strict mode if OFF then this will render with a scale value even if that is not strictly supported. The reason for supporting this is to enable use to use types like jsonb(200) as a "logical" type that maps to JSONB for Postgres and VARCHAR(200) for other databases.

withLength

public DbType withLength(int defaultLength)

Create a copy of the type with a new default length.