MariaDB

https://mariadb.com/docs/
Admin
MariaDB is a popular open-source relational database management system (RDBMS) that provides a...
Tokens:7,299,841
Snippets:62,279
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Create and start install testing image

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-debian/buildbot-setup-for-virtual-machines-debian-5-i386

Creates a qcow2 image for install testing and starts a KVM instance. Then installs debconf-utils, adds a local apt repository to sources.list, and sets debconf selections from /tmp/my.seed.

```bash
qemu-img create -b vm-debian5-i386-serial.qcow2 -f qcow2 vm-debian5-i386-install.qcow2
kvm -m 2047 -hda /kvm/vms/vm-debian5-i386-install.qcow2 -redir 'tcp:2226::22' -boot c -smp 2 -cpu qemu32,-nx -net nic,model=virtio -net user -nographic

# No packages mostly!
sudo apt-get install debconf-utils

cat >>/etc/apt/sources.list <<END
deb file:///home/buildbot/buildbot/debs binary/
deb-src file:///home/buildbot/buildbot/debs source/
END

sudo debconf-set-selections /tmp/my.seed
```

--------------------------------

### Create and start install-test VM

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-debian/buildbot-setup-for-virtual-machines-debian-4-i386

Creates a QEMU copy-on-write image for install testing and starts a KVM instance with port forwarding. This VM is used to test package installation.

```bash
qemu-img create -b vm-debian4-i386-serial.qcow2 -f qcow2 vm-debian4-i386-install.qcow2
kvm -m 2047 -hda /kvm/vms/vm-debian4-i386-install.qcow2 -cdrom /kvm/debian-40r8-i386-netinst.iso -redir 'tcp:2241::22' -boot c -smp 2 -cpu qemu32,-nx -net nic,model=e1000 -net user -nographic
```

--------------------------------

### Create and start upgrade testing image

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-debian/buildbot-setup-for-virtual-machines-debian-5-i386

Creates a qcow2 image based on the install image and starts a KVM instance. Then installs mysql-server-5.0 and runs a MySQL command to create a test database, table, and insert data.

```bash
qemu-img create -b vm-debian5-i386-install.qcow2 -f qcow2 vm-debian5-i386-upgrade.qcow2
kvm -m 2047 -hda /kvm/vms/vm-debian5-i386-upgrade.qcow2 -redir 'tcp:2226::22' -boot c -smp 2 -cpu qemu32,-nx -net nic,model=virtio -net user -nographic

sudo apt-get install mysql-server-5.0
mysql -uroot -prootpass -e "create database mytest; use mytest; create table t(a int primary key); insert into t values (1); select * from t"
```

--------------------------------

### Create and start install/test VM

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-red-hat/buildbot-setup-for-virtual-machines-centos-5-i386

Creates a new QEMU image for installation and testing purposes and starts the KVM instance.

```bash
qemu-img create -b vm-centos5-i386-serial.qcow2 -f qcow2 vm-centos5-i386-install.qcow2
kvm -m 2047 -hda /kvm/vms/vm-centos5-i386-install.qcow2 -cdrom /kvm/CentOS-5.3-i386-bin-DVD.iso -redir 'tcp:2225::22' -boot c -smp 2 -cpu qemu32,-nx -net nic,model=virtio -net user -nographic
```

--------------------------------

### Start Fedora 20 VMs from install ISO

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-red-hat/buildbot-setup-for-virtual-machines-fedora-20

Boots each VM from the Fedora 20 install ISO, with port redirection for SSH (2291 for i386, 2292 for amd64) and QEMU parameters for memory, CPU, and virtio networking. Use these commands to start the installation process for both VMs.

```bash
kvm -m 2048 -hda /kvm/vms/vm-fedora20-i386-serial.qcow2 -cdrom /ds413/iso/fedora/Fedora-20-i386-DVD.iso -redir tcp:2291::22 -boot d -smp 2 -cpu qemu64 -net nic,model=virtio -net user
kvm -m 2048 -hda /kvm/vms/vm-fedora20-amd64-serial.qcow2 -cdrom /ds413/iso/fedora/Fedora-20-x86_64-DVD.iso -redir tcp:2292::22 -boot d -smp 2 -cpu qemu64 -net nic,model=virtio -net user
```

--------------------------------

### Create and Populate Example Tables (books and authors)

Source: https://mariadb.com/docs/server/mariadb-quickstart-guides/mariadb-selecting-data-guide

Use this to create and populate the `books` and `authors` tables with sample data before running the guide's other examples.

```sql
CREATE OR REPLACE TABLE books (
    isbn CHAR(20) PRIMARY KEY,
    title VARCHAR(50),
    author_id INT,
    publisher_id INT,
    year_pub CHAR(4),
    description TEXT
);

CREATE OR REPLACE TABLE authors (
    author_id INT AUTO_INCREMENT PRIMARY KEY,
    name_last VARCHAR(50),
    name_first VARCHAR(50),
    country VARCHAR(50)
);

INSERT INTO authors (name_last, name_first, country) VALUES
  ('Kafka', 'Franz', 'Czech Republic'),
  ('Dostoevsky', 'Fyodor', 'Russia');

INSERT INTO books (title, author_id, isbn, year_pub) VALUES
 ('The Trial', 1, '0805210407', '1995'),
 ('The Metamorphosis', 1, '0553213695', '1995'),
 ('America', 2, '0805210644', '1995'), -- Note: Original data had author_id 2 for 'America', Dostoevsky is author_id 2.
 ('Brothers Karamozov', 2, '0553212168', ''),
 ('Crime & Punishment', 2, '0679420290', ''),
 ('Crime & Punishment', 2, '0553211757', ''),
 ('Idiot', 2, '0192834118', ''),
 ('Notes from Underground', 2, '067973452X', '');
```

--------------------------------

### Boot Fedora 20 VMs from disk after install

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-red-hat/buildbot-setup-for-virtual-machines-fedora-20

Boots each VM from disk after the initial installation reboot fails. Kills the failed VM and starts it again with -boot c to continue setup.

```bash
kvm -m 2048 -hda /kvm/vms/vm-fedora20-i386-serial.qcow2 -redir tcp:2291::22 -boot c -smp 2 -cpu qemu64 -net nic,model=virtio -net user
kvm -m 2048 -hda /kvm/vms/vm-fedora20-amd64-serial.qcow2 -redir tcp:2292::22 -boot c -smp 2 -cpu qemu64 -net nic,model=virtio -net user
```

--------------------------------

### ST_STARTPOINT Example

Source: https://mariadb.com/docs/server/reference/sql-statements/geometry-constructors/linestring-properties/st_startpoint

Demonstrates using StartPoint with GeomFromText to get the start point of a LineString. The output shows the result as POINT(1 1).

```sql
SET @ls = 'LineString(1 1,2 2,3 3)';

SELECT AsText(StartPoint(GeomFromText(@ls)));
+---------------------------------------+
| AsText(StartPoint(GeomFromText(@ls))) |
+---------------------------------------+
| POINT(1 1)                            |
+---------------------------------------+
```

--------------------------------

### Create and start upgrade-test VM

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-debian/buildbot-setup-for-virtual-machines-debian-4-i386

Creates a QEMU copy-on-write image based on the install-test VM and starts a KVM instance with port forwarding. Then installs MySQL server 5.0 and runs a basic SQL test to verify the upgrade.

```bash
qemu-img create -b vm-debian4-i386-install.qcow2 -f qcow2 vm-debian4-i386-upgrade.qcow2
kvm -m 2047 -hda /kvm/vms/vm-debian4-i386-upgrade.qcow2 -cdrom /kvm/debian-40r8-i386-netinst.iso -redir 'tcp:2241::22' -boot c -smp 2 -cpu qemu64 -net nic,model=e1000 -net user -nographic

sudo apt-get install mysql-server-5.0
mysql -uroot -prootpass -e "create database mytest; use mytest; create table t(a int primary key); insert into t values (1); select * from t"
```

--------------------------------

### Create volumes and start MariaDB container for logical backup

Source: https://mariadb.com/docs/server/server-management/automated-mariadb-deployment-and-administration/docker-and-mariadb/container-backup-and-restoration

Creates the mariadb_data and mariadb_backup volumes, sets permissions, and starts a MariaDB container with the root password environment variable. This setup is assumed for the logical backup examples.

```bash
$ docker volume create mariadb_data
$ docker volume create mariadb_backup
$ docker run --rm \
  -v mariadb_data:/var/lib/mysql \
  -v mariadb_backup:/backup \
  mariadb \
  chown -R mysql:mysql /var/lib/mysql /backup
$ docker run -d --name mariadb \
  -v mariadb_data:/var/lib/mysql \
  -v mariadb_backup:/backup \
  -e MARIADB_ROOT_PASSWORD='MariaDB11!' \
  <mariadb-image>
```

--------------------------------

### Create and boot upgrade testing VM with MySQL setup

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-debian/buildbot-setup-for-virtual-machines-debian-4-amd64

Creates an upgrade testing VM from the install VM and boots it with KVM. Then installs MySQL server 5.0 and creates a test database with a table and sample data.

```bash
qemu-img create -b vm-debian4-amd64-install.qcow2 -f qcow2 vm-debian4-amd64-upgrade.qcow2
kvm -m 2047 -hda /kvm/vms/vm-debian4-amd64-upgrade.qcow2 -cdrom /kvm/debian-40r8-amd64-netinst.iso -redir 'tcp:2240::22' -boot c -smp 2 -cpu qemu64 -net nic,model=e1000 -net user -nographic

sudo apt-get install mysql-server-5.0
mysql -uroot -prootpass -e "create database mytest; use mytest; create table t(a int primary key); insert into t values (1); select * from t"
```

--------------------------------

### Create and start VM for upgrade testing

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-debian/buildbot-setup-for-virtual-machines-debian-6-i386

Creates a qcow2 image based on the install-testing VM and starts it with KVM. Then installs mysql-server-5.1 and runs a simple MySQL test to create a database, table, insert, and select.

```bash
qemu-img create -b vm-debian6-i386-install.qcow2 -f qcow2 vm-debian6-i386-upgrade.qcow2
kvm -m 2047 -hda /kvm/vms/vm-debian6-i386-upgrade.qcow2 -redir 'tcp:2245::22' -boot c -smp 2 -cpu qemu64 -net nic,model=virtio -net user -nographic

sudo apt-get install mysql-server-5.1
mysql -uroot -prootpass -e "create database mytest; use mytest; create table t(a int primary key); insert into t values (1); select * from t"
```

--------------------------------

### Using transactions with the C++ Thin Client

Source: https://mariadb.com/docs/release-notes/gridgain-8/release-notes_8.7.26

Example of using transactions with the C++ thin client. Shows starting a transaction, putting and getting values, and rolling back.

```cpp
#include <ignite/thin/ignite_client.h>

using namespace ignite;

void Example(IgniteClient client) {
    cache::CacheClient<int, int> cache = client.GetOrCreateCache<int, int>("example");

    transactions::ClientTransactions transactions = client.ClientTransactions();

    cache.Put(1, 1);
    assert(1 == cache.Get(1));

    transactions::ClientTransaction tx = transactions.TxStart();

    cache.Put(1, 10);
    assert(10 == cache.Get(1));

    tx.Rollback();
    assert(1 == cache.Get(1));
}
```

--------------------------------

### Check Connection resource status with kubectl get connections

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/security/tls

After applying a Connection resource, run this command to verify the TLS setup. A `Ready` state with STATUS `True` indicates the TLS certificates are correctly issued and configured.

```bash
kubectl get connections
NAME                         READY   STATUS    SECRET                AGE
connection                   True    Ready     mariadb                
connection-maxscale          True    Ready     mariadb                
```

--------------------------------

### Replication configuration YAML example

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/topologies/replication

Example MariaDB custom resource with replication settings enabled. Shows all available replication options: gtidStrictMode, semiSyncEnabled, semiSyncAckTimeout, semiSyncWaitPoint, semiSyncWaitNoSlave, semiSyncBootAsReplica, syncBinlog, and standaloneProbes. The options are used by the operator to create a replication configuration file applied to all nodes in the cluster.

```yaml
apiVersion: enterprise.mariadb.com/v1alpha1
kind: MariaDB
metadata:
  name: mariadb-repl
spec:
  storage:
    size: 1Gi
  replicas: 3
  replication:
    enabled: true
    gtidStrictMode: true
    semiSyncEnabled: true
    semiSyncAckTimeout: 10s
    semiSyncWaitPoint: AfterCommit
    semiSyncWaitNoSlave: true
    semiSyncBootAsReplica: false
    syncBinlog: 1
    standaloneProbes: false
```

--------------------------------

### SHOW CREATE SERVER example with output

Source: https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/show/show-create-server

Example showing the SHOW CREATE SERVER statement and its output for server 'srv1'.

```sql
SHOW CREATE SERVER srv1\G
```

```output
*************************** 1. row ***************************
       Server: srv1
Create Server: CREATE SERVER `srv1` FOREIGN DATA WRAPPER mysql 
  OPTIONS (HOST '172.30.0.58', DATABASE 'db1', USER 'maxscale', PASSWORD 'password');
```

--------------------------------

### Example odbcinst.ini Driver Definition

Source: https://mariadb.com/docs/connectors/connectors-quickstart-guides/connector-odbc-guide

Defines the MariaDB ODBC driver in odbcinst.ini. The installer usually places this file in /etc/odbcinst.ini. Adjust the Driver and Setup paths for your system.

```ini
[MariaDB ODBC Driver]
Description = MariaDB Connector/ODBC
Driver = /usr/lib/x86_64-linux-gnu/odbc/libmaodbc.so # Adjust path for your system
Setup = /usr/lib/x86_64-linux-gnu/odbc/libmaodbc.so # Adjust path for your system
UsageCount = 1
FileUsage = 1
CPTimeout =
CPReconnect =
```

--------------------------------

### Example Configuration for ColumnStore HTAP

Source: https://mariadb.com/docs/server/architecture/topologies/htap/step-3-start-and-configure-mariadb-enterprise-server

Example MariaDB Enterprise Server configuration for HTAP. Set on each ColumnStore node. Note that the loose- prefix is required for ColumnStore system variables; without it the server may fail to start if the ColumnStore plugin is not installed.

```ini
[mariadb]
log_error                              = mariadbd.err
character_set_server                   = utf8
collation_server                       = utf8_general_ci

# Replication Configuration (HTAP Server)
server_id                     = 1
log_bin                       = mariadb-bin
binlog_format                 = STATEMENT
log_slave_updates             = OFF
loose-columnstore_replication_slave = ON

# HTAP filtering rules

# Transactions replicate from same server
replicate_same_server_id = ON

# Only write queries that touch 'innodb_db' to the binary log
binlog_do_db = innodb_db

# Rewrite innodb_db to columnstore_db prior to applying transaction
replicate_rewrite_db = innodb_db->columnstore_db

# Only replicate tables that begin with "htap"
replicate_wild_do_table = columnstore_db.htap%
```

--------------------------------

### Create and populate tables t1 and t2

Source: https://mariadb.com/docs/server/mariadb-quickstart-guides/mariadb-join-guide

Setup SQL that creates two simple tables, t1 and t2, and inserts sample data used by all JOIN examples in this guide.

```sql
CREATE TABLE t1 ( a INT );
CREATE TABLE t2 ( b INT );

INSERT INTO t1 VALUES (1), (2), (3);
INSERT INTO t2 VALUES (2), (4);
```

--------------------------------

### Create and start build VM

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-debian/buildbot-setup-for-virtual-machines-debian-4-i386

Creates a QEMU copy-on-write image based on a serial VM and starts a KVM instance with port forwarding. Then installs build dependencies for MySQL server 5.0 and additional packages. Note that some latex packages may fail due to old source; setting back the clock temporarily can help.

```bash
qemu-img create -b vm-debian4-i386-serial.qcow2 -f qcow2 vm-debian4-i386-build.qcow2
kvm -m 2047 -hda /kvm/vms/vm-debian4-i386-build.qcow2 -cdrom /kvm/debian-40r8-i386-netinst.iso -redir 'tcp:2241::22' -boot c -smp 2 -cpu qemu32,-nx -net nic,model=e1000 -net user -nographic

sudo apt-get build-dep mysql-server-5.0
# Some latex packages fail to install because they complain that the
# source is more than 5 years old! I solved by setting back the clock a
# couple of years temporarily ...
sudo apt-get install devscripts doxygen texlive-latex-base gs lsb-release fakeroot libevent-dev libssl-dev zlib1g-dev libreadline5-dev
```

--------------------------------

### START TRANSACTION READ ONLY, WITH CONSISTENT SNAPSHOT example

Source: https://mariadb.com/docs/server/ha-and-performance/standard-replication/enhancements-for-start-transaction-with-consistent-snapshot

Example using START TRANSACTION with both READ ONLY and WITH CONSISTENT SNAPSHOT characteristics.

```sql
START TRANSACTION READ ONLY, WITH CONSISTENT SNAPSHOT;
```

--------------------------------

### MariaDB resource update example

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/updates

Shows a diff of a MariaDB resource where the image and memory limits are updated. Any change to the Pod template triggers an update.

```yaml
apiVersion: enterprise.mariadb.com/v1alpha1
kind: MariaDB
metadata:
  name: mariadb
spec:
  # [...]
- image: docker.mariadb.com/enterprise-server:10.6.18-14.2
+ image: docker.mariadb.com/enterprise-server:10.6.19-15.1
  resources:
    requests:
      cpu: 200m
      memory: 128Mi
    limits:
-     memory: 1Gi
+     memory: 2Gi
  # [...]
```

--------------------------------

### Create a Debian VM for upgrade testing and install MySQL 5.0

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-debian/buildbot-setup-for-virtual-machines-debian-5-amd64

Creates a qcow2 snapshot based on the install-testing image and boots it, then installs mysql-server-5.0 and runs a quick MySQL command to create a database, table, insert a row, and select from it for upgrade testing.

```text
qemu-img create -b vm-debian5-amd64-install.qcow2 -f qcow2 vm-debian5-amd64-upgrade.qcow2
kvm -m 2047 -hda /kvm/vms/vm-debian5-amd64-upgrade.qcow2 -redir 'tcp:2234::22' -boot c -smp 2 -cpu qemu64 -net nic,model=virtio -net user -nographic

sudo apt-get install mysql-server-5.0
mysql -uroot -prootpass -e "create database mytest; use mytest; create table t(a int primary key); insert into t values (1); select * from t"
```

--------------------------------

### Start installed VMs with boot from disk

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-red-hat/buildbot-setup-for-virtual-machines-centos-62

Starts the installed VMs with boot from disk, without the CD-ROM, after the initial reboot fails.

```shell
kvm -m 1024 -hda /kvm/vms/vm-centos6-amd64-serial.qcow2 -redir tcp:22255::22 -boot c -smp 2 -cpu qemu64 -net nic,model=virtio -net user

kvm -m 1024 -hda /kvm/vms/vm-centos6-i386-serial.qcow2 -redir tcp:22256::22 -boot c -smp 2 -cpu qemu32,-nx -net nic,model=virtio -net user
```

--------------------------------

### SUBSTRING function examples

Source: https://mariadb.com/docs/server/reference/sql-functions/string-functions/substring

Shows various forms of the SUBSTRING function: with start position, length, negative start, zero start, and the FROM ... FOR syntax. Each example includes the query and its result table.

```sql
SELECT SUBSTRING('Knowledgebase',5);
+------------------------------+
| SUBSTRING('Knowledgebase',5) |
+------------------------------+
| ledgebase                    |
+------------------------------+

SELECT SUBSTRING('MariaDB' FROM 6);
+-----------------------------+
| SUBSTRING('MariaDB' FROM 6) |
+-----------------------------+
| DB                          |
+-----------------------------+

SELECT SUBSTRING('Knowledgebase',3,7);
+--------------------------------+
| SUBSTRING('Knowledgebase',3,7) |
+--------------------------------+
| owledge                        |
+--------------------------------+

SELECT SUBSTRING('Knowledgebase', -4);
+--------------------------------+
| SUBSTRING('Knowledgebase', -4) |
+--------------------------------+
| base                           |
+--------------------------------+

SELECT SUBSTRING('Knowledgebase', 0);
+--------------------------------+
| SUBSTRING('Knowledgebase', 0)  |
+--------------------------------+
|                                |
+--------------------------------+

SELECT SUBSTRING('Knowledgebase', -8, 4);
+-----------------------------------+
| SUBSTRING('Knowledgebase', -8, 4) |
+-----------------------------------+
| edge                              |
+-----------------------------------+

SELECT SUBSTRING('Knowledgebase' FROM -8 FOR 4);
+------------------------------------------+
| SUBSTRING('Knowledgebase' FROM -8 FOR 4) |
+------------------------------------------+
| edge                                     |
+------------------------------------------+
```

--------------------------------

### Quickstart manifests for Galera cluster

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/topologies/high-availability/galera

Apply these manifests to create a Secret and a MariaDB Galera cluster with 3 replicas and 1Gi storage. The Secret provides the root password referenced by the MariaDB resource.

```yaml
apiVersion: v1
kind: Secret
metadata:
  name: mariadb
stringData:
  root-password: MariaDB11!
---
apiVersion: enterprise.mariadb.com/v1alpha1
kind: MariaDB
metadata:
  name: mariadb-galera
spec:
  rootPasswordSecretKeyRef:
    name: mariadb
    key: root-password
  storage:
    size: 1Gi
  replicas: 3
  galera:
    enabled: true

```

--------------------------------

### SHOW CREATE DATABASE and SHOW CREATE SCHEMA Examples

Source: https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/show/show-create-database

Example output for SHOW CREATE DATABASE and SHOW CREATE SCHEMA on the test database, showing the CREATE DATABASE statement with quoted database name.

```sql
SHOW CREATE DATABASE test;
+----------+-----------------------------------------------------------------+
| Database | Create Database                                                 |
+----------+-----------------------------------------------------------------+
| test     | CREATE DATABASE `test` /*!40100 DEFAULT CHARACTER SET latin1 */ |
+----------+-----------------------------------------------------------------+

SHOW CREATE SCHEMA test;
+----------+-----------------------------------------------------------------+
| Database | Create Database                                                 |
+----------+-----------------------------------------------------------------+
| test     | CREATE DATABASE `test` /*!40100 DEFAULT CHARACTER SET latin1 */ |
+----------+-----------------------------------------------------------------+
```

--------------------------------

### Provide global configuration via spec.config.params

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/topologies/maxscale

Use spec.config.params to provide global configuration parameters that the operator uses to create maxscale.conf. The example also shows a volumeClaimTemplate for storage.

```yaml
apiVersion: enterprise.mariadb.com/v1alpha1
kind: MaxScale
metadata:
  name: maxscale-galera
spec:
  mariaDbRef:
    name: mariadb-galera
  config:
    params:
      log_info: "true"
    volumeClaimTemplate:
      resources:
        requests:
          storage: 100Mi
      accessModes:
        - ReadWriteOnce
```

--------------------------------

### Check MariaDB status after switchover

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/topologies/replication

Use `kubectl get mariadb` to view the status of the MariaDB resource. The output shows the switchover in progress, with the primary changing to 'mariadb-repl-1'.

```bash
kubectl get mariadb
NAME           READY   STATUS                                  PRIMARY          UPDATES                    AGE
mariadb-repl   False   Switching primary to 'mariadb-repl-1'   mariadb-repl-0   ReplicasFirstPrimaryLast   3d2h
```

--------------------------------

### Test TLS with Connection for MaxScale

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/security/tls

Defines a Connection resource targeting a MaxScale instance (maxScaleRef: maxscale-galera) to validate TLS certificates. Uses the same credentials and client certificate as the MariaDB connection example. A Ready state confirms the TLS setup is correct.

```yaml
apiVersion: enterprise.mariadb.com/v1alpha1
kind: Connection
metadata:
  name: connection-maxscale
spec:
  maxScaleRef:
    name: maxscale-galera
  username: mariadb
  passwordSecretKeyRef:
    name: mariadb
    key: password
  tlsClientCertSecretRef:
    name: mariadb-galera-client-cert
  database: mariadb
  healthCheck:
    interval: 30s

```

--------------------------------

### Get contracts response example

Source: https://mariadb.com/docs/mariadb-cloud/reference/mariadb-cloud-api-reference-guide/billing

Example JSON response for the GET /billing/v1/contracts/{org_id} endpoint, showing the structure of a contract object including entitlements.

```JSON
[
  {
    "billing_mode": "text",
    "created_at": "text",
    "created_by": "text",
    "currency": "text",
    "end_date": "text",
    "entitlements": [
      {
        "contract_id": "text",
        "created_at": "text",
        "end_date": "text",
        "entitlement_id": "text",
        "id": "text",
        "spec": null,
        "start_date": "text"
      }
    ],
    "estimated_contract_commit": 1,
    "estimated_contract_value": 1,
    "execution_date": "text",
    "id": "text",
    "integration_id": "text",
    "marketing_collaboration_discount": true,
    "org_id": "text",
    "renewal_date": "text",
    "renewal_id": "text",
    "start_date": "text",
    "state": "text",
    "updated_at": "text",
    "updated_by": "text"
  }
]
```

--------------------------------

### Create and start VM for building .deb packages

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-debian/buildbot-setup-for-virtual-machines-debian-6-i386

Creates a qcow2 image based on the serial VM and starts it with KVM, forwarding port 2245 to SSH. Then installs build dependencies for mysql-server-5.1 and additional packages needed for building.

```bash
qemu-img create -b vm-debian6-i386-serial.qcow2 -f qcow2 vm-debian6-i386-build.qcow2
kvm -m 2047 -hda /kvm/vms/vm-debian6-i386-build.qcow2 -redir 'tcp:2245::22' -boot c -smp 2 -cpu qemu64 -net nic,model=virtio -net user -nographic

sudo apt-get build-dep mysql-server-5.1
sudo apt-get install devscripts hardening-wrapper doxygen texlive-latex-base ghostscript libevent-dev libssl-dev zlib1g-dev libreadline-dev
```

--------------------------------

### Configure MariaDB certificate lifetime with cert-manager

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/security/tls

Example of specifying certificate configuration alongside an issuer reference for a MariaDB resource.

```yaml
apiVersion: enterprise.mariadb.com/v1alpha1
kind: MariaDB
metadata:
  name: mariadb-galera
spec:
  # [...]
  tls:
    enabled: true
    required: true
    serverCertIssuerRef:
      name: root-ca
      kind: ClusterIssuer
    serverCertConfig:
      caLifetime: 8766h # 1 year
      certLifetime: 720h # 1 month
    clientCertIssuerRef:
      name: root-ca
      kind: ClusterIssuer
    clientCertConfig:
      caLifetime: 8766h # 1 year
      certLifetime: 720h # 1 month
  # [...]
```

--------------------------------

### GET /provisioning/v1/configs/{config_id}/values - Response example

Source: https://mariadb.com/docs/mariadb-cloud/reference/mariadb-cloud-api-reference-guide/config

Example response body for the GET config values endpoint. Shows the structure with config_key_id and selected_values array.

```JSON
[
  {
    "config_key_id": "text",
    "selected_values": [
      "text"
    ]
  }
]
```

--------------------------------

### Configure MaxScale certificate lifetime with cert-manager

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/security/tls

Example of specifying certificate configuration alongside an issuer reference for a MaxScale resource.

```yaml
apiVersion: enterprise.mariadb.com/v1alpha1
kind: MaxScale
metadata:
  name: maxscale-galera
spec:
  # [...]
  tls:
    enabled: true
    adminCertIssuerRef:
      name: root-ca
      kind: ClusterIssuer
    adminCertConfig:
      caLifetime: 8766h # 1 year
      certLifetime: 1h # 1 month
    listenerCertIssuerRef:
      name: root-ca
      kind: ClusterIssuer
    listenerCertConfig:
      caLifetime: 8766h # 1 year
      certLifetime: 720h # 1 month
  # [...]
```

--------------------------------

### CREATE CATALOG example

Source: https://mariadb.com/docs/server/security/user-account-management/catalogs/create-catalog

Example of creating a catalog, switching to it, creating a user, granting privileges, and creating a database.

```sql
CREATE CATALOG cat1;
USE CATALOG cat1;
CREATE USER root@localhost;
GRANT ALL PRIVILEGES ON *.* TO root@localhost;
CREATE DATABASE test;

```

--------------------------------

### Start firewalld service

Source: https://mariadb.com/docs/analytics/mariadb-columnstore/management/deployment/install-guide/single-node-s3.md

Start the firewalld service if it was stopped during installation.

```bash
$ sudo systemctl start firewalld
```

--------------------------------

### Verify old primary Ready status (kubectl get + jq)

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/topologies/high-availability/multi-cluster

Retrieves the status of the old primary cluster and filters it with jq to show conditions, currentPrimary, and currentMultiClusterPrimary. The output shows the Ready condition is True and currentMultiClusterPrimary is mariadb-eu-central.

```bash
kubectl get mariadb mariadb-eu-south -o jsonpath="{.status}" | jq '{conditions: .conditions, currentPrimary: .currentPrimary, currentMultiClusterPrimary: .currentMultiClusterPrimary}'
{
  "conditions": [
    {
      "lastTransitionTime": "2026-05-25T15:44:41Z",
      "message": "Running",
      "reason": "StatefulSetReady",
      "status": "True",
      "type": "Ready"
    },
    # [...]
  ],
  "currentPrimary": "mariadb-eu-south-0",
  "currentMultiClusterPrimary": "mariadb-eu-central"
}
```

--------------------------------

### create server command usage and options

Source: https://mariadb.com/docs/maxscale/reference/maxscale-maxctrl

Shows the full help output for the 'create server' command, including usage, options, and notes. The created server is not linked to any services or monitors unless --services or --monitors are given. The new key=value syntax is recommended for parameters.

```text
Usage: create server <name> <host|socket> [port] [params...]

Create server options:
      --services  Link the created server to these services  [array]
      --monitors  Link the created server to these monitors  [array]

Global Options:
  -c, --config     MaxCtrl configuration file  [string] [default: "~/.maxctrl.cnf"]
  -u, --user       Username to use  [string] [default: "admin"]
  -p, --password   Password for the user. To input the password manually, use -p '' or --password=''  [string] [default: "mariadb"]
  -h, --hosts      List of MaxScale hosts. The hosts must be in HOST:PORT format and each value must be separated by a comma.  [string] [default: "127.0.0.1:8989"]
  -t, --timeout    Request timeout in plain milliseconds, e.g '-t 1000', or as duration with suffix [h|m|s|ms], e.g. '-t 10s'  [string] [default: "10000"]
  -q, --quiet      Silence all output. Ignored while in interactive mode.  [boolean] [default: false]
      --tsv        Print tab separated output  [boolean] [default: false]
      --skip-sync  Disable configuration synchronization for this command  [boolean] [default: false]

HTTPS/TLS Options:
  -s, --secure                  Enable HTTPS requests  [boolean] [default: false]
      --tls-key                 Path to TLS private key  [string]
      --tls-passphrase          Password for the TLS private key  [string]
      --tls-cert                Path to TLS public certificate  [string]
      --tls-ca-cert             Path to TLS CA certificate  [string]
  -n, --tls-verify-server-cert  Whether to verify server TLS certificates  [boolean] [default: true]

Options:
      --version  Show version number  [boolean]
      --help     Show help  [boolean]

The created server will not be used by any services or monitors unless the --services or --monitors options are given. The list of servers a service or a monitor uses can be altered with the `link` and `unlink` commands. If the <host|socket> argument is an absolute path, the server will use a local UNIX domain socket connection. In this case the [port] argument is ignored.

The recommended way of declaring parameters is with the new `key=value` syntax added in MaxScale 6.2.0. Note that for some parameters (e.g. `extra_port` and `proxy_protocol`) this is the only way to pass them. The redundant option parameters have been deprecated in MaxScale 22.08.
```

--------------------------------

### Install Sphinx on Red Hat/CentOS from RPM packages

Source: https://mariadb.com/docs/server/server-usage/storage-engines/sphinx-storage-engine/installing-sphinx

Installs dependencies and the Sphinx RPM package. The daemon is named searchd and the service is started with service searchd start.

```bash
sudo yum install postgresql-libs unixODBC
```

```bash
sudo rpm -Uhv sphinx*.rpm
```

```bash
service searchd start
```

--------------------------------

### Verify bootstrap conditions with kubectl get mariadb

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/topologies/high-availability/multi-cluster

Use this command to check the BackupRestored and ReplicationConfigured conditions in the replica cluster status. The output shows the conditions, currentPrimary, and currentMultiClusterPrimary fields.

```bash
kubectl get mariadb mariadb-eu-central -o jsonpath="{.status}" | jq '{conditions: .conditions, currentPrimary: .currentPrimary, currentMultiClusterPrimary: .currentMultiClusterPrimary}'
{
  "conditions": [
    {
      "lastTransitionTime": "2026-05-25T18:11:14Z",
      "message": "Running",
      "reason": "StatefulSetReady",
      "status": "True",
      "type": "Ready"
    },
    {
      "lastTransitionTime": "2026-05-25T18:10:55Z",
      "message": "Restored physical backup",
      "reason": "RestorePhysicalBackup",
      "status": "True",
      "type": "BackupRestored"
    },
    {
      "lastTransitionTime": "2026-05-25T18:10:55Z",
      "message": "Replication configured",
      "reason": "ReplicationConfigured",
      "status": "True",
      "type": "ReplicationConfigured"
    }
  ],
  "currentPrimary": "mariadb-eu-central-0",
  "currentMultiClusterPrimary": "mariadb-eu-south"
}
```

--------------------------------

### ETL start response example

Source: https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-sql-resource

Example JSON response from the /v1/sql/:id/queries/:query_id endpoint after an ETL start operation. Shows the loaded data and execution time.

```json
{
    "data": {
        "attributes": {
            "execution_time": 0.0094386039999999997,
            "results": {
                "ok": true,
                "stage": "load",
                "tables": [
                    {
                        "create": "CREATE DATABASE IF NOT EXISTS `test`;\nUSE `test`;\nCREATE TABLE `t1` (\n  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,\n  `data` varchar(255) DEFAULT NULL,\n  UNIQUE KEY `id` (`id`)\n) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci",
                        "execution_time": 0.0033923809999999999,
                        "insert": "INSERT INTO `test`.`t1` (`id`,`data`) VALUES (?,?)",
                        "rows": 1,
                        "schema": "test",
                        "select": "SELECT `id`,`data` FROM `test`.`t1`",
                        "table": "t1"
                    }
                ]
            },
            "sql": "ETL"
        },
        "id": "1391b67e-58a7-4be3-b686-2498cb3a0e06.1",
        "type": "queries"
    },
    "links": {
        "self": "http://localhost:8989/v1/sql/1391b67e-58a7-4be3-b686-2498cb3a0e06/queries/1391b67e-58a7-4be3-b686-2498cb3a0e06.1/"
    }
}
```

--------------------------------

### Create and configure a Debian VM for building .deb packages

Source: https://mariadb.com/docs/server/reference/product-development/server-development/tools/buildbot/setup/buildbot-setup-for-virtual-machines/buildbot-setup-for-virtual-machines-debian/buildbot-setup-for-virtual-machines-debian-5-amd64

Creates a qcow2 snapshot from a serial base image and boots it under KVM with redirection and specific CPU/network options. Then installs build dependencies for creating .deb packages using apt-get build-dep and apt-get install.

```text
qemu-img create -b vm-debian5-amd64-serial.qcow2 -f qcow2 vm-debian5-amd64-build.qcow2
kvm -m 2047 -hda /kvm/vms/vm-debian5-amd64-build.qcow2 -redir 'tcp:2234::22' -boot c -smp 2 -cpu qemu64 -net nic,model=virtio -net user -nographic

sudo apt-get build-dep mysql-server-5.0
sudo apt-get install devscripts hardening-wrapper doxygen texlive-latex-base ghostscript libevent-dev libssl-dev zlib1g-dev libreadline5-dev
```

--------------------------------

### Customize MariaDB resource certificate lifetime

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/security/tls

Example of configuring caLifetime and certLifetime within the MariaDB resource spec.

```yaml
apiVersion: enterprise.mariadb.com/v1alpha1
kind: MariaDB
metadata:
  name: mariadb-galera
spec:
  # [...]
  tls:
    enabled: true
    required: true
    serverCertConfig:
      caLifetime: 8766h # 1 year
      certLifetime: 720h # 1 month
    clientCertConfig:
      caLifetime: 8766h # 1 year
      certLifetime: 720h # 1 month
  # [...]
```

--------------------------------

### GET /organization/v1/users/{user_id} - 200 response example

Source: https://mariadb.com/docs/mariadb-cloud/reference/mariadb-cloud-api-reference-guide/users

Example JSON response for a successful get user by ID request. Shows the structure of a single user object.

```json
{
  "created_by": "text",
  "created_on": 1,
  "email": "text",
  "first_name": "text",
  "id": "text",
  "invited": true,
  "is_active": true,
  "is_deleted": true,
  "last_name": "text",
  "mfa_enabled": true,
  "org": {
    "created_by": "text",
    "created_on": 1,
    "current_owner": "text",
    "id": "text",
    "is_active": true,
    "is_deleted": true,
    "name": "text",
    "tier": "text",
    "updated_by": "text",
    "updated_on": 1
  },
  "org_id": "text",
  "roles": [
    "text"
  ],
  "updated_by": "text",
  "updated_on": 1
}

```

--------------------------------

### Create demo table and show indexes for EXPLAIN

Source: https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/analyze-and-explain-statements/explain

Creates the employees_example table with a primary key, unique key on employee_code, and a composite index on (first_name, last_name), then inserts sample rows and shows the indexes. This setup is used to see how EXPLAIN identifies poor index usage.

```sql
CREATE TABLE IF NOT EXISTS `employees_example` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `first_name` varchar(30) NOT NULL,
  `last_name` varchar(40) NOT NULL,
  `position` varchar(25) NOT NULL,
  `home_address` varchar(50) NOT NULL,
  `home_phone` varchar(12) NOT NULL,
  `employee_code` varchar(25) NOT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `employee_code` (`employee_code`),
  KEY `first_name` (`first_name`,`last_name`)
) ENGINE=Aria;

INSERT INTO `employees_example` 
  (`first_name`, `last_name`, `position`, `home_address`, `home_phone`, `employee_code`)
  VALUES
  ('Mustapha', 'Mond', 'Chief Executive Officer', '692 Promiscuous Plaza', '326-555-3492', 'MM1'),
  ('Henry', 'Foster', 'Store Manager', '314 Savage Circle', '326-555-3847', 'HF1'),
  ('Bernard', 'Marx', 'Cashier', '1240 Ambient Avenue', '326-555-8456', 'BM1'),
  ('Lenina', 'Crowne', 'Cashier', '281 Bumblepuppy Boulevard', '328-555-2349', 'LC1'),
  ('Fanny', 'Crowne', 'Restocker', '1023 Bokanovsky Lane', '326-555-6329', 'FC1'),
  ('Helmholtz', 'Watson', 'Janitor', '944 Soma Court', '329-555-2478', 'HW1');

SHOW INDEXES FROM employees_example;
+-------------------+------------+---------------+--------------+---------------+-----------+-------------+----------+--------+------+------------+---------+---------------+
| Table             | Non_unique | Key_name      | Seq_in_index | Column_name   | Collation | Cardinality | Sub_part | Packed | Null | Index_type | Comment | Index_comment |
+-------------------+------------+---------------+--------------+---------------+-----------+-------------+----------+--------+------+------------+---------+---------------+
| employees_example |          0 | PRIMARY       |            1 | id            | A         |           7 |     NULL | NULL   |      | BTREE      |         |               |
| employees_example |          0 | employee_code |            1 | employee_code | A         |           7 |     NULL | NULL   |      | BTREE      |         |               |
| employees_example |          1 | first_name    |            1 | first_name    | A         |        NULL |     NULL | NULL   |      | BTREE      |         |               |
| employees_example |          1 | first_name    |            2 | last_name     | A         |        NULL |     NULL | NULL   |      | BTREE      |         |               |
+-------------------+------------+---------------+--------------+---------------+-----------+-------------+----------+--------+------+------------+---------+---------------+

```

--------------------------------

### Permission denied writing /var/lib/maxscale error

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/topologies/maxscale

Example error message when the container user lacks write permissions to /var/lib/maxscale. The operator mitigates this by setting a securityContext in the StatefulSet.

```text
Failed to create directory '/var/lib/maxscale/maxscale.cnf.d': 13, Permission denied
```

--------------------------------

### Example .opt file with --plugin-load=$AUTH_PAM_SO

Source: https://mariadb.com/docs/server/clients-and-utilities/testing-tools/mariadb-test/mariadb-test-overview

A .opt file that loads the PAM authentication plugin using the environment variable set by mtr.

```bash
--plugin-load=$AUTH_PAM_SO
```

--------------------------------

### Deploy a MariaDB example

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/examples-catalog

Starts deploying the first example, a MariaDB instance.

```bash
kubectl apply -f examples/mariadb.yaml

```

--------------------------------

### Get Kubernetes events during failover/switchover

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/topologies/replication

Use this command to list events for the MariaDB resource, filtered by object name and sorted by timestamp. The output shows the sequence of events during a primary switchover, including locking, readonly mode, sync, and switch.

```bash
kubectl get events --field-selector involvedObject.name=mariadb-repl --sort-by='.lastTimestamp'

LAST SEEN   TYPE     REASON             OBJECT                 MESSAGE
17s         Normal   PrimaryLock        mariadb/mariadb-repl   Locking primary with read lock
17s         Normal   PrimaryReadonly    mariadb/mariadb-repl   Enabling readonly mode in primary
17s         Normal   ReplicaSync        mariadb/mariadb-repl   Waiting for replicas to be synced with primary
17s         Normal   PrimaryNew         mariadb/mariadb-repl   Configuring new primary at index '0'
7s          Normal   ReplicaConn        mariadb/mariadb-repl   Connecting replicas to new primary at '0'
7s          Normal   PrimaryToReplica   mariadb/mariadb-repl   Unlocking primary '1' and configuring it to be a replica. New primary at '0'
7s          Normal   PrimaryLock        mariadb/mariadb-repl   Unlocking primary
7s          Normal   PrimarySwitched    mariadb/mariadb-repl   Primary switched from index '1' to index '0'
```

--------------------------------

### Install shared configuration

Source: https://mariadb.com/docs/tools/mariadb-enterprise-operator/examples-catalog

Installs the configuration shared by all examples, such as RBAC and CRDs.

```bash
kubectl apply -f examples/config

```
Tokens:
Raw