Plugins for MariaDB Community Server 10.6

This page is part of MariaDB's Documentation.

The parent of this page is: Reference for MariaDB Community Server 10.6

Topics on this page:

Overview

Overview

Plugins provide optional features in MariaDB Community Server.

Plugin	Library	Description
ARCHIVE	ha_archive.so	gzip-compresses tables for a low storage footprint
Aria		Built-in plugin for Aria, a crash safe storage engine with MyISAM heritage. Used for internal temporary tables and privilege tables.
binlog		Built-in plugin for the Binary Log, used in single-primary replication and in point-in-time recoveries
BLACKHOLE	ha_blackhole.so	Plugin for Blackhole, a non-writing storage engine. Requires additional configuration to install and use.
CLIENT_STATISTICS		Built-in Information Schema table plugin, providing statistical data on client connections
Columnstore	ha_columnstore.so	ColumnStore storage engine
COLUMNSTORE_COLUMNS	ha_columnstore.so	An information schema plugin to list ColumnStore columns
COLUMNSTORE_EXTENTS	ha_columnstore.so	An information schema plugin to list ColumnStore extents
COLUMNSTORE_FILES	ha_columnstore.so	An information schema plugin to list ColumnStore files
COLUMNSTORE_TABLES	ha_columnstore.so	An information schema plugin to list ColumnStore tables
cracklib_password_check	cracklib_password_check.so	Password validation plugin, uses CrackLib to validate passwords as strong. Requires additional configuration to install and use.
CSV		Plugin for CSV, a storage engine for operating on CSV (comma-separated variables) files. Built-in plugin.
DISKS	disks.so	Information Schema table plugin, providing metadata on system disks. Ships with MariaDB Enterprise Server, and is activated by default.
ed25519	auth_ed25519.so	Authentication plugin, validates against a password hash encrypted using EDCDSA. The ed25519 plugin ships with MariaDB Enterprise Server installations and is enabled by default.
FEDERATED	ha_federated.so	Allows accessing tables on other MariaDB servers
FEDERATED	ha_federatedx.so	Allows one to access tables on other MariaDB servers, supports transactions and more
FEEDBACK		Plugin to collect configuration usage information and to optionally upload it to the MariaDB Foundation or another configured URL. Ships with MariaDB Enterprise Server, but is disabled by default.
file_key_management	file_key_management.so	Encryption key management plugin, stores keys in files on the local file system. Ships with MariaDB Enterprise Server installations.
GEOMETRY_COLUMNS		Lists all geometry columns
gssapi	auth_gssapi.so	Authentication plugin, validates user credentials against a GSSAPI-based authentication service, like Kerberos or NTLM. Requires additional configuration to install and use.
handlersocket	handlersocket.so	Direct access into InnoDB
INDEX_STATISTICS		Built-in Information Schema table plugin, providing statistical data on index usage
inet6		Data type INET6
inet6_aton		Function INET6_ATON()
inet6_ntoa		Function INET6_NTOA()
inet_aton		Function INET_ATON()
inet_ntoa		Function INET_NTOA()
InnoDB		Built-in plugin for InnoDB, an ACID-compliant transactional storage engine for general workloads
INNODB_BUFFER_PAGE		Built-in Information Schema table plugin for InnoDB, providing data on the Buffer Pool pages
INNODB_BUFFER_PAGE_LRU		Built-in Information Schema table plugin for InnoDB, providing data on the Buffer Pool pages in LRU
INNODB_BUFFER_POOL_STATS		Built-in Information Schema table plugin for InnoDB, providing statistical data on Buffer Pool usage
INNODB_CMP		Built-in Information Schema table plugin for InnoDB, providing statistical data on compression
INNODB_CMP_PER_INDEX		Built-in Information Schema table plugin, providing statistical data on InnoDB compression per index
INNODB_CMP_PER_INDEX_RESET		Built-in Information Schema table plugin, providing statistical data for compression per index while resetting cumulated counts
INNODB_CMP_RESET		Built-in Information Schema table plugin for InnoDB, providing statistical data for compression while resetting cumulated counts
INNODB_CMPMEM		Built-in Information Schema table plugin for InnoDB, providing statistical data for the compressed Buffer Pool
INNODB_CMPMEM_RESET		Built-in Information Schema table plugin for InnoDB, providing statistical data for the compressed Buffer Pool while resetting cumulative counts
INNODB_FT_BEING_DELETED		Built-in Information Schema table plugin for InnoDB, providing auxiliary data on entries being deleted from FullText indexes
INNODB_FT_CONFIG		Built-in Information Schema table plugin for InnoDB, providing data on metadata for FullText indexes
INNODB_FT_DEFAULT_STOPWORD		Built-in Information Schema table plugin for InnoDB, providing a list of the default stopwords to use in FullText index searches
INNODB_FT_DELETED		Built-in Information Schema table plugin for InnoDB, providing data on rows removed from FullText indexes to filter results
INNODB_FT_INDEX_CACHE		Built-in Information Schema table plugin for InnoDB, providing data on rows recently added to FullText indexes
INNODB_FT_INDEX_TABLE		Built-in Information Schema table plugin for InnoDB, providing data on FullText indexes
INNODB_LOCK_WAITS		Built-in Information Schema table plugin for InnoDB, providing information on locks blocking transactions
INNODB_LOCKS		Built-in Information Schema table plugin for InnoDB, providing data on conflicting locks
INNODB_METRICS		Built-in Information Schema table plugin for InnoDB, providing data on performance metrics
INNODB_SYS_COLUMNS		Built-in Information Schema table plugin for InnoDB, providing information on system columns
INNODB_SYS_FIELDS		Built-in Information Schema table plugin for InnoDB, providing data on fields used in indexes
INNODB_SYS_FOREIGN		Built-in Information Schema table plugin for InnoDB, providing data on Foreign Keys
INNODB_SYS_FOREIGN_COLS		Built-in Information Schema table plugin for InnoDB, providing data on columns used in Foreign Keys
INNODB_SYS_INDEXES		Built-in Information Schema table plugin for InnoDB, providing data on indexes
INNODB_SYS_TABLES		Built-in Information Schema table plugin for InnoDB, providing data on InnoDB tables
INNODB_SYS_TABLESPACES		Built-in Information Schema table plugin for InnoDB, providing data on InnoDB tablespaces
INNODB_SYS_TABLESTATS		Built-in Information Schema table plugin for InnoDB, providing statistical data on table status
INNODB_SYS_VIRTUAL		Built-in Information Schema table plugin for InnoDB, providing data on temporary tables
INNODB_TABLESPACES_ENCRYPTION		Built-in Information Schema table plugin for InnoDB, providing data on encrypted tablespaces
INNODB_TRX		Built-in Information Schema table plugin for InnoDB, providing information on transactions
is_ipv4		Function IS_IPV4()
is_ipv4_compat		Function IS_IPV4_COMPAT()
is_ipv4_mapped		Function IS_IPV4_MAPPED()
is_ipv6		Function IS_IPV6()
LOCALES	locales.so	Built-in Information Schema table plugin, providing data on locales supported by the server
MEMORY		Built-in plugin for Memory, an in-memory storage engine. Used internally for temporary tables and some SQL processing.
METADATA_LOCK_INFO	metadata_lock_info.so	Built-in Information Schema table plugin, providing data on active metadata locks
MRG_MyISAM		Built-in plugin for Merge, a storage engine used in combining MyISAM tables
MyISAM		This built-in plugin implements MyISAM, a legacy non-transactional storage engine used for system tables in older releases.
mysql_native_password		Built-in authentication plugin, validates a password hash encrypted using SHA-1
mysql_old_password		Built-in authentication plugin, validates against an encrypted password hash
pam	auth_pam.so	Authentication plugin, validates user credentials against a PAM-based authentication service, such as LDAP or Active Directory. Requires the installing of additional packages to use.
pam	auth_pam_v1.so	Authentication plugin, validates user credentials against a PAM-based authentication service, such as LDAP or Active Directory. Requires the installing of additional packages to use. Legacy version 1.0 library for use with MariaDB Enterprise Server 10.4. Use `auth_pam.so` for the current release.
partition		Built-in plugin for partitioning data across multiple tablespaces
PERFORMANCE_SCHEMA		Built-in plugin for the Performance Schema, a database used to collect information on Server performance and health
QUERY_CACHE_INFO	query_cache_info.so	Lists all queries in the query cache
QUERY_RESPONSE_TIME	query_response_time.so	Information Schema table plugin, providing data on how long it takes queries to execute. Ships with MariaDB Enterprise Server, but requires additional configuration to enable.
QUERY_RESPONSE_TIME_AUDIT	query_response_time.so	Auditing plugin for auditing query response times, provides similar functionality to Slow Query Log. Ships with MariaDB Enterprise Server, but requires additional configuration to enable.
ROCKSDB	ha_rocksdb.so	Plugin for MyRocks, a write and dist optimized storage engine. Requires the installation of additional packages to use. Requires additional configuration to install and use.
ROCKSDB_CF_OPTIONS	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing data on RocksDB column family options. Requires additional configuration to install and use.
ROCKSDB_CFSTATS	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing statistical data on RocksDB column families. Requires additional configuration to install and use.
ROCKSDB_COMPACTION_STATS	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing statistical data on RocksDB compaction. Requires additional configuration to install and use.
ROCKSDB_DBSTATS	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing statistical data on RocksDB database usage. Requires additional configuration to install and use.
ROCKSDB_DDL	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing the data dictionary for RocksDB. Requires additional configuration to install and use.
ROCKSDB_DEADLOCK	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing transactional information for RocksDB. Requires additional configuration to install and use.
ROCKSDB_GLOBAL_INFO	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing global information for RocksDB. Requires additional configuration to install and use.
ROCKSDB_INDEX_FILE_MAP	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing a map to index files for RocksDB. Requires additional configuration to install and use.
ROCKSDB_LOCKS	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing locking information on RocksDB tables. Requires additional configuration to install and use.
ROCKSDB_PERF_CONTEXT	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing performance context statistics for RocksDB. Requires additional configuration to install and use.
ROCKSDB_PERF_CONTEXT_GLOBAL	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing all performance context statistics for RocksDB. Requires additional configuration to install and use.
ROCKSDB_SST_PROPS	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing data on SST properties. Requires additional configuration to install and use.
ROCKSDB_TRX	ha_rocksdb.so	Information Schema table plugin for MyRocks, providing data on transactions. Requires additional configuration to install and use.
S3	ha_s3.so	Read only table stored in S3. Created by running ALTER TABLE table_name ENGINE=s3
SEQUENCE		Built-in plugin used to generate virtual tables filled with sequential values
SERVER_AUDIT	server_audit.so	Auditing plugin for the community release of MariaDB Audit
simple_password_check	simple_password_check.so	Built-in password validation plugin, used to ensure that user passwords meet minimum policy specifications
SPATIAL_REF_SYS		Lists all geometry columns
SPHINX	ha_sphinx.so	Sphinx storage engine 2.2.6-release
SPIDER	ha_spider.so	Plugin for the Spider storage engine, which is used for table federation and table sharding. Requires installing additional packages to use on some platforms. Requires additional configuration to install and use.
SPIDER_ALLOC_MEM	ha_spider.so	Information Schema table plugin for Spider, providing data on memory allocation. Installed with the Spider storage engine.
SPIDER_WRAPPER_PROTOCOLS	ha_spider.so	Available wrapper protocols of Spider
SQL_ERROR_LOG	sql_errlog.so	Auditing plugin for collecting error messages generated by SQL statements. Ships with MariaDB Enterprise Server, but requires additional configuration to use.
SQL_SEQUENCE		Built-in plugin for Sequence, a storage engine used to create numeric sequences in virtual tables
TABLE_STATISTICS		Built-in Information Schema plugin, providing statistical data on table usage
THREAD_POOL_GROUPS		Provides information about threadpool groups
THREAD_POOL_QUEUES		Provides information about threadpool queues
THREAD_POOL_STATS		Provides performance counter information for threadpool
THREAD_POOL_WAITS		Provides wait counters for threadpool
unix_socket		Built-in authentication plugin, validates user against the Unix socket of the operating system user
USER_STATISTICS		Built-in Information Schema plugin, providing data on user activity
user_variables		Built-in Information Schema plugin, providing data on user-defined variables
wsrep		Built in Galera Replication plugin, used in multi-primary replication for MariaDB Enterprise Cluster
WSREP_MEMBERSHIP	wsrep_info.so	Information about group members
WSREP_STATUS	wsrep_info.so	Group view information