package
9.0.0-alpha+incompatible
Repository: https://github.com/pingcap/tidb.git
Documentation: pkg.go.dev
# Functions
ChangeDisableFlagAndFlush changes plugin disable flag and notify other nodes to do same change.
DeclareAuditManifest declares manifest as AuditManifest.
DeclareAuthenticationManifest declares manifest as AuthenticationManifest.
DeclareDaemonManifest declares manifest as DaemonManifest.
DeclareSchemaManifest declares manifest as SchemaManifest.
ExportManifest exports a manifest to TiDB as a known format.
ForeachPlugin loops all ready plugins.
GeneralEventFromString gets the `GeneralEvent` from the given string.
Get finds and returns plugin by kind and name parameters.
GetAll finds and returns all plugins.
Init initializes the loaded plugin by config param.
IsEnable checks plugin's enable state.
Load load plugin by config param.
NotifyFlush notify plugins to do flush logic.
SetTestHook for uint test in custom plugin.
Shutdown cleanups all plugin resources.
# Constants
Audit indicates it is a Audit plugin.
Authentication indicate it is a Authentication plugin.
ChangeUser represents change user.
Completed represents a GeneralEvent that has completed.
Connected represents new connection establish event(finish auth).
Daemon indicate a plugin that can run as daemon task.
Disable indicate plugin is disabled.
Disconnect represents disconnect event.
Dying indicates plugin will be close soon.
Error represents a GeneralEvent that has error (and typically couldn't start).
GeneralEventCount is the count for the general events The new events MUST be added before it.
LibrarySuffix defines TiDB plugin's file suffix.
ManifestSymbol defines TiDB plugin's entrance symbol.
PostParse presents event after parse.
PreAuth represents event before start auth.
PreParse presents event before parse.
Ready indicates plugin is ready to work.
Reject represents event reject connection event.
Schema indicate a plugin that can change TiDB schema.
Starting represents a GeneralEvent that is about to start.
Uninitialized indicates plugin is uninitialized.
# Variables
ExecStartTimeCtxKey indicates stmt start execution time.
StaticPlugins is a registry to register plugins for other packages without loading go plugin so.
# Structs
AuditManifest presents a sub-manifest that every audit plugin must provide.
AuthenticationManifest presents a sub-manifest that every audit plugin must provide.
Config presents the init configuration for plugin framework.
DaemonManifest presents a sub-manifest that every DaemonManifest plugins must provide.
Manifest describes plugin info and how it can do by plugin itself.
Plugin presents a TiDB plugin.
SchemaManifest presents a sub-manifest that every schema plugins must provide.
# Type aliases
ConnectionEvent presents TiDB connection event.
GeneralEvent presents TiDB generate event.
ID present plugin identity.
Kind presents the kind of plugin.
ParseEvent presents events happen around parser.
State present the state of plugin.