sirius.db.jdbc

Enum Capability

java.lang.Object

java.lang.Enum<Capability>

sirius.db.jdbc.Capability

All Implemented Interfaces:

Serializable, Comparable<Capability>

public enum Capability
extends Enum<Capability>

Encapsulates functions or features which are not supported by all databases.

The capabilities of the connected db can be determined by calling Database.hasCapability(Capability). The capabilities are determined by checking the driver name.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GENERATED_KEYS
LIMIT Determines if the connected database support the LIMIT clause in SQL queries
LOWER_CASE_TABLE_NAMES Determines if the database potentially lowercases table names like MySQL commonly does.
STREAMING Signals that a streaming result is only created if the FETCH_SIZE is set to Integer.MIN_VALUE.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<Capability>	CLICKHOUSE_CAPABILITIES Contains the capabilities of a Clickhouse database
static Set<Capability>	MYSQL_CAPABILITIES Contains the capabilities of a MySQL database
static Set<Capability>	POSTGRES_CAPABILITIES Contains the capabilities of a Postgres database

Method Summary

Modifier and Type	Method and Description
static Capability	valueOf(String name) Returns the enum constant of this type with the specified name.
static Capability[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STREAMING

public static final Capability STREAMING

Signals that a streaming result is only created if the FETCH_SIZE is set to Integer.MIN_VALUE. This is more or less a MySQL specific behaviour as other drivers honor the "FETCH_SIZE" hint which MySQL doesn't.

LIMIT

public static final Capability LIMIT

Determines if the connected database support the LIMIT clause in SQL queries

LOWER_CASE_TABLE_NAMES

public static final Capability LOWER_CASE_TABLE_NAMES

Determines if the database potentially lowercases table names like MySQL commonly does. In this case the best bet is to only use lower cased table names in the first place to avoid a lot of trouble.

GENERATED_KEYS

public static final Capability GENERATED_KEYS

Field Detail

MYSQL_CAPABILITIES

public static final Set<Capability> MYSQL_CAPABILITIES

Contains the capabilities of a MySQL database

POSTGRES_CAPABILITIES

public static final Set<Capability> POSTGRES_CAPABILITIES

Contains the capabilities of a Postgres database

CLICKHOUSE_CAPABILITIES

public static final Set<Capability> CLICKHOUSE_CAPABILITIES

Contains the capabilities of a Clickhouse database

Method Detail

values

public static Capability[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Capability c : Capability.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Capability valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null