# Reference

- [MaxScale Configuration Settings](https://mariadb.com/docs/maxscale/reference/maxscale-configuration-settings.md): Browse the comprehensive list of MariaDB MaxScale configuration parameters. This reference details valid values, default settings, and dynamic capabilities for servers, services, and monitors.
- [MaxScale Module Commands](https://mariadb.com/docs/maxscale/reference/maxscale-module-commands.md): Learn about special module-specific commands in MaxScale. This guide explains how to list and execute commands using MaxCtrl for modules like authenticators, filters, and monitors.
- [MaxScale Authenticators](https://mariadb.com/docs/maxscale/reference/maxscale-authenticators.md): Secure client connections with MaxScale authentication modules. This reference details configuration for Native, PAM, GSSAPI, and Ed25519 plugins to validate user credentials.
- [MaxScale Ed25519 Authenticator](https://mariadb.com/docs/maxscale/reference/maxscale-authenticators/maxscale-ed25519-authenticator.md): Implement high-security authentication using Ed25519 signatures. This guide explains how to configure the ed25519auth module and handle backend authentication via user mapping.
- [MaxScale GSSAPI Client Authenticator](https://mariadb.com/docs/maxscale/reference/maxscale-authenticators/maxscale-gssapi-client-authenticator.md): Integrate MaxScale with Kerberos or Active Directory using GSSAPI. Learn to configure the GSSAPIAuth module, manage keytab files, and set up service principals for secure login.
- [MaxScale MariaDB/MySQL Authenticator](https://mariadb.com/docs/maxscale/reference/maxscale-authenticators/maxscale-mariadb-mysql-authenticator.md): Configure standard native password authentication. This guide covers the MariaDBAuth module, which handles the default mysql\_native\_password plugin used by MariaDB and MySQL.
- [MaxScale PAM Authenticator](https://mariadb.com/docs/maxscale/reference/maxscale-authenticators/maxscale-pam-authenticator.md): Authenticate users via Pluggable Authentication Modules (PAM). This reference details the PAMAuth module, supporting standard passwords, two-factor authentication, and SUID mode.
- [MaxScale PARSEC Authenticator](https://mariadb.com/docs/maxscale/reference/maxscale-authenticators/maxscale-parsec-authenticator.md): Enable modern, secure authentication with PARSEC. This guide explains the parsecauth module, which uses elliptic curve signatures and salted passwords to prevent replay attacks.
- [MaxScale Filters](https://mariadb.com/docs/maxscale/reference/maxscale-filters.md): Filters in MariaDB MaxScale intercept and modify database traffic. Use them to transform, block, or log queries, enabling fine-grained control over your database workload and security.
- [MaxScale Binlog Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-binlog-filter.md): Selectively replicate binary log events to replica servers. This filter uses regex matching to include or exclude specific events from the replication stream.
- [MaxScale Cache](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-cache.md): Improve query performance by caching SELECT statement results. This filter stores result sets in memory, serving identical subsequent queries directly from MaxScale.
- [MaxScale Comment Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-comment-filter.md): Inject custom comments into SQL statements. This filter allows administrators to tag queries with metadata for tracking, auditing, or debugging purposes.
- [MaxScale Consistent Critical Read Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-consistent-critical-read-filter.md): Ensure data consistency by routing reads to the primary server after a write. This filter guarantees that a client sees its own modifications immediately.
- [MaxScale Firewall Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-firewall-filter.md): Protect your database by blocking unauthorized queries. This filter inspects incoming SQL against a defined set of rules to prevent SQL injection and unauthorized access.
- [MaxScale Hintfilter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-hintfilter.md): Control query routing using SQL comments. This filter interprets hints embedded in queries to direct traffic to specific servers, primaries, or replicas.
- [MaxScale LDI Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-ldi-filter.md): Manage LOAD DATA INFILE operations. This filter splits large data loads into smaller chunks to prevent blocking and improve stability during bulk data ingestion.
- [MaxScale Masking Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-masking-filter.md): Obfuscate sensitive data in query results. This filter masks specific columns based on user roles, ensuring compliance with privacy regulations without altering the database.
- [MaxScale Maxrows Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-maxrows-filter.md): Limit the size of result sets returned to clients. This filter prevents excessive resource consumption by truncating results that exceed a configured row count.
- [MaxScale Named Server Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-named-server-filter.md): Route queries to specific servers based on regex patterns. This filter allows you to direct traffic matching defined rules to a particular backend server by name.
- [MaxScale Optimistic Transaction Execution Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-optimistic-transaction-execution-filter.md): Improve performance for read-heavy transactions. This filter attempts to execute transactions on replicas first falling back to the primary only if a write occurs.
- [MaxScale Psreuse Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-psreuse-filter.md): Optimize prepared statement execution. This filter caches prepared statements on the proxy layer reducing the overhead of re-preparing statements on backend servers.
- [MaxScale Query Log All Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-query-log-all-filter.md): Log every SQL query passing through MaxScale. This filter provides comprehensive audit trails by recording query text, execution time, and client details.
- [MaxScale Readonly](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-readonly.md): Enforce read-only access at the proxy level. This filter rejects modification statements like INSERT or UPDATE protecting the database from accidental writes.
- [MaxScale Regex Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-regex-filter.md): Rewrite or block queries using regular expressions. This versatile filter modifies SQL statements on the fly or rejects them based on pattern matching rules.
- [MaxScale Rewrite Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-rewrite-filter.md): Transform SQL queries using template-based rules. This filter modifies incoming statements to optimize performance or fix compatibility issues without changing application code.
- [MaxScale Tee Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-tee-filter.md): Duplicate query traffic to multiple targets. This filter sends a copy of incoming requests to a secondary service or server useful for testing and auditing.
- [MaxScale Throttle Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-throttle-filter.md): Regulate the rate of incoming queries. This filter prevents database overload by limiting the number of queries processed per second based on defined thresholds.
- [MaxScale Top Filter](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-top-filter.md): Identify the most expensive queries. This filter logs the top N slowest queries passing through MaxScale helping to pinpoint performance bottlenecks.
- [MaxScale Workload Capture and Replay](https://mariadb.com/docs/maxscale/reference/maxscale-filters/maxscale-workload-capture-and-replay.md): Record and replay real database traffic. This filter captures client sessions to create realistic benchmarks and test environments based on production workloads.
- [MaxScale MaxCtrl](https://mariadb.com/docs/maxscale/reference/maxscale-maxctrl.md): Reference guide for the MaxCtrl command-line utility. Learn syntax and options for managing MaxScale objects, including servers, services, monitors, and listeners via the REST API.
- [MaxScale MaxGUI](https://mariadb.com/docs/maxscale/reference/maxscale-maxgui.md): Navigate the MaxGUI browser-based interface. This reference outlines the dashboard features for visual configuration, cluster monitoring, and query execution in MariaDB MaxScale.
- [MaxScale Monitors](https://mariadb.com/docs/maxscale/reference/maxscale-monitors.md): Ensure high availability with MaxScale Monitors. This reference details monitoring modules for MariaDB replication and Galera clusters, covering failover, role detection, and health checks.
- [Common Monitor Parameters](https://mariadb.com/docs/maxscale/reference/maxscale-monitors/common-monitor-parameters.md): Configure standard settings for all MaxScale monitors. Learn about essential parameters like monitor intervals, backend timeouts, and user credentials for connecting to database servers.
- [Galera Monitor](https://mariadb.com/docs/maxscale/reference/maxscale-monitors/galera-monitor.md): Monitor Galera Clusters with the galeramon module. This guide explains how to detect cluster state, assign read/write roles, and manage node priorities for effective load balancing.
- [MariaDB Monitor](https://mariadb.com/docs/maxscale/reference/maxscale-monitors/mariadb-monitor.md): Manage primary-replica clusters with the mariadbmon module. Learn to configure automatic failover, perform switchovers, and monitor replication lag to maintain database availability.
- [MaxScale Protocols](https://mariadb.com/docs/maxscale/reference/maxscale-protocols.md): Explore the protocol modules available in MariaDB MaxScale. This reference covers configuration for the standard MariaDB protocol, the NoSQL listener, and legacy CDC integration.
- [MaxScale Change Data Capture (CDC) Protocol](https://mariadb.com/docs/maxscale/reference/maxscale-protocols/maxscale-change-data-capture-cdc-protocol.md): Learn about the legacy CDC protocol in MaxScale. This guide covers the authentication and registration phases for clients consuming AVRO-formatted replication events.
- [MaxScale Change Data Capture (CDC) users](https://mariadb.com/docs/maxscale/reference/maxscale-protocols/maxscale-change-data-capture-cdc-users.md): Manage user authentication for the legacy CDC protocol. This reference explains how to create, store, and manage user credentials for clients connecting to the CDC listener.
- [MaxScale MariaDB Protocol Module](https://mariadb.com/docs/maxscale/reference/maxscale-protocols/maxscale-mariadb-protocol-module.md): Configure the core MariaDB client-server protocol in MaxScale. Learn about settings for compression, connection redirection, and replication support for standard database listeners.
- [MaxScale NoSQL Protocol Module](https://mariadb.com/docs/maxscale/reference/maxscale-protocols/maxscale-nosql-protocol-module.md): Use MariaDB as a backend for MongoDB applications. This module allows MaxScale to accept MongoDB wire protocol commands and transparently convert them into SQL queries.
- [MaxScale REST API](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api.md): Access the complete reference for the MariaDB MaxScale REST API. Find documentation for all resources, authentication methods, and endpoints for programmatic management.
- [MaxScale Admin User Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-admin-user-resource.md): Manage administrative access to MaxScale. Learn to create, update, and delete admin users and manage their credentials for the REST API and MaxCtrl.
- [MaxScale Filter Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-filter-resource.md): Configure database traffic filters programmatically. This resource enables you to retrieve, create, and modify filter instances and their runtime parameters.
- [MaxScale Listener Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-listener-resource.md): Manage network listeners via the REST API. Use this resource to define ports, protocols, and service associations for handling incoming client connections.
- [MaxScale MaxScale Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-maxscale-resource.md): Retrieve global instance details. Access version information, manage global configuration parameters, and monitor the logging status of your MaxScale instance.
- [MaxScale Monitor Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-monitor-resource.md): Control server monitoring modules. This resource allows you to configure monitors, check cluster health status, and modify monitoring parameters dynamically.
- [MaxScale Object Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-object-resource.md): Interact with generic MaxScale objects. This endpoint provides a unified interface for retrieving and managing configuration objects across the instance.
- [MaxScale REST API](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-rest-api.md): Understand the fundamentals of the MaxScale REST API. This guide details API versioning, JSON Web Token authentication, and the standard JSON response format.
- [MaxScale Role Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-role-resource.md): Define and assign access roles. This resource allows you to manage permissions for MaxScale administrative users, controlling their access to API resources.
- [MaxScale Server Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-server-resource.md): Administer backend database servers. Use this resource to add, remove, or modify server definitions and view their current runtime state and statistics.
- [MaxScale Service Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-service-resource.md): Configure routing services. This resource manages the core services that define how MaxScale routes and balances traffic between clients and backend servers.
- [MaxScale Session Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-session-resource.md): Inspect and manage active client sessions. This resource allows you to view connected clients, check session details, and terminate specific connections.
- [MaxScale SQL Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-sql-resource.md): Execute SQL statements via the API. This resource provides an interface for running queries against backend servers or ODBC targets directly over HTTP.
- [MaxScale Routers](https://mariadb.com/docs/maxscale/reference/maxscale-routers.md): Explore the available routing modules in MariaDB MaxScale. This reference covers routers for read-write splitting, connection balancing, sharding, and specialized traffic management.
- [MaxScale Binlogrouter](https://mariadb.com/docs/maxscale/reference/maxscale-routers/maxscale-binlogrouter.md): Replicate binary logs from a primary server to local storage. This router serves as an intermediate replication master reducing load on the primary database in large clusters.
- [MaxScale Cat](https://mariadb.com/docs/maxscale/reference/maxscale-routers/maxscale-cat.md): Concatenate result sets from multiple backend servers into a single response. This router is useful for querying partitioned data or aggregating results from distributed nodes.
- [MaxScale Diff](https://mariadb.com/docs/maxscale/reference/maxscale-routers/maxscale-diff.md): Compare the behavior of two MariaDB server versions. The Diff router executes queries against a main and a test server to detect discrepancies in results or performance.
- [MaxScale Exasolrouter](https://mariadb.com/docs/maxscale/reference/maxscale-routers/maxscale-exasolrouter.md): Route analytical queries to an Exasol cluster. This router integrates Exasol with MaxScale often used alongside SmartRouter for hybrid transactional/analytical workloads.
- [MaxScale KafkaCDC](https://mariadb.com/docs/maxscale/reference/maxscale-routers/maxscale-kafkacdc.md): Stream replication events from MariaDB to Apache Kafka. This router captures data changes (CDC) and publishes them as JSON objects to Kafka topics for downstream processing.
- [MaxScale KafkaImporter](https://mariadb.com/docs/maxscale/reference/maxscale-routers/maxscale-kafkaimporter.md): Import data from Apache Kafka into MariaDB. This router consumes messages from Kafka topics and applies them as transactions to your database tables.
- [MaxScale Mirror](https://mariadb.com/docs/maxscale/reference/maxscale-routers/maxscale-mirror.md): Duplicate client queries to multiple targets. The Mirror router sends traffic to a primary server while asynchronously forwarding the same queries to a secondary server for testing.
- [MaxScale Readconnroute](https://mariadb.com/docs/maxscale/reference/maxscale-routers/maxscale-readconnroute.md): Balance connections across backend servers. This lightweight router distributes new client connections to available nodes without inspecting individual SQL statements.
- [MaxScale Readwritesplit](https://mariadb.com/docs/maxscale/reference/maxscale-routers/maxscale-readwritesplit.md): Optimize query performance with read-write splitting. This router directs write queries to the primary server and load balances read queries across available replica nodes.
- [MaxScale SchemaRouter](https://mariadb.com/docs/maxscale/reference/maxscale-routers/maxscale-schemarouter.md): Implement database sharding with a single logical entry point. The SchemaRouter routes queries to specific backend servers based on the database or table being accessed.
- [MaxScale SmartRouter](https://mariadb.com/docs/maxscale/reference/maxscale-routers/maxscale-smartrouter.md): Intelligently route queries based on workload type. SmartRouter directs transactional queries to MariaDB and analytical queries to column-store engines for hybrid processing.
- [MaxScale Servers](https://mariadb.com/docs/maxscale/reference/maxscale-servers.md): Define backend database servers in MaxScale. This reference explains how to configure server objects, set addresses and ports, and manage connection pools for your database cluster.
- [MaxScale Listeners](https://mariadb.com/docs/maxscale/reference/maxscale-listeners.md): Configure listening ports for client connections. This reference details how to define listeners, associate them with services, and enable protocol features like Proxy Protocol.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://mariadb.com/docs/maxscale/reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.