RAL (Resource & Rule Administration Language) responsible for the added-on feature of hint, transaction type switch, scaling, sharding execute planning and so on.
Hint
Statement
Function
Example
set readwrite_splitting hint source = [auto / write]
For current connection, set readwrite splitting routing strategy (automatic or forced to write data source)
set readwrite_splitting hint source = write
set sharding hint database_value = yy
For current connection, set sharding value for database sharding only, yy: sharding value
set sharding hint database_value = 100
add sharding hint database_value xx= yy
For current connection, add sharding value for table, xx: logic table, yy: database sharding value
add sharding hint database_value t_order = 100
add sharding hint table_value xx = yy
For current connection, add sharding value for table, xx: logic table, yy: table sharding value
add sharding hint table_value t_order = 100
clear hint
For current connection, clear all hint settings
clear hint
clear [sharding hint / readwrite_splitting hint]
For current connection, clear hint settings of sharding or readwrite splitting
clear readwrite_splitting hint
show [sharding / readwrite_splitting] hint status
For current connection, query hint settings of sharding or readwrite splitting
show readwrite_splitting hint status
Scaling
Statement
Function
Example
show scaling list
Query running list
show scaling list
show scaling status xx
Query scaling status, xx: jobId
show scaling status 1234
start scaling xx
Start scaling, xx: jobId
start scaling 1234
stop scaling xx
Stop scaling, xx: jobId
stop scaling 1234
drop scaling xx
Drop scaling, xx: jobId
drop scaling 1234
reset scaling xx
reset progress, xx: jobId
reset scaling 1234
check scaling xx
Data consistency check with algorithm in server.yaml, xx: jobId
check scaling 1234
show scaling check algorithms
Show available consistency check algorithms
show scaling check algorithms
check scaling {jobId} by type(name={algorithmType})
Data consistency check with defined algorithm
check scaling 1234 by type(name=DEFAULT)
stop scaling source writing xx
The source ShardingSphere data source is discontinued, xx: jobId
stop scaling source writing 1234
apply scaling xx
Switch to target ShardingSphere metadata, xx: jobId
show readwrite_splitting read resources [from schema]
Query all read resources status
show readwrite_splitting read resources
Global Rule
Statement
Function
Example
SHOW AUTHORITY RULE
Query authority rule configuration
SHOW AUTHORITY RULE
SHOW TRANSACTION RULE
Query transaction rule configuration
SHOW TRANSACTION RULE
SHOW SQL_PARSER RULE
Query SQL parser rule configuration
SHOW SQL_PARSER RULE
ALTER TRANSACTION RULE(DEFAULT=xx,TYPE(NAME=xxx, PROPERTIES(“key1"="value1”,“key2"="value2”…)))
Alter transaction rule configuration，DEFAULT: default transaction type，support LOCAL、XA、BASE; NAME: name of transaction manager, support Atomikos, Narayana and Bitronix
ALTER TRANSACTION RULE(DEFAULT=XA,TYPE(NAME=Narayana, PROPERTIES(“databaseName"="jbossts”,“host"="127.0.0.1”)))
ALTER SQL_PARSER RULE SQL_COMMENT_PARSE_ENABLE=xx, PARSE_TREE_CACHE(INITIAL_CAPACITY=xx, MAXIMUM_SIZE=xx, CONCURRENCY_LEVEL=xx), SQL_STATEMENT_CACHE(INITIAL_CAPACITY=xxx, MAXIMUM_SIZE=xxx, CONCURRENCY_LEVEL=xxx)
Alter SQL parser rule configuration, SQL_COMMENT_PARSE_ENABLE: whether to parse the SQL comment, PARSE_TREE_CACHE: local cache configuration of syntax tree, SQL_STATEMENT_CACHE: local cache of SQL statement
ALTER SQL_PARSER RULE SQL_COMMENT_PARSE_ENABLE=false, PARSE_TREE_CACHE(INITIAL_CAPACITY=10, MAXIMUM_SIZE=11, CONCURRENCY_LEVEL=1), SQL_STATEMENT_CACHE(INITIAL_CAPACITY=11, MAXIMUM_SIZE=11, CONCURRENCY_LEVEL=100)