ConfigurationPropertyKey (shardingsphere-common 4.1.1 API)

java.lang.Object
- java.lang.Enum<ConfigurationPropertyKey>
- - org.apache.shardingsphere.underlying.common.config.properties.ConfigurationPropertyKey

所有已实现的接口:

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

枚举常量概要

枚举常量
枚举常量和说明
`ACCEPTOR_SIZE` Worker group or user group thread max size.
`ALLOW_RANGE_QUERY_WITH_INLINE_SHARDING` Allow or not execute range query with inline sharding strategy.
`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.

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static ConfigurationPropertyKey`	`valueOf(String name)` 返回带有指定名称的该类型的枚举常量。
`static ConfigurationPropertyKey[]`	`values()` 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。

从类继承的方法 java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.apache.shardingsphere.underlying.common.properties.TypedPropertyKey
getDefaultValue, getKey, getType

- 枚举常量详细资料
  - SQL_SHOW
```
public static final ConfigurationPropertyKey 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 ConfigurationPropertyKey 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 ConfigurationPropertyKey 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 ConfigurationPropertyKey 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 ConfigurationPropertyKey MAX_CONNECTIONS_SIZE_PER_QUERY
```
    Max opened connection size for each query.
  - QUERY_WITH_CIPHER_COLUMN
```
public static final ConfigurationPropertyKey QUERY_WITH_CIPHER_COLUMN
```
    When encrypt data, query with cipher column or not.
  - ALLOW_RANGE_QUERY_WITH_INLINE_SHARDING
```
public static final ConfigurationPropertyKey ALLOW_RANGE_QUERY_WITH_INLINE_SHARDING
```
    Allow or not execute range query with inline sharding strategy.
    For inline sharding strategy, user only can config precise algorithm via inline expression, and cannot config range algorithm. So throw exception when SQL contains range conditions(such as BETWEEN AND, <, >, <=, >=) may better than query all data nodes. If query all data nodes instead of explicit exception, user may missing the potential performance issue. When turn this parameter on, query all data nodes with inline sharding to be allowed instead of explicit exception. Default: false
  - PROXY_FRONTEND_FLUSH_THRESHOLD
```
public static final ConfigurationPropertyKey PROXY_FRONTEND_FLUSH_THRESHOLD
```
    Sharding-Proxy's flush threshold for every records from databases.
  - PROXY_TRANSACTION_TYPE
```
public static final ConfigurationPropertyKey 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 ConfigurationPropertyKey PROXY_OPENTRACING_ENABLED
```
    Enable opentracing for Sharding-Proxy.
  - PROXY_HINT_ENABLED
```
public static final ConfigurationPropertyKey PROXY_HINT_ENABLED
```
    Enable hint for Sharding-Proxy.
  - PROXY_BACKEND_MAX_CONNECTIONS
```
public static final ConfigurationPropertyKey PROXY_BACKEND_MAX_CONNECTIONS
```
  - PROXY_BACKEND_CONNECTION_TIMEOUT_SECONDS
```
public static final ConfigurationPropertyKey PROXY_BACKEND_CONNECTION_TIMEOUT_SECONDS
```
  - CHECK_TABLE_METADATA_ENABLED
```
public static final ConfigurationPropertyKey CHECK_TABLE_METADATA_ENABLED
```
- 方法详细资料
  - values
```
public static ConfigurationPropertyKey[] values()
```
    按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。该方法可用于迭代常量, 如下所示:
```
for (ConfigurationPropertyKey c : ConfigurationPropertyKey.values())
    System.out.println(c);
```
    返回:
    
    按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
  - valueOf
```
public static ConfigurationPropertyKey valueOf(String name)
```
    返回带有指定名称的该类型的枚举常量。字符串必须与用于声明该类型的枚举常量的标识符完全匹配。(不允许有多余的空格字符。)
    
    参数:
    
    name - 要返回的枚举常量的名称。
    
    返回:
    
    返回带有指定名称的枚举常量
    
    抛出:
    
    IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量
    
    NullPointerException - 如果参数为空值

枚举 ConfigurationPropertyKey

枚举常量概要

方法概要

从类继承的方法 java.lang.Enum

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.shardingsphere.underlying.common.properties.TypedPropertyKey

枚举常量详细资料

SQL_SHOW

SQL_SIMPLE

ACCEPTOR_SIZE

EXECUTOR_SIZE

MAX_CONNECTIONS_SIZE_PER_QUERY

QUERY_WITH_CIPHER_COLUMN

ALLOW_RANGE_QUERY_WITH_INLINE_SHARDING

PROXY_FRONTEND_FLUSH_THRESHOLD

PROXY_TRANSACTION_TYPE

PROXY_OPENTRACING_ENABLED

PROXY_HINT_ENABLED

PROXY_BACKEND_MAX_CONNECTIONS

PROXY_BACKEND_CONNECTION_TIMEOUT_SECONDS

CHECK_TABLE_METADATA_ENABLED

方法详细资料

values

valueOf