org.apache.shardingsphere.core.constant.properties

Enum ShardingPropertiesConstant

java.lang.Object

java.lang.Enum<ShardingPropertiesConstant>

org.apache.shardingsphere.core.constant.properties.ShardingPropertiesConstant

All Implemented Interfaces:

Serializable, Comparable<ShardingPropertiesConstant>

public enum ShardingPropertiesConstant
extends Enum<ShardingPropertiesConstant>

Sharding properties constant.

Author:

gaohongtao, caohao, cookie

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPTOR_SIZE Worker group or user group thread max size.
CHECK_TABLE_METADATA_ENABLED
EXECUTOR_SIZE Worker thread max size.
MAX_CONNECTIONS_SIZE_PER_QUERY Max opened connection size for each query.
PROXY_BACKEND_CONNECTION_TIMEOUT_SECONDS
PROXY_BACKEND_MAX_CONNECTIONS
PROXY_FRONTEND_FLUSH_THRESHOLD Sharding-Proxy's flush threshold for every records from databases.
PROXY_HINT_ENABLED Enable hint for Sharding-Proxy.
PROXY_OPENTRACING_ENABLED Enable opentracing for Sharding-Proxy.
PROXY_TRANSACTION_TYPE Transaction type of proxy.
QUERY_WITH_CIPHER_COLUMN When encrypt data, query with cipher column or not.
SQL_SHOW Enable or Disable to show SQL details.
SQL_SIMPLE Enable or Disable to show SQL details in simple style.

Method Summary

Modifier and Type	Method and Description
static ShardingPropertiesConstant	findByKey(String key) Find value via property key.
static ShardingPropertiesConstant	valueOf(String name) Returns the enum constant of this type with the specified name.
static ShardingPropertiesConstant[]	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

SQL_SHOW

public static final ShardingPropertiesConstant SQL_SHOW

Enable or Disable to show SQL details.

Print SQL details can help developers debug easier. The details includes: logic SQL, parse context and rewrote actual SQL list. Enable this property will log into log topic: ShardingSphere-SQL, log level is INFO. Default: false

SQL_SIMPLE

public static final ShardingPropertiesConstant SQL_SIMPLE

Enable or Disable to show SQL details in simple style.

In sharding mode, if this properties is true, log will display in simple style to avoid too much contents. Default: false

ACCEPTOR_SIZE

public static final ShardingPropertiesConstant ACCEPTOR_SIZE

Worker group or user group thread max size.

Worker group accept tcp connection. Command execute engine accept MySQL command. Default: CPU cores * 2.

EXECUTOR_SIZE

public static final ShardingPropertiesConstant EXECUTOR_SIZE

Worker thread max size.

Execute SQL Statement and PrepareStatement will use this thread pool. One sharding data source will use a independent thread pool, it does not share thread pool even different data source in same JVM. Default: infinite.

MAX_CONNECTIONS_SIZE_PER_QUERY

public static final ShardingPropertiesConstant MAX_CONNECTIONS_SIZE_PER_QUERY

Max opened connection size for each query.

QUERY_WITH_CIPHER_COLUMN

public static final ShardingPropertiesConstant QUERY_WITH_CIPHER_COLUMN

When encrypt data, query with cipher column or not.

PROXY_FRONTEND_FLUSH_THRESHOLD

public static final ShardingPropertiesConstant PROXY_FRONTEND_FLUSH_THRESHOLD

Sharding-Proxy's flush threshold for every records from databases.

PROXY_TRANSACTION_TYPE

public static final ShardingPropertiesConstant PROXY_TRANSACTION_TYPE

Transaction type of proxy.

LOCAL: Sharding-Proxy will run with LOCAL transaction.

XA: Sharding-Proxy will run with XA transaction.

BASE: Sharding-Proxy will run with BASE transaction.

PROXY_OPENTRACING_ENABLED

public static final ShardingPropertiesConstant PROXY_OPENTRACING_ENABLED

Enable opentracing for Sharding-Proxy.

PROXY_HINT_ENABLED

public static final ShardingPropertiesConstant PROXY_HINT_ENABLED

Enable hint for Sharding-Proxy.

PROXY_BACKEND_MAX_CONNECTIONS

public static final ShardingPropertiesConstant PROXY_BACKEND_MAX_CONNECTIONS

PROXY_BACKEND_CONNECTION_TIMEOUT_SECONDS

public static final ShardingPropertiesConstant PROXY_BACKEND_CONNECTION_TIMEOUT_SECONDS

CHECK_TABLE_METADATA_ENABLED

public static final ShardingPropertiesConstant CHECK_TABLE_METADATA_ENABLED

Method Detail

values

public static ShardingPropertiesConstant[] 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 (ShardingPropertiesConstant c : ShardingPropertiesConstant.values())
    System.out.println(c);

Returns:

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

valueOf

public static ShardingPropertiesConstant 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

findByKey

public static ShardingPropertiesConstant findByKey(String key)

Find value via property key.

Parameters:

key - property key

Returns:

value enum, return null if not found