ConfigurationPropertyKey (shardingsphere-infra-common 5.1.1 API)

java.lang.Object
- java.lang.Enum<ConfigurationPropertyKey>
- - org.apache.shardingsphere.infra.config.props.ConfigurationPropertyKey

All Implemented Interfaces:

Serializable, Comparable<ConfigurationPropertyKey>, TypedPropertyKey
```
public enum ConfigurationPropertyKey
extends Enum<ConfigurationPropertyKey>
implements TypedPropertyKey
```
Typed property key of configuration.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CHECK_DUPLICATE_TABLE_ENABLED` Whether check duplicate table.
`CHECK_TABLE_METADATA_ENABLED` Whether validate table meta data consistency when application startup or updated.
`KERNEL_EXECUTOR_SIZE` The max thread size of worker group to execute SQL.
`LOCK_WAIT_TIMEOUT_MILLISECONDS` The length of time in milliseconds an SQL waits for a global lock before giving up.
`MAX_CONNECTIONS_SIZE_PER_QUERY` Max opened connection size for each query.
`PROXY_BACKEND_DRIVER_TYPE` Proxy backend driver type.
`PROXY_BACKEND_EXECUTOR_SUITABLE` Available options of proxy backend executor suitable: OLAP(default), OLTP.
`PROXY_BACKEND_QUERY_FETCH_SIZE` Proxy backend query fetch size.
`PROXY_FRONTEND_DATABASE_PROTOCOL_TYPE` Frontend database protocol type for ShardingSphere-Proxy.
`PROXY_FRONTEND_EXECUTOR_SIZE` Proxy frontend executor size.
`PROXY_FRONTEND_FLUSH_THRESHOLD` Flush threshold for every records from databases for ShardingSphere-Proxy.
`PROXY_FRONTEND_MAX_CONNECTIONS` Less than or equal to 0 means no limitation.
`PROXY_HINT_ENABLED` Whether enable hint for ShardingSphere-Proxy.
`SHOW_PROCESS_LIST_ENABLED` Whether enable show process list.
`SQL_FEDERATION_ENABLED` Whether enable sql federation.
`SQL_SHOW` Whether show SQL in log.
`SQL_SIMPLE` Whether show SQL details in simple style.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Collection<String>`	`getKeyNames()` Get property key names.
`static ConfigurationPropertyKey`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ConfigurationPropertyKey[]`	`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

Methods inherited from interface org.apache.shardingsphere.infra.properties.TypedPropertyKey
getDefaultValue, getKey, getType

- Enum Constant Detail
  - SQL_SHOW
```
public static final ConfigurationPropertyKey SQL_SHOW
```
    Whether show SQL in log.
  - SQL_SIMPLE
```
public static final ConfigurationPropertyKey SQL_SIMPLE
```
    Whether show SQL details in simple style.
  - KERNEL_EXECUTOR_SIZE
```
public static final ConfigurationPropertyKey KERNEL_EXECUTOR_SIZE
```
    The max thread size of worker group to execute SQL.
  - MAX_CONNECTIONS_SIZE_PER_QUERY
```
public static final ConfigurationPropertyKey MAX_CONNECTIONS_SIZE_PER_QUERY
```
    Max opened connection size for each query.
  - CHECK_TABLE_METADATA_ENABLED
```
public static final ConfigurationPropertyKey CHECK_TABLE_METADATA_ENABLED
```
    Whether validate table meta data consistency when application startup or updated.
  - PROXY_FRONTEND_DATABASE_PROTOCOL_TYPE
```
public static final ConfigurationPropertyKey PROXY_FRONTEND_DATABASE_PROTOCOL_TYPE
```
    Frontend database protocol type for ShardingSphere-Proxy.
  - PROXY_FRONTEND_FLUSH_THRESHOLD
```
public static final ConfigurationPropertyKey PROXY_FRONTEND_FLUSH_THRESHOLD
```
    Flush threshold for every records from databases for ShardingSphere-Proxy.
  - PROXY_HINT_ENABLED
```
public static final ConfigurationPropertyKey PROXY_HINT_ENABLED
```
    Whether enable hint for ShardingSphere-Proxy.
  - SHOW_PROCESS_LIST_ENABLED
```
public static final ConfigurationPropertyKey SHOW_PROCESS_LIST_ENABLED
```
    Whether enable show process list.
  - LOCK_WAIT_TIMEOUT_MILLISECONDS
```
public static final ConfigurationPropertyKey LOCK_WAIT_TIMEOUT_MILLISECONDS
```
    The length of time in milliseconds an SQL waits for a global lock before giving up.
  - PROXY_BACKEND_QUERY_FETCH_SIZE
```
public static final ConfigurationPropertyKey PROXY_BACKEND_QUERY_FETCH_SIZE
```
    Proxy backend query fetch size. A larger value may increase the memory usage of ShardingSphere Proxy. The default value is -1, which means set the minimum value for different JDBC drivers.
  - CHECK_DUPLICATE_TABLE_ENABLED
```
public static final ConfigurationPropertyKey CHECK_DUPLICATE_TABLE_ENABLED
```
    Whether check duplicate table.
  - PROXY_FRONTEND_EXECUTOR_SIZE
```
public static final ConfigurationPropertyKey PROXY_FRONTEND_EXECUTOR_SIZE
```
    Proxy frontend executor size. The default value is 0, which means let Netty decide.
  - PROXY_BACKEND_EXECUTOR_SUITABLE
```
public static final ConfigurationPropertyKey PROXY_BACKEND_EXECUTOR_SUITABLE
```
    Available options of proxy backend executor suitable: OLAP(default), OLTP. The OLTP option may reduce time cost of writing packets to client, but it may increase the latency of SQL execution and block other clients if client connections are more than PROXY_FRONTEND_EXECUTOR_SIZE, especially executing slow SQL.
  - PROXY_FRONTEND_MAX_CONNECTIONS
```
public static final ConfigurationPropertyKey PROXY_FRONTEND_MAX_CONNECTIONS
```
    Less than or equal to 0 means no limitation.
  - SQL_FEDERATION_ENABLED
```
public static final ConfigurationPropertyKey SQL_FEDERATION_ENABLED
```
    Whether enable sql federation.
  - PROXY_BACKEND_DRIVER_TYPE
```
public static final ConfigurationPropertyKey PROXY_BACKEND_DRIVER_TYPE
```
    Proxy backend driver type. Default driver is JDBC.
- Method Detail
  - values
```
public static ConfigurationPropertyKey[] 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 (ConfigurationPropertyKey c : ConfigurationPropertyKey.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ConfigurationPropertyKey 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
  - getKeyNames
```
public static Collection<String> getKeyNames()
```
    Get property key names.
    
    Returns:
    
    collection of key names

Enum ConfigurationPropertyKey

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.shardingsphere.infra.properties.TypedPropertyKey

Enum Constant Detail

SQL_SHOW

SQL_SIMPLE

KERNEL_EXECUTOR_SIZE

MAX_CONNECTIONS_SIZE_PER_QUERY

CHECK_TABLE_METADATA_ENABLED

PROXY_FRONTEND_DATABASE_PROTOCOL_TYPE

PROXY_FRONTEND_FLUSH_THRESHOLD

PROXY_HINT_ENABLED

SHOW_PROCESS_LIST_ENABLED

LOCK_WAIT_TIMEOUT_MILLISECONDS

PROXY_BACKEND_QUERY_FETCH_SIZE

CHECK_DUPLICATE_TABLE_ENABLED

PROXY_FRONTEND_EXECUTOR_SIZE

PROXY_BACKEND_EXECUTOR_SUITABLE

PROXY_FRONTEND_MAX_CONNECTIONS

SQL_FEDERATION_ENABLED

PROXY_BACKEND_DRIVER_TYPE

Method Detail

values

valueOf

getKeyNames