package
9.0.0-alpha+incompatible
Repository: https://github.com/pingcap/tidb.git
Documentation: pkg.go.dev

# Functions

CloneConf deeply clones this config.
ContainHiddenConfig checks whether it contains the configuration that needs to be hidden.
DefaultPessimisticTxn returns the default configuration for PessimisticTxn.
DefaultTrxSummary returns the default configuration for TrxSummary collector.
FlattenConfigItems flatten this config, see more cases in the test.
GetGlobalConfig returns the global configuration for this server.
GetGlobalKeyspaceName is used to get global keyspace name from config file or command line.
GetJSONConfig returns the config as JSON with hidden items removed It replaces the earlier HideConfig() which used strings.Split() in an way that didn't work for similarly named items (like enable).
GetTxnScopeFromConfig extracts @@txn_scope value from the config.
InitializeConfig initialize the global config handler.
MergeConfigItems overwrites the dynamic config items and leaves the other items unchanged.
NewAtomicBool creates an AtomicBool.
NewConfig creates a new config instance with default value.
RestoreFunc gets a function that restore the config to the current value.
StoreGlobalConfig stores a new config to the globalConf.
StoreTypeList returns all valid storage types.
TableLockEnabled uses to check whether enabled the table lock feature.
UpdateGlobal updates the global config, and provide a restore function that can be used to restore to the original.

# Constants

DefAuthTokenRefreshInterval is the default time interval to refresh tidb auth token.
DefDDLSlowOprThreshold sets log DDL operations whose execution time exceeds the threshold value.
DefExpensiveQueryTimeThreshold indicates the time threshold of expensive query.
DefExpensiveTxnTimeThreshold indicates the time threshold of expensive txn.
DefHost is the default host of TiDB.
DefIndexLimit is the limitation of index on a single table.
DefMaxIndexLength is the maximum index length(in bytes).
DefMaxOfIndexLimit is the maximum limitation of index on a single table for TiDB.
DefMaxOfMaxIndexLength is the maximum index length(in bytes) for TiDB v3.0.7 and previous version.
DefMaxOfStatsLoadConcurrencyLimit is maximum limitation of the concurrency of stats-load.
DefMaxOfStatsLoadQueueSizeLimit is maximum limitation of the size of stats-load request queue.
DefMaxOfTableColumnCountLimit is maximum limitation of the number of columns in a table.
DefMemoryUsageAlarmRatio is the threshold triggering an alarm which the memory usage of tidb-server instance exceeds.
DefPort is the default port of TiDB.
DefRowsForSampleRate is default sample rows used to calculate samplerate.
Config number limitations.
DefStatsLoadConcurrencyLimit is limit of the concurrency of stats-load.
DefStatsLoadQueueSizeLimit is limit of the size of stats-load request queue.
DefStatusHost is the default status host of TiDB.
DefStatusPort is the default status port of TiDB.
DefTableColumnCountLimit is limit of the number of columns in a table.
DefTempDir is the default temporary directory path for TiDB.
DefTxnEntrySizeLimit is the default value of TxnEntrySizeLimit.
DefTxnTotalSizeLimit is the default value of TxnTxnTotalSizeLimit.
EnvVarKeyspaceName is the system env name for keyspace name.
MB.
MaxTokenLimit is the max token limit value.
120MB.
The following constants represents the valid action configurations for Security.SpilledFileEncryptionMethod.
The following constants represents the valid action configurations for Security.SpilledFileEncryptionMethod.
StoreTypeMockTiKV is MockTiKV type which we implemented using goleveldb, for test only.
StoreTypeTiKV is TiKV type.
StoreTypeUniStore is UniStore type which we implemented using badger, for test only.
100T, we expect a txn can never be this large.
Config number limitations.

# Variables

CheckTableBeforeDrop enable to execute `admin check table` before `drop table`.
ConflictOptions indicates the conflict config options existing in both [instance] and other sections in config file.
DeprecatedOptions indicates the config options existing in some other sections in config file.
TableLockDelayClean uses to get the time of delay clean table lock.
TikvConfigLock protects against concurrent tikv config refresh.

# Structs

AtomicBool is a helper type for atomic operations on a boolean value.
Config contains configuration options.
ErrConfigInstanceSection error is used to warning the user which config options should be moved to 'instance'.
The ErrConfigValidationFailed error is used so that external callers can do a type assertion to defer handling of this specific error when someone does not want strict type checking.
Experimental controls the features that are still experimental: their semantics, interfaces are subject to change.
Instance is the section of instance scope system variables.
InstanceConfigSection indicates a config session that has options moved to [instance] session.
IsolationRead is the config for isolation read.
Log is the log section of config.
LogBackup is the config for log backup service.
OpenTracing is the opentracing section of the config.
OpenTracingReporter is the config for opentracing reporter.
OpenTracingSampler is the config for opentracing sampler.
Performance is the performance section of the config.
PessimisticTxn is the config for pessimistic transaction.
PlanCache is the PlanCache section of the config.
Plugin is the config for plugin.
PreparedPlanCache is the PreparedPlanCache section of the config.
ProxyProtocol is the PROXY protocol section of the config.
Security is the security section of the config.
Status is the status section of the config.
TopSQL is the config for TopSQL.
TrxSummary is the config for transaction summary collecting.

# Type aliases

ConfReloadFunc is used to reload the config to make it work.
StoreType is the type of storage.