A reference for table-level parameters in Spider, which can be set via the COMMENT or CONNECTION string to control connection settings, monitoring, and query behavior.
When a table uses the Spider storage engine, the following Spider table parameters can be set in the COMMENT clause of the CREATE TABLE statement. Many Spider table parameters have corresponding system variables, so they can be set for all Spider tables on the node. For additional information, see the Spider System Variables page.
From , many table parameters can be set using dedicated Spider table options, see the Table Option Name fields below. From MariaDB 11.4, using the COMMENT clause is deprecated, as well as table parameters that do not have corresponding table options.
access_balancesDescription: Connection load balancing integer weight.
Default Table Value: 0
DSN Parameter Name: abl
Deprecated:
active_link_countDescription: Number of active remote servers, for use in load balancing read connections
Default Table Value: all backends
DSN Parameter Name: alc
Deprecated:
auto_increment_modeDescription: The table level value of
Table Option Name: AUTO_INCREMENT_MODE
Table Option Introduced:
bgs_modeDescription: The table level value of .
Table Option Name: BGS_MODE
Table Option Introduced:
bulk_sizeDescription: The table level value of .
Table Option Name: BULK_SIZE
Table Option Introduced:
bulk_update_sizeDescription: The table level value of .
Table Option Name: BULK_UPDATE_SIZE
Table Option Introduced:
casual_readDescription:
Default Table Value:
DSN Parameter Name:
Introduced: Spider 3.2
connect_timeoutDescription: The table level value of .
Table Option Name: CONNECT_TIMEOUT
Table Option Introduced:
databaseDescription: Database name for reference table that exists on remote backend server.
Default Table Value: local table database
DSN Parameter Name: database
Table Option Name: REMOTE_DATABASE
default_fileDescription: Configuration file used when connecting to remote servers. When the table variable is set, this variable defaults to the values of the --defaults-extra-file or --defaults-file options. When the table variable is not set, it defaults to none.
Default Table Value: none
DSN Parameter Name: dff
default_groupDescription: Group name in configuration file used when connecting to remote servers.
Default Table Value: none
DSN Parameter Name: dfg
Table Option Name: DEFAULT_GROUP
delete_all_rows_typeDescription: The table level value of .
Introduced: Spider 3.2
Table Option Name: DELETE_ALL_ROWS_TYPE
Table Option Introduced:
force_bulk_deleteDescription:
Introduced:
Table Option Name: FORCE_BULK_DELETE
Table Option Introduced:
force_bulk_updateDescription:
Introduced:
Table Option Name: FORCE_BULK_UPDATE
Table Option Introduced:
hostDescription: Host name of remote server.
Default Table Value: localhost
DSN Parameter Name: host
Table Option Name: REMOTE_HOST
idx000Description: When using an index on Spider tables for searching, Spider uses this hint to search the remote table. The remote table index is related to the Spider table index by this hint. The number represented by 000 is the index ID, which is the number of the index shown by the statement. 000 is the Primary Key. For instance, idx000 "force index(PRIMARY)" (in abbreviated format idx000 "f PRIMARY").
f force index
link_statusDescription: Change status of the remote backend server link.
0 Doesn't change status.
1 Changes status to OK.
monitoring_bg_intervalDescription: Interval of background monitoring in microseconds.
Default Table Value: 10000000
DSN Parameter Name: mbi
Deprecated:
monitoring_bg_kindDescription: Kind of background monitoring to use.
0 Disables background monitoring.
1 Monitors connection state.
monitoring_kindDescription: Kind of monitoring.
0 Disables monitoring
1 Monitors connection state.
monitoring_limitDescription: Limits the number of records in the monitoring table. This is only effective when Spider monitors the state of a table, which occurs when the table variable is set to a value greater than 1.
Default Table Value: 1
Range: 0 upwards
monitoring_server_idDescription: Preferred monitoring @@server_id for each backend failure. You can use this to geo-localize backend servers and set the first Spider monitoring node to contact for failover. In the event that this monitor fails, other monitoring nodes are contacted. For multiple copy backends, you can set a lazy configuration with a single MSI instead of one per backend.
Default Table Value: server_id
DSN Parameter Name: msi
multi_split_readDescription: The table level value of .
Table Option Name: MULTI_SPLIT_READ
Table Option Introduced:
net_read_timeoutDescription: The table level value of .
Table Option Name: NET_READ_TIMEOUT
Table Option Introduced:
net_write_timeoutDescription: The table level value of .
Table Option Name: NET_WRITE_TIMEOUT
Table Option Introduced:
passwordDescription: Remote server password.
Default Table Value: none
DSN Parameter Name: password
Table Option Name: REMOTE_PASSWORD
portDescription: Remote server port.
Default Table Value: 3306
DSN Parameter Name: port
Table Option Name: REMOTE_PORT
priorityDescription: Priority. Used to define the order of execution. For instance, Spider uses priority when deciding the order in which to lock tables on a remote server.
Default Table Value: 1000000
DSN Parameter Name: prt
Table Option Name:
query_cacheDescription: Uses the option for the when issuing statements to the remote server.
0 No option used.
1 Uses the option.
query_cache_syncDescription: A two-bit bitmap. Whether to pass the option for the (if any) when issuing statements to the remote server.
0 No option passed.
1 Passes the option, if specified in the query to the spider table.
read_rateDescription: Rate used to calculate the amount of time Spider requires when executing index scans.
Default Table Value: 0.0002
DSN Parameter Name: rrt
Deprecated:
scan_rateDescription: Rate used to calculate the amount of time Spider requires when scanning tables.
Default Table Value: 0.0001
DSN Parameter Name: srt
Deprecated:
serverDescription: Server name. Used when generating connection information with statements.
Default Table Value: none
DSN Parameter Name: srv
Table Option Name: REMOTE_SERVER
skip_parallel_searchDescription: The table level value of .
Table Option Name: SKIP_PARALLEL_SEARCH
Table Option Introduced:
socketDescription: Remote server socket.
Default Table Value: none
DSN Parameter Name: socket
Table Option Name: REMOTE_SOCKET
ssl_caDescription: Path to the Certificate Authority file.
Default Table Value: none
DSN Parameter Name: sca
Table Option Name: SSL_CA
ssl_capathDescription: Path to directory containing trusted TLS CA certificates in PEM format.
Default Table Value: none
DSN Parameter Name: scp
Table Option Name: SSL_CAPATH
ssl_certDescription: Path to the certificate file.
Default Table Value: none
DSN Parameter Name: scr
Table Option Name: SSL_CERT
ssl_cipherDescription: List of allowed ciphers to use with .
Default Table Value: none
DSN Parameter Name: sch
Table Option Name: SSL_CIPHER
ssl_keyDescription: Path to the key file.
Default Table Value: none
DSN Parameter Name: sky
Table Option Name: SSL_KEY
ssl_verify_server_certDescription: Enables verification of the server's Common Name value in the certificate against the host name used when connecting to the server.
0 Disables verification.
1 Enables verification.
tableDescription: Destination table name.
Default Table Value: Same table name
DSN Parameter Name: tbl
Table Option Name: REMOTE_TABLE
table_count_modeDescription: for setting table flags HA_STATS_RECORDS_IS_EXACT and HA_HAS_RECORDS.
Default Table Value: 0
Table Option Name: TABLE_COUNT_MODE
Table Option Introduced:
usernameDescription: user name for the data node.
Default Table Value: Same user name
Table Option Name: REMOTE_USERNAME
Table Option Introduced:
use_pushdown_udfDescription: The table level value of .
Table Option Name: USE_PUSHDOWN_UDF
Table Option Introduced:
wrapperDescription: wrapper for the data node.
Table Option Name: WRAPPER
Table Option Introduced:
This page is licensed: CC BY-SA / Gnu FDL
Table Option Introduced:
Table Option Name: DEFAULT_FILE
Table Option Introduced:
Table Option Introduced:
Table Option Introduced:
u use index
ig ignore index
Default Table Value: none
Table Option Name: IDX
Table Option Introduced:
2 Changes status to RECOVERY.
3 Changes status to no more in group communication.
Default Table Value: 0
DSN Parameter Name: lst
Deprecated: MariaDB 11.4.0
2 Monitors state of table without WHERE clause.3 Monitors state of table with WHERE clause (currently unsupported).
Default Table Value: 0
DSN Parameter Name: mbk
Deprecated: MariaDB 11.4.0
2WHERE3 Monitors state of table with WHERE clause (currently unsupported).
Default Table Value: 0
DSN Parameter Name: mkd
Deprecated: MariaDB 11.4.0
DSN Parameter Name: mlt
Deprecated: MariaDB 11.4.0
Deprecated: MariaDB 11.4.0
Table Option Introduced:
Table Option Introduced:
PRIORITYTable Option Introduced:
2 Uses the SQL_NO_CACHE option.Default Table Value: 0
DSN Parameter Name: qch
Table Option Name: QUERY_CACHE
Table Option Introduced:
2 Passes the SQL_NO_CACHE option, if specified in the query to the spider table.
3 Passes both the SQL_CACHE option and the SQL_NO_CACHE option, if specified in the query to the spider table.
Default Table Value: 3
Table Option Name: QUERY_CACHE_SYNC
Table Option Introduced:
Table Option Introduced:
Table Option Introduced:
Table Option Introduced:
Table Option Introduced:
Table Option Introduced:
Table Option Introduced:
Table Option Introduced:
0DSN Parameter Name: svc
Table Option Name: SSL_VSC
Table Option Introduced:
Table Option Introduced: