MariaDB SkySQL customers should assess the availability requirements of their application and choose an appropriate service tier to meet their objectives. MariaDB SkySQL customers are on the Foundation Tier unless they have specifically purchased and paid for Power Tier service.
+| Tier | +Performance Standard | +
|---|---|
| SkySQL Foundation Tier | +• Multi-node configurations will deliver a 99.95% service availability on a per-billing-month basis. | +
| • For example, with this availability target in a 30 day calendar month the maximum service downtime is 21 minutes and 54 seconds. | ++ |
| SkySQL Power Tier | +• Multi-node configurations will deliver a 99.995% service availability on a per-billing-month basis. | +
| • For example, with this availability target in a 30 day calendar month the maximum service downtime is 2 minutes and 11 seconds. | ++ |
Service Downtime is measured at each SkySQL database endpoint as the total number of full minutes, outside of scheduled downtime for maintenance and upgrades, where continuous attempts to establish a connection within the minute fail as reflected in minute-by-minute logs.
+Monthly Uptime Percentage is calculated on a per-billing-month basis as the total number of minutes in a month, minus the number of minutes of measured Service Downtime within the month, divided by the number of minutes in that month. When a service is deployed for only part of a month, it is assumed to be 100% available for the portion of the month that it is not deployed.
+Service Credit is the percentage of the total fees paid by you for a given SkySQL service during the month in which the downtime occurred to be credited if MariaDB approves your claim. The percentage used in calculating Service Credit is dependent on whether the customer is on Foundation Tier or Power Tier, and is dependent on the calculated Monthly Uptime Percentage.
+| Tier | +Monthly Uptime Percentage | +Percentage Applied | +
|---|---|---|
| Foundation Tier | +Less than 99.95%, but greater than or equal to 99.0% | +10% | +
| Foundation Tier | +Less than 99.0% | +25% | +
| Power Tier | +Less than 99.995%, but greater than or equal to 99.0% | +10% | +
| Power Tier | +Less than 99.0% | +25% | +
MariaDB will grant and process claims, provided the customer has satisfied its Customer Obligations and that none of the Exclusions listed apply to the claim. Service Credits will be issued only upon request within 60 days of the end of the billing period of the month of impact to service availability, and upon confirmation of outage. Service Credits will be issued in the form of a monetary credit applied to future use of the service that experienced the Service Downtime. Service Credits will not be applied to fees for any other SkySQL instance.
+The aggregate maximum number of Service Credits to be issued by MariaDB to customers for any and all Service Downtime that occurs in a single billing month will not exceed 50% of the amount due from the customer for the covered service for the applicable month.
+A customer will forfeit their right to receive a Service Credit unless they:
+Out-of-scope configurations
+The Performance Standard does not apply to single instance SkySQL service configuration or services in Technical Preview. Customers requiring High Availability should deploy instead in production-ready multi-node service configuration.
+See "Choose a SkySQL Release" for information on SkySQL services in Technical Preview.
+Underlying infrastructure
+Impact to service availability caused by availability or performance of cloud services used to operate MariaDB SkySQL is excluded. This includes any such outages in Amazon Web Services (AWS) and Amazon Elastic Kubernetes Service (EKS), and Google Cloud Platform (GCP) and Google Kubernetes Engine (GKE).
+Network interruption
+Impact to service availability caused by blocking of network traffic by ISPs, network providers, governments, or third parties is excluded.
+External factors
+Impact to your use of service based on factors outside MariaDB SkySQL are excluded. This includes periods of downtime for your applications.
+Uncorroborated impacts
+Only impacts to service availability detected at point of measurement are subject when determining the uptime percentage. Service availability impacts measured through any other means, such as application instrumentation, are excluded except as also measured as Service Downtime by MariaDB.
+Portal access
+Impact to your ability to access or use the MariaDB SkySQL portal, an interface provided to manage services, is excluded. This includes any component and content linked from the MariaDB SkySQL portal, including Documentation, the Customer Support portal, Monitoring, and Workload Analysis. These components operate independently from database services and do not impact database availability.
+Resource usage
+Impact to service availability caused by usage of system resources, such as problems caused by excessive workload consumption of CPU, disk I/O, disk capacity, memory, and other system resources, are excluded.
+Clients and connectors
+Impact to service availability caused by the use of unsupported third-party clients and connectors is excluded.
+Non-paying customers
+The Performance Standard applies only to paying MariaDB SkySQL customers who are paid-in-full. All other MariaDB SkySQL customers, including those not paid-in-full and those customers participating in a free or credited service trial, are excluded.
+Customer-directed maintenance
+When a customer directs that MariaDB conduct a maintenance operation on a service, any resulting impact to service availability is excluded.
+Customer-approved maintenance
+When a customer approves MariaDB-recommended maintenance on a service, any resulting impact to service availability is excluded.
+Customer-initiated changes
+When a customer initiates changes to their SkySQL services, e.g., via access to the database or via the SkySQL portal, any resulting impact to service availability is excluded.
+Initial provisioning
+Availability of services during initial provisioning, e.g., before a service becomes online, healthy, and available, is excluded.
+Autonomous features enable automatic scaling in response to changes in workload.
+Auto-scale of nodes enables scaling based on load:
+Auto-scale of storage enables expansion of capacity based on usage.
+Autonomous features can be enabled at time of service launch. Autonomous features can be enabled or disabled after launch.
+
Auto-scaling of nodes can be enabled either at time of service launch or after service launch.
+During service launch:
+After service launch, manage Autonomous settings, and enable the desired auto-scaling features.
+Auto-scaling of storage can be enabled either at time of service launch or after service launch.
+During Service Launch:
+After service launch, manage Autonomous settings, and enable the desired auto-scaling features.
+For ColumnStore Data Warehouse, object storage adjusts automatically. Autonomous scaling features for storage are not used by this topology.
+To manage Autonomous settings:
+Automatic scaling occurs based on rules.
+| Policy | +Condition | +Action | +
|---|---|---|
| Auto-Scale Disk | +Disk utilization > 90% sustained for 5 minutes. The disk is expected to run out of capacity in the next 24 hours (predicted based on the last 6 hours of service usage). |
+Upgrade storage to the next available size in 100GB increments. Note: you cannot downgrade storage, the upgrade is irreversible |
+
| Auto-Scale Nodes Out | +CPU utilization > 75% over all replicas sustained for 30 minutes. Number of concurrent sessions > 90% over all replicas sustained for 1 hour. Number of concurrent sessions is expected to hit the maximum within 4 hours (predicted based on the last 2 hours of service usage) |
+Add new replica or node Additional nodes will be of the same size and configuration as existing nodes | +
| Auto-Scale Nodes In | +CPU utilization < 50% over all replicas sustained for 1 hour. Number of concurrent sessions < 50% over all replicas sustained for 1 hour |
+Remove replica or node Node count will not decrease below the initial count set at launch | +
| Auto-Scale Nodes Up | +Number of concurrent sessions is expected to hit the maximum within 4 hours (predicted based on the last 2 hours of service usage) | +Upgrade all nodes to the next available size | +
| Auto-Scale Nodes Down | +CPU utilization < 50% over all replicas sustained for 1 hour. Number of concurrent sessions < 50% over all replicas sustained for 1 hour |
+Downgrade nodes Node size will not decrease below the initial node size set at launch | +
Autonomous actions are not instantaneous.
+Cooldown periods may apply. A cooldown period is the time period after a scaling operation is completed before another scaling operation can occur. The cooldown period for storage scaling is 6 hours.
+ + + + + + + + + + + + + + +Regular and reliable backups are essential to successful recovery of mission critical applications. MariaDB Enterprise Server backup and restore operations are performed using MariaDB Enterprise Backup, an enterprise-build of MariaDB Backup.
+MariaDB Enterprise Backup is compatible with MariaDB Enterprise Server 10.2, 10.3, 10.4, 10.5, and 10.6.
+MariaDB Enterprise Backup creates a file-level backup of data from the MariaDB Enterprise Server data directory. This backup includes temporal data, and the encrypted and unencrypted tablespaces of supported storage engines (e.g., InnoDB, MyRocks, Aria).
+MariaDB Enterprise Server implements:
+Backup support is specific to storage engines. All supported storage engines enable full backup. The InnoDB storage engine additionally supports incremental backup.
+A feature of MariaDB Enterprise Backup and MariaDB Enterprise Server, non-blocking backups minimize workload impact during backups. When MariaDB Enterprise Backup connects to MariaDB Enterprise Server, staging operations are initiated to protect data during read.
+Non-blocking backup functionality differs from historical backup functionality in the following ways:
+FLUSH TABLES WITH READ LOCK, which closed open tables and only allowed tables to be reopened with a read lock during the duration of backups.MariaDB Enterprise Backup creates complete or incremental backups of MariaDB Enterprise Server data, and is also used to restore data from backups produced using MariaDB Enterprise Backup.
+Full backups produced using MariaDB Enterprise Server are not initially point-in-time consistent, and an attempt to restore from a raw full backup will cause InnoDB to crash to protect the data.
+Incremental backups produced using MariaDB Enterprise Backup contain only the changes since the last backup and cannot be used standalone to perform a restore.
+To restore from a backup, you first need to prepare the backup for point-in-time consistency using the --prepare command:
-prepare command on a full backup synchronizes the tablespaces, ensuring that they are point-in-time consistent and ready for use in recovery.-prepare command on an incremental backup synchronizes the tablespaces and also applies the updated data into the previous full backup, making it a complete backup ready for use in recovery.-prepare command on data that is to be used for a partial restore (when restoring only one or more selected tables) requires that you also use the -export option to create the necessary .cfg files to use in recovery.When MariaDB Enterprise Backup restores from a backup, it copies or moves the backup files into the MariaDB Enterprise Server data directory, as defined by the datadir system variable.
For MariaDB Enterprise Backup to safely restore data from full and incremental backups, the data directory must be empty. One way to achieve this is to move the data directory aside to a unique directory name:
+/var/lib/mysql-2020-01-01) OR remove the old data directory (depending on how much space you have available).mkdir /var/lib/mysql).chown -R mysql:mysql /var/lib/mysql).When MariaDB Enterprise Backup performs a backup operation, it not only copies files from the data directory but also connects to the running MariaDB Enterprise Server.
+This connection to MariaDB Enterprise Server is used to manage locks and backup staging that prevent the Server from writing to a file while being read for a backup.
+MariaDB Enterprise Backup establishes this connection based on the user credentials specified with the --user and --password options when performing a backup.
It is recommended that a dedicated user be created and authorized to perform backups.
+MariaDB Enterprise Backup 10.5 and later requires this user to have the RELOAD, PROCESS, LOCK TABLES, and BINLOG MONITOR privileges. (The BINLOG MONITOR privilege replaced the REPLICATION CLIENT privilege in MariaDB Enterprise Server 10.5.):
**CREATE** **USER** 'mariabackup'@'localhost'IDENTIFIED **BY** 'mbu_passwd'**;GRANT** RELOAD**,** PROCESS**,** **LOCK** TABLES**,** BINLOG MONITOR**ON** ***.*****TO** 'mariabackup'@'localhost'**;**
In the above example, MariaDB Enterprise Backup would run on the local system that runs MariaDB Enterprise Server. Where backups may be run against a remote server, the user authentication and authorization should be adjusted.
+While MariaDB Enterprise Backup requires a user for backup operations, no user is required for restore operations since restores occur while MariaDB Enterprise Server is not running.
+MariaDB Enterprise Backup 10.4 and earlier requires this user to have the RELOAD, PROCESS, LOCK TABLES, and REPLICATION CLIENT privileges. (The BINLOG MONITOR privilege replaced the REPLICATION CLIENT privilege in MariaDB Enterprise Server 10.5.):
**CREATE** **USER** 'mariabackup'@'localhost'IDENTIFIED **BY** 'mbu_passwd'**;GRANT** RELOAD**,** PROCESS**,** **LOCK** TABLES**,** REPLICATION CLIENT**ON** ***.*****TO** 'mariabackup'@'localhost'**;**
In the above example, MariaDB Enterprise Backup would run on the local system that runs MariaDB Enterprise Server. Where backups may be run against a remote server, the user authentication and authorization should be adjusted.
+While MariaDB Enterprise Backup requires a user for backup operations, no user is required for restore operations since restores occur while MariaDB Enterprise Server is not running.
+Full backups performed with MariaDB Enterprise Backup contain all table data present in the database.
+When performing a full backup, MariaDB Enterprise Backup makes a file-level copy of the MariaDB Enterprise Server data directory. This backup omits log data such as the binary logs (binlog), error logs, general query logs, and slow query logs.
+When you perform a full backup, MariaDB Enterprise Backup writes the backup to the --target-dir path. The directory must be empty or non-existent and the operating system user account must have permission to write to that directory. A database user account is required to perform the backup.
The version of mariabackup or mariadb-backup should be the same version as the MariaDB Enterprise Server version. When the version does not match the server version, errors can sometimes occur, or the backup can sometimes be unusable.
To create a backup, execute mariabackup or mariadb-backup with the [--backup](https://mariadb.com/docs/server/ref/mdb/cli/mariadb-backup/backup/) option, and provide the database user account credentials using the [--user](https://mariadb.com/docs/server/ref/mdb/cli/mariadb-backup/user/) and [--password](https://mariadb.com/docs/server/ref/mdb/cli/mariadb-backup/password/) options:
$ sudo mariabackup --backup \ --target-dir=/data/backups/full \ --user=mariabackup \ --password=mbu_passwd
Subsequent to the above example, the backup is now available in the designated --target-dir path.
A raw full backup is not point-in-time consistent and must be prepared before it can be used for a restore. The backup can be prepared any time after the backup is created and before the backup is restored. However, MariaDB recommends preparing a backup immediately after taking the backup to ensure that the backup is consistent.
+The backup should be prepared with the same version of MariaDB Enterprise Backup that was used to create the backup.
+To prepare the backup, execute mariabackup or mariadb-backup with the [--prepare](https://mariadb.com/docs/server/ref/mdb/cli/mariadb-backup/prepare/) option:
$ sudo mariabackup --prepare \ --use-memory=34359738368 \ --target-dir=/data/backups/full
For best performance, the [--use-memory](https://mariadb.com/docs/server/ref/mdb/cli/mariadb-backup/use-memory/) option should be set to the server's [innodb_buffer_pool_size](https://mariadb.com/docs/server/ref/mdb/system-variables/innodb_buffer_pool_size/) value.
Once a full backup has been prepared to be point-in-time consistent, MariaDB Enterprise Backup is used to copy backup data to the MariaDB Enterprise Server data directory.
+To restore from a full backup:
+Restore from the "full" directory using the -copy-back option:
$ sudo mariabackup --copy-back --target-dir=/data/backups/full
MariaDB Enterprise Backup writes to the data directory as the current user, which can be changed using sudo. To confirm that restored files are properly owned by the user that runs MariaDB Enterprise Server, run a command like this (adapted for the correct user/group):
$ sudo chown -R mysql:mysql /var/lib/mysql
Once this is done, start MariaDB Enterprise Server:
+$ sudo systemctl start mariadb
When the Server starts, it works from the restored data directory.
+Full backups of large data-sets can be time-consuming and resource-intensive. MariaDB Enterprise Backup supports the use of incremental backups to minimize this impact.
+While full backups are resource-intensive at time of backup, the resource burden around incremental backups occurs when preparing for restore. First, the full backup is prepared for restore, then each incremental backup is applied.
+When you perform an incremental backup, MariaDB Enterprise Backup compares a previous full or incremental backup to what it finds on MariaDB Enterprise Server. It then creates a new backup containing the incremental changes.
+Incremental backup is supported for InnoDB tables. Tables using other storage engines receive full backups even during incremental backup operations.
+To increment a full backup, use the --incremental-basedir option to indicate the path to the full backup and the --target-dir option to indicate where you want to write the incremental backup:
$ sudo mariabackup --backup \ --incremental-basedir=/data/backups/full \ --target-dir=/data/backups/inc1 \ --user=mariabackup \ --password=mbu_passwd
In this example, MariaDB Enterprise Backup reads the /data/backups/full directory, and MariaDB Enterprise Server then creates an incremental backup in the /data/backups/inc1 directory.
An incremental backup must be applied to a prepared full backup before it can be used in a restore operation. If you have multiple full backups to choose from, pick the nearest full backup prior to the incremental backup that you want to restore. You may also want to back up your full-backup directory, as it will be modified by the updates in the incremental data.
+If your full backup directory is not yet prepared, run this to make it consistent:
+$ sudo mariabackup --prepare --target-dir=/data/backups/full
Then, using the prepared full backup, apply the first incremental backup's data to the full backup in an incremental preparation step:
+$ sudo mariabackup --prepare \ --target-dir=/data/backups/full \ --incremental-dir=/data/backups/inc1
Once the incremental backup has been applied to the full backup, the full backup directory contains the changes from the incremental backup (that is, the inc1/ directory). Feel free to remove inc1/ to save disk space.
Once you have prepared the full backup directory with all the incremental changes you need (as described above), stop the MariaDB Enterprise Server, empty its data directory, and restore from the original full backup directory using the --copy-back option:
$ sudo mariabackup --copy-back --target-dir=/data/backups/full
MariaDB Enterprise Backup writes files into the data directory using either the current user or root (in the case of a sudo operation), which may be different from the system user that runs the database. Run the following to recursively update the ownership of the restored files and directories:
+$ sudo chown -R mysql:mysql /var/lib/mysql
Then, start MariaDB Enterprise Server. When the Server starts, it works from the restored data directory.
+In a partial backup, MariaDB Enterprise Backup copies a specified subset of tablespaces from the MariaDB Enterprise Server data directory. Partial backups are useful in establishing a higher frequency of backups on specific data, at the expense of increased recovery complexity. In selecting tablespaces for a partial backup, please consider referential integrity.
+Command-line options can be used to narrow the set of databases or tables to be included within a backup:
+| Option | +Description | +
|---|---|
| --databases | +List of databases to include | +
| --databases-exclude | +List of databases to omit from the backup | +
| --databases-file | +Path to file listing the databases to include | +
| --tables | +List of tables to include | +
| --tables-exclude | +List of tables to exclude | +
| --tables-file | +Path to file listing the tables to include | +
For example, you may wish to produce a partial backup, which excludes a specific database:
+$ sudo mariabackup --backup \ --target-dir=/data/backups/part \ --user=mariabackup \ --password=mbu_passwd \ --database-exclude=test
Partial backups can also be incremental:
+$ sudo mariabackup --backup \ --incremental-basedir=/data/backups/part \ --target-dir=/data/backups/part_inc1 \ --user=mariabackup \ --password=mbu_passwd \ --database-exclude=test
As with full and incremental backups, partial backups are not point-in-time consistent. A partial backup must be prepared before it can be used for recovery.
+A partial restore can be performed from a full backup or partial backup.
+The preparation step for either partial or full backup restoration requires the use of transportable tablespaces for InnoDB. As such, each prepare operation requires the --export option:
$ sudo mariabackup --prepare --export --target-dir=/data/backups/part
When using a partial incremental backup for restore, the incremental data must be applied to its prior partial backup data before its data is complete. If performing partial incremental backups, run the prepare statement again to apply the incremental changes onto the partial backup that served as the base.
+$ sudo mariabackup --prepare --export \ --target-dir=/data/backups/part \ --incremental-dir=/data/backups/part_inc1
Unlike full and incremental backups, you cannot restore partial backups directly using MariaDB Enterprise Backup. Further, as a partial backup does not contain a complete data directory, you cannot restore MariaDB Enterprise Server to a startable state solely with a partial backup.
+To restore from a partial backup, you need to prepare a table on the MariaDB Enterprise Server, then manually copy the files into the data directory.
+The details of the restore procedure depend on the characteristics of the table:
+As partial restores are performed while the server is running, not stopped, care should be taken to prevent production workloads during restore activity.
+Note
+You can also use data from a full backup in a partial restore operation if you have prepared the data using the --export option as described above.
To restore a non-partitioned table from a backup, first create a new table on MariaDB Enterprise Server to receive the restored data. It should match the specifications of the table you're restoring.
+Be extra careful if the backup data is from a server with a different version than the restore server, as some differences (such as a differing ROW_FORMAT) can cause an unexpected result.
Create an empty table for the data being restored:
+**CREATE** **TABLE** test**.**address_book **(** id INT **PRIMARY** **KEY** AUTO_INCREMENT**,** name VARCHAR**(**255**),** email VARCHAR**(**255**));**
Modify the table to discard the tablespace:
+**ALTER** **TABLE** test**.**address_book DISCARD TABLESPACE**;**
You can copy (or move) the files for the table from the backup to the data directory:
+$ sudo cp /data/backups/part_inc1/test/address_book.* /var/lib/mysql/test
Use a wildcard to include both the .ibd and .cfg files. Then, change the owner to the system user running MariaDB Enterprise Server:
$ sudo chown mysql:mysql /var/lib/mysql/test/address_book.*
Lastly, import the new tablespace:
+**ALTER** **TABLE** test**.**address_book IMPORT TABLESPACE**;**
MariaDB Enterprise Server looks in the data directory for the tablespace you copied in, then imports it for use. If the table is encrypted, it also looks for the encryption key with the relevant key ID that the table data specifies.
+Repeat this step for every table you wish to restore.
+Restoring a partitioned table from a backup requires a few extra steps compared to restoring a non-partitioned table.
+To restore a partitioned table from a backup, first create a new table on MariaDB Enterprise Server to receive the restored data. It should match the specifications of the table you're restoring, including the partition specification.
+Be extra careful if the backup data is from a server with a different version than the restore server, as some differences (such as a differing ROW_FORMAT) can cause an unexpected result.
Create an empty table for the data being restored:
+**CREATE** **TABLE** test**.**students **(** id INT **NOT** **NULL** AUTO_INCREMENT**,** name VARCHAR**(**255**),** email VARCHAR**(**255**),** graduating_year **YEAR,** **PRIMARY** **KEY** **(**id**,** graduating_year**))** ENGINE = InnoDBPARTITION **BY** RANGE **(**graduating_year**)** **(** PARTITION p0 **VALUES** **LESS** **THAN** **(**2019**),** PARTITION p1 **VALUES** **LESS** **THAN** **MAXVALUE);**
Then create a second empty table matching the column specification, but without partitions. This will be your working table:
+**CREATE** **TABLE** test**.**students_work **ASSELECT** * **FROM** test**.**students **WHERE** **NULL;**
For each partition you want to restore, discard the working table's tablespace:
+**ALTER** **TABLE** test**.**students_work DISCARD TABLESPACE**;**
Then, copy the table files from the backup, using the new name:
+$ sudo cp /data/backups/part_inc1/test/students.ibd /var/lib/mysql/test/students_work.ibd
+$ sudo cp /data/backups/part_inc1/test/students.cfg /var/lib/mysql/test/students_work.cfg
Change the owner to that of the user running MariaDB Enterprise Server:
+$ sudo chown mysql:mysql /var/lib/mysql/test/students_work.*
Import the copied tablespace:
+**ALTER** **TABLE** test**.**students_work IMPORT TABLESPACE**;**
Lastly, exchange the partition, copying the tablespace from the working table into the partition file for the target table:
+**ALTER** **TABLE** test**.**students EXCHANGE PARTITION p0 **WITH** **TABLE** test**.**students_work**;**
Repeat the above process for each partition until you have them all exchanged into the target table. Then delete the working table, as it's no longer necessary:
+**DROP** **TABLE** test**.**students_work**;**
This restores a partitioned table.
+When restoring a table with a full-text search (FTS) index, InnoDB may throw a schema mismatch error.
+In this case, to restore the table, it is recommended to:
+.cfg file.For example, to restore table t1 with FTS index from database db1:
In the MariaDB shell, drop the table you are going to restore:
+**DROP** **TABLE** **IF** **EXISTS** db1**.**t1**;**
Create an empty table for the data being restored:
+**CREATE** **TABLE** db1**.**t1**(**f1 CHAR**(**10**))** ENGINE=INNODB**;**
Modify the table to discard the tablespace:
+**ALTER** **TABLE** db1**.**t1 DISCARD TABLESPACE**;**
In the operating system shell, copy the table files from the backup to the data directory of the corresponding database:
+$ sudo cp /data/backups/part/db1/t1.* /var/lib/mysql/db1
Remove the .cfg file from the data directory:
$ sudo rm /var/lib/mysql/db1/t1.cfg
Change the owner of the newly copied files to the system user running MariaDB Enterprise Server:
+$ sudo chown mysql:mysql /var/lib/mysql/db1/t1.*
In the MariaDB shell, import the copied tablespace:
+**ALTER** **TABLE** db1**.**t1 IMPORT TABLESPACE**;**
Verify that the data has been successfully restored:
+**SELECT** * **FROM** db1**.**t1**;**
+--------+
+| f1 |
++--------+
+| ABC123 |
++--------+
Add the necessary secondary indexes:
+**ALTER** **TABLE** db1**.**t1 **FORCE,** **ADD** FULLTEXT **INDEX** f_idx**(**f1**);**
The table is now fully restored:
+**SHOW** **CREATE** **TABLE** db1**.**t1**\G**
*************************** 1. row ***************************
+ Table: t1
+Create Table: CREATE TABLE `t1` (
+ `f1` char(10) DEFAULT NULL,
+ FULLTEXT KEY `f_idx` (`f1`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci
+Recovering from a backup restores the data directory at a specific point-in-time, but it does not restore the binary log. In a point-in-time recovery, you begin by restoring the data directory from a full or incremental backup, then use the mysqlbinlog utility to recover the binary log data to a specific point in time.
First, prepare the backup as you normally would for a full or incremental backup:
+$ sudo mariabackup --prepare --target-dir=/data/backups/full
When MariaDB Enterprise Backup runs on a MariaDB Enterprise Server where binary logs is enabled, it stores binary log information in the xtrabackup_binlog_info file. Consult this file to find the name of the binary log position to use. In the following example, the log position is 321.
`$ sudo cat /data/backups/full/xtraback_binlog_info
+mariadb-node4.00001 321`
+Update the configuration file to use a new data directory.
+**[mysqld]**datadir=/var/lib/mysql_new
Using MariaDB Enterprise Backup, restore from the backup to the new data directory:
+$ sudo mariabackup --copy-back --target-dir=/data/backups/full
Then change the owner to the MariaDB Enterprise Server system user:
+$ sudo chown -R mysql:mysql /var/lib/mysql_new
Start MariaDB Enterprise Server:
+$ sudo systemctl start mariadb
Using the binary log file in the old data directory, the start position in the xtrabackup_binlog_info file, the date and time you want to restore to, and the mysqlbinlog utility to create an SQL file with the binary log changes:
$ mysqlbinlog --start-position=321 \ --stop-datetime="2019-06-28 12:00:00" \ /var/lib/mysql/mariadb-node4.00001 \ > mariadb-binlog.sql
Lastly, run the binary log SQL to restore the databases:
+$ mysql -u root -p < mariadb-binlog.sql
The SkySQL Backup service provides comprehensive Backup and Restore features through a secure API. We extend the automated nightly backups with a number of self service features. You can automatically create and store backups of your databases to ensure additional data safety or provide a robust disaster recovery solution. The backups are stored on reliable and secure cloud storage, ensuring they are readily available when needed. The backup process is seamless and does not affect the performance of your databases. SkySQL also offers the flexibility to customize your backup schedule according to your specific needs.
+Here is the list of features offered:
+Automatic nightly backups : Automated nightly backups include a full backup of every database in the service.
+Secure On-demand or scheduled backups
+Full (physical) backups : Full backups create a complete backup of the database server into a new backup folder. It uses mariabackup under the hood. Physical backups are performed by copying the individual data files or directories and the fastest way to do a backup.
+Incremental backups : Incremental backups update a previous backup with whatever changes to the data have occurred since the backup.
+Logical backups : Logical backups consist of the SQL statements necessary to restore the data, such as CREATE DATABASE, CREATE TABLE and INSERT. This is done using mariadb-dump(https://mariadb.com/kb/en/mariadb-dump/) and is the most flexible way to perform a backup and restore, and a good choice when the data size is relatively small.
+Bring your own Bucket (BYOB) : you can backup or restore data to/from your own bucket in either GCP or AWS.
+Backup your binlogs : Binlogs record database changes (data modifications, table structure changes) in a sequential, binary format. You can preserve binlogs for setting up replication or to recover to a certain point-in-time.
+Point-in-time recovery : you can restore from a full or a logical backup and then use a binlog backup to restore to a point-in-time.
+Secure backup/restores : Control backup/restore privileges by granting roles to users in SkySQL.
+while the daily automated backups are included the use of this API will incur nominal additional charges. Please contact info@skysql.com for details.
+The following documentation describes the API for the SkySQL Backup Service. This can be used directly with any HTTP client.
+Note
+Please refer to the API docs (swagger) for the latest API. +The information below might be slightly outdated.
+To authenticate with the API, do the following:
+Go to SkySQL API Key management page: https://app.skysql.com/user-profile/api-keys and generate an API key
+Export the value from the token field to an environment variable $API_KEY
+Use it on subsequent request, e.g:
+ curl --request GET 'https://api.skysql.com/skybackup/v1/backups/schedules' \\
+ --header "X-API-Key: ${API_KEY}"
+Backups on large data sets can take time. You instruct the creation of a backup using a "schedule". You can either schedule a one-time backup (schedule now) or set up automatic backups using a cron schedule. A backup schedule results in a backup job which can be tracked using the status API. We support the following types of backups : full(physical), incremental(physical), binary log, and dump(logical).
+To create a backup schedule, you need to have the "administrator" role. You can add members and configure roles using the SkySQL portal.
+To create a full backup you need to make the following API call:
+curl --location 'https://api.skysql.com/skybackup/v1/backups/schedules' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "backup_type": "full",
+ "schedule": "once",
+ "service_id": "dbtgf28044362"
+}'
+++note that each launched database is tracked with a service ID in SkySQL. You can fetch the service ID from the Fully qualified domain name(FQDN) of your service. For instance in dbpgf17106534.sysp0000.db2.skysql.com, 'dbpgf17106534' is the service ID. +You will find the FQDN in the Connect window
+
Typical API server response should look like:
+{
+ "id": 253,
+ "service_id": "dbtgf28044362",
+ "schedule": "once",
+ "type": "full",
+ "status": "Scheduled",
+ "message": "Backup is scheduled."
+}
+++you can fetch the Status of the backup using 'https://api.skysql.com/skybackup/v1/backups'. See the 'Backup Status' section for an example. The 'status' field will report Success or failure.
+
To set up an automatic periodic full backup at 3 am UTC, you need to make the following API call:
+curl --location 'https://api.skysql.com/skybackup/v1/backups/schedules' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "backup_type": "full",
+ "schedule": "0 3 * * *",
+ "service_id": "dbtgf28044362"
+}'
+For more information about cron schedules take a look at this document.
+Incremental backups can be taken once you have full backup. Read here for more details.
+To set up an one-time incremental backup, you need to make the following API call:
+curl --location 'https://api.skysql.com/skybackup/v1/backups/schedules' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "backup_type": "incremental",
+ "schedule": "once",
+ "service_id": "dbtgf28044362"
+}'
+To set up an cron incremental backup, you need to make the following API call:
+curl --location 'https://api.skysql.com/skybackup/v1/backups/schedules' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "backup_type": "incremental",
+ "schedule": "0 3 * * *",
+ "service_id": "dbtgf28044362"
+}'
+To set up an one-time binarylog backup:
+curl --location 'https://api.skysql.com/skybackup/v1/backups/schedules' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "backup_type": "binarylog",
+ "schedule": "once",
+ "service_id": "dbtgf28044362"
+}'
+To set up an cron incremental backup:
+curl --location 'https://api.skysql.com/skybackup/v1/backups/schedules' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "backup_type": "binarylog",
+ "schedule": "0 3 * * *",
+ "service_id": "dbtgf28044362"
+}'
+To set up an one-time dump backup:
+curl --location 'https://api.skysql.com/skybackup/v1/backups/schedules' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "backup_type": "dump",
+ "schedule": "once",
+ "service_id": "dbtgf28044362"
+}'
+To set up an cron dump backup:
+curl --location 'https://api.skysql.com/skybackup/v1/backups/schedules' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "backup_type": "dump",
+ "schedule": "0 3 * * *",
+ "service_id": "dbtgf28044362"
+}'
+To set up an external storage backup, you need to make the following API call:
+For GCP you need to create an service account key. Please follow the steps from this documentation. Once you have created the service account key you will need to base64 encode it. You can encode it directly from a command line itself. For example the execution of command echo -n 'service-account-key' | base64 will produce something like c2VydmljZS1hY2NvdW50LWtleQ==
curl --location 'https://api.skysql.com/skybackup/v1/backups/schedules' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "backup_type": "full",
+ "schedule": "0 2 * * *",
+ "service_id": "dbtgf28044362",
+ "external_storage": {
+ "bucket": {
+ "path": "s3://my_backup_bucket",
+ "credentials": "c2VydmljZS1hY2NvdW50LWtleQ=="
+ }
+ }
+}'
+The service account key will be in the following format:
+{
+ "type": "service_account",
+ "project_id": "XXXXXXX",
+ "private_key_id": "XXXXXXX",
+ "private_key": "-----BEGIN PRIVATE KEY-----XXXXX-----END PRIVATE KEY-----",
+ "client_email": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX.iam.gserviceaccount.com",
+ "client_id": "XXXXXXX",
+ "auth_uri": "<https://accounts.google.com/o/oauth2/auth>",
+ "token_uri": "<https://oauth2.googleapis.com/token>",
+ "auth_provider_x509_cert_url": "<https://www.googleapis.com/oauth2/v1/certs>",
+ "client_x509_cert_url": "<https://www.googleapis.com/robot/v1/metadata/x509/XXXXXXXXXXXXXX.iam.gserviceaccount.com>",
+ "universe_domain": "googleapis.com"
+}
+For AWS, you must provide your own credentials. These include the AWS access key associated with an IAM account and the bucket region. For more information about AWS credentials, please refer to the documentation. The required credentials are aws_access_key_id , aws_secret_access_key and region. For example your credentials should look like:
+[default]
+aws_access_key_id = AKIAIOSFODNN7EXAMPLE
+aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+region = us-west-2
+You should encode your credentials base64 before passing it to the API. You can encode it directly from a command line itself. For example the execution of command echo '[default]\naws_access_key_id = AKIAIOSFODNN7EXAMPLE\naws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\nregion = us-west-2' | base64 will produce the following W2RlZmF1bHRdCmF3c19hY2Nlc3Nfa2V5X2lkID0gQUtJQUlPU0ZPRE5ON0VYQU1QTEUKYXdzX3NlY3JldF9hY2Nlc3Nfa2V5ID0gd0phbHJYVXRuRkVNSS9LN01ERU5HL2JQeFJmaUNZRVhBTVBMRUtFWQpyZWdpb24gPSB1cy13ZXN0LTIK.
+Using encoded credentials you will be able to pass it to the API server. To initiate a new backup to your external storage you need to execute an API call to the backup service:
```bash
+curl --location '<https://api.skysql.com/skybackup/v1/backups/schedules>' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "backup_type": "full",
+ "schedule": "0 2 ** *",
+ "service_id": "dbtgf28044362",
+ "external_storage": {
+ "bucket": {
+ "path": "s3://my_backup_bucket",
+ "credentials": "W2RlZmF1bHRdCmF3c19hY2Nlc3Nfa2V5X2lkID0gQUtJQUlPU0ZPRE5ON0VYQU1QTEUKYXdzX3NlY3JldF9hY2Nlc3Nfa2V5ID0gd0phbHJYVXRuRkVNSS9LN01ERU5HL2JQeFJmaUNZRVhBTVBMRUtFWQpyZWdpb24gPSB1cy13ZXN0LTIK"
+ }
+ }
+}'
To get backup schedules inside the Organization :
+curl --location '<https://api.skysql.com/skybackup/v1/backups/schedules>' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}'
+To get backup schedules for specific service :
+curl --location '<https://api.skysql.com/skybackup/v1/backups/schedules?service_id=dbtgf28044362>' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}'
+To get specific backup schedule by id :
+curl --location 'https://api.skysql.com/skybackup/v1/backups/schedules/200' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}'
+In the following example, we update the backup schedule to 9 AM UTC. Remember, you cannot change the schedules for one-time backups. +To update specific backup schedule you need to make the following API call:
+curl --location --request PATCH '<https://api.skysql.com/skybackup/v1/backups/schedules/215>' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "schedule": "0 9 ** *"
+}'
+To delete a backup schedule you need to provide the backup schedule id. Example of the api call below:
+curl --location --request DELETE 'https://api.skysql.com/skybackup/v1/backups/schedules/215' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}'
+The following API illustrates how to get the available backups and status of backup jobs .
+Here is an example to fetch all the available Backups in your org:
+curl --location 'https://api.skysql.com/skybackup/v1/backups' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}'
+To list all backups available for your service :
+curl --location 'https://api.skysql.com/skybackup/v1/backups?service_id=dbtgf28216706' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}'
+The typical response of either of two calls should look like:
+{
+ "backups": [
+ {
+ "id": "eda3b72460c8c0d9d61a7f01b6a22e32:dbtgf28216706:tx-filip-mdb-ms-0",
+ "service_id": "dbtgf28216706",
+ "type": "full",
+ "method": "skybucket",
+ "server_pod": "tx-filip-mdb-ms-0",
+ "backup_size": 5327326,
+ "reference_full_backup": "",
+ "point_in_time": "2024-03-26 17:18:21",
+ "start_time": "2024-03-26T17:18:57Z",
+ "end_time": "2024-03-26T17:19:01Z",
+ "status": "Succeeded"
+ }
+ ],
+ "backups_count": 1,
+ "pages_count": 1
+}
+++The ** Backup id is the most important part of this data as you need to provide it in the restore api call** to schedule restore execution.
+
WARNING
+++restoring from a Backup will likely wipe out all data in your target DB service. If you aren't sure, first take a backup of the Db service where a restore is being performed. The DB being restored will also be stopped during a Restore. You will need restart it.
+
You can restore your database from the backup located in the default SkySQL managed backup storage. In this case, you need to provide the backup ID when making the restore API call. Here is an example:
+curl --location 'https://api.skysql.com/skybackup/v1/restores' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "key": "eda3b72460c8c0d9d61a7f01b6a22e32:dbtgf28216706:tx-filip-mdb-ms-0",
+ "service_id": "dbtgf28044362"
+}'
+Inside the service_id parameter of your restore API request, you need to provide the id of the service, where you want to restore your data.
+You can restore your data from external storage. Your external storage bucket data should be created via one of the following tools: mariabackup, mysqldump. Credentials to external storage access could be fetched from:
For GCP you need to create an service account key. Please follow the steps from this documentation. Once you have created the service account key you will need to base64 encode it. You can encode it directly from a command line itself. For example the execution of command echo -n 'service-account-key' | base64 will produce the following c2VydmljZS1hY2NvdW50LWtleQ==
curl --location 'https://api.skysql.com/skybackup/v1/backups/schedules' \
+--header 'Content-Type: application/json' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}' \
+--data '{
+ "backup_type": "full",
+ "schedule": "0 2 * * *",
+ "service_id": "dbtgf28044362",
+ "external_storage": {
+ "bucket": {
+ "path": "s3://my_backup_bucket",
+ "credentials": "c2VydmljZS1hY2NvdW50LWtleQ=="
+ }
+ }
+}'
+The service account key will be in the following format:
+{
+ "type": "service_account",
+ "project_id": "XXXXXXX",
+ "private_key_id": "XXXXXXX",
+ "private_key": "-----BEGIN PRIVATE KEY-----XXXXX-----END PRIVATE KEY-----",
+ "client_email": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX.iam.gserviceaccount.com",
+ "client_id": "XXXXXXX",
+ "auth_uri": "<https://accounts.google.com/o/oauth2/auth>",
+ "token_uri": "<https://oauth2.googleapis.com/token>",
+ "auth_provider_x509_cert_url": "<https://www.googleapis.com/oauth2/v1/certs>",
+ "client_x509_cert_url": "<https://www.googleapis.com/robot/v1/metadata/x509/XXXXXXXXXXXXXX.iam.gserviceaccount.com>",
+ "universe_domain": "googleapis.com"
+}
+For AWS, you must provide your own credentials. These include the AWS access key associated with an IAM account and the bucket region. For more information about AWS credentials, please refer to the documentation. The required credentials are aws_access_key_id , aws_secret_access_key and region. For example your credentials should look like:
+[default]
+aws_access_key_id = AKIAIOSFODNN7EXAMPLE
+aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+region = us-west-2
+You should encode your credentials base64 before passing it to the API. You can encode it directly from a command line itself. For example the execution of command echo '[default]\naws_access_key_id = AKIAIOSFODNN7EXAMPLE\naws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\nregion = us-west-2' | base64 will produce the following W2RlZmF1bHRdCmF3c19hY2Nlc3Nfa2V5X2lkID0gQUtJQUlPU0ZPRE5ON0VYQU1QTEUKYXdzX3NlY3JldF9hY2Nlc3Nfa2V5ID0gd0phbHJYVXRuRkVNSS9LN01ERU5HL2JQeFJmaUNZRVhBTVBMRUtFWQpyZWdpb24gPSB1cy13ZXN0LTIK.
The following request demonstrates how to restore your data from an external storage:
+{
+ "service_id": "dbtgf28044362",
+ "key": "/backup.tar.gz",
+ "external_source": {
+ "bucket": "gs://my_backup_bucket",
+ "method": "mariabackup",
+ "credentials" "W2RlZmF1bHRdCmF3c19hY2Nlc3Nfa2V5X2lkID0gQUtJQUlPU0ZPRE5ON0VYQU1QTEUKYXdzX3NlY3JldF9hY2Nlc3Nfa2V5ID0gd0phbHJYVXRuRkVNSS9LN01ERU5HL2JQeFJmaUNZRVhBTVBMRUtFWQpyZWdpb24gPSB1cy13ZXN0LTIK"
+ }
+}
+In case your backup data is encrypted you need to pass encryption key as well:
+{
+ "service_id": "dbtgf28044362",
+ "key": "/backup.tar.gz",
+ "external_source": {
+ "bucket": "gs://my_backup_bucket",
+ "method": "mariabackup",
+ "credentials": "W2RlZmF1bHRdCmF3c19hY2Nlc3Nfa2V5X2lkID0gQUtJQUlPU0ZPRE5ON0VYQU1QTEUKYXdzX3NlY3JldF9hY2Nlc3Nfa2V5ID0gd0phbHJYVXRuRkVNSS9LN01ERU5HL2JQeFJmaUNZRVhBTVBMRUtFWQpyZWdpb24gPSB1cy13ZXN0LTIK",
+ "encryption_key": "my_encryption_key"
+ }
+}
+In order to get all Restores scheduled in the past you need to make api call:
+curl --location 'https://api.skysql.com/skybackup/v1/restores' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}'
+curl --location 'https://api.skysql.com/skybackup/v1/restores/12' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}'
+Typical response of those two apis should look like:
+In case restore is in progress:
+[
+ {
+ "id": 12,
+ "service_id": "dbtgf28216706",
+ "bucket": "gs://sky-syst0000-backup-us-84e9d84ecf265a/orgpxw1x",
+ "key": "eda3b72460c8c0d9d61a7f01b6a22e32:dbtgf28216706:tx-filip-mdb-ms-0",
+ "type": "physical",
+ "status": "Running",
+ "message": "server is not-ready"
+ }
+]
+In case restore completed:
+[
+ {
+ "id": 13,
+ "service_id": "dbtgf28216706",
+ "bucket": "gs://sky-syst0000-backup-us-84e9d84ecf265a/orgpxw1x",
+ "key": "dda9b72460c9c0d9d61a7f01b6a33e39:dbtgf28216706:tx-filip-mdb-ms-0",
+ "type": "physical",
+ "status": "Succeeded",
+ "message": "Restore has succeeded!"
+ }
+]
+You can delete older completed restore schedules. To clean up your auditing history you need to execute the following api call:
+curl --location --request DELETE 'https://api.skysql.com/skybackup/v1/restores/12' \
+--header 'Accept: application/json' \
+--header 'X-API-Key: ${API_KEY}'
+Billing is associated with a MariaDB ID.
+For pricing information see "Pricing" .
+From the Portal, you can access a current billing and usage summary:
+Current charges, prior billing date, and next invoice date are shown.
+Usage information can be shown by service or by resource.
+Click the resource name or service name to expand the view.
+
Billing - Usage
+https://skysql.mariadb.com/billings/usage
+From the Portal, you can access prior invoices:
+
Billing - Billing History
+https://skysql.mariadb.com/billings/history
+ + + + + + + + + + + + + +Note
+COMING SOON … a complete feature checklist of both the tiers ... +A full description of billing and invoicing (FAQ covers a bit)
+Power Tier is a premium service offering who have the most critical requirements for uptime, availability, performance, and support.
+By default, any new signed up users are in the “Foundation Tier”. To upgrade to Power Tier, simply click the ‘Upgrade’ button - SkySQL support will contact you and start the upgrade process. You can also directly reach out to SkySQL Support.
+Features available to SkySQL Power Tier customers include:
+Database server configuration, including system variables, is managed through the Configuration Manager.
+
Configuration Manager
+https://app.skysql.com/settings/configuration-manager
+To access the Configuration Manager interface:
+Available configuration parameters differ by cloud database topology.
+For cloud databases with the Enterprise Server Single Node topology, the following Configuration Manager parameters are used to configure MariaDB Enterprise Server behavior:
+Parameter
+disconnect_on_expired_password
+explicit_defaults_for_timestamp
+idle_readonly_transaction_timeout
+idle_write_transaction_timeout
+innodb_flush_log_at_trx_commit
+performance_schema_accounts_size
+performance_schema_digests_size
+performance_schema_events_stages_history_long_size
+performance_schema_events_stages_history_size
+performance_schema_events_statements_history_long_size
+performance_schema_events_statements_history_size
+performance_schema_events_waits_history_long_size
+performance_schema_events_waits_history_size
+performance_schema_max_cond_classes
+performance_schema_max_cond_instances
+performance_schema_max_digest_length
+performance_schema_max_file_classes
+performance_schema_max_file_handles
+performance_schema_max_file_instances
+performance_schema_max_mutex_classes
+performance_schema_max_mutex_instances
+performance_schema_max_rwlock_classes
+performance_schema_max_rwlock_instances
+performance_schema_max_socket_classes
+performance_schema_max_socket_instances
+performance_schema_max_stage_classes
+performance_schema_max_table_handles
+performance_schema_max_table_instances
+performance_schema_max_thread_classes
+performance_schema_max_thread_instances
+performance_schema_session_connect_attrs_size
+session_track_system_variables
+simple_password_check_letters_same_case
+simple_password_check_minimal_length
+simple_password_check_other_characters
+system_versioning_alter_history
+For cloud databases with the Enterprise Server With Replica(s) topology, Configuration Manager can be used to configure MariaDB Enterprise Server behavior and MariaDB MaxScale behavior.
+The following Configuration Manager parameters are used to configure MariaDB Enterprise Server behavior:
+Parameter
+disconnect_on_expired_password
+explicit_defaults_for_timestamp
+idle_readonly_transaction_timeout
+idle_write_transaction_timeout
+innodb_flush_log_at_trx_commit
+performance_schema_accounts_size
+performance_schema_digests_size
+performance_schema_events_stages_history_long_size
+performance_schema_events_stages_history_size
+performance_schema_events_statements_history_long_size
+performance_schema_events_statements_history_size
+performance_schema_events_waits_history_long_size
+performance_schema_events_waits_history_size
+performance_schema_max_cond_classes
+performance_schema_max_cond_instances
+performance_schema_max_digest_length
+performance_schema_max_file_classes
+performance_schema_max_file_handles
+performance_schema_max_file_instances
+performance_schema_max_mutex_classes
+performance_schema_max_mutex_instances
+performance_schema_max_rwlock_classes
+performance_schema_max_rwlock_instances
+performance_schema_max_socket_classes
+performance_schema_max_socket_instances
+performance_schema_max_stage_classes
+performance_schema_max_table_handles
+performance_schema_max_table_instances
+performance_schema_max_thread_classes
+performance_schema_max_thread_instances
+performance_schema_session_connect_attrs_size
+rpl_semi_sync_master_wait_no_slave
+rpl_semi_sync_master_wait_point
+rpl_semi_sync_slave_delay_master
+rpl_semi_sync_slave_kill_conn_timeout
+session_track_system_variables
+simple_password_check_letters_same_case
+simple_password_check_minimal_length
+simple_password_check_other_characters
+system_versioning_alter_history
+The following Configuration Manager parameters are used to configure MariaDB MaxScale behavior:
+Parameter
+transaction_replay_retry_on_deadlock
+MariaDB Connector/J enables Java applications to connect to MariaDB database products using a native MariaDB connector.
+| Version | +Latest Release | +Latest Release Date | +Maturity | +
|---|---|---|---|
| MariaDB Connector/J 3.1 | +https://mariadb.com/docs/server/release-notes/mariadb-connector-j-3-1/3-1-4/ | +2023-05-01 | +General Availability | +
| MariaDB Connector/J 3.0 | +https://mariadb.com/docs/server/release-notes/mariadb-connector-j-3-0/3-0-10/ | +2023-01-11 | +General Availability | +
| MariaDB Connector/J 2.7 | +https://mariadb.com/docs/server/release-notes/mariadb-connector-j-2-7/2-7-9/ | +2023-03-22 | +General Availability | +
| MariaDB Connector/J 1.8 | +MariaDB Connector/J 1.8.0 | +2019-02-11 | +GA | +
To download the JAR file manually:
+Maven can install MariaDB Connector/J as a dependency of your application during build. Set the <version> element to correspond to the version of MariaDB Connector/J that you would like to install.
To use Maven to install MariaDB Connector/J, add the dependency to your pom.xml file:
<dependency>
+ <groupId>org.mariadb.jdbc</groupId>
+ <artifactId>mariadb-java-client</artifactId>
+ <version>3.0.10</version>
+</dependency>
+For additional information on available releases, see the "Release Notes for MariaDB Connector/J".
+Depending on the features you plan to use, you may need to add some additional dependencies to pom.xml.
If you downloaded the connector JAR, place it on your CLASSPATH
+export CLASSPATH="/path/to/application:/path/to/mariadb-java-client-3.0.10.jar"
+In MariaDB Connector/J 3.0, TLS is enabled for connections to SkySQL using the sslMode parameter.
import java.sql.*;
+import java.util.Properties;
+
+public class App {
+ public static void main(String[] argv) {
+ Properties connConfig = new Properties();
+ connConfig.setProperty("user", "db_user");
+ connConfig.setProperty("password", "db_user_password");
+ **connConfig.setProperty("sslMode", "verify-full");**
+
+ try (Connection conn = DriverManager.getConnection("jdbc:mariadb://HOST:PORT", connConfig)) {
+ try (Statement stmt = conn.createStatement()) {
+ try (ResultSet contact_list = stmt.executeQuery("SELECT first_name, last_name, email FROM test.contacts")) {
+ while (contact_list.next()) {
+ System.out.println(String.format("%s %s <%s>",
+ contact_list.getString("first_name"),
+ contact_list.getString("last_name"),
+ contact_list.getString("email")));
+ }
+ }
+ }
+ } catch (Exception e) {
+ e.printStackTrace();
+ }
+ }
+}
+In MariaDB Connector/J 2.7 and before, TLS is enabled for connections to SkySQL using the useSsl parameter.
import java.sql.*;
+import java.util.Properties;
+
+public class App {
+ public static void main(String[] argv) {
+ Properties connConfig = new Properties();
+ connConfig.setProperty("user", "db_user");
+ connConfig.setProperty("password", "db_user_password");
+ **connConfig.setProperty("useSsl", "true");**
+
+ try (Connection conn = DriverManager.getConnection("jdbc:mariadb://HOST:PORT", connConfig)) {
+ try (Statement stmt = conn.createStatement()) {
+ try (ResultSet contact_list = stmt.executeQuery("SELECT first_name, last_name, email FROM test.contacts")) {
+ while (contact_list.next()) {
+ System.out.println(String.format("%s %s <%s>",
+ contact_list.getString("first_name"),
+ contact_list.getString("last_name"),
+ contact_list.getString("email")));
+ }
+ }
+ }
+ } catch (Exception e) {
+ e.printStackTrace();
+ }
+ }
+}
+| Connector | +MariaDB Connector/J | +
|---|---|
| Supported Versions | +https://mariadb.com/docs/server/release-notes/mariadb-connector-j-3-1/https://mariadb.com/docs/server/release-notes/mariadb-connector-j-3-0/https://mariadb.com/docs/server/release-notes/mariadb-connector-j-2-7/MariaDB Connector/J 1.8 | +
| Programming Language | +Java | +
| Programming Language Version | +Java 17, Java 11, Java 8 (Connector/J 3.1)Java 17, Java 11, Java 8 (Connector/J 3.0)Java 17, Java 11, Java 8 (Connector/J 2.7)Java 7 (Connector/J 1.8) | +
| API | +JDBC 4.2 (Connector/J 3.1)JDBC 4.2 (Connector/J 3.0)JDBC 4.2 (Connector/J 2.7)JDBC 4.1 (Connector/J 1.8) | +
| Supports TLS | +Yes | +
| License | +GNU Lesser General Public License v2.1 | +
The NoSQL protocol module allows a MariaDB server or cluster to execute transactions for applications using MongoDB client libraries, transparently converting MongoDB API calls into the equivalent SQL. The MariaDB responses are then converted into the format expected by the MongoDB® client library and application.
+For detailed information on supported commands, see "NoSQL Protocol Module" in MariaDB MaxScale documentation.
+ + +Connect to the NoSQL interface using a MongoDB client library or compatible application. Documentation on official MongoDB libraries is available from MongoDB.
+Documentation on installing mongosh (the MongoDB Shell) is available from MongoDB.
From the Dashboard, the details needed to connect to your SkySQL service can be seen by clicking on the "CONNECT" button for the desired service.
+The "NoSQL port" is the TCP port used to connect to the NoSQL interface.
+The firewall must be configured to allowlist the client's IP address or netblock before connections can occur.
+See the "Connecting using Mongosh" section of the Connect page for an example mongosh command-line, authentication instructions, and instructions to change the default password.
Node.js developers can connect to MariaDB database products through a native MariaDB Connector. Using MariaDB Connector/Node.js you can connect to MariaDB database products to use and administer databases from within your Node.js application.
+MariaDB Connector/Node.js is usually installed either from the Node.js repository or manually from the source code package.
+To install MariaDB Connector/Node.js from the Node.js repository, use NPM:
+$ npm install mariadb
NPM connects to the Node.js repository and downloads MariaDB Connector/Node.js and all relevant dependencies into the node_modules/ directory.
To download and install the MariaDB Connector/Node.js manually from source code:
+When the source code package finishes downloading, install it with NPM:
+$ npm install mariadb-connector-nodejs-*.tar.gz
NPM untars the download and installs MariaDB Connector/Node.js in the node_modules/ directory.
Node.js developers can use MariaDB Connector/Node.js to establish client connections with MariaDB database products.
+MariaDB Connector/Node.js provides two different connection implementations: one built on the Promise API and the other built on the Callback API.
+To use the Callback API, use the following module:
+**const** mariadb = require**(**'mariadb/callback'**);**
createConnection(options) -> Connection is the base function used to create a Connection object.
The createConnection(options) function returns a Connection object.
Determine the connection information for your MariaDB SkySQL database service:
+| Option | +Description | +
|---|---|
| host | +The fully Qualified Domain Name in the https://mariadb.com/docs/skysql-previous-release/connect/connection-parameters-portal/ | +
| port | +The Read-Write Port or Read-Only Port in the https://mariadb.com/docs/skysql-previous-release/connect/connection-parameters-portal/ | +
| user | +The desired username, which might be the default username in the Service Credentials view | +
| password | +The user's password, which might be the default password in the Service Credentials view if it was not yet customized | +
| database | +Database name to establish a connection to. No default is configured. | +
| connectTimeout | +Connection timeout in milliseconds. In Connector/Node.js 2.5.6, the default value changed to 1000. The default value for earlier versions is 10000. | +
| rowsAsArray | +A boolean value to indicate whether to return result sets as array instead of the default JSON. Arrays are comparatively faster. | +
The following code example connects using the database and user account created in the example setup:
+const mariadb = require('mariadb/callback');
+
+// Certificate Authority (CA)",
+var serverCert = [fs.readFileSync(process.env.SKYSQL_CA_PEM, "utf8")];
+
+// Declare async function
+function main() {
+ let conn;
+
+ try {
+ conn = mariadb.createConnection({
+ host: "example.skysql.net",
+ port: 5009,
+ ssl: { ca: serverCert },
+ user: "db_user",
+ password: "db_user_password",
+ database: "test",
+ });
+
+ // Use Connection
+ // ...
+ } catch (err) {
+ // Manage Errors
+ console.log("SQL error in establishing a connection: ", err);
+ } finally {
+ // Close Connection
+ if (conn) conn.end(err => {if(err){
+ console.log("SQL error in closing a connection: ", err);}
+ });
+ }
+}
+
+main();
+try...catch...finally statement is used for exception handling.connection.end([callback]) function.connection.end([callback]) function to close/end the connection in the finally block after the queries that are running have completed.end() function takes a callback function that defines one implicit argument for the Error object if thrown in closing the connection as argument. If no error is generated in closing a connection the Error object is null.Node.js developers can use MariaDB Connector/Node.js to establish client connections with MariaDB database products.
+MariaDB Connector/Node.js provides two different connection implementations: one built on the Promise API and the other built on the Callback API. Promise is the default.
+To use the Promise API, use the mariadb module:
**const** mariadb = require**(**'mariadb'**);**
createConnection(options) -> Promise is the base function used to create a Connection object.
The createConnection(options) returns a Promise that resolves to a Connection object if no error occurs, and rejects with an Error object if an error occurs.
Determine the connection information for your MariaDB SkySQL database service:
+| Option | +Description | +
|---|---|
| host | +The fully Qualified Domain Name in the https://mariadb.com/docs/skysql-previous-release/connect/connection-parameters-portal/ | +
| port | +The Read-Write Port or Read-Only Port in the https://mariadb.com/docs/skysql-previous-release/connect/connection-parameters-portal/ | +
| user | +The desired username, which might be the default username in the Service Credentials view | +
| password | +The user's password, which might be the default password in the Service Credentials view if it was not yet customized | +
| ssl.ca | +The contents of the skysql_chain.pem file containing the https://mariadb.com/docs/skysql-previous-release/connect/connection-parameters-portal/#Certificate_Authority_Chain | +
| • https://supplychain.mariadb.com/skysql_chain.pem | ++ |
| • https://supplychain.mariadb.com/aws_skysql_chain.pem | ++ |
| database | +Database name to establish a connection to. No default is configured. | +
| connectTimeout | +Connection timeout in milliseconds. In Connector/Node.js 2.5.6, the default value changed to 1000. The default value for earlier versions is 10000. | +
| rowsAsArray | +A boolean value to indicate whether to return result sets as array instead of the default JSON. Arrays are comparatively faster. | +
Create a file named .env to store your database credentials:
MDB_HOST = 192.0.2.50
+MDB_PORT = 3306
+MDB_USER = db_user
+MDB_PASS = db_user_password
+MDB_HOST = example.skysql.net
+MDB_PORT = 5001
+MDB_CA_PEM = /path/to/skysql_chain.pem
+MDB_USER = db_user
+MDB_PASS = db_user_password
+The following code example connects using the database and user account created in Setup for Examples:
+// Required Modules
+const fs = require("fs");
+const mariadb = require("mariadb");
+require("dotenv").config()
+
+// Certificate Authority (CA)
+const serverCert = [fs.readFileSync(process.env.MDB_CA_PEM, "utf8")];
+
+// Declare async function
+async function main() {
+ let conn;
+
+ try {
+ conn = await mariadb.createConnection({
+ host: process.env.MDB_HOST,
+ port: process.env.MDB_PORT,
+ user: process.env.MDB_USER,
+ password: process.env.MDB_PASS,
+ ssl: { ca: serverCert },
+ database: "test",
+ });
+
+ // Use Connection
+ // ...
+ } catch (err) {
+ // Manage Errors
+ console.log("SQL error in establishing a connection: ", err);
+ } finally {
+ // Close Connection
+ if (conn) conn.close();
+ }
+}
+
+main();
+mariadb module using the require() function.main() using the async keyword.await expressions using the await keyword.await expression is the resolved value of the Promise.main is arbitrary and does not have special meaning as in some other programming languages.conn for the connection to be created using a let statement with the async function main.try...catch...finally statement is used for exception handling.try block, create a new connection using the mariadb#createConnection(options) function in the Promise API.catch block.close() function.| Connector | +MariaDB Connector/Node.js | +
|---|---|
| Supported Versions | +https://mariadb.com/docs/server/release-notes/mariadb-connector-nodejs-2-5/https://mariadb.com/docs/server/release-notes/mariadb-connector-nodejs-3-2/ | +
| Programming Language | +JavaScript | +
| Programming Language Version | +• Connector/Node.js 2.5: Node.js 16 | +
| • Connector/Node.js 3.2: Node.js 16, 18, 20 | ++ |
| API | +Promise APICallback API | +
| Supports TLS | +Yes | +
| Supports Connection Pools | +Yes | +
| License | +GNU Lesser General Public License v2.1 | +
Python developers can use MariaDB Connector/Python to establish client connections with SkySQL database products.
+Connections are managed using the following Python class:
+| Class | +Description | +
|---|---|
| Connection | +Represents a connection to a MariaDB database product. | +
Connections are created, used, and managed using the following Connection class functions:
| Function | +Description | +
|---|---|
| connect() | +Establishes a connection to a database server and returns a connection object. | +
| cursor() | +Returns a new cursor object for the current connection. | +
| change_user() | +Changes the user and default database of the current connection. | +
| reconnect() | +Tries to make a connection object active again by reconnecting to the server using the same credentials which were specified in connect() method. | +
| close() | +Closes the connection. | +
Determine the connection information for your SkySQL database service:
+| connect() parameter | +Where to find it | +
|---|---|
| user | +Default username in the Service Credentials view, or the username you created | +
| passwd | +Default password in the Service Credentials view, the password you set on the default user, or the password for the user you created | +
| host | +Fully Qualified Domain Name in the Connection Parameters Portal | +
| ssl_verify_cert | +Set to True to support SSL | +
| port | +Read-Write Port or Read-Only Port in the Connection Parameters Portal | +
The following code example connects to an example server.
+Examples:
+# Module Import
+import mariadb
+import sys
+
+# Instantiate Connection
+try:
+ conn = mariadb.connect(
+ host="192.0.2.1",
+ port=3306,
+ user="db_user",
+ password="USER_PASSWORD")
+except mariadb.Error as e:
+ print(f"Error connecting to the database: {e}")
+ sys.exit(1)
+
+# Use Connection
+# ...
+
+# Close Connection
+conn.close()
+# Module Import
+import mariadb
+import sys
+
+# Instantiate Connection
+try:
+ conn = mariadb.connect(
+ host="SKYSQL_SERVICE.mdb0000001.db.skysql.com",
+ port=5009,
+ ssl_verify_cert=True,
+ user="DB00000001",
+ password="USER_PASSWORD")
+except mariadb.Error as e:
+ print(f"Error connecting to the database: {e}")
+ sys.exit(1)
+
+# Use Connection
+# ...
+
+# Close Connection
+conn.close()
+connect() function returns an instance of the Connection class, which is assigned to the conn variable.connect()function.close()method.Instantiating the Connection class creates a single connection to MariaDB database products. Applications that require multiple connections may benefit from pooling connections.
MariaDB Connector/Python closes the connection as part of the class's destructor, which is executed when an instance of the class goes out of scope. This can happen in many cases, such as:
+Connection class is defined in the local scope of a function, and the function returnsConnection class is defined as an attribute of a custom class's instance, and the custom class's instance goes out of scope.Connections can also be explicitly closed using the close() method, which is helpful when the connection is no longer needed, but the variable is still in scope.
Starting with MariaDB Connector/Python 1.1 when MariaDB Connector/Python is built with MariaDB Connector/C 3.3, the connector supports connection failover when auto_reconnect is
+enabled and the connection string contains a comma-separated list of multiple server addresses.
To enable connection failover:
+mariadb.connect function with the host argument specified as a comma-separated list containing multiple server addresses. The connector attempts to connect to the addresses in the order specified in the list.auto_reconnect to True. If the connection fails, the connector will attempt to reconnect to the addresses in the order specified in the list.The following code example connects with connection failover enabled:
+# Module Import
+import mariadb
+import sys
+
+# Instantiate Connection
+try:
+ conn = mariadb.connect(
+ host="192.0.2.1,192.0.2.0,198.51.100.0",
+ port=3306,
+ user="db_user",
+ password="USER_PASSWORD")
+ conn.auto_reconnect = True
+except mariadb.Error as e:
+ print(f"Error connecting to the database: {e}")
+ sys.exit(1)
+
+# Use Connection
+# ...
+
+# Close Connection
+conn.close()
+# Module Import
+import mariadb
+import sys
+
+# Instantiate Connection
+try:
+ conn = mariadb.connect(
+ host="SKYSQL_SERVICE.mdb0000001.db.skysql.com,SKYSQL_SERVICE.mdb0000002.db.skysql.com",
+ port=5009,
+ ssl_verify_cert=True,
+ user="DB00000001",
+ password="USER_PASSWORD")
+ conn.auto_reconnect = True
+except mariadb.Error as e:
+ print(f"Error connecting to the database: {e}")
+ sys.exit(1)
+
+# Use Connection
+# ...
+
+# Close Connection
+conn.close()
+MariaDB Connector/C++ enables C++ applications to establish client connections to MariaDB database over TLS.
+MariaDB Connector/C++ has dependencies. You must install MariaDB Connector/C to use it.
+| MariaDB Connector/C++ | +MariaDB Connector/C | +
|---|---|
| 1.1 | +3.2.3 or later | +
| 1.0 | +3.1.1 or later | +
For additional information, see "MariaDB Connector/C++ Release Notes".
+To install MariaDB Connector/C++ on Linux:
+Extract the tarball:
+$ tar -xvzf mariadb-connector-cpp-*.tar.gz
Change into the relevant directory:
+$ cd mariadb-connector-cpp-*/
Install the directories for the header files:
+$ sudo install -d /usr/include/mariadb/conncpp
+$ sudo install -d /usr/include/mariadb/conncpp/compat
Install the header files:
+$ sudo install include/mariadb/* /usr/include/mariadb/
+$ sudo install include/mariadb/conncpp/* /usr/include/mariadb/conncpp
+$ sudo install include/mariadb/conncpp/compat/* /usr/include/mariadb/conncpp/compat
Install the directories for the shared libraries:
+On CentOS, RHEL, Rocky Linux:
+$ sudo install -d /usr/lib64/mariadb
+$ sudo install -d /usr/lib64/mariadb/plugin
On Debian, Ubuntu:
+$ sudo install -d /usr/lib/mariadb
+$ sudo install -d /usr/lib/mariadb/plugin
Install the shared libraries:
+On CentOS, RHEL, Rocky Linux:
+$ sudo install lib64/mariadb/libmariadbcpp.so /usr/lib64
+$ sudo install lib64/mariadb/plugin/* /usr/lib64/mariadb/plugin
On Debian, Ubuntu:
+$ sudo install lib/mariadb/libmariadbcpp.so /usr/lib
+$ sudo install lib/mariadb/plugin/* /usr/lib/mariadb/plugin
To install MariaDB Connector/C++ on Windows:
+mariadbcpp LIB file (example "C:\Program Files\MariaDB\MariaDB C++ Connector 64-bit") to PATH environment variable.| Version | +Latest Release | +Latest Release Date | +Maturity | +
|---|---|---|---|
| MariaDB Connector/C++ 1.1 | +https://mariadb.com/docs/server/release-notes/mariadb-connector-cpp-1-1/1-1-2/ | +2022-11-30 | +Release Candidate | +
| MariaDB Connector/C++ 1.0 | +https://mariadb.com/docs/server/release-notes/mariadb-connector-cpp-1-0/1-0-2/ | +2022-10-11 | +General Availability | +
The connection is configured via the information that is initially acquired from the SkySQL Portal pages:
+| What to set | +Where to find it | +
|---|---|
| Hostname in the URL | +The fully Qualified Domain Name in the https://mariadb.com/docs/skysql-previous-release/connect/connection-parameters-portal/ | +
| Port number in the URL | +The Read-Write Port or Read-Only Port in the https://mariadb.com/docs/skysql-previous-release/connect/connection-parameters-portal/ | +
| user parameter | +The desired username, which might be the default username in the Service Credentials view | +
| password parameter | +The user's password, which might be the default password in the Service Credentials view if it was not yet customized | +
| tlsCert parameter | +The path to the skysql_chain.pem file containing the https://mariadb.com/docs/skysql-previous-release/connect/connection-parameters-portal/#Certificate_Authority_Chain | +
| • https://supplychain.mariadb.com/skysql_chain.pem | ++ |
| • https://supplychain.mariadb.com/aws_skysql_chain.pem | ++ |
While MariaDB Connector/C++ supports several connection styles, we are going to detail just the JDBC syntax since all connections to SkySQL use a single idiom of hostname, port, user, password, and SSL parameters.
+The base URL is specified as follows:
+jdbc:mariadb://example.skysql.net:5001/dbname
If the trailing database name is left off of the URL, the connection will start without selecting a database.
+MariaDB Connector/C++ supports several optional connection parameters. These parameters can be specified using a Properties object, as we do in our examples, or appended to the URL in standard name=value query-string encoding.
In the following list, we've left out any parameters that aren't pertinent to accessing SkySQL:
+| Parameter Name | +Description | +Type | +Default | +Aliases | +
|---|---|---|---|---|
| autoReconnect | +Defines whether the connector automatically reconnects after a connection failure. | +bool | +false | +• OPT_RECONNECT | +
| connectTimeout | +Defines the connect timeout value in milliseconds. When set to 0, there is no connect timeout. | +int | +30000 | ++ |
| enabledTlsCipherSuites | +A list of permitted ciphers or cipher suites to use for TLS. | +string | ++ | • enabledSslCipherSuites | +
| • enabledSSLCipherSuites | ++ | + | + | + |
| jdbcCompliantTruncation | +This mode is enabled by default. This mode configures the connector to add STRICT_TRANS_TABLES to https://mariadb.com/docs/server/ref/mdb/system-variables/sql_mode/https://mariadb.com/docs/server/ref/mdb/system-variables/sql_mode/, which causes ES to handle truncation issues as errors instead of warnings. | +bool | +true | ++ |
| password | +Defines the password of the user account to connect with. | ++ | + | + |
| socketTimeout | +Defines the network socket timeout (SO_TIMEOUT) in milliseconds. When set to 0, there is no socket timeout. This connection parameter is not intended to set a maximum time for statements. To set a maximum time for statements, please see the https://mariadb.com/docs/server/ref/mdb/system-variables/max_statement_time/https://mariadb.com/docs/server/ref/mdb/system-variables/max_statement_time/https://mariadb.com/docs/server/ref/mdb/system-variables/max_statement_time/ system variable. | +int | +0 | +• OPT_READ_TIMEOUT | +
| tcpRcvBuf | +The buffer size for TCP/IP and socket communication. tcpSndBuf changes the same buffer value, and the biggest value of the two is selected. | +int | +0x4000 | +• tcpSndBuf | +
| tcpSndBuf | +The buffer size for TCP/IP and socket communication. tcpRcvBuf changes the same buffer value, and the biggest value of the two is selected. | +int | +0x4000 | +• tcpRcvBuf | +
| tlsCert | +Path to the X509 certificate file. | +string | ++ | • sslCert | +
| tlsCRL | +Path to a PEM file that should contain one or more revoked X509 certificates. | +string | ++ | • tlsCrl | +
| • sslCRL | ++ | + | + | + |
| useCompression | +Compresses network traffic between the client and server. | +bool | +false | +• CLIENT_COMPRESS | +
| user | +Defines the user name of the user account to connect with. | ++ | + | • userName | +
| useServerPrepStmts | +Defines whether the connector uses server-side prepared statements using the https://mariadb.com/docs/skysql-previous-release/ref/mdb/sql-statements/PREPARE/, https://mariadb.com/docs/skysql-previous-release/ref/mdb/sql-statements/EXECUTE/, and https://mariadb.com/docs/skysql-previous-release/ref/mdb/sql-statements/DROP_PREPARE/ statements. By default, the connector uses client-side prepared statements. | +bool | +false | ++ |
| useTls | +Whether to force TLS. This enables TLS with the default system settings. | +bool | ++ | • useSsl | +
| • useSSL | ++ | + | + | + |
Two categories of methods are available to to establish a connection.
+MariaDB Connector/C++ can connect using the non-static connect() methods in the sql::Driver class.
The non-static connect() methods in the sql::Driver class have the following prototypes:
Connection* connect(const SQLString& url, Properties& props);Connection* connect(const SQLString& host, const SQLString& user, const SQLString& pwd);Connection* connect(const Properties& props);The non-static connect() methods in the sql::Driver class:
sql::Driver class to establish a connection.nullptr as the Connection* value when an error occurs, so applications should check the return value before use.For example:
+// Instantiate Driver
+sql::Driver* driver = sql::mariadb::get_driver_instance();
+
+// Configure Connection, including an optional initial database name "places":
+sql::SQLString url("jdbc:mariadb://example.skysql.net:5009/places");
+
+// Use a properties map for the other connection options
+sql::Properties properties({
+ {"user", "db_user"},
+ {"password", "db_user_password"},
+ {"autocommit", false},
+ {"useTls", true},
+ {"tlsCert", "classpath:static/skysql_chain.pem"},
+ });
+
+// Establish Connection
+// Use a smart pointer for extra safety
+std::unique_ptr<sql::Connection> conn(driver->connect(url, properties));
+
+if (!conn) {
+ cerr << "Invalid database connection" << endl;
+ exit (EXIT_FAILURE);
+}
+MariaDB Connector/C++ can connect using the static getConnection() methods in the sql::DriverManager class.
The static getConnection() methods in the sql::DriverManager class have the following prototypes:
static Connection* getConnection(const SQLString& url);static Connection* getConnection(const SQLString& url, Properties& props);static Connection* getConnection(const SQLString& url, const SQLString& user, const SQLString& pwd);The static getConnection() methods in the sql::DriverManager class:
sql::DriverManager class to establish a connection, because they are static.try { .. } catch ( .. ) { .. } to catch the exception.For example:
+try {
+ // Configure Connection, including an optional initial database name "places":
+ sql::SQLString url("jdbc:mariadb://example.skysql.net:5009/places");
+
+ // Use a properties map for the other connection options
+ sql::Properties properties({
+ {"user", "db_user"},
+ {"password", "db_user_password"},
+ {"autocommit", false},
+ {"useTls", true},
+ {"tlsCert", "classpath:static/skysql_chain.pem"},
+ });
+
+ // Establish Connection
+ // Use a smart pointer for extra safety
+ std::unique_ptr<sql::Connection> conn(DriverManager::getConnection(url, properties));
+ } catch (...) {
+ cerr << "Invalid database connection" << endl;
+ exit (EXIT_FAILURE);
+}
+The following code demonstrates how to connect using the example database and user account:
+// Includes
+#include <iostream>
+#include <mariadb/conncpp.hpp>
+
+// Main Process
+int main(int argc, char **argv)
+{
+ try {
+ // Instantiate Driver
+ sql::Driver* driver = sql::mariadb::get_driver_instance();
+
+ // Configure Connection, including initial database name "test":
+ sql::SQLString url("jdbc:mariadb://example.skysql.net:5009/test");
+
+ // Use a properties map for the other connection options
+ sql::Properties properties({
+ {"user", "db_user"},
+ {"password", "db_user_password"},
+ {"autocommit", false},
+ {"useTls", true},
+ {"tlsCert", "classpath:static/skysql_chain.pem"},
+ });
+
+ // Establish Connection
+ // Use a smart pointer for extra safety
+ std::unique_ptr<sql::Connection> conn(driver->connect(url, properties));
+
+ // Use Connection
+ // ...
+
+ // Close Connection
+ conn->close();
+ }
+
+ // Catch Exceptions
+ catch (sql::SQLException& e) {
+ std::cerr << "Error Connecting to the database: "
+ << e.what() << std::endl;
+
+ // Exit (Failed)
+ return 1;
+ }
+
+ // Exit (Success)
+ return 0;
+}
+MariaDB Connector/C enables C and C++ applications to establish client connections to SkySQL and MariaDB database products over TLS. MariaDB Connector/C is a native connector that is written in C.
+MariaDB Connector/C is compatible with:
+MariaDB Connector/C enables C and C++ applications to establish client connections to SkySQL and MariaDB database products over TLS.
+Additional information on MariaDB Connector/C is available in the MariaDB Knowledge Base.
+The connection is configured via the information that is initially acquired from the SkySQL Portal pages:
+| Function | +Option/Argument | +Where to find it | +
|---|---|---|
| mysql_optionsv() | +MYSQL_OPT_SSL_CA option | +The path to the skysql_chain.pem file containing the https://mariadb.com/docs/skysql-previous-release/connect/connection-parameters-portal/#Certificate_Authority_Chain | +
| • https://supplychain.mariadb.com/skysql_chain.pem | ++ | + |
| • https://supplychain.mariadb.com/aws_skysql_chain.pem | ++ | + |
| mysql_real_connect() | +host argument | +The fully Qualified Domain Name in the https://mariadb.com/docs/skysql-previous-release/connect/connection-parameters-portal/ | +
| mysql_real_connect() | +user argument | +The desired username, which might be the default username in the Service Credentials view | +
| mysql_real_connect() | +passwd argument | +The user's password, which might be the default password in the Service Credentials view if it was not yet customized | +
| mysql_real_connect() | +port argument | +The Read-Write Port or Read-Only Port in the https://mariadb.com/docs/skysql-previous-release/connect/connection-parameters-portal/ | +
The following code demonstrates how to use MariaDB Connector/C to connect to MariaDB database products. This example uses the example database and user account:
+#include <stdio.h>
+#include <stdlib.h>
+#include <mysql.h>
+
+int main (int argc, char* argv[])
+{
+
+ // Initialize Connection
+ MYSQL *conn;
+ if (!(conn = mysql_init(0)))
+ {
+ fprintf(stderr, "unable to initialize connection struct\n");
+ exit(1);
+ }
+
+ // Connect to the database
+ if (!mysql_real_connect(
+ conn, // Connection
+ "example.skysql.net", // Host
+ "db_user", // User account
+ "db_user_password", // User password
+ "test", // Default database
+ 3006, // Port number
+ NULL, // Path to socket file
+ 0 // Additional options
+ ))
+ {
+ // Report the failed-connection error & close the handle
+ fprintf(stderr, "Error connecting to Server: %s\n", mysql_error(conn));
+ mysql_close(conn);
+ exit(1);
+ }
+
+ // Use the Connection
+ // ...
+
+ // Close the Connection
+ mysql_close(conn);
+
+ return 0;
+}
+Java developers can use MariaDB Connector/R2DBC to connect to MariaDB database products using the Reactive Relational Database Connectivity (R2DBC) API. R2DBC operations are non-blocking, which makes the R2DBC API more scalable than Java's standard JDBC API. MariaDB Connector/R2DBC is available both with a native R2DBC implementation and the Spring Data R2DBC framework.
+| Connector | +MariaDB Connector/R2DBC | +MariaDB Connector/R2DBC | +
|---|---|---|
| Supported Versions | +1.0 | +1.1 | +
| Programming Language | +Java | +Java | +
| Programming Language Version | +Java 8+ | +Java 8+ | +
| API | +https://r2dbc.io/spec/0.8.5.RELEASE/spec/html/ | +https://r2dbc.io/spec/1.0.0.RELEASE/spec/html | +
| Supports TLS | +Yes | +Yes | +
| Supports Connection Pools | +Yes | +Yes | +
| License | +Apache 2.0 | +Apache 2.0 | +
For details on how to use MariaDB Connector/R2DBC, choose a supported framework:
+| https://mariadb.com/docs/skysql-previous-release/connect/programming-languages/java-r2dbc/native/ | +The native implementation of R2DBC can be used to connect using MariaDB Connector/R2DBC from within your Java application. | +
|---|---|
| https://mariadb.com/docs/skysql-previous-release/connect/programming-languages/java-r2dbc/spring/ | +Spring Data implementation of R2DBC allows you to connect using MariaDB Connector/R2DBC using the Spring Framework. | +
Application developers can use MariaDB Connector/ODBC to establish a data source for client connections with MariaDB database products.
+The method for configuring the data source varies between operating systems.
+Configure unixODBC to recognize the driver by creating a file called MariaDB_odbc_driver_template.iniwith the relevant driver definition.
For example, on CentOS / RHEL / Rocky Linux:
+[MariaDB ODBC 3.1 Driver]
+Description = MariaDB Connector/ODBC v.3.1
+Driver = /usr/lib64/libmaodbc.so
+On Debian / Ubuntu:
+[MariaDB ODBC 3.1 Driver]
+Description = MariaDB Connector/ODBC v.3.1
+Driver = /usr/lib/libmaodbc.so
+Install the driver using the odbcinst command.
For example:
+$ sudo odbcinst -i -d -f MariaDB_odbc_driver_template.ini
+odbcinst: Driver installed. Usage count increased to 1.
+Target directory is /etc
+Determine the connection parameters for your database.
+Configure unixODBC to connect to the data source by creating a file called MariaDB_odbc_data_source_template.iniwith the relevant data source parameters. Be sure to specify SSLVERIFY = 1 for your SkySQL database.
For example:
+# Data Source for unixODBC
+[My-Test-Server]
+Description = Describe your database setup here
+Driver = MariaDB ODBC 3.1 Driver
+Trace = Yes
+TraceFile = /tmp/trace.log
+SERVER = localhost
+SOCKET = /var/run/mysqld/mysqld.sock
+USER = db_user
+PASSWORD = db_user_password
+DATABASE = test
+# Data Source for unixODBC
+[My-Test-Server]
+Description = Describe your database setup here
+Driver = MariaDB ODBC 3.1 Driver
+Trace = Yes
+TraceFile = /tmp/trace.log
+SERVER = example.skysql.com
+PORT = 3306
+SSLVERIFY = 1
+USER = db_user
+PASSWORD = db_user_password
+DATABASE = test
+SSLCA = /path/to/ca-cert.pem
+SSLKEY = /path/to/client-key.pem
+SSL_CERT = /path/to/client-cert.pem
+Install the unixODBC data source template file:
$ sudo odbcinst -i -s -h -f MariaDB_odbc_data_source_template.ini
+Test the data source My-Test-Serverconfigured in the MariaDB_odbc_data_source_template.ini
+file using the isql command. If you see the output below, you have successfully connected to your Sky database.
$ isql -v My-Test-Server
++-------------------------+
+| Connected! |
+| sql-statement |
+| help[tablename] |
+| quit |
++-------------------------+
+SQL>
+To select your new data source in your application, select the data source with the name that you configured, which is My-Test-Server in the above example.
Confirm that MariaDB Connector/ODBC has been registered withiODBC by confirming that the following options are set in the iODBCconfiguration file at /Library/ODBC/odbcinst.ini:
[ODBC]
+Trace = no
+TraceFile = /tmp/iodbc_trace.log
+
+[ODBC Drivers]
+MariaDB ODBC 3.1 Unicode Driver = Installed
+
+[MariaDB ODBC 3.1 Unicode Driver]
+Driver = /Library/MariaDB/MariaDB-Connector-ODBC/libmaodbc.dylib
+Description = MariaDB Connector/ODBC(Unicode) 3.1 64bit
+Threading = 0
+Determine the connection parameters for your database.
+Add a data source for your database to iODBC by adding the following options to the iODBC configuration file at /Library/ODBC/odbc.ini:
[ODBC Data Sources]
+My-Test-Server = MariaDB ODBC 3.1 Unicode Driver
+
+[My-Test-Server]
+Driver = /Library/MariaDB/MariaDB-Connector-ODBC/libmaodbc.dylib
+SERVER = 192.0.2.1
+DATABASE = test
+USER = db_user
+PASSWORD = db_user_password
+SERVER, SOCKET, DATABASE, PORT, USER, and PASSWORD parameters with the relevant value for your environment.iodbctestcommand:$ iodbctest "DSN=My-Test-Server"
+To select your new data source in your application, select the data source with the name that you configured, which is My-Test-Server in the above example.
MariaDB Connector/ODBC requires at least Windows 8.
+Windows 10 was used to prepare these instructions. When using other versions of Windows, these instructions may require adjustment.
+MariaDB Connector/ODBC supports failover in case one or more hosts are not available.
+The failover feature requires using MariaDB Connector/ODBC 3.1.16 or greater with MariaDB Connector/C 3.3 or greater.
+MariaDB Connector/ODBC 3.1.16 and greater is statically linked for Windows and macOS with MariaDB Connector/C 3.3.1. MariaDB Connector/ODBC 3.1.16 and greater is dynamically linked for Linux with MariaDB Connector/C.
+The failover feature is enabled by providing a comma separated list of hosts as a server name.
+The failover host string is the SERVER string. If the SERVER string does not include a port, the default port will be used.
The following syntax is required:
+"[]"":"hostname:port pairs must be be separated by a comma ","hostname:port is specified, the host string must end with a commaAn example of a failover host string:
+[::1]:3306,192.168.0.1:3307,test.example.com
| Connection Parameter | +Description | +Default Value | +
|---|---|---|
| DRIVER | +• On Linux, the name of the driver, which is configured in the | ++ |
| unixODBC driver template file. | ++ | + |
| • On macOS, the path to the driver's shared library, which is | ++ | + |
| installed at /Library/MariaDB/MariaDB-Connector-ODBC/libmaodbc.dylib | ++ | + |
| by default. | ++ | + |
| SERVER | +Host name, IPv4 address, or IPv6 address of the database | ++ |
| server. | +localhost | ++ |
| SOCKET | +• The path to the socket file. On Linux, MariaDB Enterprise Server | ++ |
| uses different default socket files on different Linux | ++ | + |
| distributions. | ++ | + |
| • On Debian / Ubuntu, the default socket file is /var/run/mysqld/mysqld.sock | ++ | + |
| or /run/mysqld/mysqld.sock. | ++ | + |
| • On CentOS / RHEL / Rocky Linux, the default socket file is /var/lib/mysql/mysql.sock. | +/tmp/mysql.sock | ++ |
| DATABASE | +Database name to select upon successful connection. The database | ++ |
| must already exist, and the user account must have privileges to select | ++ | + |
| it. | ++ | + |
| PORT | +TCP port of the database server. | +3306 | +
| USER | +The username to use for authentication. | ++ |
| PASSWORD | +User password. | ++ |
| FORWARDONLY | +When enabled, cursors are created as SQL_CURSOR_FORWARD_ONLY, | ++ |
| so they can only move forward. Starting in Connector/ODBC 3.2, cursors | ++ | + |
| are SQL_CURSOR_FORWARD_ONLY | ++ | + |
| by default. In previous releases, cursors are created as SQL_CURSOR_STATIC by | ++ | + |
| default. | ++ | + |
| NO_CACHE | +When enabled, result set streaming is enabled, which enables the | ++ |
| application to fetch result sets from the server row-by-row instead of | ++ | + |
| caching the entire result set on the client side. Since the application | ++ | + |
| is not caching the entire result set, the application is less likely to | ++ | + |
| run out of memory when working with large result sets. | ++ | + |
| STREAMRS | +Alias for the NO_CACHE connection | ++ |
| parameter. | ++ | + |
| OPTIONS | +See about:blank#OPTIONS_Bitmaskabout:blank#OPTIONS_Bitmask. | ++ |
| PREPONCLIENT | +When enabled, the SQLPrepare ODBC API | ++ |
| function uses the text protocol and client-side prepared statements | ++ | + |
| (CSPS). | ++ | + |
| ATTR | +Sets connection attributes that can be queried via the https://www.notion.so../../../../ref/mdb/performance-schema/session_account_connect_attrs/https://www.notion.so../../../../../server/ref/mdb/performance-schema/session_account_connect_attrs/ | ++ |
| and https://www.notion.so../../../../ref/mdb/performance-schema/session_connect_attrs/https://www.notion.so../../../../../server/ref/mdb/performance-schema/session_connect_attrs/ | ++ | + |
| tables when https://www.notion.so../../../../ref/mdb/system-variables/performance_schema/https://www.notion.so../../../../../server/ref/mdb/system-variables/performance_schema/ | ++ | + |
| is enabled. Specify attributes in the format ATTR={ |
++ | + |
| What | +Where to find it | +
|---|---|
| DRIVER | +• On Linux, the name of the driver, which is configured in the | +
| unixODBC driver template file. | ++ |
| • On macOS, the path to the driver's shared library, which is | ++ |
| installed at /Library/MariaDB/MariaDB-Connector-ODBC/libmaodbc.dylib | ++ |
| by default. | ++ |
| SERVER | +Fully Qualified Domain Name in the https://www.notion.so../../../connection-parameters-portal/ | +
| PORT | +Read-Write Port or Read-Only Port in the https://www.notion.so../../../connection-parameters-portal/ | +
| USER | +Default username in the Service Credentials view, or the username | +
| you created | ++ |
| PASSWORD | +Default password in the Service Credentials view, the password | +
| you set on the default user, or the password for the user you | ++ |
| created | ++ |
| SSLVERIFY | +Set to 1 to connect with SSL | +
| FORCETLS | +Set to 1 to enable TLS | +
| FORWARDONLY | +When enabled, cursors are created as SQL_CURSOR_FORWARD_ONLY, | +
| so they can only move forward. Starting in Connector/ODBC 3.2, cursors | ++ |
| are SQL_CURSOR_FORWARD_ONLY | ++ |
| by default. In previous releases, cursors are created as SQL_CURSOR_STATIC by | ++ |
| default. | ++ |
| NO_CACHE | +When enabled, result set streaming is enabled, which enables the | +
| application to fetch result sets from the server row-by-row instead of | ++ |
| caching the entire result set on the client side. Since the application | ++ |
| is not caching the entire result set, the application is less likely to | ++ |
| run out of memory when working with large result sets. | ++ |
| STREAMRS | +Alias for the NO_CACHE connection | +
| parameter. | ++ |
| OPTIONS | +See about:blank#OPTIONS_Bitmaskabout:blank#OPTIONS_Bitmask. | +
| PREPONCLIENT | +When enabled, the SQLPrepare ODBC API | +
| function uses the text protocol and client-side prepared statements | ++ |
| (CSPS). | ++ |
| ATTR | +Sets connection attributes that can be queried via the https://www.notion.so../../../../ref/mdb/performance-schema/session_account_connect_attrs/ | +
| and https://www.notion.so../../../../ref/mdb/performance-schema/session_connect_attrs/ | ++ |
| tables when https://www.notion.so../../../../ref/mdb/system-variables/performance_schema/ | ++ |
| is enabled. Specify attributes in the format ATTR={ |
++ |
OPTIONS BitmaskThe OPTIONS bitmask
+contains the following bits:
| Bit Number | +Bit Value | +Description | +
|---|---|---|
| 0 | +1 | +Unused | +
| 1 | +2 | +Tells connector to return the number of matched rows instead of | +
| number of changed rows | ++ | + |
| 4 | +16 | +Same as NO_PROMPT connection | +
| parameter | ++ | + |
| 5 | +32 | +Forces all cursors to be dynamic | +
| 6 | +64 | +Forbids the DATABASE_NAME.TABLE_NAME.COLUMN_NAME | +
| syntax | ++ | + |
| 11 | +2048 | +Enables compression in the protocol | +
| 13 | +8192 | +Same as the NAMEDPIPE connection | +
| parameter | ++ | + |
| 16 | +65536 | +Same as the USE_MYCNF connection | +
| parameter | ++ | + |
| 20 | +1048576 | +Same as the NO_CACHE connection | +
| parameter | ++ | + |
| 21 | +2097152 | +Same as the FORWARDONLY | +
| connection parameter | ++ | + |
| 22 | +4194304 | +Same as the AUTO_RECONNECT | +
| connection parameter | ++ | + |
| 26 | +67108864 | +Enables multi-statement queries | +
This page describes how to connect to a SkySQL database using a MariaDB-compatible client.
+Note
+💡 Access to all services are protected by a firewall, by default. You need to IP whitelist your client’s (your desktop, laptop or server) IP. Just select ‘Manage —> Security Access’ and then click ‘Add my current IP’ to add the IP of your current workstation (laptop, desktop).
+Note
+💡 If you are not sure or unable to obtain the IP address, you can use 0.0.0.0/0 to effectively disable the firewall. Goes without saying — don’t do this for your production DBs.
+For more details go to the Firewall settings page.
+Once your DB service is launched, click on the ‘Connect’ option for your service on the dashboard. This pops up all the required attributes to connect from any SQL client.
+Connection parameters include:
+
If using a mac, install MariaDB using brew install mariadb. Go through MariaDB Client for details on how to connect from Linux or Windows.
Finally, simply copy/paste the MariaDB CLI command as displayed in the Connect window.
+Applications can connect to MariaDB SkySQL DBs using any of the below MariaDB supported connectors. There are several other connectors from the community too.
+Note
+💡 For Enterprise Server With Replica(s), you can also use any MongoDB client and use the NoSQL Interface
+Clients listed here have been tested to properly connect with MariaDB SkySQL and execute queries.
+Note
+💡 Unlike previous SkySQL versions, the current version no longer requires clients to supply the Server SSL Certificate for SSL connections. Customers who migrated from MariaDB corporation to SkySQL Inc can continue to use provided certificates (when using the previous SkySQL method for connecting). But, we strongly recommend moving to the connection properties as shown in the Connect window for your service
+Most of the SQL clients and editors natively support MariaDB. Most often you can also just select 'MySQL' and connect to your SkySQL DB service.
+Note
+💡 The links below point to the older version of Docs. In all cases you DO NOT need to pass any Certificates. Just set 'use SSL' where available to true when using SSL.
+MariaDB SkySQL customers can import data into a SkySQL service using the LOAD DATA LOCAL INFILE SQL statement:
LOAD DATA LOCAL INFILE statement can import data from TSV and CSV filesLOAD DATA LOCAL INFILE statement can be executed by any client or connectorNote
+Make sure your schema is already created in the database. If you need to import entire databases or create tables, you should use mariab-import.
+Support for local infiles must be enabled on the client side and on the SkySQL service.
+To execute the LOAD DATA LOCAL INFILE statement, most clients and connectors require a specific option to be enabled.
If you are using mariadb client, the --local-infile option must be specified.
Support for local infiles must be enabled on the SkySQL service.
+For SkySQL services that use MariaDB Enterprise Server and MariaDB Enterprise ColumnStore, the local_infile system variable must be enabled:
+OFF by defaultConfiguration Manager can be used to modify the value of the local_infile system variable.
+mariadb client and specify the -local-infile option, which is needed by the next step:mariadb --host FULLY_QUALIFIED_DOMAIN_NAME --port TCP_PORT \
+ --user DATABASE_USER --password \
+ --ssl-verify-server-cert \
+ --ssl-ca ~/PATH_TO_PEM_FILE \
+ --default-character-set=utf8 \
+ --local-infile
+After the command is executed, you will be prompted for a password. Enter the default password for your default user, the password you set for the default user, or the password for the database user you created.
+For each table that you want to import, execute the LOAD DATA LOCAL INFILE statement to import the data from the TSV or CSV file into your MariaDB SkySQL database service.
+For a TSV file:
+LOAD DATA LOCAL INFILE 'contacts.tsv'
+INTO TABLE accounts.contacts;
+For a CSV file:
+LOAD DATA LOCAL INFILE 'contacts.csv'
+INTO TABLE accounts.contacts
+FIELDS TERMINATED BY ',';
+If you are using a MariaDB Connector, then you must select the method for the specific connector from the list below.
+If you are using MariaDB Connector/C, the MYSQL_OPT_LOCAL_INFILE option can be set with the mysql_optionsv() function:
/* enable local infile */
+unsigned int enable_local_infile = 1;
+mysql_optionsv(mysql, MYSQL_OPT_LOCAL_INFILE, (void *) &enable_local_infile);
+If you are using MariaDB Connector/J, the allowLocalInfile parameter can be set for the connection:
Connection connection = DriverManager.getConnection("jdbc:mariadb://FULLY_QUALIFIED_DOMAIN_NAME:TCP_PORT/test?user=DATABASE_USER&password=DATABASE_PASSWORD&allowLocalInfile=true");
+If you are using MariaDB Connector/Node.js, the permitLocalInfile parameter can be set for the connection:
mariadb.createConnection({
+ host: 'FULLY_QUALIFIED_DOMAIN_NAME',
+ port: 'TCP_PORT',
+ user:'DATABASE_USER',
+ password: 'DATABASE_PASSWORD',
+ permitLocalInfile: 'true'
+ });
+If you are using MariaDB Connector/Python, the local_infile parameter can be set for the connection:
conn = mariadb.connect(
+ user="DATABASE_USER",
+ password="DATABASE_PASSWORD",
+ host="FULLY_QUALIFIED_DOMAIN_NAME",
+ port=TCP_PORT,
+ local_infile=true)
+Data can be loaded to SkySQL services with the assistance of SkySQL Support or by using self-service tools. When importing large data sets, we recommend working with SkySQL Support.
+Instructions are provided for the following data import methods:
+| Data Import Method | +Use Case | +
|---|---|
| https://mariadb.com/docs/skysql-dbaas/data-operations/data-import/nr-support-assisted/ | +Coordinate data import with SkySQL Support | +
| https://mariadb.com/docs/skysql-dbaas/data-operations/data-import/nr-load-data-local-infile/ | +Import TSV (tab-delimited) or CSV (comma-delimited) file data using the LOAD DATA LOCAL INFILE statement with your database client | +
| https://mariadb.com/docs/skysql-dbaas/data-operations/data-import/nr-mariadb-import/ | +Import TSV (tab-delimited) or CSV (comma-delimited) file data using the mariadb-import utility | +
To export data from a MySQL/MariaDB database and import it into MariaDB SkySQL, you can follow these steps:
+Start by using the mysqldump command to export the data from the source database. This command allows you to create a backup of your database in a SQL file. For example, you can use the following command:
mysqldump -u [username] -p [database_name] > dump.sql
+In this command, replace [username] with your MySQL/MariaDB username and [database_name] with the name of the database you want to export. The > symbol redirects the output to a file named dump.sql.
An optional step - Once you have exported the data, you need to transfer the dump.sql file to the destination server where you can efficiently connect to your MariaDB SkySQL database. This is typically the same cloud provider region where your Sky DB is running.
CREATE DATABASE statement. This step is necessary if you want to import the data into a new database. If you already have a database in which you want to import the data, you can skip this step.Finally, import the data from the dump.sql file into the destination database using the mariadb or mysql command. This command reads the SQL statements in the file and executes them in the specified database. Here's an example command:
## mariadb -u [username] -p [database_name] < dump.sql
+
+mariadb --host dbpwp27784332.orgtd5j0.db1.skysql.mariadb.com --port 3306 --user dbpwp27784332 -p [database_name] < dump.sql
+Replace [hostname], username] with your MariaDB SkySQL username and [database_name] with the name of the destination database. The < symbol is used to redirect the input from the file dump.sql.
By following these steps, you will be able to export data from your MySQL/MariaDB database and import it into MariaDB SkySQL, ensuring a smooth transition of your data.
+ + + + +MariaDB SkySQL customers can manually create a backup of a SkySQL service using the mariadb-dump utility:
mariadb-dump utility provides a command-line interface (CLI)mariadb-dump utility is available for Linux and Windowsmariadb-dump utility supports many command-line optionsFor details about restoring a backup created with the mariadb-dump utility, see "Restore a Manual Backup".
Installation of MariaDB Dump varies by operating system.
+Configure YUM package repositories:
+`$ sudo yum install wget
+$ wget https://downloads.mariadb.com/MariaDB/mariadb_repo_setup
+$ echo "935944a2ab2b2a48a47f68711b43ad2d698c97f1c3a7d074b34058060c2ad21b mariadb_repo_setup" \ | sha256sum -c -
+$ chmod +x mariadb_repo_setup
+$ sudo ./mariadb_repo_setup \ --mariadb-server-version="mariadb-10.6"`
+Install MariaDB Dump and package dependencies:
+$ sudo yum install MariaDB-client
Configure APT package repositories:
+`$ sudo apt install wget
+$ wget https://downloads.mariadb.com/MariaDB/mariadb_repo_setup
+$ echo "935944a2ab2b2a48a47f68711b43ad2d698c97f1c3a7d074b34058060c2ad21b mariadb_repo_setup" \ | sha256sum -c -
+$ chmod +x mariadb_repo_setup
+$ sudo ./mariadb_repo_setup \ --mariadb-server-version="mariadb-10.6"$ sudo apt update`
+Install MariaDB Dump and package dependencies:
+$ sudo apt install mariadb-client
Configure ZYpp package repositories:
+`$ sudo zypper install wget
+$ wget https://downloads.mariadb.com/MariaDB/mariadb_repo_setup
+$ echo "935944a2ab2b2a48a47f68711b43ad2d698c97f1c3a7d074b34058060c2ad21b mariadb_repo_setup" \ | sha256sum -c -
+$ chmod +x mariadb_repo_setup
+$ sudo ./mariadb_repo_setup \ --mariadb-server-version="mariadb-10.6"`
+Install MariaDB Dump and package dependencies:
+$ sudo zypper install MariaDB-client
The procedure to create a backup depends on the operating system.
+If you plan to restore the backup to a SkySQL service, the mysql database should be excluded from the backup by specifying [--ignore-database=mysql](https://mariadb.com/docs/skysql-dbaas/ref/mdb/cli/mariadb-dump/ignore-database/), because SkySQL user accounts do not have sufficient privileges to restore that database.
mariadb-dump --host FULLY_QUALIFIED_DOMAIN_NAME --port TCP_PORT \
+ --user DATABASE_USER --password \
+ --ssl-verify-server-cert \
+ --ssl-ca ~/PATH_TO_PEM_FILE \
+ --all-databases \
+ --ignore-database=mysql \
+ --single-transaction \
+ --events \
+ --routines \
+ --default-character-set=utf8mb4 \
+ > skysql_dump.sql
+FULLY_QUALIFIED_DOMAIN_NAME with the Fully Qualified Domain Name of your service.TCP_PORT with the read-write or read-only port of your service.DATABASE_USER with the default username for your service, or the username you created.~/PATH_TO_PEM_FILE with the path to the certificate authority chain (.pem) file.After the command is executed, you will be prompted for a password. Enter the default password for your default user, the password you set for the default user, or the password for the database user you created.
+Fix your executable search path.
+On Windows, MariaDB Dump is not typically found in the executable search path by default. You must find its installation path, and add that path to the executable search path:
+$ SET "PATH=C:\Program Files\MariaDB 10.6\bin;%PATH%"
Determine the connection parameters for your MariaDB SkySQL service.
+mariadb-dump --host FULLY_QUALIFIED_DOMAIN_NAME --port TCP_PORT \
+ --user DATABASE_USER --password \
+ --ssl-verify-server-cert \
+ --ssl-ca ~/PATH_TO_PEM_FILE \
+ --all-databases \
+ --ignore-database=mysql \
+ --single-transaction \
+ --events \
+ --routines \
+ --default-character-set=utf8mb4 \
+ > skysql_dump.sql
+FULLY_QUALIFIED_DOMAIN_NAME with the Fully Qualified Domain Name of your service.TCP_PORT with the read-write or read-only port of your service.DATABASE_USER with the default username for your service, or the username you created.PATH_TO_PEM_FILE with the path to the certificate authority chain (.pem) file.After the command is executed, you will be prompted for a password. Enter the default password for your default user, the password you set for the default user, or the password for the database user you created.
+The instructions provided above are written for MariaDB Dump 10.4 and later, which uses the binary filename of mariadb-dump.
For MariaDB Dump 10.3 and older, the binary filename was mysqldump. The instructions can be adapted for MariaDB Dump 10.3 and older by executing mysqldump rather than mariadb-dump.
For system-versioned tables and transaction-precise tables, MariaDB Dump only backs up current row versions. It does not back up historical row versions.
+ + + + + + + + + + + + + +MariaDB SkySQL customers can import data into a SkySQL service using the mariadb-import utility:
mariadb-import utility provides a command-line interface (CLI)mariadb-import utility can import data from TSV and CSV filesmariadb-import utility is available for Linux and Windowsmariadb-import utility supports many command-line optionsInstallation of MariaDB Import varies by operating system.
+Configure YUM package repositories:
+`$ sudo yum install wget
+$ wget https://downloads.mariadb.com/MariaDB/mariadb_repo_setup
+$ echo "935944a2ab2b2a48a47f68711b43ad2d698c97f1c3a7d074b34058060c2ad21b mariadb_repo_setup" \ | sha256sum -c -
+$ chmod +x mariadb_repo_setup
+$ sudo ./mariadb_repo_setup \ --mariadb-server-version="mariadb-10.6"`
+Install MariaDB Import and package dependencies:
+$ sudo yum install MariaDB-client
Configure APT package repositories:
+`$ sudo apt install wget
+$ wget https://downloads.mariadb.com/MariaDB/mariadb_repo_setup
+$ echo "935944a2ab2b2a48a47f68711b43ad2d698c97f1c3a7d074b34058060c2ad21b mariadb_repo_setup" \ | sha256sum -c -
+$ chmod +x mariadb_repo_setup
+$ sudo ./mariadb_repo_setup \ --mariadb-server-version="mariadb-10.6"$ sudo apt update`
+Install MariaDB Import and package dependencies:
+$ sudo apt install mariadb-client
Configure ZYpp package repositories:
+`$ sudo zypper install wget
+$ wget https://downloads.mariadb.com/MariaDB/mariadb_repo_setup
+$ echo "935944a2ab2b2a48a47f68711b43ad2d698c97f1c3a7d074b34058060c2ad21b mariadb_repo_setup" \ | sha256sum -c -
+$ chmod +x mariadb_repo_setup
+$ sudo ./mariadb_repo_setup \ --mariadb-server-version="mariadb-10.6"`
+Install MariaDB Import and package dependencies:
+$ sudo zypper install MariaDB-client
The procedure to import data depends on the operating system.
+Use MariaDB Import with the connection information to import the data from the TSV or CSV file into your MariaDB SkySQL database service:
+mariadb-import --host FULLY_QUALIFIED_DOMAIN_NAME --port TCP_PORT \
+ --user DATABASE_USER --password \
+ --ssl-verify-server-cert \
+ --ssl-ca ~/PATH_TO_PEM_FILE \
+ --local \
+ --ignore-lines=1 \
+ accounts contacts.tsv
+FULLY_QUALIFIED_DOMAIN_NAME with the Fully Qualified Domain Name of your serviceTCP_PORT with the read-write or read-only port of your serviceDATABASE_USER with the default username for your service, or the username you created~/PATH_TO_PEM_FILE with the path to the certificate authority chain (.pem) file-fields-terminated-by=,accounts)contacts)Fix your executable search path.
+On Windows, MariaDB Import is not typically found in the executable search path by default. You must find its installation path, and add that path to the executable search path:
+$ SET "PATH=C:\Program Files\MariaDB 10.6\bin;%PATH%"
Determine the connection parameters for your MariaDB SkySQL service.
+Use MariaDB Import with the connection information to import the data from the TSV or CSV file into your MariaDB SkySQL database service:
+mariadb-import --host FULLY_QUALIFIED_DOMAIN_NAME --port TCP_PORT \
+ --user DATABASE_USER --password \
+ --ssl-verify-server-cert \
+ --ssl-ca ~/PATH_TO_PEM_FILE \
+ --local \
+ --ignore-lines=1 \
+ accounts contacts.tsv
+FULLY_QUALIFIED_DOMAIN_NAME with the Fully Qualified Domain Name of your serviceTCP_PORT with the read-write or read-only port of your serviceDATABASE_USER with the default username for your service, or the username you created~/PATH_TO_PEM_FILE with the path to the certificate authority chain (.pem) file-fields-terminated-by=,accounts)contacts)The instructions provided above are written for MariaDB Import 10.4 and later, which uses the binary filename of mariadb-import.
For MariaDB Import 10.3 and older, the binary filename was mysqlimport. The instructions can be adapted for MariaDB Import 10.3 and older by executing mysqlimport rather than mariadb-import.
Databases can be migrated to MariaDB SkySQL from many different database platforms, including Oracle, MySQL, PostgreSQL, Microsoft SQL Server, IBM DB2, and more
+To perform a lift-and-shift migration to SkySQL, use the following process:
+SkySQL customers can receive assistance from SkySQL Inc when migrating a database to SkySQL:
+For assistance with a migration:
+We use a multi-step process to assist customers with migrations:
+For additional information, see "Whitepaper: Migrate to MariaDB from Oracle".
+This blog article details how to Migrate RDS MySQL to SkySQL MariaDB Using AWS Data Migration Service
+Click here for a detailed walk through of the steps involved.
+For assistance with a migration:
+MariaDB SkySQL customers can configure inbound replication from MySQL 5.7 to a compatible MariaDB running in SkySQL.
+For additional information about the stored procedures used to configure replication with Replicated Transactions services, see "SkySQL Replication Helper Procedures for Replicated Transactions".
+ + +On the external primary server, obtain the binary log file and position from which to start replication.
+When you want to start replication from the most recent transaction, the current binary log file position can be obtained by executing the SHOW MASTER STATUS statement:
SHOW MASTER STATUS;
+
+`+------------------+----------+--------------+------------------+-------------------+
+| File | Position | Binlog_Do_DB | Binlog_Ignore_DB | Executed_Gtid_Set |
++------------------+----------+--------------+------------------+-------------------+
+| mysql-bin.000001 | 154 | | | |
++------------------+----------+--------------+------------------+-------------------+
+On the SkySQL service, configure the binary log file and position from which to start replication.
+The binary log file and position can be configured using the sky.change_external_primary() stored procedure:
CALL sky.change_external_primary('mysql1.example.com', 3306, 'mysql-bin.000001', 154, false);
+
++--------------------------------------------------------------------------------------------------------------+
+| Run_this_grant_on_your_external_primary |
++--------------------------------------------------------------------------------------------------------------+
+| GRANT REPLICATION SLAVE ON *.* TO 'skysql_replication'@'%' IDENTIFIED BY '<password_hash>'; |
++--------------------------------------------------------------------------------------------------------------+
+This procedure will return the GRANT statement you must run on the source DB.
On the external primary server, execute the GRANT statement returned by the last step:
GRANT REPLICATION SLAVE ON *.* TO 'skysql_replication'@'%' IDENTIFIED BY '<password_hash>';
+On the SkySQL service, start replication.
+Replication can be started using the sky.start_replication() stored procedure:
CALL sky.start_replication();
++----------------------------------------+
+| Message |
++----------------------------------------+
+| External replication running normally. |
++----------------------------------------+
+On the SkySQL service, check replication status.
+Replication status can be checked using the sky.replication_status() stored procedure:
CALL sky.replication_status()\G
+
+*************************** 1. row ***************************
+ Slave_IO_State: Waiting for master to send event
+ Master_Host: mariadb1.example.com
+ Master_User: skysql_replication
+ Master_Port: 3306
+ Connect_Retry: 60
+ Master_Log_File: mysql-bin.000001
+ Read_Master_Log_Pos: 462
+ Relay_Log_File: mariadb-relay-bin.000002
+ Relay_Log_Pos: 665
+ Relay_Master_Log_File: mysql-bin.000001
+ Slave_IO_Running: Yes
+ Slave_SQL_Running: Yes
+ Replicate_Do_DB:
+ Replicate_Ignore_DB:
+ Replicate_Do_Table:
+ Replicate_Ignore_Table:
+ Replicate_Wild_Do_Table:
+ Replicate_Wild_Ignore_Table:
+ Last_Errno: 0
+ Last_Error:
+ Skip_Counter: 0
+ Exec_Master_Log_Pos: 462
+ Relay_Log_Space: 985
+ Until_Condition: None
+ Until_Log_File:
+ Until_Log_Pos: 0
+ Master_SSL_Allowed: No
+ Master_SSL_CA_File:
+ Master_SSL_CA_Path:
+ Master_SSL_Cert:
+ Master_SSL_Cipher:
+ Master_SSL_Key:
+ Seconds_Behind_Master: 0
+ Master_SSL_Verify_Server_Cert: No
+ Last_IO_Errno: 0
+ Last_IO_Error:
+ Last_SQL_Errno: 0
+ Last_SQL_Error:
+ Replicate_Ignore_Server_Ids:
+ Master_Server_Id: 200
+ Master_SSL_Crl:
+ Master_SSL_Crlpath:
+ Using_Gtid: No
+ Gtid_IO_Pos:
+ Replicate_Do_Domain_Ids:
+ Replicate_Ignore_Domain_Ids:
+ Parallel_Mode: conservative
+ SQL_Delay: 0
+ SQL_Remaining_Delay: NULL
+ Slave_SQL_Running_State: Slave has read all relay log; waiting for more updates
+ Slave_DDL_Groups: 0
+Slave_Non_Transactional_Groups: 0
+ Slave_Transactional_Groups: 0
+When replicating from another MariaDB database, you can use GTID based replication. The first two steps are different from MySQL.
+On the external primary server, obtain the GTID position from which to start replication.
+When you want to start replication from the most recent transaction, the current GTID position can be obtained by querying the value of the gtid_current_pos system variable with the SHOW GLOBAL VARIABLES statement:
SHOW GLOBAL VARIABLES LIKE 'gtid_current_pos';
+
+`+------------------+---------+
+| Variable_name | Value |
++------------------+---------+
+| gtid_current_pos | 0-100-1 |
++------------------+---------+
+On the SkySQL service, configure the GTID position from which to start replication.
+The GTID position can be configured using the sky.change_external_primary_gtid() stored procedure:
CALL sky.change_external_primary_gtid('mariadb1.example.com', 3306, '0-100-1', false);
+
++--------------------------------------------------------------------------------------------------------------+
+| Run_this_grant_on_your_external_primary |
++--------------------------------------------------------------------------------------------------------------+
+| GRANT REPLICATION SLAVE ON *.* TO 'skysql_replication'@'%' IDENTIFIED BY '<password_hash>'; |
++--------------------------------------------------------------------------------------------------------------+
+The stored procedure returns a GRANT statement that is used in the next step.
To configure inbound replication from an external primary server using MariaDB Server to your Replicated Transactions service in SkySQL, the following requirements must be met:
+MariaDB SkySQL customers can configure outbound replication from a Replicated Transactions service to a compatible MariaDB Server running elsewhere - could be your data center, self-managed MariaDB DB on the cloud or even other managed services like AWS RDS.
+SkySQL uses stored procedures to configure replication to other MariaDB or MySQL database servers.
+For additional information about the stored procedures used to configure replication with Replicated Transactions services, see SkySQL Replication Helper Procedures for Replicated Transactions
+To configure outbound replication from your Replicated Transactions service in SkySQL to an external replica server using MariaDB Server, the following requirements must be met:
+With the default database admin user provided, create an external_replication user as seen below.
+CREATE USER 'replication_user'@'%' IDENTIFIED BY 'bigs3cret';
+GRANT REPLICATION SLAVE ON *.* TO ‘external_replication’@'hostname';
+On the SkySQL service, confirm that the new user has sufficient privileges by executing
+SHOW GRANTS FOR 'external_replication'@'%';
++-------------+
+| Grants for external_replication@% |
++-------------+
+| GRANT REPLICATION SLAVE, SLAVE MONITOR ON *.* TO `external_replication`@`%` IDENTIFIED BY PASSWORD '*CCD3A959D6A004B9C3807B728BC2E55B67E10518' |
++-------------+
+On the SkySQL Customer Portal, add the IP address of the external replica server to the SkySQL service's allowlist +- Click ‘Manage’→ ‘Manage Allowlist’ to add the IP address to the allowed list.
+ + +On the SkySQL service, obtain the GTID position from which to start replication.
+When you want to start replication from the most recent transaction, the current GTID position can be obtained by querying the value of the 'gtid_current_pos:
+SHOW GLOBAL VARIABLES
+ LIKE 'gtid_current_pos';
+`+------------------+-------------------+
+| Variable_name | Value |
++------------------+-------------------+
+| gtid_current_pos | 435700-435700-124 |
++------------------+-------------------+`
+On the external replica server, configure the GTID position from which to start replication.
+The GTID position can be configured by setting the 'gtid_slave_pos':
+SET GLOBAL gtid_slave_pos='435700-435700-124';
+On the external replica server, configure replication using the connection parameters for your MariaDB SkySQL service.
+Replication can be configured using the 'CHANGE MASTER TO' SQL statement:
+CHANGE MASTER TO
+ MASTER_HOST='FULLY_QUALIFIED_DOMAIN_NAME',
+ MASTER_PORT=TCP_PORT,
+ MASTER_USER='external_replication',
+ MASTER_PASSWORD='my_password',
+ MASTER_SSL=1,
+ MASTER_SSL_CA='~/PATH_TO_PEM_FILE',
+ MASTER_USE_GTID=slave_pos;
+FULLY_QUALIFIED_DOMAIN_NAME with the Fully Qualified Domain Name of your serviceTCP_PORT with the read-write or read-only port of your service~/PATH_TO_PEM_FILE with the path to the certificate authority chain (.pem) fileOn the external replica server, start replication.
+Replication can be started using the 'START REPLICA' SQL statement:
+START REPLICA;
+On the external replica server, check replication status.
+Replication status can be checked using the 'SHOW REPLICA STATUS' SQL statement:
+SHOW REPLICA STATUS \G
+
+*************************** 1. row ***************************
+ Slave_IO_State: Waiting for master to send event
+ Master_Host: my-service.mdb0002147.db.skysql.net
+ Master_User: external_replication
+ Master_Port: 5003
+ Connect_Retry: 60
+ Master_Log_File: mariadb-bin.000001
+ Read_Master_Log_Pos: 558
+ Relay_Log_File: mariadb-relay-bin.000002
+ Relay_Log_Pos: 674
+ Relay_Master_Log_File: mariadb-bin.000001
+ Slave_IO_Running: Yes
+ Slave_SQL_Running: Yes
+ Replicate_Do_DB:
+ Replicate_Ignore_DB:
+ Replicate_Do_Table:
+ Replicate_Ignore_Table:
+ Replicate_Wild_Do_Table:
+ Replicate_Wild_Ignore_Table:
+ Last_Errno: 0
+ Last_Error:
+ Skip_Counter: 0
+ Exec_Master_Log_Pos: 558
+ Relay_Log_Space: 985
+ Until_Condition: None
+ Until_Log_File:
+ Until_Log_Pos: 0
+ Master_SSL_Allowed: Yes
+ Master_SSL_CA_File: /var/lib/mysql/skysql_chain.pem
+ Master_SSL_CA_Path:
+ Master_SSL_Cert:
+ Master_SSL_Cipher:
+ Master_SSL_Key:
+ Seconds_Behind_Master: 0
+ Master_SSL_Verify_Server_Cert: No
+ Last_IO_Errno: 0
+ Last_IO_Error:
+ Last_SQL_Errno: 0
+ Last_SQL_Error:
+ Replicate_Ignore_Server_Ids:
+ Master_Server_Id: 435701
+ Master_SSL_Crl: /var/lib/mysql/skysql_chain.pem
+ Master_SSL_Crlpath:
+ Using_Gtid: Slave_Pos
+ Gtid_IO_Pos: 435700-435700-127
+ Replicate_Do_Domain_Ids:
+ Replicate_Ignore_Domain_Ids:
+ Parallel_Mode: optimistic
+ SQL_Delay: 0
+ SQL_Remaining_Delay: NULL
+ Slave_SQL_Running_State: Slave has read all relay log; waiting for more updates
+ Slave_DDL_Groups: 0
+Slave_Non_Transactional_Groups: 0
+ Slave_Transactional_Groups: 0
+Note
+TODO - this section needs detailed review
+The simplest way to offload your database is to use the mariadb-dump utility:
mariadb-dump utility provides a command-line interface (CLI)mariadb-dump utility is available for Linux and Windowsmariadb-dump utility supports many command-line optionsmariadb-dump usage is fully described here.
Use MariaDB Client with the connection information to export your schema from your MariaDB SkySQL database service. Here is an example to export all rows from a single table:
+mariadb --host FULLY_QUALIFIED_DOMAIN_NAME --port TCP_PORT \
+ --user DATABASE_USER --password \
+ --ssl-verify-server-cert \
+ --default-character-set=utf8 \
+ --batch \
+ --skip-column-names \
+ --execute='SELECT * FROM accounts.contacts;' \
+ > contacts.tsv
+FULLY_QUALIFIED_DOMAIN_NAME with the Fully Qualified Domain Name of your service.TCP_PORT with the read-write or read-only port of your service.DATABASE_USER with the default username for your service, or the username you created.~/PATH_TO_PEM_FILE with the path to the certificate authority chain (.pem) file.you can use the SELECT INTO OUTFILE statement to export query results directly to a file. This is useful for exporting specific data from tables.
Usage:
+SELECT * INTO OUTFILE '/path/to/file.csv' FIELDS TERMINATED BY ',' FROM your_table;
+Note
+Note that this file system export is not directly accessible to SkySQL users. To generate CSV files, you should contact SkySQL support.
+SkySQL is a database-as-a-service (DBaaS) that was originally developed and managed by MariaDB Corporation. The cloud division (SkySQL) was later spun out of MariaDB into a independent company - SkySQL Inc. The team that developed SkySQL transitioned over to the new company.
+Our platform and experts handle the infrastructure needs, allowing you to focus on your core business.
+When you choose SkySQL, a full-featured DBaaS, you forego the capital expenditure of buying hardware, the delay of waiting for new systems to ship every time you need to scale-up or scale-out, and the overhead and opportunity-cost of tuning, monitoring, and upgrading your database. SkySQL also handles routine tasks such as nightly backups and infrastructure maintenance.
+And if you need ultimate control, and have the necessary skills and resources to hand-pick instances and tune configurations, we offer SkySQL Power Tier to deliver all of the on-premises benefits without the capex (capital expense) and operational overhead.
+In Foundation Tier smaller databases launch in 2-4 mins. Power Tier deployments with isolated, dedicated Kubernetes environments can take up to 25 minutes. Subsequent database deployments will use the same Kubernetes environment and usually launch in 2-4 minutes.
+The real time benefits come every day after, when you're operating at scale. A failed database node can recover in a matter of seconds using Kubernetes self-healing, or instantly failover to alternate replicated server. Instead of an eight-hour bare metal rebuild as you might see on-premises or on other cloud platforms.
+SkySQL provides services backed by:
+No, SkySQL is dedicated to being the top choice for MariaDB. Our goal is to provide the best price-performance of any DBaaS, offer significant productivity improvements through automation, and serve as the most comprehensive end-to-end platform for all your database needs.
+We offer “fractional DBAs” - expert-maintained multi-cloud databases. We're glad to help with your move to SkySQL, whether you're migrating from another database platform or looking to lift-and-shift a MariaDB implementation to SkySQL.
+SkySQL is multi-cloud and as a full-featured DBaaS we handle all of the hardware and infrastructure needs.
+Services are currently available with a range of instance sizes running on the following cloud service providers:
+Transactional services (such as our Replicated Transactions topology) operate on:
+SkySQL runs on Amazon Elastic Kubernetes Service (EKS), Google Kubernetes Engine (GKE), and MariaDB database products - Enterprise Server, MaxScale. MariaDB Enterprise Server enables a predictable development and operations experience through optimized builds, predictable release behavior, and vendor support.
+SkySQL officially launched as a production-ready enterprise-grade DBaaS in 2020, after extensive pre-release testing.
+Yes. SkySQL delivers enterprise-grade cloud database services for mission-critical applications. SkySQL is built to make MariaDB Enterprise ready - optimized for security, stability, and reliability in demanding production environments. Multi-node database deployments feature a comprehensive SLA, High Availability (HA) features, and operations features. Enterprise support options extend support to 24x7, with the additional option of SkyDBA for reactive and proactive assistance from a team of expert DBAs. Security features are designed to meet the GRC and infosec challenges faced by modern applications, and DPA (GDPR) and BAA (HIPAA) are available.
+SkySQL is primarily designed for online applications and offers two topologies -
+Replicated Transactions, Single Node Transactions
+You can choose topologies to match your workload requirements, cloud regions to match your latency and operating requirements, instance sizes, and support plan.
+Our platform features:
+Estimated SkySQL pricing is available from the SkySQL portal. SkySQL pricing is very competitive and starts at about $100 per month for production grade databases.
+SkySQL pricing varies based on the selections made when you launch a service. Examples of selections include provider, topology, instance and storage size, and region.
+The pricing shown is not a quote and does not guarantee the cost for your actual use of SkySQL services, as is shown on monthly invoices. The cost estimate can vary from your actual costs for several reasons.
+No. Purchase of SkySQL service includes support and access to MariaDB database products on SkySQL.
+Yes. SkySQL is listed in the Google Cloud Marketplace. Customers have the ability to retire their GCP commitment with a SkySQL subscription via the Marketplace.
+ +Contact us if you have further questions.
+Yes. SkySQL is an AWS partner network. Customers can retire their AWS commitment with a SkySQL subscription via the AWS Marketplace.
+See the AWS Marketplace listing
+Contact us if you have further questions.
+Estimated SkySQL pricing information is shown when you create a service based on the selections you make at launch time, such as topology, region, and instance size. Please contact us for assistance in cost estimation, including support and Power Tier.
+SkySQL pricing includes instances for a specific service topology, and monitoring, and also includes management features, e.g., backups, upgrades, patch installs, etc. Some factors, such as object storage and network egress which are variable and usage-dependent, are not included in estimated pricing. We typically pass-thru the cloud provider costs with no additional markup.
+Add-ons are available to optimize your SkySQL experience:
+Yes. Discounts are typically offered for one-year and three-year commitments. Please contact us for more information.
+SkySQL accepts payment by major credit card and through remittance accounts
+SkySQL accepts all major credit cards. Specifically, we accept Visa, Mastercard, American Express, Discover, and Diners Club payments from customers worldwide.
+Note
+SkySQL does not store any of your credit card information. We use Stripe to manage all credit card transactions. Stripe is a widely used payment processing platform that enables businesses to accept credit card payments securely
+Contact us to have your account set up for payment by wire transfer or ACH.
+SkySQL contract customers can pre-fund their account. Contact us for more information.
+SkySQL charges are paid using a credit card, or via wire transfer/ACH upon invoice in the case of remittance accounts.
+Yes. We offer direct purchase through the AWS Marketplace or we can craft a "private offer" to customize a subscription.
+See the AWS Marketplace listing
+Contact us if you have further questions.
+Yes. SkySQL is an AWS partner network. Customers can retire their AWS commitment with a SkySQL subscription via the AWS Marketplace.
+See the AWS Marketplace listing
+Contact us if you have further questions.
+Yes. We offer direct purchase through the Google Marketplace or we can craft a "private offer" to customize a subscription.
+ +Contact us if you have further questions.
+Yes. SkySQL is listed in the Google Cloud Marketplace. Customers have the ability to retire their GCP commitment with a SkySQL subscription via the Marketplace.
+ +Contact us if you have further questions.
+If you stop a SkySQL service, you will continue to be charged for storage, since your data is not deleted. Instance and egress charges will stop until the instance is started again.
+Current month's estimated charges can be viewed on the SkySQL portal dashboard. Detailed information is also available under ‘Billing’ where you can see the breakdown for all your current charges - you can see resource usage by Service Name (your individual DB clusters) or by resource type. Variable charges such as object storage and network egress are updated the day prior to the last day of the month and are available in the invoice. You can also use the SkySQL REST API to fetch usage and billing data.
+SkySQL invoices are sent monthly and include a detailed breakdown of usage, pricing, and taxes. For Team accounts, only the Team owner has access to Account Information.
+Invoices for SkySQL are sent by email on subscription renewal. Subscription renewal occurs on the last day of the month. Accounts using a credit card are charged at this time.
+MariaDB will bill for VAT and/or taxes in applicable jurisdictions. Customers are responsible for paying all applicable taxes and fees. See the SkySQL Terms of Use for additional information.
+Current month's estimated charges, including coupons and service credits, can be viewed on the Account Information page and are updated six times per day.
+In the event of service credits issued based on SLA, service credits will be included in coupons and service credits on the Account Information page.
+Instances can be stopped to save money. While stopped, additional instance and egress charges will not accrue, but you will continue to be charged for storage.
+Contact info@skysql.com with billing questions.
+SkySQL runs full backups automatically each night. SkySQL also allows on-demand backups (a Preview feature)
+No. Backup frequency and schedule are not customer configurable. SkySQL Power Tier customers should contact us if alternate backup frequency or schedule is required.
+No. Data is not sent to another country. All data is managed within the same region where your database is running for data sovereignty.
+No.
+No.
+MariaDB Enterprise Backup (mariabackup) is used for Replicated Transactions and Single Node Transactions service backups. MariaDB Enterprise Backup breaks up backups into non-blocking stages so writes and schema changes can occur during backups.
+The backup service provides support for incremental backups. It is in preview state (Dec 2023).
+Backups for running and stopped services are retained for 30 days. If a service is deleted, no further backups for that service are produced and backups on hand are purged after 7 days.
+No. Backup retention is not customer configurable. SkySQL Power Tier customers should contact us if an alternate retention schedule is required.
+Request data restore by creating a support case in the Customer Support Portal. Please state what you need restored, and the desired restore point. Self service Restore functionality is available using the Backup service and API (in Preview as of Dec 2023)
+Yes, by support case.
+By default, full and complete backup restoration is available. To enable point-in-time recovery, services must be configured in advance for additional binary log retention. Point-in-time recovery (PITR) configuration is available to Power Tier customers.
+Yes, by support case
+Yes, by support case
+Yes, you can retrieve your database. No, there is no vendor lock. Your data is your data. Create a support case for access to a backup.
+Yes. All SkySQL data is encrypted on disk.
+By default, SkySQL services feature data-in-transit encryption for client connections.
+By default, server-to-server communications between the nodes of a SkySQL service are protected with data-in-transit encryption.
+For additional information, see "Data-in-Transit Encryption".
+Yes. By default, SkySQL requires client connections via TLS (TLS 1.2, TLS 1.3).
+SkySQL supports disabling SSL/TLS via the Portal or using the API.
+SkySQL on Amazon AWS benefits from Amazon EBS encryption, which is AES256.
+SkySQL on Google GCP leverages Google's default encryption, which is AES256 or AES128.
+TLS 1.2, and TLS 1.3 are supported.
+TLS certificates expire every two years.
+MariaDB Corporation leverages HashiCorp Vault for certificate and key management. Certificates and keys are not customer-configurable.
+No. SkySQL supports server-side certificates. Database users are authenticated by standard password authentication, LDAP, and/or Two-Factor Authentication (2FA).
+No. While MariaDB Enterprise Server includes ed25519 support, SkySQL leverages a version of MariaDB MaxScale which is not ed25519-compatible.
+A certificate authority chain is provided to allow your client to establish a secure and encrypted connection to a SkySQL database service, confirming the authenticity of the server certificate.
+Cryptography libraries are included in our standard release process, and vulnerability scanning is conducted for each release.
+Yes. The decision to delete your running service rests with you and your business. Please consider production impacts before deleting a service. SkySQL permits the on-demand deletion of running and stopped services.
+No. The launch process must complete before deletion is permitted.
+All data residing on a service's storage is deleted at time of service deletion. Backups for deleted services are purged after 7 days.
+Maybe. If you contact us before the system completes data deletion, yes, we can recover. Backups for deleted services are purged after 7 days.
+No. You should download your data so you have a local copy before you delete the service.
+No. SkySQL is hosted on public cloud provider systems.
+Yes. If you would like backups purged, please create a support case
+You can SkySQL Monitoring after launching a service, then clicking the "Monitoring" link in the SkySQL main menu (left navigation).
+SkySQL Monitoring covers status and metrics specific to a service and its servers. A complete list of charts is provided.
+SkySQL Inc’s Support and SRE teams are alerted if a SkySQL service becomes unavailable or when serious issues are detected (e.g. disk is 90% utilized).
+Additionally, SkySQL automatically turns on several sensible alerting rules so the customer can also be alerted.
+SkySQL Monitoring includes alerting features, which allow configurable alerting rules, notification channels, and notification criteria. These settings are managed from the SkySQL Monitoring interface. You can SkySQL Monitoring after launching a service by clicking the "Monitoring" link in the SkySQL main menu (left navigation).
+SkySQL customers can contact us via the Customer Support Portal.
+If you are not yet a SkySQL customer, please contact us with questions.
+Included with Foundation Tier services:
+Available to Power Tier customers:
+See full details of our support options.
+Yes. Enterprise support levels are available for customers requiring 24x7x365 support (24 hours per day, 7 days per week, 365 (or 366) days per year).
+Yes. SkySQL infrastructure is fully managed, including many typical operations features such as automated nightly backups and monitoring.
+Standard support is included with Foundation Tier services. Activities like performance tuning and assistance with schema change is not included in standard support. Power Tier customers choose between Enterprise and Platinum support options, which include consultative support.
+Our optional SkyDBA service is available for Enterprise and Platinum support customers, and SkyDBA customers receive both reactive (break/fix) and proactive (analyze/enhance) assistance.
+SkySQL offers a full range of professional services, including:
+Contact SkySQL Inc or email us at info@skysql.com
+Release notes are provided to show changes to SkySQL services, features, interfaces, and documentation.
+SkySQL is available for immediate use. Sign up today and get started. If you would like assistance from sales, contact us.
+Billing questions can be directed to info@skysql.com.
+To aid our continuous improvement efforts, we encourage you to provide feedback on our documentation and your experiences using it via the following:
+SkySQL customers can contact us via the Customer Support Portal
+ + + + + + + + + + + + + +SkyDBA is a "Fractional" DBA Service, a cost-effective solution for businesses that need database administration but do not require a full-time database administrator. This service provides access to a team of experienced database administrators on a part-time basis. Whether it's for routine maintenance, troubleshooting, or strategic advice, SkyDBA's Fractional DBA Service ensures that expert assistance is just a message away. This approach not only saves the expense of a full-time employee but also provides a higher level of service due to the collective knowledge and experience of the SkyDBA team.
+Note
+SkyDBA is an optional service that you can purchase. You can use this service regardless of the Tier (Foundation or Power) used to deploy DB services. For more information, please contact SkySQL support
+Here is what you can expect from this “add-on” service.
+Expert advice available on migration methodology and procedures.
+SkyDBAs offers tailored query analysis and professional tuning upon request. Our team provides expert assistance in implementing low-impact table alterations when necessary.
+With a SkyDBA subscription, your customer success manager can schedule quarterly business reviews with someone from the SkyDBA team to review items such as:
+Work with the SkyDBA team to ensure that your environment is safe and secure. This includes auditing of users and grants.
+SkyDBAs monitors instances for potential business impact events. Upon detection, events are internally flagged. We investigate and collaborate with your team as needed for swift resolution.
+With a SkyDBA Subscription, our database experts can assist with tasks such as analyzing core dumps, system logs and other similar technical issues that require expert database server knowledge.
+Partner with SkyDBAs to create tailored backup stratagies to meet your organization's Recovery Time Objective (RTO) and Recovery Point Objective (RPO) goals.
+SkyDBAs can assists in data recovery from backups or other sources, providing expertise for analysis. Additionally, as requestied, SkyDBA can conduct annual Disaster Recovery exercises upon request to ensure preparedness. It's important to note that running a recovery to a secondary service may require additional compute resources.
+ + + + + + + + + + + + + +
Launch
+https://skysql.mariadb.com/launch-service
+While making launch-time selections, your selections and estimated costs are shown at right.
+If you require AWS PrivateLink or Google Private Service Connect, please Contact Support.
+To launch a SkySQL service from the Portal:
+After initiating service launch, the service will be shown on the Portal Dashboard.
+A notification will be sent at time of service launch initiation and when service launch completes.
+ + + + + + + + + + + + + +SkySQL's self-service management features enable authorized accounts to launch cloud databases, start and stop cloud databases, delete cloud databases, apply database configuration changes, and configure the cloud database's IP firewall.
+Self-service user management features enable you to define role-based access for your team to jointly manage SkySQL resources.
+
Service - Stop
+https://app.skysql.com/dashboard
+To stop a service:
+The service will be stopped. You will only be charged for storage on a stopped service.
+Notifications will be generated when this operation is initiated and when the operation is performed.
+
Service - Start
+https://skysql.mariadb.com/dashboard
+To start a service:
+The service will be started. Service start may take up to 15 minutes. The normal billing cycle for the service will resume.
+Notifications will be generated when this operation is initiated and when the operation is performed.
+
Service - Horizontal Scaling
+https://skysql.mariadb.com/dashboard
+Horizontal scaling is performed by scaling nodes In (reducing node count) or Out (increasing node count).
+To scale nodes horizontally:
+The service immediately goes into scaling status.
+Notifications will be generated when this operation is initiated and when the operation is performed.
+
Service - Vertical Scaling
+https://skysql.mariadb.com/dashboard
+Vertical scaling is performed by scaling nodes Up (increasing node size) or Down (decreasing node size).
+To scale nodes vertically:
+The service immediately goes into scaling status.
+Notifications will be generated when this operation is initiated and when the operation is performed.
+
Service - Scale Storage
+https://skysql.mariadb.com/dashboard
+To expand block storage capacity:
+Storage scaling is subject to a 6 hour cooldown period.
+Storage upgrades are not reversible.
+
Service - Delete
+https://skysql.mariadb.com/dashboard
+To delete a service:
+Your service and all its data will be deleted. This operation is non-reversible.
+Notifications will be generated when this operation is initiated and when the operation is performed.
+Actions performed through the Portal will generate a notification.
+One notification is generated when an action is initiated.
+Additional notifications are generated to convey status as the action is carried out by the system.
+To access current notifications:
+A menu of recent notifications will be displayed.
+The bell icon will include a red dot indicator when a new notification is present. This indicator can be cleared by clicking the "Clear all" link.
+
Notifications
+https://skysql.mariadb.com/dashboard
+To view historical notifications, click the "View more" link at the bottom of the menu. When viewing historical notifications, notifications can be filtered by category and time frame.
+
Notifications - current and historical
+https://skysql.mariadb.com/notifications
+You can configure the notifications delivered to your email address from User Preferences.
+To access User Preferences:
+From User Preferences you can specify your notification preferences:
+
User Preferences
+https://skysql.mariadb.com/user-preferences
+In addition to display in the Portal, notifications can also be delivered by email.
+Notification Channels define who receives what type of notifications.
+To access Notification Channel settings:
+
Notification Channels
+https://skysql.mariadb.com/settings/channel
+To add a Notification Channel, from the Notification Channel settings interface:
+
Notification Channels - Adding a Channel
+https://skysql.mariadb.com/settings/channel
+To remove a Notification Channel, from the Notification Channel settings interface:
+To modify a Notification Channel, from the Notification Channel settings interface:
+After service launch, a detailed summary of the service can be accessed in the Service Details interface.
+
Service Details
+https://skysql.mariadb.com/service/DBID/details
+Service details vary based on topology.
+Service details may include:
+The available panels are :
+Should be evaluated as "Panel name(context, UI tab)"
+This panel shows the ratio between the types of SQL statements executed by the service during the selected time interval.
+This panel shows the ratio between the types of SQL statements executed by the ES node during the selected time interval.
+This panel shows the CPU usage for each ES node during the selected time interval.
+This panel shows the CPU usage for the ES node during the selected time interval.
+This panel shows the queries per second (QPS) executed by the ES node during the selected time interval.
+This panel shows the number of used and aborted connections for each ES node along with the max_connections value.
+This panel shows the number of clients connected to the MaxScale node.
+This panel shows summarized values for certain replication-related metadata to help determine if any replica ES nodes encountered replication issues during the selected time interval.
+This panel shows average values for certain replication-related metadata to help determine if the replica ES nodes are currently lagging behind the primary ES node.
+This panel shows the amount of storage space used (as the usage percentage, actual size, and total size) by each ES node.
+This panel shows the amount of storage space used by the ES node during the selected time interval.
+This panel shows the amount of storage space used by all ES nodes during the selected time interval.
+This panel shows the Global Transaction ID (GTID) for each ES node during the selected time interval.
+This panel shows the average number of seconds that the replica ES nodes lagged behind the primary ES node during the selected time interval.
+This panel shows the current binary log position of the replica SQL thread for each ES node during the selected time interval.
+This panel shows the current binary log position of the replica I/O thread for each ES node during the selected time interval.
+This panel shows the top 30 statement types that were most frequently executed by all ES nodes during the selected time interval.
+This panel shows the top 30 statement types that were most frequently executed by the ES node during the selected time interval.
+This panel shows the top 30 statement types that were most frequently executed by all ES and Xpand nodes in 1 hour intervals over the past 24 hours.
+This panel shows the top 30 statement types that were most frequently executed by the ES node in 1 hour intervals over the past 24 hours.
+This panel shows the number of queries per second (QPS) executed by all ES nodes during the selected time interval.
+This panel shows the number of slow queries executed by all ES nodes during the selected time interval.
+This panel shows the number of slow queries executed by the ES node during the selected time interval.
+This panel shows the number of queries and questions per second executed by the ES node during the selected time interval.
+This panel shows the number of client threads running on all ES nodes during the selected time interval.
+This panel shows the number of client threads connected and running on the ES node during the selected time interval.
+This panel shows the number of clients connected to all MaxScale nodes during the selected time interval.
+This panel shows the number of client connections open between the MaxScale node and each ES node during the selected time interval.
+This panel shows the number of clients connected to the ES node during the selected time interval.
+This panel shows the number of connections aborted by the ES node during the selected time interval.
+This panel shows the number of table locks requested by all ES nodes during the selected time interval.
+This panel shows the number of table locks requested by the ES node during the selected time interval.
+This panel shows the number of tables opened by the database servers on all ES nodes during the selected time interval.
+This panel shows the number of tables opened by the database server on the ES node during the selected time interval.
+This panel shows the number of tables that have been opened by all ES nodes during the selected time interval.
+This panel shows the number of times the ES node has used certain execution strategies to execute SELECT statements during the selected time interval.
+This panel shows the number of times the ES node has used certain algorithms to sort data during the selected time interval.
+This panel shows memory usage details for all ES nodes during the selected time interval.
+This panel shows the total number of bytes read from the ES node's file system during the selected time interval.
+This panel shows the total number of bytes written to the ES node's file system during the selected time interval.
+This panel shows the total number of bytes written to or read from the ES node's file system during the selected time interval.
+This panel shows the number of input/output operations per second performed by the ES node during the selected time interval.
+This panel shows the total number of reads performed from the ES node's file system during the selected time interval.
+This panel shows the total number of writes performed from the ES node's file system during the selected time interval.
+This panel shows the amount of data received over the network by the operating systems on all ES nodes during the selected time interval.
+This panel shows the amount of data sent over the network by the operating systems on all ES nodes during the selected time interval.
+This panel shows the amount of data sent and received over the network by the database servers on all ES nodes during the selected time interval.
+This panel shows the amount of data sent and received over the network by the database server on the ES node during the selected time interval.
+This panel shows the amount of data sent and received over the network by the operating system on the ES node during the selected time interval.
+This panel shows the amount of data sent and received over the network per hour by the database servers on all ES nodes over the past 24 hours.
+This panel shows the amount of data sent and received over the network per hour by the database server on the ES node over the past 24 hours.
+This panel shows the number of network errors encountered by all ES nodes during the selected time interval.
+This panel shows the number of network errors encountered by the ES node during the selected time interval.
+This panel shows the number of network packets dropped by all ES nodes during the selected time interval.
+This panel shows the number of network packets dropped by the ES node during the selected time interval.
+This panel shows the current CPU usage for the ES or Xpand node.
+This panel shows the current memory usage details for the ES or Xpand node.
+This panel shows memory usage details for the ES or Xpand node during the selected time interval.
+This panel shows the current size of the InnoDB buffer pool for the ES node in two units: the absolute size and the percentage of the server's usable memory.
+This panel shows the current number of client connections as a percentage of the ES node's max_connections value.
+This panel shows the number of bytes per second read and written by InnoDB during the selected time interval.
+This panel shows the total number of rows written and read per second by the ES node during the selected time interval.
+This panel shows the number of client connections to the ES node during the selected time interval.
+This panel shows the number of files opened per second by the database server on the ES node during the selected time interval.
+This panel shows the number of files opened by the database server on the ES node during the selected time interval.
+This panel shows the number of transaction-related handlers created by the ES node during the selected time interval.
+This panel shows the number of temporary tables created by the ES node during the selected time interval.
+This panel shows the number of threads created and cached for re-use on the ES node during the selected time interval.
+This panel shows the activity of the table open cache on the ES node during the selected time interval.
+This panel shows how many table definitions were cached by the ES node during the selected time interval.
+This panel shows memory usage details for the ES node during the selected time interval.
+This panel shows how much memory the ES node used for the InnoDB buffer pool, InnoDB log buffer, MyISAM key buffer, and query cache during the selected time interval.
+This panel shows memory usage details for the MaxScale node during the selected time interval.
+This panel shows the number of read and write operations per second that were handled by the threads on the MaxScale node during the selected time interval.
+This panel shows the number of threads currently used by the MaxScale node.
+This panel lists the modules installed on the MaxScale node.
+This panel shows the number of client connections closed by the MaxScale node during the selected time interval.
+This panel shows the number of errors encountered by threads on the MaxScale node during the selected time interval.
+This panel shows the total event queue length for all threads on the MaxScale node during the selected time interval.
+This panel shows the number of descriptors used by the MaxScale node during the selected time interval.
+This panel shows the longest time the MaxScale node waited for an I/O event during the selected time interval.
+This panel shows the number of clients connected to the MaxScale node during the selected time interval.
+This panel shows the number of database server connections open between the MaxScale node and each ES or Xpand node during the selected time interval.
+This panel shows the current resident set size (RSS) of the MaxScale process.
+This panel shows the current stack size of the MaxScale node.
+ + + + + + + + + + + + + +From the SkySQL Portal, you can launch, query, monitor, and manage your SkySQL services.
+You can access the Portal here
+
From the Dashboard, you can see a list of your SkySQL services and status information for each service.
+From a different view, the Dashboard can be accessed by clicking the "Dashboard" link in the main menu (left navigation in the Portal).
+To launch a new service, click the "+ Launch New Service" button on the Dashboard.
+See "Service Launch" for details on the service launch process and launch-time selections.
+Service-specific interfaces are available from the Dashboard by clicking on the service name for the desired service.
+Service-specific interfaces will vary by topology.
+Service-specific interfaces are provided to:
+From the Dashboard, the details needed to connect to your SkySQL service can be seen by clicking on the "CONNECT" button for the desired service.
+See "Client Connections" for details on how to connect to a service.
+From the Dashboard, the "MANAGE" button for a service provides access to:
+The Dashboard includes a Spending gauge to indicate current charges. More detailed billing information can be accessed by clicking on the Spending gauge.
+Alternatively, you can access detailed billing and invoice information by clicking on your name in the upper-right corner of the interface, then select "Billing" from the menu.
+See "Billing" for additional details.
+The Dashboard includes monitoring gauges for Current SQL Commands, CPU Load, and QPS (Queries Per Second). More detailed monitoring can be accessed by clicking on one of these gauges.
+Alternatively, you can access detailed server and service monitoring by clicking on the service name from the Dashboard, then accessing the Monitoring tab (the default view).
+See "Monitoring" for additional details.
+The Dashboard includes the count of active monitoring alerts for your service. More detailed alert information can be accessed by clicking on the Alerts gauge.
+Alternatively, you can access monitoring alerts by clicking the "Alerts" link in the main menu (left navigation in the Portal).
+See "Alerts" for additional details.
+Server log files can be accessed by clicking the "Logs" link in the main menu (left navigation in the Portal).
+See "Logs" for additional details.
+From the Portal, you can connect to and query your SkySQL databases.
+These features can be accessed by clicking the "Workspace" link in the main menu (left navigation in the Portal):
+These settings can be accessed by clicking the "Settings" link in the main menu (left navigation in the Portal):
+Actions performed through the Portal will generate a notification.
+To view current notifications, click the bell icon in the upper-right corner of the interface.
+See "Notifications" for additional details.
+To customize your email notification preferences, click your name in the upper-right corner of the interface, then choose "User preferences".
+See "Notifications" for additional details.
+To log out from SkySQL, click your name in the upper-right corner of the interface, then choose "Logout" from the menu.
+Note
+💡 TODO - most of these features are described elsewhere. To be removed later.
+| https://mariadb.com/docs/skysql-previous-release/service-management/options/aws-privatelink/ | +Connects your AWS VPC network to MariaDB SkySQL with connectivity over Amazon's network | +
|---|---|
| https://mariadb.com/docs/skysql-previous-release/service-management/options/cross-region-replicas/ | +For disaster recovery, data is replicated to a different supported region | +
| https://mariadb.com/docs/skysql-previous-release/service-management/options/custom-configuration/ | +Changes the default service design and configuration | +
| https://mariadb.com/docs/skysql-previous-release/service-management/options/custom-instance-sizes/ | +Changes the available instance sizes | +
| https://mariadb.com/docs/skysql-previous-release/service-management/options/database-account-2fa/ | +Enables two-factor authentication (2FA) for database user accounts | +
| https://mariadb.com/docs/skysql-previous-release/service-management/options/database-account-ldap/ | +Enables LDAP authentication for database user accounts | +
| https://mariadb.com/docs/skysql-previous-release/service-management/options/disable-ssltls/ | +Disables default data-in-transit encryption; typically paired with AWS PrivateLink or GCP VPC Peering | +
| https://mariadb.com/docs/skysql-previous-release/service-management/options/maxscale-redundancy/ | +Enables highly available (HA) active-active load balancers and ability to choose load balancer instance size | +
| https://mariadb.com/docs/skysql-previous-release/service-management/options/point-in-time-recovery/ | +Configures additional retention of binary logs to enable point-in-time recovery at a later date | +
| https://mariadb.com/docs/skysql-previous-release/service-management/options/replication/ | +Inbound (to MariaDB SkySQL) and outbound (from MariaDB SkySQL) replication | +
| https://mariadb.com/docs/skysql-previous-release/service-management/options/single-zone-deployment/ | +Reduced latency for Distributed Transactions | +
| https://mariadb.com/docs/skysql-previous-release/service-management/options/skysql-portal-sso/ | +Authenticate to SkySQL Portal using SAML 2.0 IDP | +
| https://mariadb.com/docs/skysql-previous-release/service-management/options/skysql-teams/ | +Multiple SkySQL user accounts jointly maintain services under a single billing profile | +
| https://mariadb.com/docs/skysql-previous-release/service-management/options/vpc-peering/ | +Connects your GCP VPC network to MariaDB SkySQL with connectivity over Google's network | +
This walkthrough explains how to launch database services and manage the lifecycle of database services using the SkySQL DBaaS REST API.
+Go to SkySQL API Key management page: https://app.skysql.com/user-profile/api-keys and generate an API key
+Export the value from the token field to an environment variable $API_KEY
+$ export API_KEY='... key data ...'
+The API_KEY environment variable will be used in the subsequent steps.
Use it on subsequent request, e.g: +
curl --request GET 'https://api.skysql.com/provisioning/v1/services' \\
+ --header "X-API-Key: $API_KEY"
+Note
+You can use the Swagger docs site we host we try out the API OR +Follow the instructions below to try the API using your command Shell
+You can use the API Documentation here and directly try out the APIs in your browser.
+All you need is to click ‘Authorize’ and type in <supply your API key here>
Note
+** Pre-requisites for code below **
+The examples below use curl as the REST client. curl is available for Linux, macOS, and MS Windows. Of course, you can use any language client that supports invoking REST over HTTP. +Examples below also use jq, a JSON parsing utility. jq is available for Linux, macOS, and MS Windows. Install jq then proceed.
+The examples also make use of tee to save the response JSON data to a file while also allowing it to be piped to jq for output. Both Linux and macOS support tee as described in the examples. On MS Windows, Powershell has a tee command that requires the -filepath option to be inserted prior to the filename.
+The chmod command is used to make a file private to the current user. If your environment doesn't support chmod, you can set the file's permissions using other means.
+The examples also make use of exported variables and ${VARIABLE_NAME} variable references that are compatible with Bourne-like shells (such as sh, bash, and zsh). On MS Windows, you will need to adapt these instructions if you are not using a Bourne-like shell. For example, you can copy just the jq part of an export command (from inside the backticks), run that on its own, and then copy/paste the resulting string into a variable assignment for your shell.
+Finally, the examples use a backslash at the end of some of the lines to indicate to the shell that a command spans multiple lines. If your shell doesn't allow this, remove each trailing backslash character and join the following line to the end of the current line.
+When your new service is created, your client can only connect through the service's firewall if the client IP address is in the service's IP allowlist.
+Before creating the new service, determine the public IP address of your client host and save it to the SKYSQL_CLIENT_IP environment variable.
If you are not sure of your public IP address, you can use a lookup service, such as checkip.amazonaws.com:
$ export SKYSQL_CLIENT_IP=`curl -sS checkip.amazonaws.com`
+To launch a service:
+request-service.json:cat > request-service.json <<EOF
+{
+ "service_type": "transactional",
+ "topology": "es-single",
+ "provider": "gcp",
+ "region": "us-central1",
+ "architecture": "amd64",
+ "size": "sky-2x8",
+ "storage": 100,
+ "nodes": 1,
+ "name": "skysql-quickstart",
+ "ssl_enabled": true,
+ "allow_list": [
+ {
+ "comment": "Describe the IP address",
+ "ip": "${SKYSQL_CLIENT_IP}/32"
+ }
+ ]
+}
+EOF
+This configuration is suitable for a quick test, but a more customized configuration should be selected for performance testing or for alignment to the needs of production workloads:
+service_type, choose a Service Type Selectiontopology, choose a Topology Selectionprovider, choose a Cloud Provider Selection (aws or gcp)region, choose a Region Selectionarchitecture, choose a Hardware Architecture Selectionsize, choose an Instance Size Selectionstorage, choose a Transactional Storage Size Selectionnodes, choose a Node Count Selectionversion, choose the Software Version Selectionname, choose a Service Name for the new serviceFor allow_list, set the client IP address using CIDR notation, so that the client can connect through the Firewall
Provide the request to the [/provisioning/v1/services API endpoint](https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_services,POST/) to create (launch) a new database service and save the response to the response-service.json file:
curl -sS --location --request POST \
+ --header "X-API-Key: ${API_KEY}" \
+ --header "Accept: application/json" \
+ --header "Content-type: application/json" \
+ --data '@request-service.json' \
+ https://api.skysql.com/provisioning/v1/services \
+ | tee response-service.json | jq .
+Upon success, the command will return JSON with details about the new service.
+Read the service ID for the new service and save the value in the SKYSQL_SERVICE environment variable:
$ export SKYSQL_SERVICE=`jq -r .id response-service.json`
+Before advancing, check the service state using the [/provisioning/v1/services/${SKYSQL_SERVICE} API endpoint](https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_services_slash_ocb_service_id_ccb_,GET/):
curl -sS --location --request GET \
+ --header "X-API-Key: ${API_KEY}" \
+ --header "Accept: application/json" \
+ https://api.skysql.com/provisioning/v1/services/${SKYSQL_SERVICE} \
+ | tee response-state.json | jq .status
+When the service is still being launched, the JSON payload will contain "pending_create" or "pending_modifying" as the service status.
When the service has been launched, the JSON payload contains "ready", and you can continue with the next steps. Keep in mind that some of the following values will not be populated in the JSON data until this ready status has been achieved.
Obtain the connection credentials for the new SkySQL service by executing the following commands:
+If ssl_enabled is true on your service (the default), download [skysql_chain_2022.pem](https://supplychain.mariadb.com/skysql/skysql_chain_2022.pem), which contains the Certificate Authority chain that is used to verify the server's certificate for TLS:
$ curl https://supplychain.mariadb.com/skysql/skysql_chain_2022.pem --output ~/Downloads/skysql_chain_2022.pem
+Obtain the hostname and port of the service and save them to the SKYSQL_FQDN and SKYSQL_PORT environment variables:
The hostname is specified with the "fqdn" key.
$ export SKYSQL_FQDN=`jq -r .fqdn response-state.json`
+Available TCP ports are specified in the "endpoints" array. For this test, connect to the "port" where "name" is "readwrite".
$ export SKYSQL_PORT=`jq '.endpoints[0].ports[] | select(.name=="readwrite") | .port' response-state.json`
+Obtain the default username and password for the service using the [/provisioning/v1/services/${SKYSQL_SERVICE}/security/credentials API endpoint](https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_services_slash_ocb_service_id_ccb_slash_security_slash_credentials/) and save the response to the response-credentials.json file:
curl -sS --location --request GET \
+ --header "X-API-Key: ${API_KEY}" \
+ --header "Accept: application/json" \
+ --header "Content-type: application/json" \
+ https://api.skysql.com/provisioning/v1/services/${SKYSQL_SERVICE}/security/credentials \
+ | tee response-credentials.json | jq .
+The default username and password will not be available until the service state is "ready".
Set the file's mode to only allow the current user to read its contents:
+$ chmod 600 response-credentials.json
+Read the username and password from response-credentials.json and save them to the SKYSQL_USERNAME and SKYSQL_PASSWORD environment variables:
$ export SKYSQL_USERNAME=`jq -r .username response-credentials.json`
+$ export SKYSQL_PASSWORD=`jq -r .password response-credentials.json`
+Connect to the database using the host, port, and default credentials using the mariadb client:
+mariadb --host ${SKYSQL_FQDN} --port ${SKYSQL_PORT} \
+ --user ${SKYSQL_USERNAME} --password="${SKYSQL_PASSWORD}" \
+ --ssl-verify-server-cert
+If you don't want the password to appear on the command-line, specify the --password command-line option without an argument to be prompted for a password.
+To connect to your SkySQL service easily, it is possible to create a .my.cnf file in your home directory that contains all the details of your connection.
.my.cnf file or overwrite an existing one and populates it with the connection information that was collected in the previous steps:cat > ~/.my.cnf <<EOF
+[client]
+host=${SKYSQL_FQDN}
+port=${SKYSQL_PORT}
+user=${SKYSQL_USERNAME}
+password="${SKYSQL_PASSWORD}"
+EOF
+Set the file system permissions for the .my.cnf file to ensure that other users can't read it:
$ chmod 600 ~/.my.cnf
+When all the connection parameters are in your ~/.my.cnf file, the mariadb client can connect without specifying any command-line options:
$ mariadb
+This walkthrough explains how to launch database services and manage the lifecycle of database services using the Terraform provider.
+For users who prefer other interfaces, SkySQL offers the following alternatives:
+ +This walkthrough demonstrates a service configuration that is suitable for a quick test. A more customized configuration should be selected for performance testing or for alignment to the needs of production workloads.
+Note
+This procedure uses Terraform. HashiCorp officially supports Terraform on several Linux distributions, but HashiCorp also provides binaries for Microsoft Windows, macOS, and other operating systems.
+For a list of operating systems that are officially supported for Terraform, see "HashiCorp Terraform Documentation: Supported Operating Systems".
+For a list of operating systems that have binaries available for Terraform, see "HashiCorp Terraform Documentation: Install Terraform".
+jq, a JSON parsing utility. jq is available for Linux, macOS, and MS Windows. Install jq then proceed.curl, a data transfer utility. curl is available for Linux, macOS, and MS Windows. Install curl then proceed.wget, a file download utility. GNU Wget is available for Linux, macOS, and MS Windows. Install wget then proceed.sh, bash, and zsh).SkySQL API: Databases.Create a directory for your Terraform project and change to the directory:
+$ mkdir -p ~/skysql-nr-tf
+$ cd ~/skysql-nr-tf
main.tfIn the Terraform project directory, create a main.tf file that contains the following:
# ---------------------
+# Provider Requirements
+# ---------------------
+# TF Documentation: https://developer.hashicorp.com/terraform/language/providers/requirements
+
+terraform {
+ required_providers {
+ skysql = {
+ source = "registry.terraform.io/mariadb-corporation/skysql"
+ }
+ }
+}
+
+# ----------------------
+# Provider Configuration
+# ----------------------
+# TF Documentation: https://developer.hashicorp.com/terraform/language/providers/configuration
+
+provider "skysql" {
+ access_token = var.api_key
+}
+
+# ---------
+# Resources
+# ---------
+# TF Documentation: https://developer.hashicorp.com/terraform/language/resources/syntax
+
+# Create a service
+resource "skysql_service" "default" {
+ service_type = var.service_type
+ topology = var.topology
+ cloud_provider = var.cloud_provider
+ region = var.region
+ availability_zone = coalesce(var.availability_zones, data.skysql_availability_zones.default.zones[0].name)
+ architecture = var.architecture
+ size = var.size
+ storage = var.storage
+ nodes = var.nodes
+ version = coalesce(var.sw_version, data.skysql_versions.default.versions[0].name)
+ name = var.name
+ ssl_enabled = var.ssl_enabled
+ deletion_protection = var.deletion_protection
+ wait_for_creation = true
+ wait_for_deletion = true
+ wait_for_update = true
+ is_active = true
+ allow_list = [
+ {
+ "ip" : var.ip_address,
+ "comment" : var.ip_address_comment
+ }
+ ]
+}
+
+# ------------
+# Data Sources
+# ------------
+# TF Documentation: https://developer.hashicorp.com/terraform/language/data-sources
+
+# Retrieve the list of projects. Projects are a way to group services.
+data "skysql_projects" "default" {}
+
+# Retrieve the list of available versions for a specific topology
+data "skysql_versions" "default" {
+ topology = var.topology
+}
+
+# Retrieve the service details
+data "skysql_service" "default" {
+ service_id = skysql_service.default.id
+}
+
+# Retrieve the service default credentials.
+# When the service is created please change the default credentials
+data "skysql_credentials" "default" {
+ service_id = skysql_service.default.id
+}
+
+data "skysql_availability_zones" "default" {
+ region = var.region
+ filter_by_provider = var.cloud_provider
+}
+outputs.tfIn the Terraform project directory, create an outputs.tf file that contains the output values used to display metadata about the SkySQL service:
# -------------
+# Output Values
+# -------------
+# TF Documentation: https://developer.hashicorp.com/terraform/language/values/outputs
+
+output "skysql_projects" {
+ value = data.skysql_projects.default
+}
+
+# Show the service details
+output "skysql_service" {
+ value = data.skysql_service.default
+}
+
+# Show the service credentials
+output "skysql_credentials" {
+ value = data.skysql_credentials.default
+ sensitive = true
+}
+
+# Example how you can generate a command line for the database connection
+output "skysql_cmd" {
+ value = "mariadb --host ${data.skysql_service.default.fqdn} --port 3306 --user ${data.skysql_service.default.service_id} -p --ssl-ca ~/Downloads/skysql_chain_2022.pem"
+}
+
+output "availability_zones" {
+ value = data.skysql_availability_zones.default
+}
+variables.tfIn the Terraform project directory, create a variables.tf file that contains the input variables used to configure the SkySQL service:
# ---------------
+# Input Variables
+# ---------------
+# TF Documentation: https://developer.hashicorp.com/terraform/language/values/variables
+
+variable "api_key" {
+ type = string
+ sensitive = true
+ description = "The SkySQL API Key generated at: https://id.mariadb.com/account/api/generate-key"
+}
+
+variable "service_type" {
+ type = string
+ default = "transactional"
+ description = "Specify \"transactional\" or \"analytical\". For additional information, see: https://mariadb.com/docs/skysql/ref/skynr/selections/service-types/"
+}
+
+variable "topology" {
+ type = string
+ default = "es-single"
+ description = "Specify a topology. For additional information, see: https://mariadb.com/docs/skysql/ref/skynr/selections/topologies/"
+}
+
+variable "cloud_provider" {
+ type = string
+ default = "gcp"
+ description = "Specify the cloud provider. For additional information, see: https://mariadb.com/docs/skysql/ref/skynr/selections/providers/"
+}
+
+variable "region" {
+ type = string
+ default = "us-central1"
+ description = "Specify the region. For additional information, see: https://mariadb.com/docs/skysql/ref/skynr/selections/regions/"
+}
+
+variable "availability_zone" {
+ type = string
+ default = null
+ description = "Specify the availability zone for the cloud provider and region. For additional information, see: https://mariadb.com/docs/skysql/ref/skynr/selections/availability-zones/"
+}
+
+variable "architecture" {
+ type = string
+ default = "amd64"
+ description = "Specify a hardware architecture. For additional information, see: https://mariadb.com/docs/skysql/ref/skynr/selections/architectures/"
+}
+
+variable "size" {
+ type = string
+ default = "sky-2x8"
+ description = "Specify the database node instance size. For additional information, see: https://mariadb.com/docs/skysql/ref/skynr/selections/instance-sizes/"
+}
+
+variable "storage" {
+ type = number
+ default = 100
+ description = "Specify a transactional storage size. For additional information, see: https://mariadb.com/docs/skysql/ref/skynr/selections/storage-sizes/"
+}
+
+variable "nodes" {
+ type = number
+ default = 1
+ description = "Specify a node count. For additional information, see: https://mariadb.com/docs/skysql/ref/skynr/selections/node-count/"
+}
+
+variable "sw_version" {
+ type = string
+ default = null
+ description = "Specify a software version. For additional information, see: https://mariadb.com/docs/skysql/ref/skynr/selections/versions/"
+}
+
+variable "name" {
+ type = string
+ default = "skysql-nr-quickstart"
+ description = "Specify a name for the service. For additional information, see: https://mariadb.com/docs/skysql/selections/nr-launch-time-service-name/"
+}
+
+variable "ssl_enabled" {
+ type = bool
+ default = true
+ description = "Specify whether TLS should be enabled for the service. For additional information, see: https://mariadb.com/docs/skysql/selections/nr-launch-time-disable-ssltls/"
+}
+
+variable "deletion_protection" {
+ type = bool
+ default = true
+ description = "Specify whether the service can be deleted via Terraform (false) or whether trying to do so raises an error (true)"
+}
+
+variable "ip_address" {
+ type = string
+ description = "Specify an IP address in CIDR format to add to the service's IP allowlist. For additional information, see: https://mariadb.com/docs/skysql/security/nr-firewall/"
+}
+
+variable "ip_address_comment" {
+ type = string
+ description = "Specify a comment describing the IP address. For additional information, see: https://mariadb.com/docs/skysql/security/nr-firewall/"
+}
+The variables are configured in the next step.
+.tfvars FileA [.tfvars file](https://developer.hashicorp.com/terraform/tutorials/configuration-language/variables#assign-values-with-a-file) can be used to configure the service using the input variables.
For example:
+api_key = "... key data ..."
+service_type = "transactional"
+topology = "es-single"
+cloud_provider = "gcp"
+region = "us-central1"
+availability_zone = null
+architecture = "amd64"
+size = "sky-2x8"
+storage = 100
+nodes = 1
+sw_version = null
+name = "skysql-nr-quickstart"
+ssl_enabled = true
+deletion_protection = true
+ip_address = "192.0.2.10/32"
+ip_address_comment = "Describe the IP address"
+The input variables should be customized for your own needs:
+api_key, set it to the API key previously created in "Step 1: Generate API Key".service_type, choose a Service Type Selectiontopology, choose a Topology Selectioncloud_provider, choose a Cloud Provider Selectionregion, choose a Region Selectionavailability_zone, choose a Availability Zone Selection or leave it null to use the default availability zone for the cloud provider and regionarchitecture, choose a Hardware Architecture Selectionsize, choose an Instance Size Selectionstorage, choose a Transactional Storage Size Selectionnodes, choose a Node Count Selectionsw_version, choose the Software Version Selection or leave it null to use the default version for the topologyname, choose a Service Name for the new servicedeletion_protection, choose whether the service can be deleted via Terraform (false) or whether trying to do so raises an error (true)ip_address, choose an IP address to allow through the Firewallip_address_comment, provide a description for the IP addressThe following steps assume that the file is called skysql-nr-quickstart.tfvars.
terraform initInitialize the Terraform project directory and download the Terraform provider from the Terraform Registry by executing the [terraform init command](https://developer.hashicorp.com/terraform/cli/commands/init):
$ terraform init
If you need to download the provider manually, see "Manually Install Provider from Binary Distribution".
+terraform planCreate a Terraform execution plan by executing the [terraform plan command](https://developer.hashicorp.com/terraform/cli/commands/plan) and specifying the path to the .tfvars file:
$ terraform plan -var-file="skysql-nr-quickstart.tfvars"
terraform applyExecute the Terraform execution plan and create the SkySQL service by executing the [terraform apply command](https://developer.hashicorp.com/terraform/cli/commands/apply) and specifying the path to the .tfvars file:
$ terraform apply -var-file="skysql-nr-quickstart.tfvars"
Terraform prints the plan from the previous step again and prompts the user to confirm that the plan should be applied:
+Do you want to perform these actions?
+ Terraform will perform the actions described above.
+ Only 'yes' will be accepted to approve.
+
+ Enter a value: yes
+Then Terraform creates the objects and prints status messages:
+skysql_service.default: Creating...
+skysql_service.default: Still creating... [10s elapsed]
+skysql_service.default: Still creating... [20s elapsed]
+skysql_service.default: Still creating... [30s elapsed]
+skysql_service.default: Still creating... [40s elapsed]
+skysql_service.default: Still creating... [50s elapsed]
+skysql_service.default: Still creating... [1m0s elapsed]
+skysql_service.default: Still creating... [1m10s elapsed]
+skysql_service.default: Still creating... [1m20s elapsed]
+skysql_service.default: Still creating... [1m30s elapsed]
+skysql_service.default: Still creating... [1m40s elapsed]
+skysql_service.default: Still creating... [1m50s elapsed]
+skysql_service.default: Still creating... [2m0s elapsed]
+skysql_service.default: Still creating... [2m10s elapsed]
+skysql_service.default: Still creating... [2m20s elapsed]
+skysql_service.default: Still creating... [2m30s elapsed]
+skysql_service.default: Still creating... [2m40s elapsed]
+skysql_service.default: Still creating... [2m50s elapsed]
+skysql_service.default: Still creating... [3m0s elapsed]
+skysql_service.default: Still creating... [3m10s elapsed]
+skysql_service.default: Still creating... [3m20s elapsed]
+skysql_service.default: Still creating... [3m30s elapsed]
+skysql_service.default: Creation complete after 3m40s [id=dbpgf00000001]
+data.skysql_credentials.default: Reading...
+data.skysql_service.default: Reading...
+data.skysql_service.default: Read complete after 0s [name=skysql-nr-quickstart]
+data.skysql_credentials.default: Read complete after 0s
+
+Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
+Then Terraform prints the outputs.
+Obtain the connection credentials for the new SkySQL service by executing the following commands:
+Download [skysql_chain_2022.pem](https://supplychain.mariadb.com/skysql/skysql_chain_2022.pem), which contains the Certificate Authority chain that is used to verify the server's certificate for TLS:
$ curl https://supplychain.mariadb.com/skysql/skysql_chain_2022.pem --output ~/Downloads/skysql_chain_2022.pem
Obtain the connection command from the terraform.tfstate file:
$ jq ".outputs.skysql_cmd" terraform.tfstate
"mariadb --host dbpgf00000001.sysp0000.db.skysql.net --port 3306 --user dbpgf00000001 -p --ssl-ca ~/Downloads/skysql_chain_2022.pem"
Obtain the user password from the terraform.tfstate file:
$ jq ".outputs.skysql_credentials.value.password" terraform.tfstate
"..password string.."
Connect to the SkySQL service by executing the connection command from the previous step:
+$ mariadb --host dbpgf00000001.sysp0000.db.skysql.net --port 3306 --user dbpgf00000001 -p --ssl-ca ~/Downloads/skysql_chain_2022.pem
When prompted, type the password and press enter to connect:
+Enter password:
+Welcome to the MariaDB monitor. Commands end with ; or \g.
+Your MariaDB connection id is 1059
+Server version: 10.6.11-6-MariaDB-enterprise-log MariaDB Enterprise Server
+
+Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.
+
+Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
+
+MariaDB [(none)]>
+terraform destroyDelete the service by executing the [terraform destroy command](https://developer.hashicorp.com/terraform/cli/commands/destroy) and specifying the path to the .tfvars file:
$ terraform destroy -var-file="skysql-nr-quickstart.tfvars"
Terraform prints the plan to delete the service and prompts the user to confirm that the plan should be applied:
+`Do you really want to destroy all resources? + Terraform will destroy all your managed infrastructure, as shown above. + There is no undo. Only 'yes' will be accepted to confirm.
+Enter a value: yes`
+If deletion protection is enabled for the resources, the operation raises an error:
+╷
+│ Error: Can not delete service
+│
+│ Deletion protection is enabled
+╵
If deletion protection is not enabled for the resources, Terraform deletes the resources and prints status messages:
+skysql_service.default: Destroying... [id=dbpgf00000001]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 10s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 20s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 30s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 40s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 50s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 1m0s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 1m10s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 1m20s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 1m30s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 1m40s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 1m50s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 2m0s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 2m10s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 2m20s elapsed]
+skysql_service.default: Still destroying... [id=dbpgf00000001, 2m30s elapsed]
+skysql_service.default: Destruction complete after 2m38s
+
+Destroy complete! Resources: 1 destroyed.
+The SkySQL New Release Terraform provider can be downloaded from the GitHub releases page as a binary distribution and manually installed.
+With Linux, manually install the provider on the target system by performing the following steps in the same Bash terminal:
+Set some environment variables to configure your provider version, OS, and architecture:
+$ export TF_PROVIDER_RELEASE=1.1.0
+$ export TF_PROVIDER_OS=linux
+$ export TF_PROVIDER_ARCH=amd64
For TF_PROVIDER_ARCH, the following architectures are supported on Linux:
386amd64armarm64wget:$ wget -q https://github.com/mariadb-corporation/terraform-provider-skysql/releases/download/v1.1.0/terraform-provider-skysql_${TF_PROVIDER_RELEASE}_${TF_PROVIDER_OS}_${TF_PROVIDER_ARCH}.zip
Create a Terraform plugin directory:
+$ mkdir -p ~/.terraform.d/plugins/registry.terraform.io/mariadb-corporation/skysql
Move the provider's binary distribution to the Terraform plugin directory:
+$ mv terraform-provider-skysql_${TF_PROVIDER_RELEASE}_${TF_PROVIDER_OS}_${TF_PROVIDER_ARCH}.zip ~/.terraform.d/plugins/registry.terraform.io/mariadb-corporation/skysql/
Verify that the provider's binary distribution is present in the Terraform plugin directory:
+$ ls -l ~/.terraform.d/plugins/registry.terraform.io/mariadb-corporation/skysql/
With macOS, manually install the provider on the target system by performing the following steps in the same macOS Terminal:
+If Homebrew is not installed, install it:
+$ /bin/bash -c "**$(**curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh**)**"
Install wget using Homebrew:
$ brew install wget
Set some environment variables to configure your provider version, OS, and architecture:
+$ export TF_PROVIDER_RELEASE=1.1.0
+$ export TF_PROVIDER_OS=darwin
+$ export TF_PROVIDER_ARCH=arm64
For TF_PROVIDER_ARCH, the following architectures are supported on macOS:
amd64arm64wget:$ wget -q https://github.com/mariadb-corporation/terraform-provider-skysql/releases/download/v1.1.0/terraform-provider-skysql_${TF_PROVIDER_RELEASE}_${TF_PROVIDER_OS}_${TF_PROVIDER_ARCH}.zip
Create a Terraform plugin directory:
+$ mkdir -p ~/.terraform.d/plugins/registry.terraform.io/mariadb-corporation/skysql
Move the provider's binary distribution to the Terraform plugin directory:
+$ mv terraform-provider-skysql_${TF_PROVIDER_RELEASE}_${TF_PROVIDER_OS}_${TF_PROVIDER_ARCH}.zip ~/.terraform.d/plugins/registry.terraform.io/mariadb-corporation/skysql/
Verify that the provider's binary distribution is present in the Terraform plugin directory:
+$ ls -l ~/.terraform.d/plugins/registry.terraform.io/mariadb-corporation/skysql/
It only takes a few minutes to launch a standalone or clustered database on SkySQL. You can pick from about 30 global regions and launch on AWS or GCP.
+You have three choices to provision a DB on SkySQL :
+This Quickstart explains how to launch database services and manage the lifecycle of database services using the Portal in a web browser.
+For users who prefer other interfaces, SkySQL offers the following alternatives:
+Goto app.skysql.com to sign up. You can sign up using your Google, Github or LinkedIn credentials. Or, just use your Email address to sign up.
+
Log in to the SkySQL Portal with your MariaDB ID and launch a service.
+
From the launch interface, select the type of service you want to launch.
+Click the configuration choices detailed below.
+https://app.skysql.com/launch-service
+Select:
+us-east-2, or Google Cloud and us-east1, or a region of your choicequickstart-1Then, click the "LAUNCH SERVICE" button.
+
For additional information on available selections, see "Service Launch".
+You will be returned to the Dashboard where your service will be in a "Creating" state.
+When the service reaches "Healthy" state, go to the next step. It typically takes about 5 mins or less to launch a new DB.
+SkySQL services support most MariaDB-compatible database clients and most popular programming languages (such as Python, Node.js, Java, and PHP).
+However, with SkySQL's Query Editor, we can query databases directly from the web browser. This can be handy for development and day-to-day operations.
+To access the Query Editor:
+You may be prompted to add your IP address to the Firewall allowlist. Your service will enter a "Modifying" state while that change is performed.
+
Query Editor - Allowlist
+Once the Firewall update is completed, you can select your database in Query Editor.
+
Query Editor
+For additional information on this feature, see "Query Editor".
+You can monitor all the important database and OS metrics from the dashboard. The monitoring UI also allows you to view,download any/all logs - error, info or Audit logs.
+Basic status is shown on the Dashboard.
+To see expanded status and metrics information:
+Specific views are provided for different sets of metrics. These views can be accessed using the buttons in the upper-right corner. From the service overview, views include "Status", "Queries", and "Connections".
+
Monitoring Dashboard
+Policies (alerting rules) identify "warning" and "critical" events within status and metrics data. Alerts are customer configurable, but pre-configured with sensible defaults in alignment to typical customer requirements. For additional information, see "Alerts".
+SkySQL features automatic rule-based scaling (Autonomous) and manual on-demand scaling.
+With automatic scaling, node count (horizontal) and node count (vertical) changes can be triggered based on load. Additionally, storage capacity expansion can be triggered based on usage. These Autonomous features are opt-in. For additional information, see "Autonomous".
+
Autonomous
+https://app.skysql.com/
+With manual scaling, you can perform horizontal scaling (In/Out), vertical scaling (Up/Down), and storage expansion on-demand using Self-Service Operations. For additional information, see "Self-Service Operations".
+
Self-Service Scaling of Nodes
+When you are done with your testing session, you can stop the service. When a service is stopped, storage charges continue to accrue, but compute charges pause until the service is started again.
+When you are done with testing, you can delete the service.
+Stopping, starting, and deleting a service are examples of Self-Service Operations that you can perform through the Portal.
+For additional information, see "Self-Service Operations".
+ + + + + + + + + + + + + + + +Instance size choices are specific to the cloud provider, topology, region, and hardware architecture.
+ + +For Foundation tier:
+| Instance Size | +Cloud Provider | +CPU | +Memory | +
|---|---|---|---|
| sky-2x4 | +aws | +2 vCPU | +4 GB | +
| sky-2x8 | +aws | +2 vCPU | +8 GB | +
| sky-2x8 | +gcp | +2 vCPU | +8 GB | +
| sky-4x16 | +aws | +4 vCPU | +16 GB | +
| sky-4x16 | +gcp | +4 vCPU | +16 GB | +
| sky-4x32 | +aws | +4 vCPU | +32 GB | +
| sky-4x32 | +gcp | +4 vCPU | +32 GB | +
| sky-8x32 | +aws | +8 vCPU | +32 GB | +
| sky-8x32 | +gcp | +8 vCPU | +32 GB | +
| sky-8x64 | +aws | +8 vCPU | +64 GB | +
| sky-8x64 | +gcp | +8 vCPU | +64 GB | +
For Power tier:
+| Instance Size | +Cloud Provider | +CPU | +Memory | +
|---|---|---|---|
| sky-2x4 | +aws | +2 vCPU | +4 GB | +
| sky-2x8 | +aws | +2 vCPU | +8 GB | +
| sky-2x8 | +gcp | +2 vCPU | +8 GB | +
| sky-4x16 | +aws | +4 vCPU | +16 GB | +
| sky-4x16 | +gcp | +4 vCPU | +16 GB | +
| sky-4x32 | +aws | +4 vCPU | +32 GB | +
| sky-4x32 | +gcp | +4 vCPU | +32 GB | +
| sky-8x32 | +aws | +8 vCPU | +32 GB | +
| sky-8x32 | +gcp | +8 vCPU | +32 GB | +
| sky-8x64 | +aws | +8 vCPU | +64 GB | +
| sky-16x64 | +aws | +16 vCPU | +64 GB | +
| sky-16x64 | +gcp | +16 vCPU | +64 GB | +
| sky-16x128 | +aws | +16 vCPU | +128 GB | +
| sky-16x128 | +gcp | +16 vCPU | +128 GB | +
| sky-32x128 | +aws | +32 vCPU | +128 GB | +
| sky-32x128 | +gcp | +32 vCPU | +128 GB | +
| sky-32x256 | +aws | +32 vCPU | +256 GB | +
| sky-32x256 | +gcp | +32 vCPU | +256 GB | +
| sky-64x256 | +aws | +64 vCPU | +256 GB | +
| sky-64x256 | +gcp | +64 vCPU | +256 GB | +
| sky-64x512 | +aws | +64 vCPU | +512 GB | +
| sky-64x512 | +gcp | +64 vCPU | +512 GB | +
With Power tier, the following instance sizes can be selected for MaxScale nodes:
+| Instance Size | +Cloud Provider | +CPU | +Memory | +
|---|---|---|---|
| sky-2x4 | +aws | +2 vCPU | +4 GB | +
| sky-2x8 | +gcp | +2 vCPU | +8 GB | +
| sky-4x16 | +aws | +4 vCPU | +16 GB | +
| sky-4x16 | +gcp | +4 vCPU | +16 GB | +
| sky-8x32 | +aws | +8 vCPU | +32 GB | +
| sky-8x32 | +gcp | +8 vCPU | +32 GB | +
| sky-16x64 | +aws | +16 vCPU | +64 GB | +
| sky-16x64 | +gcp | +16 vCPU | +64 GB | +
| sky-32x128 | +aws | +32 vCPU | +128 GB | +
| sky-32x128 | +gcp | +32 vCPU | +128 GB | +
| sky-64x256 | +aws | +64 vCPU | +256 GB | +
| sky-64x256 | +gcp | +64 vCPU | +256 GB | +
A REST client can use the SkySQL DBaaS API to query instance size selections and choose an instance size for a new service.
+A REST client can query the SkySQL DBaaS API for the database node instance size selections for a specific cloud provider, architecture, and topology.
+To see the available database node instance sizes for a topology, use curl to call the [/provisioning/v1/sizes API endpoint](https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_sizes/) with type=server set:
curl -sS --location \
+ --header "X-API-Key: ${API_KEY}" \
+ 'https://api.skysql.com/provisioning/v1/sizes?architecture=amd64&service_type=transactional&provider=gcp&topology=es-replica&type=server' \
+ | jq .
+[
+ {
+ "id": "37629543-65d2-11ed-8da6-2228d0ae81af",
+ "name": "sky-2x8",
+ "display_name": "Sky-2x8",
+ "service_type": "transactional",
+ "provider": "gcp",
+ "tier": "foundation",
+ "architecture": "amd64",
+ "cpu": "2 vCPU",
+ "ram": "8 GB",
+ "type": "server",
+ "default_maxscale_size_name": "sky-2x8",
+ "updated_on": "2022-11-16T17:15:06Z",
+ "created_on": "2022-11-16T17:15:06Z",
+ "is_active": true,
+ "topology": "es-replica"
+ },
+ {
+ "id": "37629489-65d2-11ed-8da6-2228d0ae81af",
+ "name": "sky-4x16",
+ "display_name": "Sky-4x16",
+ "service_type": "transactional",
+ "provider": "gcp",
+ "tier": "foundation",
+ "architecture": "amd64",
+ "cpu": "4 vCPU",
+ "ram": "16 GB",
+ "type": "server",
+ "default_maxscale_size_name": "sky-2x8",
+ "updated_on": "2022-11-16T17:15:06Z",
+ "created_on": "2022-11-16T17:15:06Z",
+ "is_active": true,
+ "topology": "es-replica"
+ },
+....
+
+]
+A REST client can query the SkySQL DBaaS API for the MaxScale node instance size selections for a specific cloud provider, architecture, and topology.
+To see the default MaxScale instance size for a topology, cloud, and architecture, use curl to call the [/provisioning/v1/sizes API endpoint](https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_sizes/):
curl -sS --location \
+ --header "X-API-Key: ${API_KEY}" \
+ 'https://api.skysql.com/provisioning/v1/sizes?provider=gcp&architecture=amd64&topology=es-replica' \
+ | jq .
+[
+ {
+ "id": "c0666ab8-4a3b-11ed-8853-b278760e6ab5",
+ "name": "sky-2x8",
+ "display_name": "Sky-2x8",
+ "service_type": "transactional",
+ "provider": "gcp",
+ "tier": "foundation",
+ "architecture": "amd64",
+ "cpu": "2 vCPU",
+ "ram": "8 GB",
+ "type": "server",
+ "default_maxscale_size_name": "sky-2x8",
+ "updated_on": "2022-10-12T14:40:00Z",
+ "created_on": "2022-10-12T14:40:00Z",
+ "is_active": true,
+ "topology": "es-replica"
+ }
+]
+The default_maxscale_size_name attribute shows the default MaxScale instance size.
To see the available MaxScale node instance sizes for a topology, use curl to call the [/provisioning/v1/sizes API endpoint](https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_sizes/) with type=proxy set:
curl -sS --location \
+ --header "X-API-Key: ${API_KEY}" \
+ 'https://api.skysql.com/provisioning/v1/sizes?architecture=amd64&service_type=transactional&provider=gcp&topology=es-replica&type=proxy' \
+ | jq .
+The output can show different instance sizes, depending on whether your SkySQL account is Foundation tier or Power tier.
+ + + + + + + + + + + + + +The following Authenticators are supported by MariaDB MaxScale 22.08:
+| Method | +Authenticator | +Enterprise Server Plugin | +Xpand Plugin | +Description | +
|---|---|---|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/authenticator/GSSAPI/ | +GSSAPIAuth | +https://mariadb.com/docs/server/ref/mdb/plugins/gssapi/ | ++ | Authenticates client connections using a GSSAPI authentication service | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/authenticator/Native/ | +MariaDBAuth | +https://mariadb.com/docs/skysql-dbaas/ref/mdb/plugins/mysql_native_password/ | +https://mariadb.com/docs/xpand/security/authentication/xpand/mysql_native_password/ | +Authenticates client connections using the native password authentication method | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/authenticator/PAM/ | +PAMAuth | +https://mariadb.com/docs/server/ref/mdb/plugins/pam,auth_pam.so/ | ++ | Authenticates client connections using a Pluggable Authentication Modules (PAM) service | +
To see Authenticators supported in other versions, see "Authenticators by MariaDB MaxScale Version".
+The following Filters are supported by MariaDB MaxScale 22.08:
+| Filter | +Type | +Description | +
|---|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/binlogfilter/ | +Special Routing | +Binary Log Filter can be used with the binlogrouter to selectively replicate Binary Log events to Replica Servers | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/cache/ | +Performance | +Caches the result-sets of https://mariadb.com/docs/skysql-dbaas/ref/mdb/sql-statements/SELECT/ statements to improve query performance | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/ccrfilter/ | +Server Selection | +Consistent Critical Read (CCR) Filter detects when a statement modifies the database, and it attaches routing hints to any subsequent statements, so they get routed to the master | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/hintfilter/ | +Server Selection | +Hint Filter allows services to interpret routing hints, which can be specified in a comment when a query is executed. Note that if master_accept_reads is enabled, MaxScale will still route to both master and slave | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/insertstream/ | +Performance | +Insert Stream Filter translates bulk https://mariadb.com/docs/skysql-dbaas/ref/mdb/sql-statements/INSERT/ statements into CSV data that is streamed to the backend server and loaded using the https://mariadb.com/docs/skysql-dbaas/ref/mdb/sql-statements/LOAD_DATA_INFILE/ statement | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/luafilter/ | +Programmatic | +Lua Filter processes queries with the specified Lua scripts (experimental) | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/masking/ | +Security | +Masking Filter obfuscates the return values of specified columns | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/maxrows/ | +Performance | +Max Rows Filter limits the number of rows that https://mariadb.com/docs/skysql-dbaas/ref/mdb/sql-statements/SELECT/ statements, prepared statements, and stored procedures can return | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/namedserverfilter/ | +Server Selection | +Named Server Filter compares queries to specified Regular Expressions, and when the query matches, the filter applies the specified routing hint to the query | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/qlafilter/ | +Security | +Query Log All (QLA) Filter logs matching queries to a CSV file | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/regexfilter/ | +Programmatic | +Regex Filter rewrites matching queries using Regular Expressions | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/rewritefilter/ | ++ | Rewrites queries based on a query template | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/tee/ | +Special Routing | +Tee Filter copies client requests to other services | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/throttlefilter/ | +Performance | +Throttle Filter limits the maximum frequency of queries per second allowed for a database session | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/topfilter/ | +Performance | +Top Filter logs the top queries by execution time | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/filter/tpmfilter/ | +Performance | +Transaction Performance Monitoring (TPM) Filter logs information on committed transactions for performance analysis (experimental) | +
To see Filters supported in other versions, see "Filters by MariaDB MaxScale Version".
+The following Global Parameters are supported by MariaDB MaxScale 22.08:
+| Global Parameter | +Description | +
|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_auth/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_auth/ | +Enables HTTP Basic Access authentication for REST API | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_enabled/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_enabled/ | +Enables the administrative interface for REST API | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_gui/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_gui/ | +Enable admin GUI | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_host/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_host/ | +Network interface the REST API listens on | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_jwt_algorithm/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_jwt_algorithm/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_jwt_algorithm/ | +JWT signature algorithm | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_jwt_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_jwt_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_jwt_key/ | +Encryption key ID for symmetric signature algorithms. If left empty, MaxScale will generate a random key that is used to sign the JWT. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_log_auth_failures/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_log_auth_failures/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_log_auth_failures/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_log_auth_failures/ | +Enables logging authentication failures to the administrative interface | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_oidc_url/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_oidc_url/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_oidc_url/ | +Extra public certificates used to validate externally signed JWTs | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_pam_readonly_service/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_pam_readonly_service/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_pam_readonly_service/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_pam_readonly_service/ | +Enables PAM-based authentication served for REST API for read-only users | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_pam_readwrite_service/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_pam_readwrite_service/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_pam_readwrite_service/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_pam_readwrite_service/ | +Enables PAM-based authentication service for REST API for users who can perform any REST API operation | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_port/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_port/ | +Port on network interface the REST API listenes on | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_secure_gui/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_secure_gui/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_secure_gui/ | +Only serve GUI over HTTPS | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_ca/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_ca/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_ca/ | +Path to PEM file containing TLS Certificate Authority (CA) to use in HTTPS for REST API. Formerly admin_ssl_ca_cert. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_ca_cert/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_ca_cert/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_ca_cert/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_ca_cert/ | +Alias for 'admin_ssl_ca' | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_cert/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_cert/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_cert/ | +Path to PEM file containing TLS certificate to use in HTTPS for REST API | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_key/ | +Path to PEM file containing TLS key to use in HTTPS for REST API | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_version/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_version/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_ssl_version/ | +Minimum required TLS protocol version for the REST API | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_verify_url/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_verify_url/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/admin_verify_url/ | +URL for third-party verification of client tokens | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/auth_connect_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/auth_connect_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/auth_connect_timeout/ | +Amount of time to wait in seconds for authentication to the Server | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/auth_read_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/auth_read_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/auth_read_timeout/ | +Amount of time to wait in seconds when retrieving user authentication data from the Server | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/auth_write_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/auth_write_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/auth_write_timeout/ | +Amount of time to wait in seconds when retrieving user authentication data from the Server. MaxScale does not write authentication data to the Server. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/auto_tune/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/auto_tune/ | +Specifies whether a MaxScale parameter whose value depends on a specific global server variable, should automatically be updated to match the variable's current value | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/cachedir/ | +Path to the directory containing cached data | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_cluster/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_cluster/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_cluster/ | +Cluster used for configuration synchronization. If left empty (i.e., value is ""), synchronization is not done. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_db/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_db/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_db/ | +Database where the 'maxscale_config' table is created | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_interval/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_interval/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_interval/ | +How often to synchronize the configuration | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_password/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_password/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_password/ | +Password for the user used for configuration synchronization | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_timeout/ | +Timeout for the configuration synchronization operations | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_user/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_user/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/config_sync_user/ | +User account used for configuration synchronization | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/connector_plugindir/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/connector_plugindir/ | +Path to MariaDB Connector C plugin directory | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/datadir/ | +Path to the data directory | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/debug/ | +Debug options | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/dump_last_statements/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/dump_last_statements/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/dump_last_statements/ | +Sets condition on which MariaDB MaxScale dumps the last statement sent by the client | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/execdir/ | +Path to directory containing executable files | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/key_manager/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/key_manager/ | +Key manager type | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/language/ | +Path to directory containing the errmsg.sys file | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/libdir/ | +Path to the directory searched for modules | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/load_persisted_configs/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/load_persisted_configs/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/load_persisted_configs/ | +Enables loading persistent runtime configuration changes on startup. Persistent runtime changes are saved to the /var/lib/maxscale/maxscale.cnf.d/ directory. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/local_address/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/local_address/ | +Sets local address or network interface to use when connecting to Servers | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_augmentation/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_augmentation/ | +Appends logging messages with the name of the function where the message was logged (used primarily for development purposes) | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_debug/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_debug/ | +Enables logging messages at the debug syslog priority | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_info/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_info/ | +Enables logging messages at the info syslog priority | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_notice/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_notice/ | +Enables logging messages at the notice syslog priority | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_throttling/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_throttling/ | +Limit the amount of identical log messages than can be logged during a certain time period | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_warn_super_user/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_warn_super_user/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_warn_super_user/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_warn_super_user/ | +Log a warning when a user with super privilege logs in | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_warning/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/log_warning/ | +Enables logging messages at the warning syslog priority | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/logdir/ | +Path to directory used to store log files | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/max_auth_errors_until_block/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/max_auth_errors_until_block/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/max_auth_errors_until_block/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/max_auth_errors_until_block/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/max_auth_errors_until_block/ | +Maximum number of authentication failures allowed before temporarily blocking a host | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/max_read_amount/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/max_read_amount/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/max_read_amount/ | +Maximum amount of data read before return to epoll_wait | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/maxlog/ | +Logs messages to the log file | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/module_configdir/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/module_configdir/ | +Path to directory containing module configurations | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/ms_timestamp/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/ms_timestamp/ | +Enables millisecond precision in log timestamps | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/passive/ | +Puts the MaxScale Instance on stand-by, Passive Instances monitor Servers and accept client connections, but take no action | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/persist_runtime_changes/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/persist_runtime_changes/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/persist_runtime_changes/ | +Persist configurations changes done at runtime | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/persistdir/ | +Path to directory containing persistent configurations | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/piddir/ | +Path to the directory containing the PID file | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_classifier/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_classifier/ | +Sets the Query Classifier module | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_classifier_args/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_classifier_args/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_classifier_args/ | +Specifies arguments passed to the Query Classifier | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_classifier_cache_size/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_classifier_cache_size/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_classifier_cache_size/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_classifier_cache_size/ | +Maximum size for Query Classifier Cache | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_retries/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_retries/ | +Number of times to retry an internal query interruped by network errors | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_retry_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_retry_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/query_retry_timeout/ | +Amount of time in seconds to wait on retried queries | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/rebalance_period/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/rebalance_period/ | +How often should the load of the worker threads be checked and rebalancing be made | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/rebalance_threshold/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/rebalance_threshold/ | +If the difference in load between the thread with the maximum load and the thread with the minimum load is larger than the value of this parameter, then work will be moved from the former to the latter | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/rebalance_window/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/rebalance_window/ | +The load of how many seconds should be taken into account when rebalancing | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/retain_last_statements/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/retain_last_statements/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/retain_last_statements/ | +Number of statements stored for each session. Used in debugging. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/session_trace/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/session_trace/ | +Number of log entries stored in the session trace log. Used in debugging. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/session_trace_match/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/session_trace_match/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/session_trace_match/ | +Regular expression that is matched against the contents of the session trace log and if it matches the contents are logged when the session stops | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/sharedir/ | ++ |
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/skip_name_resolve/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/skip_name_resolve/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/skip_name_resolve/ | +Do not resolve client IP addresses to hostnames during authentication | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/skip_permission_checks/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/skip_permission_checks/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/skip_permission_checks/ | +Disables user permission checks for services and monitors during startup | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/sql_mode/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/sql_mode/ | +Specifies SQL Mode for Query Classifier | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/substitute_variables/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/substitute_variables/ | +Sets environmental variables for cofniguration files | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/syslog/ | +Logs messages to the syslog | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/threads/ | +This parameter specifies how many threads will be used for handling the routing | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/users_refresh_interval/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/users_refresh_interval/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/users_refresh_interval/ | +How often the users will be refreshed | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/users_refresh_time/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/users_refresh_time/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/users_refresh_time/ | +How often the users can be refreshed | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/writeq_high_water/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/writeq_high_water/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/writeq_high_water/ | +Maximum size of client-side write queue to a given Server before MaxScale blocks traffic going to the Server to allow it to catch up | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/writeq_low_water/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/writeq_low_water/https://mariadb.com/docs/skysql-dbaas/ref/mxs/global-parameters/writeq_low_water/ | +Size the client-side write queue must drop to before MaxScale unblocks a throttled Server | +
To see Global Parameters supported in other versions, see "Global Parameters by MariaDB MaxScale Version".
+The Module Parameters supported by MariaDB MaxScale 22.08 are listed below.
+To see Module Parameters supported in other versions, see "Module Parameters by MariaDB MaxScale Version".
+The parameters for mariadbmon:
+| Parameter | +Description | +
|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/assume_unique_hostnames/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/assume_unique_hostnames/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/assume_unique_hostnames/ | +Assume that hostnames are unique | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auto_failover/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auto_failover/ | +Enable automatic server failover | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auto_rejoin/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auto_rejoin/ | +Enable automatic server rejoin | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/backend_connect_attempts,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/backend_connect_attempts,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/backend_connect_attempts,Monitor.mariadbmon/ | +Number of connection attempts to make to a server | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/backend_connect_timeout,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/backend_connect_timeout,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/backend_connect_timeout,Monitor.mariadbmon/ | +Connection timeout for monitor connections | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/backend_read_timeout,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/backend_read_timeout,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/backend_read_timeout,Monitor.mariadbmon/ | +Read timeout for monitor connections | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/backend_write_timeout,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/backend_write_timeout,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/backend_write_timeout,Monitor.mariadbmon/ | +Write timeout for monitor connections | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cooperative_monitoring_locks/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cooperative_monitoring_locks/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cooperative_monitoring_locks/ | +Cooperative monitoring type | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cs_admin_api_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cs_admin_api_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cs_admin_api_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cs_admin_api_key/ | +The API key used in communication with the ColumnStore admin daemon | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cs_admin_base_path/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cs_admin_base_path/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cs_admin_base_path/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cs_admin_base_path/ | +The base path to be used when accessing the ColumnStore administrative daemon. If, for instance, a daemon URL is https://localhost:8640/cmapi/0.4.0/node/start then the admin_base_path is "/cmapi/0.4.0". | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cs_admin_port/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cs_admin_port/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/cs_admin_port/ | +Port of the ColumnStore administrative daemon | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/demotion_sql_file/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/demotion_sql_file/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/demotion_sql_file/ | +Path to SQL file that is executed during node demotion | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disk_space_check_interval,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disk_space_check_interval,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disk_space_check_interval,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disk_space_check_interval,Monitor.mariadbmon/ | +How often the disk space is checked | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disk_space_threshold,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disk_space_threshold,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disk_space_threshold,Monitor.mariadbmon/ | +Disk space threshold | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enforce_read_only_slaves/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enforce_read_only_slaves/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enforce_read_only_slaves/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enforce_read_only_slaves/ | +Enable read_only on all slave servers | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enforce_simple_topology/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enforce_simple_topology/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enforce_simple_topology/ | +Enforce a simple topology | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enforce_writable_master/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enforce_writable_master/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enforce_writable_master/ | +Disable read_only on the current master server | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/events,Monitor.mariadbmon/ | +Events that cause the script to be called | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/failcount/ | +Number of consecutive times MaxScale can fail to reach the Primary Server before it considers it down | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/failover_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/failover_timeout/ | +Timeout for failover | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/handle_events/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/handle_events/ | +Manage server-side events | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/journal_max_age,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/journal_max_age,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/journal_max_age,Monitor.mariadbmon/ | +The time the on-disk cached server states are valid for | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/maintenance_on_low_disk_space/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/maintenance_on_low_disk_space/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/maintenance_on_low_disk_space/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/maintenance_on_low_disk_space/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/maintenance_on_low_disk_space/ | +Put the server into maintenance mode when it runs out of disk space | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_conditions/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_conditions/ | +Conditions that the master servers must meet | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_failure_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_failure_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_failure_timeout/ | +Master failure timeout | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/monitor_interval,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/monitor_interval,Monitor.mariadbmon/ | +How often the servers are monitored | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/password,Monitor.mariadbmon/ | +Password for the user used to monitor the servers | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/promotion_sql_file/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/promotion_sql_file/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/promotion_sql_file/ | +Path to SQL file that is executed during node promotion | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/rebuild_port/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/rebuild_port/ | +Listen port used for transferring server backup | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/replication_master_ssl/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/replication_master_ssl/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/replication_master_ssl/ | +Enable SSL when configuring replication | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/replication_password/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/replication_password/ | +Password for the user that is used for replication | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/replication_user/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/replication_user/ | +User used for replication | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/script,Monitor.mariadbmon/ | +Script to run whenever an event occurs | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/script_max_replication_lag/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/script_max_replication_lag/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/script_max_replication_lag/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/script_max_replication_lag/ | +Replication lag limit at which the script is run | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/script_timeout,Monitor.mariadbmon/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/script_timeout,Monitor.mariadbmon/ | +Timeout for the script | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/servers,Monitor.mariadbmon/ | +List of servers to use | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/servers_no_promotion/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/servers_no_promotion/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/servers_no_promotion/ | +List of servers that are never promoted | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/slave_conditions/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/slave_conditions/ | +Conditions that the slave servers must meet | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssh_check_host_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssh_check_host_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssh_check_host_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssh_check_host_key/ | +Is SSH host key check enabled | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssh_keyfile/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssh_keyfile/ | +SSH keyfile. Used for running remote commands on servers. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssh_port/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssh_port/ | +SSH port. Used for running remote commands on servers. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssh_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssh_timeout/ | +SSH connection and command timeout | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssh_user/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssh_user/ | +SSH username. Used for running remote commands on servers. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/switchover_on_low_disk_space/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/switchover_on_low_disk_space/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/switchover_on_low_disk_space/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/switchover_on_low_disk_space/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/switchover_on_low_disk_space/ | +Perform a switchover when a server runs out of disk space | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/switchover_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/switchover_timeout/ | +Timeout for switchover | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user,Monitor.mariadbmon/ | +Username used to monitor the servers | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/verify_master_failure/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/verify_master_failure/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/verify_master_failure/ | +Verify master failure | +
The parameters for readwritesplit:
+| Parameter | +Description | +
|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_all_servers,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_all_servers,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_all_servers,Router.readwritesplit/ | +Retrieve users from all backend servers instead of only one | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/causal_reads/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/causal_reads/ | +Configures read causality, reads subsequent to writes issued in manner to reduce replication lag | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/causal_reads_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/causal_reads_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/causal_reads_timeout/ | +Timeout for synchronization of the Primary Server with a Replica Server during causal reads | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/connection_keepalive,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/connection_keepalive,Router.readwritesplit/ | +How ofted idle connections are pinged | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/connection_timeout,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/connection_timeout,Router.readwritesplit/ | +Connection idle timeout | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/delayed_retry/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/delayed_retry/ | +Retry queries that fail to route due to connection issues | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/delayed_retry_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/delayed_retry_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/delayed_retry_timeout/ | +Timeout for retrying queries that fail to route due to connection issues | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disable_sescmd_history,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disable_sescmd_history,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disable_sescmd_history,Router.readwritesplit/ | +Disable session command history | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enable_root_user,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enable_root_user,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enable_root_user,Router.readwritesplit/ | +Allow the root user to connect to this service | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/force_connection_keepalive,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/force_connection_keepalive,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/force_connection_keepalive,Router.readwritesplit/ | +Ping connections unconditionally | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/idle_session_pool_time,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/idle_session_pool_time,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/idle_session_pool_time,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/idle_session_pool_time,Router.readwritesplit/ | +Put connections into pool after session has been idle for this long | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/lazy_connect/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/lazy_connect/ | +Create connections only when needed | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/localhost_match_wildcard_host,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/localhost_match_wildcard_host,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/localhost_match_wildcard_host,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/localhost_match_wildcard_host,Router.readwritesplit/ | +Match localhost to wildcard host | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_auth_warnings,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_auth_warnings,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_auth_warnings,Router.readwritesplit/ | +Log a warning when client authentication fails | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_debug,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_debug,Router.readwritesplit/ | +Log debug messages for this service (debug builds only) | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_info,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_info,Router.readwritesplit/ | +Log info messages for this service | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_notice,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_notice,Router.readwritesplit/ | +Log notice messages for this service | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_warning,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_warning,Router.readwritesplit/ | +Log warning messages for this service | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_accept_reads,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_accept_reads,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_accept_reads,Router.readwritesplit/ | +Use master for reads | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_failure_mode/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_failure_mode/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_failure_mode/ | +Master failure mode behavior | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_reconnection/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_reconnection/ | +Reconnect to the Primary Server if it changes mid-session | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_connections,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_connections,Router.readwritesplit/ | +Maximum number of connections | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_sescmd_history,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_sescmd_history,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_sescmd_history,Router.readwritesplit/ | +Session command history size | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_slave_connections/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_slave_connections/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_slave_connections/ | +Maximum number of connections the router session can use to connect to Replica Servers | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_slave_replication_lag/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_slave_replication_lag/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_slave_replication_lag/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_slave_replication_lag/ | +Number of seconds a Replica Server is allowed to fall behind the Primary Server | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/multiplex_timeout,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/multiplex_timeout,Router.readwritesplit/ | +How long a session can wait for a connection to become available | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/net_write_timeout,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/net_write_timeout,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/net_write_timeout,Router.readwritesplit/ | +Network write timeout | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/optimistic_trx/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/optimistic_trx/ | +Optimistically offload transactions to slaves | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/password,Router.readwritesplit/ | +Password for the user used to retrieve database users | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/prune_sescmd_history,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/prune_sescmd_history,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/prune_sescmd_history,Router.readwritesplit/ | +Prune old session command history if the limit is exceeded | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/rank,Router.readwritesplit/ | +Service rank | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/retain_last_statements,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/retain_last_statements,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/retain_last_statements,Router.readwritesplit/ | +Number of statements kept in memory | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/retry_failed_reads/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/retry_failed_reads/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/retry_failed_reads/ | +Automatically retry failed reads outside of transactions | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/reuse_prepared_statements/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/reuse_prepared_statements/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/reuse_prepared_statements/ | +Reuse identical prepared statements inside the same connection | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_trace,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_trace,Router.readwritesplit/ | +Enable session tracing for this service | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_track_trx_state,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_track_trx_state,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_track_trx_state,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_track_trx_state,Router.readwritesplit/ | +Track session state using server responses | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/slave_connections/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/slave_connections/ | +Starting number of slave connections | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/slave_selection_criteria/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/slave_selection_criteria/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/slave_selection_criteria/ | +Criteria the router uses to select Replica Servers in load balancing read operations | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/strict_multi_stmt/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/strict_multi_stmt/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/strict_multi_stmt/ | +Routes multi-statement queries to the Primary Server | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/strict_sp_calls/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/strict_sp_calls/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/strict_sp_calls/ | +Routes https://mariadb.com/docs/skysql-dbaas/ref/mdb/sql-statements/CALL/ statements to the Primary Server | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/strip_db_esc,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/strip_db_esc,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/strip_db_esc,Router.readwritesplit/ | +Strip escape characters from database names | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay/ | +Replays in progress transactions that fail on a different Server | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_attempts/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_attempts/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_attempts/ | +Maximum number of times to attempt to replay failed transactions | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_checksum/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_checksum/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_checksum/ | +Type of checksum to calculate for results | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_max_size/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_max_size/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_max_size/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_max_size/ | +Maximum size in bytes permitted for transaction replays | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_retry_on_deadlock/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_retry_on_deadlock/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_retry_on_deadlock/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_retry_on_deadlock/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_retry_on_deadlock/ | +Maximum number of times the router attempts to replay transactions in the event that the transaction fails due to deadlocks | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_retry_on_mismatch/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_retry_on_mismatch/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_retry_on_mismatch/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_retry_on_mismatch/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_retry_on_mismatch/ | +Retry transaction on checksum mismatch | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/transaction_replay_timeout/ | +Timeout for transaction replay | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/use_sql_variables_in/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/use_sql_variables_in/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/use_sql_variables_in/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/use_sql_variables_in/ | +Where the router sends session variable queries | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user,Router.readwritesplit/ | +Username used to retrieve database users | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file,Router.readwritesplit/ | +Load additional users from a file | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file_usage,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file_usage,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file_usage,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file_usage,Router.readwritesplit/ | +When and how the user accounts file is used | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/version_string,Router.readwritesplit/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/version_string,Router.readwritesplit/ | +Custom version string to use | +
The parameters for MariaDBProtocol:
+| Parameter | +Description | +
|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/address,Protocol.MariaDBProtocol/ | +Listener address | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/authenticator,Protocol.MariaDBProtocol/ | +Listener authenticator | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/authenticator_options,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/authenticator_options,Protocol.MariaDBProtocol/ | +Authenticator options | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/connection_init_sql_file,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/connection_init_sql_file,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/connection_init_sql_file,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/connection_init_sql_file,Protocol.MariaDBProtocol/ | +Path to connection initialization SQL | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/port,Protocol.MariaDBProtocol/ | +Listener port | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/protocol,Protocol.MariaDBProtocol/ | +Listener protocol to use | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/service,Protocol.MariaDBProtocol/ | +Service to which the listener connects to | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/socket,Protocol.MariaDBProtocol/ | +Listener UNIX socket | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/sql_mode,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/sql_mode,Protocol.MariaDBProtocol/ | +SQL parsing mode | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl,Protocol.MariaDBProtocol/ | +Enable TLS for server | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca,Protocol.MariaDBProtocol/ | +Path to the X.509 certificate authority chain file in PEM format. In MaxScale 6 and earlier, this parameter was named https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca_cert,Protocol.MariaDBProtocol/. In MaxScale 22.08, ssl_ca_cert was renamed to ssl_ca. For backward compatibility, ssl_ca_cert can be used as an alias, but MariaDB recommends using ssl_ca because ssl_ca_cert has been deprecated. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca_cert,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca_cert,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca_cert,Protocol.MariaDBProtocol/ | +Alias for https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca,Protocol.MariaDBProtocol/ | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cert,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cert,Protocol.MariaDBProtocol/ | +TLS public certificate | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cert_verify_depth,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cert_verify_depth,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cert_verify_depth,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cert_verify_depth,Protocol.MariaDBProtocol/ | +TLS certificate verification depth | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cipher,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cipher,Protocol.MariaDBProtocol/ | +TLS cipher list | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_crl,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_crl,Protocol.MariaDBProtocol/ | +TLS certificate revocation list | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_key,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_key,Protocol.MariaDBProtocol/ | +TLS private key | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_certificate,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_certificate,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_certificate,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_certificate,Protocol.MariaDBProtocol/ | +Verify TLS peer certificate | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_host,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_host,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_host,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_host,Protocol.MariaDBProtocol/ | +Verify TLS peer host | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_version,Protocol.MariaDBProtocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_version,Protocol.MariaDBProtocol/ | +Minimum TLS protocol version | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_mapping_file/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_mapping_file/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_mapping_file/ | +Path to user and group mapping file | +
The parameters for readconnroute:
+| Parameter | +Description | +
|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_all_servers,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_all_servers,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_all_servers,Router.readconnroute/ | +Retrieve users from all backend servers instead of only one | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/connection_keepalive,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/connection_keepalive,Router.readconnroute/ | +How ofted idle connections are pinged | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/connection_timeout,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/connection_timeout,Router.readconnroute/ | +Connection idle timeout | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disable_sescmd_history,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disable_sescmd_history,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disable_sescmd_history,Router.readconnroute/ | +Disable session command history | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enable_root_user,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enable_root_user,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/enable_root_user,Router.readconnroute/ | +Allow the root user to connect to this service | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/force_connection_keepalive,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/force_connection_keepalive,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/force_connection_keepalive,Router.readconnroute/ | +Ping connections unconditionally | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/idle_session_pool_time,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/idle_session_pool_time,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/idle_session_pool_time,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/idle_session_pool_time,Router.readconnroute/ | +Put connections into pool after session has been idle for this long | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/localhost_match_wildcard_host,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/localhost_match_wildcard_host,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/localhost_match_wildcard_host,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/localhost_match_wildcard_host,Router.readconnroute/ | +Match localhost to wildcard host | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_auth_warnings,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_auth_warnings,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_auth_warnings,Router.readconnroute/ | +Log a warning when client authentication fails | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_debug,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_debug,Router.readconnroute/ | +Log debug messages for this service (debug builds only) | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_info,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_info,Router.readconnroute/ | +Log info messages for this service | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_notice,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_notice,Router.readconnroute/ | +Log notice messages for this service | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_warning,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_warning,Router.readconnroute/ | +Log warning messages for this service | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_accept_reads,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_accept_reads,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/master_accept_reads,Router.readconnroute/ | +Route read operations to the Primary Server or whether it only accepts write operations | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_connections,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_connections,Router.readconnroute/ | +Maximum number of connections | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_replication_lag,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_replication_lag,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_replication_lag,Router.readconnroute/ | +Maximum acceptable replication lag | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_sescmd_history,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_sescmd_history,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_sescmd_history,Router.readconnroute/ | +Session command history size | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/multiplex_timeout,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/multiplex_timeout,Router.readconnroute/ | +How long a session can wait for a connection to become available | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/net_write_timeout,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/net_write_timeout,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/net_write_timeout,Router.readconnroute/ | +Network write timeout | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/password,Router.readconnroute/ | +Password for the user used to retrieve database users | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/prune_sescmd_history,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/prune_sescmd_history,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/prune_sescmd_history,Router.readconnroute/ | +Prune old session command history if the limit is exceeded | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/rank,Router.readconnroute/ | +Service rank | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/retain_last_statements,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/retain_last_statements,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/retain_last_statements,Router.readconnroute/ | +Number of statements kept in memory | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/router_options,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/router_options,Router.readconnroute/ | +A comma separated list of server roles | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_trace,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_trace,Router.readconnroute/ | +Enable session tracing for this service | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_track_trx_state,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_track_trx_state,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_track_trx_state,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_track_trx_state,Router.readconnroute/ | +Track session state using server responses | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/strip_db_esc,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/strip_db_esc,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/strip_db_esc,Router.readconnroute/ | +Strip escape characters from database names | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user,Router.readconnroute/ | +Username used to retrieve database users | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file,Router.readconnroute/ | +Load additional users from a file | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file_usage,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file_usage,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file_usage,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/user_accounts_file_usage,Router.readconnroute/ | +When and how the user accounts file is used | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/version_string,Router.readconnroute/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/version_string,Router.readconnroute/ | +Custom version string to use | +
The parameters for maxscale:
+| Parameter | +Description | +
|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_auth/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_auth/ | +Admin interface authentication | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_enabled/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_enabled/ | +Admin interface is enabled | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_gui/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_gui/ | +Enable admin GUI | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_host/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_host/ | +Admin interface host | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_jwt_algorithm/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_jwt_algorithm/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_jwt_algorithm/ | +JWT signature algorithm | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_jwt_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_jwt_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_jwt_key/ | +Encryption key ID for symmetric signature algorithms. If left empty, MaxScale will generate a random key that is used to sign the JWT. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_log_auth_failures/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_log_auth_failures/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_log_auth_failures/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_log_auth_failures/ | +Log admin interface authentication failures | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_oidc_url/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_oidc_url/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_oidc_url/ | +Extra public certificates used to validate externally signed JWTs | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_pam_readonly_service/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_pam_readonly_service/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_pam_readonly_service/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_pam_readonly_service/ | +PAM service for read-only users | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_pam_readwrite_service/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_pam_readwrite_service/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_pam_readwrite_service/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_pam_readwrite_service/ | +PAM service for read-write users | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_port,maxscale.maxscale/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_port,maxscale.maxscale/ | +Admin interface port | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_secure_gui/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_secure_gui/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_secure_gui/ | +Only serve GUI over HTTPS | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_ca/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_ca/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_ca/ | +Admin SSL CA cert | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_ca_cert/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_ca_cert/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_ca_cert/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_ca_cert/ | +Alias for 'admin_ssl_ca' | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_cert/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_cert/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_cert/ | +Admin SSL cert | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_key/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_key/ | +Admin SSL key | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_version/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_version/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_ssl_version/ | +Minimum required TLS protocol version for the REST API | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_verify_url/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_verify_url/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/admin_verify_url/ | +URL for third-party verification of client tokens | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_connect_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_connect_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_connect_timeout/ | +Connection timeout for fetching user accounts | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_read_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_read_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_read_timeout/ | +Read timeout for fetching user accounts (deprecated) | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_write_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_write_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auth_write_timeout/ | +Write timeout for for fetching user accounts (deprecated) | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auto_tune/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/auto_tune/ | +Specifies whether a MaxScale parameter whose value depends on a specific global server variable, should automatically be updated to match the variable's current value | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_cluster/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_cluster/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_cluster/ | +Cluster used for configuration synchronization. If left empty (i.e., value is ""), synchronization is not done. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_db/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_db/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_db/ | +Database where the 'maxscale_config' table is created | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_interval/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_interval/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_interval/ | +How often to synchronize the configuration | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_password/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_password/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_password/ | +Password for the user used for configuration synchronization | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_timeout/ | +Timeout for the configuration synchronization operations | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_user/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_user/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/config_sync_user/ | +User account used for configuration synchronization | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/debug,maxscale.maxscale/ | +Debug options | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/dump_last_statements/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/dump_last_statements/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/dump_last_statements/ | +In what circumstances should the last statements that a client sent be dumped | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/key_manager/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/key_manager/ | +Key manager type | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/load_persisted_configs/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/load_persisted_configs/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/load_persisted_configs/ | +Specifies whether persisted configuration files should be loaded on startup | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/local_address,maxscale.maxscale/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/local_address,maxscale.maxscale/ | +Local address to use when connecting | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_debug,maxscale.maxscale/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_debug,maxscale.maxscale/ | +Specifies whether debug messages should be logged (meaningful only with debug builds) | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_info,maxscale.maxscale/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_info,maxscale.maxscale/ | +Specifies whether info messages should be logged | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_notice,maxscale.maxscale/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_notice,maxscale.maxscale/ | +Specifies whether notice messages should be logged | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_throttling/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_throttling/ | +Limit the amount of identical log messages than can be logged during a certain time period | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_warn_super_user/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_warn_super_user/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_warn_super_user/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_warn_super_user/ | +Log a warning when a user with super privilege logs in | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_warning,maxscale.maxscale/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/log_warning,maxscale.maxscale/ | +Specifies whether warning messages should be logged | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_auth_errors_until_block/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_auth_errors_until_block/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_auth_errors_until_block/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_auth_errors_until_block/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_auth_errors_until_block/ | +The maximum number of authentication failures that are tolerated before a host is temporarily blocked | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_read_amount/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_read_amount/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_read_amount/ | +Maximum amount of data read before return to epoll_wait | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/maxlog/ | +Log to MaxScale's own log | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ms_timestamp/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ms_timestamp/ | +Enable or disable high precision timestamps | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/passive/ | +True if MaxScale is in passive mode | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/persist_runtime_changes/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/persist_runtime_changes/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/persist_runtime_changes/ | +Persist configurations changes done at runtime | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_classifier/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_classifier/ | +The name of the query classifier to load | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_classifier_args/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_classifier_args/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_classifier_args/ | +Arguments for the query classifier | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_classifier_cache_size/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_classifier_cache_size/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_classifier_cache_size/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_classifier_cache_size/ | +Type: size, default value is 15% of available memory | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_retries/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_retries/ | +Number of times an interrupted query is retried | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_retry_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_retry_timeout/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/query_retry_timeout/ | +The total timeout in seconds for any retried queries | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/rebalance_period/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/rebalance_period/ | +How often should the load of the worker threads be checked and rebalancing be made | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/rebalance_threshold/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/rebalance_threshold/ | +If the difference in load between the thread with the maximum load and the thread with the minimum load is larger than the value of this parameter, then work will be moved from the former to the latter | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/rebalance_window/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/rebalance_window/ | +The load of how many seconds should be taken into account when rebalancing | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/retain_last_statements,maxscale.maxscale/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/retain_last_statements,maxscale.maxscale/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/retain_last_statements,maxscale.maxscale/ | +How many statements should be retained for each session for debugging purposes | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_trace,maxscale.maxscale/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_trace,maxscale.maxscale/ | +How many log entries are stored in the session specific trace log | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_trace_match/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_trace_match/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/session_trace_match/ | +Regular expression that is matched against the contents of the session trace log and if it matches the contents are logged when the session stops | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/skip_name_resolve/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/skip_name_resolve/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/skip_name_resolve/ | +Do not resolve client IP addresses to hostnames during authentication | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/skip_permission_checks/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/skip_permission_checks/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/skip_permission_checks/ | +Skip service and monitor permission checks | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/sql_mode,maxscale.maxscale/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/sql_mode,maxscale.maxscale/ | +The query classifier sql mode | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/syslog/ | +Log to syslog | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/threads/ | +Type: count, default value is based on cpu count | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/users_refresh_interval/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/users_refresh_interval/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/users_refresh_interval/ | +How often the users will be refreshed | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/users_refresh_time/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/users_refresh_time/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/users_refresh_time/ | +How often the users can be refreshed | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/writeq_high_water/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/writeq_high_water/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/writeq_high_water/ | +High water mark of dcb write queue | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/writeq_low_water/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/writeq_low_water/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/writeq_low_water/ | +Low water mark of dcb write queue | +
The parameters for server objects:
+| Parameter | +Description | +
|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/address,servers.servers/ | +Server address | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/authenticator,servers.servers/ | +Server authenticator (deprecated) | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disk_space_threshold,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disk_space_threshold,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/disk_space_threshold,servers.servers/ | +Server disk space threshold | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/extra_port/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/extra_port/ | +Server extra port | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_routing_connections/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_routing_connections/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/max_routing_connections/ | +Maximum routing connections | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/monitorpw/ | +Monitor password | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/monitoruser/ | +Monitor user | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/persistmaxtime/ | +Maximum time that a connection can be in the pool | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/persistpoolmax/ | +Maximum size of the persistent connection pool | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/port,servers.servers/ | +Server port | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/priority/ | +Server priority | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/protocol,servers.servers/ | +Server protocol (deprecated) | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/proxy_protocol/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/proxy_protocol/ | +Enable proxy protocol | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/rank,servers.servers/ | +Server rank | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/socket,servers.servers/ | +Server UNIX socket | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl,servers.servers/ | +Enable TLS for server | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca,servers.servers/ | +Path to the X.509 certificate authority chain file in PEM format. In MaxScale 6 and earlier, this parameter was named https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca_cert,servers.servers/. In MaxScale 22.08, ssl_ca_cert was renamed to ssl_ca. For backward compatibility, ssl_ca_cert can be used as an alias, but MariaDB recommends using ssl_ca because ssl_ca_cert has been deprecated. | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca_cert,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca_cert,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca_cert,servers.servers/ | +Alias for https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_ca,servers.servers/ | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cert,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cert,servers.servers/ | +TLS public certificate | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cert_verify_depth,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cert_verify_depth,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cert_verify_depth,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cert_verify_depth,servers.servers/ | +TLS certificate verification depth | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cipher,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_cipher,servers.servers/ | +TLS cipher list | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_key,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_key,servers.servers/ | +TLS private key | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_certificate,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_certificate,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_certificate,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_certificate,servers.servers/ | +Verify TLS peer certificate | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_host,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_host,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_host,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_verify_peer_host,servers.servers/ | +Verify TLS peer host | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_version,servers.servers/https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/ssl_version,servers.servers/ | +Minimum TLS protocol version | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/module-parameters/type,servers.servers/ | +Object type | +
The following Monitors are supported by MariaDB MaxScale 22.08:
+| Monitor | +Description | +
|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/monitor/auroramon/ | +Tracks Servers in an Amazon Aurora deployment | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/monitor/csmon/ | +Tracks Servers in a MariaDB ColumnStore deployment | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/monitor/galeramon/ | +Tracks Servers in a MariaDB Enterprise Cluster deployment | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/monitor/grmon/ | +Tracks Servers in a MySQL Group Replication deployment | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/monitor/mariadbmon/ | +Tracks Servers in a MariaDB Replication deployment | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/monitor/xpandmon/ | +A Xpand cluster monitor | +
To see Monitors supported in other versions, see "Monitors by MariaDB MaxScale Version".
+MariaDB MaxScale uses protocols to specify how it communicates with a given client, server, or back-end.
+The following MaxScale Protocols are supported by MariaDB MaxScale 22.08:
+| Protocol | +Description | +
|---|---|
| CDC | +Used with connections to a CDC service | +
| MariaDBProtocol | +The client to MaxScale MySQL protocol implementation | +
| nosqlprotocol | +MaxScale NoSQL client protocol implementation | +
To see MaxScale Protocols supported in other versions, see "MaxScale Protocols by MariaDB MaxScale Version".
+The following Routers are supported by MariaDB MaxScale 22.08:
+| Router | +Type | +Description | +
|---|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/routing/avrorouter/ | +Replication | +Avro Router renders Binary Log events to JSON or Avro files and passed through the CDC Protocol to other services, like Kafka or Hadoop | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/routing/binlogrouter/ | +Replication | +Binary Log Router serves binlog events to Replica Servers | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/routing/cat/ | +Query | +Cat Router sends queries to all Servers | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/routing/hintrouter/ | +Query | +Hint Router uses routing hints to specify where to send queries | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/routing/kafkacdc/ | ++ | Replicate data changes from MariaDB to Kafka | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/routing/kafkaimporter/ | ++ | Stream Kafka messages into MariaDB | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/routing/mirror/ | ++ | Mirrors SQL statements to multiple targets | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/routing/readconnroute/ | +Query | +Read Connection Router balances the query load across the available Servers | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/routing/readwritesplit/ | +Query | +Read/Write Splitter sends write operations to the Primary Server and balances the query load of read operations between the Replica Servers | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/routing/replicator/ | ++ | + |
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/routing/schemarouter/ | +Query | +Schema Router provides simple sharding of data across multiple Servers | +
| https://mariadb.com/docs/skysql-dbaas/ref/mxs/routing/smartrouter/ | ++ | Provides routing for the Smart Query feature | +
To see Routers supported in other versions, see "Routers by MariaDB MaxScale Version".
+ + + + + + + + + + + + + +| Panel Name | +UI Tab | +Scope | +Panel Type | +Description | +
|---|---|---|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Aborted_Connections/ | +status | +server | +singlestat | +This panel shows the number of aborted connections for the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Adaptive_Avg_Select_Time,server,cluster,graph/ | +cluster | +server | +graph | +This panel shows the average time taken by the MaxScale node to perform read operations during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Adaptive_Avg_Select_Time,server,cluster,stat/ | +cluster | +server | +stat | +This panel shows the average time taken by the MaxScale node to perform read operations | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Adaptive_Avg_Select_Time,server,performance,graph/ | +performance | +server | +graph | +This panel shows the average time taken by the MaxScale node to perform read operations during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Adaptive_Avg_Select_Time,server,performance,stat/ | +performance | +server | +stat | +This panel shows the average time taken by MaxScale to perform read operations | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Average_Network_Latency,server/ | +historical | +server | +graph | +This panel shows the average network latency over the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Average_Network_Latency,service/ | +historical | +service | +graph | +This panel shows the average network latency over the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Average_Network_Latency_in_the_last_24_hours_(5_minute_intervals)/ | +system | +service | +graph | +This panel shows the average network latency in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Average_Network_Latency_over_the_last_24_hours_(5_minute_intervals)/ | +system | +server | +graph | +This panel shows the average network latency in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Buffer_Pool_Size_of_Total_RAM/ | +status | +server | +mariadb-pie-chart | +This panel shows the current size of the InnoDB buffer pool for the ES node in two units: the absolute size and the percentage of the server's usable memory | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Cluster_Component/ | +cluster | +server | +singlestat | +This panel shows the status of Enterprise Cluster on the ES node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Cluster_State_UUID_vs._Local_State_UUID/ | +cluster | +service | +table | +This panel compares the Enterprise Cluster's state UUID to each ES node's local state UUID | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Connected/ | +cluster | +server | +singlestat | +This panel shows whether the ES node is connected to other ES nodes in the cluster over the network | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Connection_Pool_Empty,server,cluster,graph/ | +cluster | +server | +graph | +This panel shows the number of times that the MaxScale node's connection pool has been empty when a connection has been requested during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Connection_Pool_Empty,server,cluster,stat/ | +cluster | +server | +stat | +This panel shows the number of times that the MaxScale node's connection pool has been empty when a connection has been requested | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Connection_Pool_Empty,server,performance/ | +performance | +server | +graph | +This panel shows the number of times that the MaxScale node's connection pool has been empty when a connection has been requested during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Connection_Pool_Empty,server,status,graph/ | +status | +server | +graph | +This panel shows the number of times that the MaxScale node's connection pool has been empty when a connection has been requested during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Connection_Pool_Empty,server,status,stat/ | +status | +server | +stat | +This panel shows the number of times that the MaxScale node's connection pool has been empty when a connection has been requested | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Connections,server,cluster/ | +cluster | +server | +singlestat | +This panel shows the number of clients connected to the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Connections,server,cluster,stat/ | +cluster | +server | +stat | +This panel shows the number of clients connected to the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Connections,server,status/ | +status | +server | +stat | +This panel shows the number of clients connected to the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Connections,service/ | +status | +service | +table | +This panel shows the number of used and aborted connections for each ES node along with the max_connections value | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Connections_slash_minute/ | +historical | +service | +graph | +This panel shows the total number of connection attempts (successful and unsuccessful) to the service during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Connections_slash_minute_in_the_last_24_hours/ | +connections | +service | +graph | +This panel shows the total number of connection attempts (successful and unsuccessful) to the service over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Container_Memory_Distribution/ | +historical | +server | +graph | +This panel shows details about an Xpand node's RAM usage during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Container_Memory_Distribution_in_the_last_24_hours_(5_minute_intervals)/ | +system | +server | +graph | +This panel shows details about an Xpand node's RAM usage in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Container_Memory_Hourly/ | +system | +service | +graph | +This panel shows details about each Xpand node's RAM usage in 1 hour intervals | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Container_Memory_Usage/ | +historical | +service | +graph | +This panel shows details about each Xpand node's RAM usage during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Container_Memory_Usage_in_the_last_24_hours_(5_minute_intervals)/ | +system | +service | +graph | +This panel shows details about each Xpand node's RAM usage in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Container_Row_Operations/ | +historical | +server | +graph | +This panel shows the number of row operations executed by the Xpand node for each type of operation during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Core_0_Utilization/ | +historical | +server | +graph | +This panel shows the CPU usage of core 0 for the Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/CPU,server,historical/ | +historical | +server | +graph | +This panel shows the CPU usage for the Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/CPU,server,status,gauge/ | +status | +server | +gauge | +This panel shows the current CPU usage for the ES or Xpand node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/CPU,server,status,graph/ | +status | +server | +graph | +This panel shows the CPU usage for the ES or Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/CPU,service/ | +system | +service | +graph | +This panel shows the CPU usage for each Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/CPU_Load,service,status/ | +status | +service | +graph | +This panel shows the CPU usage for each ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/CPU_Load,service,system/ | +system | +service | +graph | +This panel shows the CPU usage for each ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/CPU_Usage/ | +historical | +service | +graph | +This panel shows the CPU usage for each Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/CPU_Usage_slash_Load/ | +system | +server | +graph | +This panel shows the CPU usage for the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/CPU_Usage_in_the_last_24_hours_(5_minute_intervals)/ | +system | +server | +graph | +This panel shows the CPU usage for the Xpand node in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/CPU_Usage_over_the_last_24_hours_(5_minute_intervals)/ | +system | +service | +graph | +This panel shows the CPU usage for each Xpand node in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Current_Average_Cluster_Latency_-_Read/ | +queries | +service | +singlestat | +This panel shows the average amount of time the cluster spent executing read queries before returning a result set during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Current_Average_Cluster_Latency_-_Write/ | +queries | +service | +singlestat | +This panel shows the average amount of time the cluster spent executing write queries before returning a result set during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Current_CPU_Usage/ | +system | +server | +gauge | +This panel shows the current CPU usage for the Xpand node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Current_Execution_Times/ | +queries | +service | +mariadb-pie-chart | +This panel shows the time required to execute queries during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Current_Memory_Usage/ | +system | +server | +bargauge | +This panel shows the percentage of working memory currently used by the Xpand node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Current_QPS/ | +status | +server | +singlestat | +This panel shows the number of queries per second (QPS) processed by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Current_Rebalancer_Actions/ | +status | +service | +table | +This panel shows the number of times the Xpand Rebalancer executed certain tasks during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Current_SQL_Commands,server/ | +status | +server | +mariadb-pie-chart | +This panel shows the ratio between the types of SQL statements executed by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Current_SQL_Commands,service/ | +status | +service | +mariadb-pie-chart | +This panel shows the ratio between the types of SQL statements executed by the service during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Current_Storage/ | +system | +server | +bargauge | +This panel shows the percentage of storage space that is currently used by the Xpand node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Database_Server_Connections/ | +cluster | +server | +graph | +This panel shows the number of database server connections open between the MaxScale node and each ES or Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Disk_size,server/ | +status | +server | +table | +This panel shows the amount of storage space currently used by the ES or Xpand node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Disk_size,service/ | +system | +service | +table | +This panel shows the amount of storage space currently used by the ES or Xpand node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Disk_Size_by_Partition,service,status/ | +status | +service | +table | +This panel shows the amount of storage space used (as the usage percentage, actual size, and total size) by each ES node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Disk_Size_by_Partition,server/ | +system | +server | +graph | +This panel shows the amount of storage space used by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Disk_Size_by_Partition,service,system/ | +system | +service | +graph | +This panel shows the amount of storage space used by all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Disk_space_usage/ | +historical | +service | +graph | +This panel shows the percentage of storage space used by each Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Disk_space_usage_in_the_last_24_hours_(5_minute_intervals)/ | +system | +service | +graph | +This panel shows the amount of storage space used by each Xpand node in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Errors,server,cluster/ | +cluster | +server | +graph | +This panel shows the number of errors encountered by threads on the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Errors,server,performance/ | +performance | +server | +graph | +This panel shows the number of errors encountered by threads on the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Event_Queue_Length,server,cluster/ | +cluster | +server | +graph | +This panel shows the total event queue length for all threads on the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Event_Queue_Length,server,performance/ | +performance | +server | +graph | +This panel shows the total event queue length for all threads on the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Exec_Primary_Log_Position/ | +replicas | +service | +graph | +This panel shows the current binary log position of the replica SQL thread for each ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Flow_Control_Commits,server/ | +cluster | +server | +graph | +This panel shows the sequence number of the latest writeset applied by Enterprise Cluster on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Flow_Control_Commits,service/ | +cluster | +service | +graph | +This panel shows the sequence number of the latest writeset applied by Enterprise Cluster on all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Flow_Control_Pauses,server/ | +cluster | +server | +graph | +This panel shows the fraction of time that Enterprise Cluster was paused on the ES node due to flow control during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Flow_Control_Pauses,service/ | +cluster | +service | +graph | +This panel shows the fraction of time that Enterprise Cluster was paused on all ES nodes due to flow control during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/GTID_Replication_Position,service,lags/ | +lags | +service | +graph | +This panel shows the Global Transaction ID (GTID) for each ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/GTID_Replication_Position,service,replicas/ | +replicas | +service | +graph | +This panel shows the Global Transaction ID (GTID) for each ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/I_slash_O_Activity,server,status/ | +status | +server | +graph | +This panel shows the total number of bytes written to or read from the ES node's file system during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/I_slash_O_Activity,server,system/ | +system | +server | +graph | +This panel shows the total number of bytes written to or read from the ES node's file system during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/I_slash_O_Activity_-_Page_In/ | +system | +service | +graph | +This panel shows the total number of bytes read from the ES node's file system during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/I_slash_O_Activity_-_Page_Out/ | +system | +service | +graph | +This panel shows the total number of bytes written to the ES node's file system during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/I_slash_O_Latency,server/ | +historical | +server | +graph | +This panel shows the latency for I/O operations performed by the Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/I_slash_O_Latency,service/ | +historical | +service | +graph | +This panel shows the latency for I/O operations performed by all Xpand nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/I_slash_O_Latency_in_the_last_24_hours_(5_minute_intervals)/ | +system | +service | +graph | +This panel shows the latency for I/O operations performed by all Xpand nodes in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/I_slash_O_Latency_over_the_last_24_hours_(5_minute_intervals)/ | +system | +server | +graph | +This panel shows the latency for I/O operations performed by the Xpand node in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/InnoDB_Data_slash_sec,server,status/ | +status | +server | +graph | +This panel shows the number of bytes per second read and written by InnoDB during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/InnoDB_Data_slash_sec,server,system/ | +system | +server | +graph | +This panel shows the number of bytes per second read and written by InnoDB during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Integrity_of_clusters_(Split_Brain)/ | +cluster | +service | +table | +This panel shows Enterprise Cluster metadata that can help determine the integrity of the cluster | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/IOPS/ | +system | +server | +graph | +This panel shows the number of input/output operations per second performed by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/IOPS_-_Page_In/ | +system | +service | +graph | +This panel shows the total number of reads performed from the ES node's file system during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/IOPS_-_Page_Out/ | +system | +service | +graph | +This panel shows the total number of writes performed from the ES node's file system during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Local_Received_Queue,server/ | +cluster | +server | +graph | +This panel shows details about the size of the Enterprise Cluster receive queue on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Local_Received_Queue,service/ | +cluster | +service | +graph | +This panel shows details about the size of the Enterprise Cluster receive queue on all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Local_Send_Queue,server/ | +cluster | +server | +graph | +This panel shows details about the size of the Enterprise Cluster send queue on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Local_Send_Queue,service/ | +cluster | +service | +graph | +This panel shows details about the size of the Enterprise Cluster send queue on all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Aborted_Connections,server/ | +database | +server | +graph | +This panel shows the number of connections aborted by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Aborted_Connections,service/ | +database | +service | +graph | +This panel shows the number of connections aborted by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Client_Thread_Activity,server/ | +database | +server | +graph | +This panel shows the number of client threads connected and running on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Client_Thread_Activity,service/ | +queries | +service | +graph | +This panel shows the number of client threads running on all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Connections/ | +database | +server | +graph | +This panel shows the number of client connections to the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Handlers_slash_sec/ | +queries | +server | +graph | +This panel shows how many internal query handlers per second have been created by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Memory_Overview/ | +system | +server | +graph | +This panel shows how much memory the ES node used for the InnoDB buffer pool, InnoDB log buffer, MyISAM key buffer, and query cache during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Network_Traffic,server/ | +system | +server | +graph | +This panel shows the amount of data sent and received over the network by the database server on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Network_Traffic,service/ | +system | +service | +graph | +This panel shows the amount of data sent and received over the network by the database servers on all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Network_Usage_Hourly,server/ | +system | +server | +graph | +This panel shows the amount of data sent and received over the network per hour by the database server on the ES node over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Network_Usage_Hourly,service/ | +system | +service | +graph | +This panel shows the amount of data sent and received over the network per hour by the database servers on all ES nodes over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Open_Files/ | +database | +server | +graph | +This panel shows the number of files opened by the database server on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Open_Tables,server/ | +database | +server | +graph | +This panel shows the number of tables opened by the database server on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Open_Tables,service/ | +database | +service | +graph | +This panel shows the number of tables opened by the database servers on all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Opened_Files_slash_sec/ | +database | +server | +graph | +This panel shows the number of files opened per second by the database server on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_QPS/ | +queries | +service | +graph | +This panel shows the number of queries per second (QPS) executed by all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_QPS_and_Questions/ | +queries | +server | +graph | +This panel shows the number of queries and questions per second executed by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Questions_slash_sec/ | +queries | +service | +graph | +This panel shows the number of questions per second executed by all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Select_Types/ | +queries | +server | +graph | +This panel shows the number of times the ES node has used certain execution strategies to execute SELECT statements during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Service_Connections/ | +database | +service | +graph | +This panel shows the number of clients connected to the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Slow_Queries,server/ | +queries | +server | +graph | +This panel shows the number of slow queries executed by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Slow_Queries,service,queries/ | +queries | +service | +graph | +This panel shows the number of slow queries executed by all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Slow_Queries,service,status/ | +status | +service | +graph | +This panel shows the number of slow queries executed by all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Sorts/ | +queries | +server | +graph | +This panel shows the number of times the ES node has used certain algorithms to sort data during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Table_Definition_Cache/ | +caches | +server | +graph | +This panel shows how many table definitions were cached by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Table_Locks,server/ | +database | +server | +graph | +This panel shows the number of table locks requested by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Table_Locks,service/ | +database | +service | +graph | +This panel shows the number of table locks requested by all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Table_Open_Cache_Status/ | +caches | +server | +graph | +This panel shows the activity of the table open cache on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Table_Opened/ | +database | +service | +graph | +This panel shows the number of tables that have been opened by all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Thread_Cache/ | +caches | +server | +graph | +This panel shows the number of threads created and cached for re-use on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MariaDB_Transaction_Handlers_slash_sec/ | +queries | +server | +graph | +This panel shows the number of transaction-related handlers created by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Max_Connections,server,cluster,graph/ | +cluster | +server | +graph | +This panel shows the highest number of clients that were concurrently connected to the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Max_Connections,server,cluster,stat/ | +cluster | +server | +stat | +This panel shows the highest number of clients that have ever been concurrently connected to the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Max_Connections,server,status,graph/ | +status | +server | +graph | +This panel shows the highest number of clients that were concurrently connected to the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Max_Connections,server,status,stat/ | +status | +server | +stat | +This panel shows the highest number of clients that have ever been concurrently connected to the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Max_Pool_Size,server,cluster,graph/ | +cluster | +server | +graph | +This panel shows the highest number of connections that were in the MaxScale node's connection pool during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Max_Pool_Size,server,cluster,stat/ | +cluster | +server | +stat | +This panel shows the highest number of connections that have ever been in the MaxScale node's connection pool | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Max_Pool_Size,server,performance/ | +performance | +server | +graph | +This panel shows the highest number of connections that were in the MaxScale node's connection pool during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Max_Pool_Size,server,status/ | +status | +server | +stat | +This panel shows the highest number of connections that have ever been in the MaxScale node's connection pool | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Max_Time_in_Queue,server,cluster/ | +cluster | +server | +graph | +This panel shows the longest time the MaxScale node waited for an I/O event during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Max_Time_in_Queue,server,status/ | +status | +server | +graph | +This panel shows the longest time the MaxScale node waited for an I/O event during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MaxScale_Connections/ | +cluster | +server | +graph | +This panel shows the number of clients connected to the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MaxScale_Descriptors,server,cluster/ | +cluster | +server | +graph | +This panel shows the number of descriptors used by the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MaxScale_Descriptors,server,performance/ | +performance | +server | +graph | +This panel shows the number of descriptors used by the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MaxScale_Hangups,server,cluster/ | +cluster | +server | +graph | +This panel shows the number of client connections closed by the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MaxScale_Hangups,server,performance/ | +performance | +server | +graph | +This panel shows the number of client connections closed by the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MaxScale_Modules/ | +modules | +server | +table | +This panel lists the modules installed on the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MaxScale_Server_Connections/ | +database | +service | +graph | +This panel shows the number of client connections open between the MaxScale node and each ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/MaxScale_Service_Connections/ | +database | +service | +graph | +This panel shows the number of clients connected to all MaxScale nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Memory,server,cluster/ | +cluster | +server | +graph | +This panel shows memory usage details for the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Memory,server,performance/ | +performance | +server | +graph | +This panel shows memory usage details for the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Memory_Distribution/ | +system | +server | +graph | +This panel shows memory usage details for the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Memory_Usage/ | +system | +service | +graph | +This panel shows memory usage details for all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Memory_Utilization,server/ | +historical | +server | +graph | +This panel shows memory usage details for the Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Memory_Utilization,service/ | +historical | +service | +graph | +This panel shows memory usage details for all Xpand nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Memory_Utilization_in_the_last_24_hours_(5_minute_intervals),server/ | +system | +server | +graph | +This panel shows memory usage details for the Xpand node in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Memory_Utilization_in_the_last_24_hours_(5_minute_intervals),service/ | +system | +service | +graph | +This panel shows memory usage details for all Xpand nodes in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Network_Data/ | +historical | +server | +graph | +This panel shows the amount of data sent and received over the network by the database server on the Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Network_Errors,server/ | +system | +server | +graph | +This panel shows the number of network errors encountered by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Network_Errors,service/ | +system | +service | +graph | +This panel shows the number of network errors encountered by all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Network_Packets_Dropped,server/ | +system | +server | +graph | +This panel shows the number of network packets dropped by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Network_Packets_Dropped,service/ | +system | +service | +graph | +This panel shows the number of network packets dropped by all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Network_Traffic,server,status/ | +status | +server | +graph | +This panel shows the amount of data sent and received over the network by the operating system on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Network_Traffic,server,system/ | +system | +server | +graph | +This panel shows the amount of data sent and received over the network by the operating system on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Network_Traffic_-_Inbound/ | +system | +service | +graph | +This panel shows the amount of data received over the network by the operating systems on all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Network_Traffic_-_Outbound/ | +system | +service | +graph | +This panel shows the amount of data sent over the network by the operating systems on all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Node_Queues/ | +cluster | +service | +table | +This panel shows details about the size of the Enterprise Cluster send and receive queues on all ES nodes | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Node_Status/ | +cluster | +service | +table | +This panel shows details about the size of the Enterprise Cluster send and receive queues on all ES nodes | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Nodes_in_Cluster/ | +status | +service | +stat | +This panel shows the number of Xpand nodes that are currently in the cluster | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Nodes_in_quorum/ | +status | +service | +stat | +This panel shows the number of Xpand nodes that are currently in quorum | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Persistent_Connections,server,cluster,graph/ | +cluster | +server | +graph | +This panel shows the number of connections in the MaxScale node's connection pool during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Persistent_Connections,server,cluster,stat/ | +cluster | +server | +stat | +This panel shows the number of connections currently in the MaxScale node's connection pool | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Persistent_Connections,server,status,graph/ | +status | +server | +graph | +This panel shows the number of connections in the MaxScale node's connection pool during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Persistent_Connections,server,status,stat/ | +status | +server | +stat | +This panel shows the number of connections currently in the MaxScale node's connection pool | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/QPS,service,historical/ | +historical | +service | +graph | +This panel shows the queries per second (QPS) executed by all Xpand nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/QPS,service,queries/ | +queries | +service | +singlestat | +This panel shows the queries per second (QPS) executed by all Xpand nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/QPS,service,status/ | +status | +service | +graph | +This panel shows the queries per second (QPS) executed by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/QPS_(at_5_minute_intervals)/ | +queries | +service | +graph | +This panel shows the average queries per second (QPS) executed by all Xpand nodes in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/QPS_Hourly/ | +queries | +service | +graph | +This panel shows the average queries per second (QPS) executed by all Xpand nodes in 1 hour intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Queries_per_second_by_Query_Type/ | +historical | +service | +graph | +This panel shows the queries per second (QPS) of certain query types executed by all Xpand nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Query_Latency/ | +historical | +service | +graph | +This panel shows the average amount of time all Xpand nodes spent executing queries before returning a result set during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Query_Latency_over_the_last_24_hours_(5_minute_intervals)/ | +queries | +service | +graph | +This panel shows the average amount of time all Xpand nodes spent executing queries before returning a result set in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Queue_Received/ | +lags | +service | +graph | +This panel shows details about the size of the Enterprise Cluster receive queue on all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Queue_Send/ | +lags | +service | +graph | +This panel shows details about the size of the Enterprise Cluster send queue on all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/RAM,server,status/ | +status | +server | +gauge | +This panel shows the current memory usage details for the ES or Xpand node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/RAM,server,status,graph/ | +status | +server | +graph | +This panel shows memory usage details for the ES or Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/RAM,service/ | +system | +service | +graph | +This panel shows memory usage details for all Xpand nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Read_Primary_Log_Position/ | +replicas | +service | +graph | +This panel shows the current binary log position of the replica I/O thread for each ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Ready/ | +cluster | +server | +singlestat | +This panel shows whether Enterprise Cluster is ready for queries on the ES node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Rebalancer_-_Underprotected_Slices/ | +status | +service | +stat | +This panel shows the number of slices in the cluster that are currently unprotected | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Rebalancer_Activity/ | +historical | +service | +graph | +This panel shows the number of times the Xpand Rebalancer executed certain tasks during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Rebalancer_Activity_in_the_last_24_hours/ | +status | +service | +graph | +This panel shows the number of times the Xpand Rebalancer executed certain tasks over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Rebalancer_Jobs/ | +status | +service | +stat | +This panel shows the number of tasks currently scheduled in the Xpand Rebalancer's priority queue | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Replicas_lags/ | +status | +service | +table | +This panel shows average values for certain replication-related metadata to help determine if the replica ES nodes are currently lagging behind the primary ES node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Replicas_status/ | +status | +service | +table | +This panel shows summarized values for certain replication-related metadata to help determine if any replica ES nodes encountered replication issues during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Replicated_Writeset_Bytes,server/ | +cluster | +server | +graph | +This panel shows how many bytes the ES node replicated to other ES nodes in the cluster in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Replicated_Writeset_Bytes,service/ | +cluster | +service | +graph | +This panel shows how many bytes all ES nodes replicated to other ES nodes in the cluster in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Replicated_Writesets,server/ | +cluster | +server | +graph | +This panel shows how many writesets the ES node replicated to other ES nodes in the cluster in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Replicated_Writesets,service/ | +cluster | +service | +graph | +This panel shows how many writesets all ES nodes replicated to other ES nodes in the cluster in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Replication_Latency/ | +cluster | +server | +graph | +This panel shows details about latency from Enterprise Cluster replication on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Resident,server,cluster/ | +cluster | +server | +gauge | +This panel shows the current resident set size (RSS) of the MaxScale process | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Resident,server,status/ | +status | +server | +gauge | +This panel shows the current resident set size (RSS) of the MaxScale process | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Reused_Connections,server,cluster,graph/ | +cluster | +server | +graph | +This panel shows the number of times a connection was successfully reused from the MaxScale node's connection pool during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Reused_Connections,server,cluster,stat/ | +cluster | +server | +stat | +This panel shows the number of times a connection was successfully reused from the MaxScale node's connection pool | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Reused_Connections,server,status,graph/ | +status | +server | +graph | +This panel shows the number of times a connection was successfully reused from the MaxScale node's connection pool during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Reused_Connections,server,status,stat/ | +status | +server | +stat | +This panel shows the number of times a connection was successfully reused from the MaxScale node's connection pool | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/RO_Service_Connections/ | +status | +server | +singlestat | +This panel shows the number of clients currently connected to the MaxScale node's read-only listener | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Routed_Packets,server,cluster/ | +cluster | +server | +graph | +This panel shows the number of MariaDB protocol packets routed by the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Routed_Packets,server,performance/ | +performance | +server | +graph | +This panel shows the number of MariaDB protocol packets routed by the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Rows_slash_sec/ | +status | +server | +graph | +This panel shows the total number of rows written and read per second by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/RW_Service_Connections/ | +status | +server | +singlestat | +This panel shows the number of clients currently connected to the MaxScale node's read-write listener | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/RW_slash_sec,server,cluster/ | +cluster | +server | +graph | +This panel shows the number of read and write operations per second that were handled by the threads on the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/RW_slash_sec,server,status/ | +status | +server | +graph | +This panel shows the number of read and write operations per second that were handled by the threads on the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Seconds_Behind_Primary/ | +replicas | +service | +graph | +This panel shows the average number of seconds that the replica ES nodes lagged behind the primary ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Sequentially_in_Parallel,server/ | +cluster | +server | +graph | +This panel shows the average distance between the highest and lowest sequence numbers for writesets applied in parallel by Enterprise Cluster on the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Sequentially_in_Parallel,service/ | +cluster | +service | +graph | +This panel shows the average distance between the highest and lowest sequence numbers for writesets applied in parallel by Enterprise Cluster on all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Server_Connections/ | +status | +server | +graph | +This panel shows the number of client connections open between the MaxScale node and each ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Server_Routed_Packets,server,cluster/ | +cluster | +server | +graph | +This panel shows the number of MariaDB protocol packets routed by the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Server_Routed_Packets,server,performance/ | +performance | +server | +graph | +This panel shows the number of MariaDB protocol packets routed by the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Server_Routed_Packets,server,status/ | +status | +server | +bargauge | +This panel shows the number of MariaDB protocol packets routed by the MaxScale node over the past 5 minutes | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Service_Connections/ | +status | +server | +graph | +This panel shows the number of clients connected to the MaxScale node's listeners during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Session_time_in_state/ | +historical | +service | +graph | +This panel shows the total length of time for all Xpand nodes that client connections were in each connection state during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Session_time_in_state_in_the_last_24_hours_(5_minute_intervals)/ | +connections | +service | +graph | +This panel shows the total length of time for all Xpand nodes that client connections were in each connection state in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Session_transaction_age/ | +historical | +service | +graph | +This panel shows the session transaction age for all Xpand nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Session_transaction_age_in_the_last_24_hours_(5_minute_intervals)/ | +connections | +service | +graph | +This panel shows the session transaction age for all Xpand nodes in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Sessions/ | +historical | +service | +graph | +This panel shows how many client connections on all Xpand nodes were in each connection state during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Sessions_in_the_last_24_hours_(5_minute_intervals)/ | +connections | +service | +graph | +This panel shows how many client connections on all Xpand nodes were in each connection state in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Stack_size,server,cluster/ | +cluster | +server | +gauge | +This panel shows the current stack size of the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Stack_size,server,status/ | +status | +server | +gauge | +This panel shows the current stack size of the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Status/ | +cluster | +server | +singlestat | +This panel shows the current local state of the ES node according to Enterprise Cluster | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Storage/ | +historical | +server | +graph | +This panel shows the total amount of storage space used by each Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Storage_allocation/ | +historical | +service | +graph | +This panel shows the amount of storage space allocated to each Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Storage_allocation_in_the_last_24_hours_(5_minute_intervals)/ | +system | +service | +graph | +This panel shows the amount of storage space allocated to each Xpand node in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Storage_in_the_last_24_hours_(5_minute_intervals)/ | +system | +server | +graph | +This panel shows the total amount of storage space used by each Xpand node in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Temporary_Objects_Created/ | +database | +server | +graph | +This panel shows the number of temporary tables created by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Threads/ | +cluster | +server | +singlestat | +This panel shows the number of threads currently used by the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Threads_Count/ | +status | +server | +singlestat | +This panel shows the number of threads currently used by the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/TIL_Core_Utilization/ | +historical | +server | +graph | +This panel shows the CPU usage of each CPU core (excluding core-0) for the Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Top_Command_Counters,service,historical/ | +historical | +service | +graph | +This panel shows how often certain statement types were executed by the Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Top_Command_Counters,server/ | +queries | +server | +graph | +This panel shows the top 30 statement types that were most frequently executed by the ES node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Top_Command_Counters,service,queries/ | +queries | +service | +graph | +This panel shows the top 30 statement types that were most frequently executed by all ES nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Top_Command_Counters_Hourly,server/ | +queries | +server | +graph | +This panel shows the top 30 statement types that were most frequently executed by the ES node in 1 hour intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Top_Command_Counters_Hourly,service/ | +queries | +service | +graph | +This panel shows the top 30 statement types that were most frequently executed by all ES and Xpand nodes in 1 hour intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Top_Command_Counters_in_the_last_24_hours_(5_minute_intervals)/ | +queries | +service | +graph | +This panel shows how often certain statement types were executed by all Xpand nodes in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Total_Active_Operations,server,cluster,graph/ | +cluster | +server | +graph | +This panel shows the total number of queries that were actively being executed by the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Total_Active_Operations,server,cluster,stat/ | +cluster | +server | +stat | +This panel shows the total number of queries that are actively being executed by the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Total_Active_Operations,server,status,graph/ | +status | +server | +graph | +This panel shows the total number of queries that were actively being executed by the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Total_Active_Operations,server,status,stat/ | +status | +server | +stat | +This panel shows the total number of queries that are actively being executed by the MaxScale node | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Total_Connections,server,cluster,graph/ | +cluster | +server | +graph | +This panel shows the total number of connections created by the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Total_Connections,server,cluster,stat/ | +cluster | +server | +stat | +This panel shows the total number of connections created by the MaxScale node since the MaxScale node was started | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Total_Connections,server,status,graph/ | +status | +server | +graph | +This panel shows the total number of connections created by the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Total_Connections,server,status,stat/ | +status | +server | +stat | +This panel shows the total number of connections created by the MaxScale node since the MaxScale node was started | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/TPS,service,historical/ | +historical | +service | +graph | +This panel shows the average transactions per second (TPS) executed by all Xpand nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/TPS,service,queries/ | +queries | +service | +singlestat | +This panel shows the average transactions per second (TPS) executed by all Xpand nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/TPS_(at_5_minute_intervals)/ | +queries | +service | +graph | +This panel shows the average transactions per second (TPS) executed by all Xpand nodes in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/TPS_Hourly/ | +queries | +service | +graph | +This panel shows the average transactions per second (TPS) executed by all Xpand nodes in 1 hour intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Uptime/ | +status | +service | +singlestat | +This panel shows how long all Xpand nodes have been online | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Used_Connections/ | +status | +server | +mariadb-pie-chart | +This panel shows the current number of client connections as a percentage of the ES node's max_connections value | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Utilization,server,cluster/ | +cluster | +server | +bargauge | +This panel shows details about the CPU and memory usage for the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Utilization,server,status/ | +status | +server | +bargauge | +This panel shows details about the CPU and memory usage for the MaxScale node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/WAL_sync_time/ | +historical | +service | +graph | +This panel shows the average time the Xpand nodes required to sync changes to the Write Ahead Log (WAL) during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/WAL_sync_time_in_the_last_24_hours_(5_minute_intervals)/ | +status | +service | +graph | +This panel shows the average time the Xpand nodes required to sync changes to the Write Ahead Log (WAL) in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Xpand_Memory_Distribution/ | +historical | +server | +graph | +This panel shows details about memory usage for the Xpand node during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Xpand_Memory_Distribution_in_the_last_24_hours_(5_minute_intervals)/ | +system | +server | +graph | +This panel shows details about memory usage for the Xpand node in 5 minute intervals over the past 24 hours | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Xpand_Total_Memory/ | +historical | +service | +graph | +This panel shows the total memory usage for all Xpand nodes during the selected time interval | +
| https://mariadb.com/docs/skysql-dbaas/ref/skymon/panels/Xpand_Total_Memory_in_the_last_24_hours_(5_minute_intervals)/ | +system | +service | +graph | +This panel shows the total memory usage for all Xpand nodes in 5 minute intervals over the past 24 hours | +
The easiest way to get started with the API is to use this swagger Docs. Just generate your API key , Click ‘Authorize’ and enter ‘
You can use the REST API to Provision, get pricing and billing information, fetch/change service or MariaDB configuration, Manage users and their roles, schedule backups or restores, scale, stop and Delete services.
+Please refer to the API docs for examples and a complete list of all the APIs.
+The Backup Service API is available here
+ + + + + + + + + + + + + +| Region | +Location | +
|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-ap-northeast-1/ | +Tokyo, Japan | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-ap-northeast-2/ | +Seoul, South Korea | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-ap-southeast-1/ | +Jurong West, Singapore | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-ap-southeast-2/ | +Sydney, Australia | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-ca-central-1/ | +Montréal, Québec, Canada | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-eu-central-1/ | +Frankfurt, Germany | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-eu-north-1/ | +Stockholm, Sweden | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-eu-west-1/ | +Dublin, Ireland | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-eu-west-2/ | +London, England, UK | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-eu-west-3/ | +Paris, France | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-us-east-1/ | +Northern Virginia, USA | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-us-east-2/ | +Ohio, USA | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/aws-us-west-2/ | +Oregon, USA | +
Please contact us if any aspect of service does not align to your intended use case.
+| Region | +Location | +
|---|---|
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-asia-northeast1/ | +Tokyo, Japan | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-asia-south1/ | +Mumbai, India | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-asia-southeast1/ | +Jurong West, Singapore | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-asia-southeast2/ | +Jakarta, Indonesia | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-australia-southeast1/ | +Sydney, Australia | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-europe-north1/ | +Hamina, Finland | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-europe-west1/ | +St. Ghislain, Belgium | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-europe-west2/ | +London, England, UK | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-europe-west3/ | +Frankfurt, Germany | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-europe-west4/ | +Eemshaven, Netherlands | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-europe-west9/ | +Paris, France | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-northamerica-northeast1/ | +Montréal, Québec, Canada | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-us-central1/ | +Council Bluffs, Iowa, USA | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-us-east1/ | +Moncks Corner, South Carolina, USA | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-us-east4/ | +Ashburn (Loudoun County), Virginia, USA | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-us-west1/ | +The Dalles, Oregon, USA | +
| https://mariadb.com/docs/skysql-dbaas/ref/regions/gcp-us-west4/ | +Las Vegas, Nevada, USA | +
Please contact us if any aspect of service does not align to your intended use case.
+ + + + + + + + + + + + + +Executes the CHANGE MASTER TO statement to configures inbound replication from an external primary server based on binary log file and position.
+CALL sky.change_external_primary(
+ host VARCHAR(255),
+ port INT,
+ logfile TEXT,
+ logpos LONG ,
+ use_ssl_encryption BOOLEAN
+);
++------------------------------+
+| Run_this_grant_on_your_external_primary |
++------------------------------+
+| GRANT REPLICATION SLAVE ON *.* TO 'skysql_replication'@'%' IDENTIFIED BY '<password_hash>'; |
++------------------------------+
+Sets the connection retry interval for the external replication master.
+CALL change_connect_retry(connect_retry INT);
+If the value is NULL, a default retry interval of 60 seconds will be used.
+Executes the CHANGE MASTER TO statement to configures inbound replication from an external primary server based on the provided GTID.
+CALL sky.change_external_primary_gtid(
+ host VARCHAR(255),
+ port INT,
+ gtid VARCHAR(60),
+ use_ssl_encryption BOOLEAN
+);
++------------------------------+
+| Run_this_grant_on_your_external_primary |
++------------------------------+
+| GRANT REPLICATION SLAVE ON *.* TO 'skysql_replication'@'%' IDENTIFIED BY '<password_hash>'; |
++------------------------------+
+Sets the heartbeat period for the external replication master.
+CALL change_heartbeat_period(heartbeat_period DECIMAL(10,3));
+If the value is NULL, a default heartbeat period of 5 seconds will be used.
+Sets the replication delay for the external replication master.
+CALL change_replica_delay(replica_delay INT);
+If the value is NULL, a default delay of 1 second will be used.
+Toggles the SSL encryption setting for the external replication master.
+CALL change_use_ssl_encryption(use_ssl_encryption BOOLEAN);
+If the value is NULL, SSL encryption will be enabled by default.
+Provides a list of GTID-related system variables.
+CALL sky.gtid_status();
++-------------------+---------------------------+
+| Variable_name | Value |
++-------------------+---------------------------+
+| gtid_binlog_pos | 435700-435700-122 |
+| gtid_binlog_state | 435700-435700-122 |
+| gtid_current_pos | 0-100-1,435700-435700-122 |
+| gtid_slave_pos | 0-100-1 |
++-------------------+---------------------------+
+Kills any non-root or non-SkySQL threads, similar to the KILL statement.
+CALL sky.kill_session(IN thread BIGINT);
+Provides a GRANT statement to run on an external primary server when configuring inbound replication.
+CALL sky.replication_grants();
++------------------------------+
+| Run_this_grant_on_your_external_primary |
++------------------------------+
+| GRANT REPLICATION SLAVE ON *.* TO 'skysql_replication'@'%' IDENTIFIED BY '<password_hash>'; |
++------------------------------+
+Executes the SHOW REPLICA STATUS statement to obtain the status of inbound replication.
+CALL sky.replication_status()\G
+*************************** 1. row ***************************
+ Slave_IO_State: Waiting for master to send event
+ Master_Host: mariadb1.example.com
+ Master_User: skysql_replication
+ Master_Port: 3306
+ Connect_Retry: 60
+ Master_Log_File: mariadb-bin.000001
+ Read_Master_Log_Pos: 558
+ Relay_Log_File: mariadb-relay-bin.000002
+ Relay_Log_Pos: 674
+ Relay_Master_Log_File: mariadb-bin.000001
+ Slave_IO_Running: Yes
+ Slave_SQL_Running: Yes
+ Replicate_Do_DB:
+ Replicate_Ignore_DB:
+ Replicate_Do_Table:
+ Replicate_Ignore_Table:
+ Replicate_Wild_Do_Table:
+ Replicate_Wild_Ignore_Table:
+ Last_Errno: 0
+ Last_Error:
+ Skip_Counter: 0
+ Exec_Master_Log_Pos: 558
+ Relay_Log_Space: 985
+ Until_Condition: None
+ Until_Log_File:
+ Until_Log_Pos: 0
+ Master_SSL_Allowed: No
+ Master_SSL_CA_File:
+ Master_SSL_CA_Path:
+ Master_SSL_Cert:
+ Master_SSL_Cipher:
+ Master_SSL_Key:
+ Seconds_Behind_Master: 0
+ Master_SSL_Verify_Server_Cert: No
+ Last_IO_Errno: 0
+ Last_IO_Error:
+ Last_SQL_Errno: 0
+ Last_SQL_Error:
+ Replicate_Ignore_Server_Ids:
+ Master_Server_Id: 100
+ Master_SSL_Crl:
+ Master_SSL_Crlpath:
+ Using_Gtid: Slave_Pos
+ Gtid_IO_Pos: 0-100-1
+ Replicate_Do_Domain_Ids:
+ Replicate_Ignore_Domain_Ids:
+ Parallel_Mode: conservative
+ SQL_Delay: 0
+ SQL_Remaining_Delay: NULL
+ Slave_SQL_Running_State: Slave has read all relay log; waiting for more updates
+ Slave_DDL_Groups: 0
+Slave_Non_Transactional_Groups: 0
+ Slave_Transactional_Groups: 0
+Executes the RESET REPLICA statement to clear inbound replication configuration.
+CALL sky.reset_replication();
++------------------------+
+| Message |
++------------------------+
+| Replica has been reset |
++------------------------+
+Toggles the MASTER_SSL replication option using the CHANGE MASTER TO statement.
CALL sky.set_master_ssl();
+This stored procedure can be used to ignore a transaction that is causing a replication error.
+Executes the STOP REPLICA statement, then sets the sql_slave_skip_counter system variable, and then executes the START REPLICA statement to skip a single transaction. Does not currently work with GTID.
+CALL sky.skip_repl_error();
+Executes the [START REPLICA](https://mariadb.com/docs/skysql-previous-release/ref/mdb/sql-statements/START_REPLICA/) statement to start inbound replication from an external primary.
CALL sky.start_replication();
++----------------------------------------+
+| Message |
++----------------------------------------+
+| External replication running normally. |
++----------------------------------------+
+Start the external replication until a specified relay log file and position. It checks if the replication threads are running and starts the replication if they are not. It also provides feedback on the replication status.
+CALL start_replication_until(relay_log_file TEXT, relay_log_pos LONG);
+Starts the external replication until the specified GTID position. It checks if the replication threads are running and starts the replication if they are not. It also provides feedback on the replication status.
+CALL start_replication_until_gtid(master_gtid_pos TEXT);
+Executes the STOP REPLICA statement to stop inbound replication from an external primary.
+CALL sky.stop_replication();
++---------------------------------+
+| Message |
++---------------------------------+
+| Replication is down or disabled |
++---------------------------------+
+Note
+COMING SOON
+SkySQL, unlike hyperscalers, deploy replicas in a active-active configuration. When primary crashes our smart proxy(maxscale) allows us to failover near instantly to an alternate replica. Or, failback when the original primary recovers. Ensuring data consistency even when replicas have a replication lag through “causal reads”, or transaction replay.
+Our underlying k8s based operator has smarts to rebuild replicas that lag a lot using cloud native snapshots.
+ + + + + + + + + + + + + +SkySQL services are firewall-protected.
+Access to MariaDB SkySQL services is managed on a per-service basis.
+IPv4 addresses and IPv4 netblocks can be added to the allowlist to enable service access. Access from other addresses will be blocked.
+By default, when a service is launched its allowlist is empty. All external traffic to the service is blocked.
+To modify Secure Access settings:
+
Secure Access settings.
+https://skysql.mariadb.com/settings/secure-access
+Alternatively, you can access firewall settings for a specific service by clicking on the "MANAGE" button for the desired service, then choose "Security access" from the menu.
+
Whitelist dialog.
+https://skysql.mariadb.com/dashboard
+IP addresses can be added to the allowlist from the Firewall settings interface or a service's Security Access interface:
+After saving the change, a notification will be provided when the change has been applied.
+IP addresses can be removed from the allowlist from the Firewall settings interface or a service's Security Access interface:
+After saving the change, a notification will be provided when the change has been applied.
+An allowlist entry can be edited from the Firewall settings interface or a service's Security Access interface:
+After saving the change, a notification will be provided when the change has been applied.
+ + + + + + + + + + + + + +Go to SkySQL API Key management page: https://app.skysql.com/user-profile/api-keys and generate an API key
+Export the value from the token field to an environment variable $API_KEY
+Use it on subsequent request, e.g: +
curl --request GET 'https://api.skysql.com/provisioning/v1/services' \\
+ --header "X-API-Key: $API_KEY"
+Use the Portal to create new, revoke or permanently delete these Keys.
+OR
+You can use the swagger API portal to manage the keys. +1. Fetch all keys +2. Create a new API Key +3. Delete a user specific Key +4. Update a user specific key
+ + + + + + + + + + + + + +By default, SkySQL services are launched and managed in the Portal from a single MariaDB ID.
+For multiple MariaDB ID accounts to jointly manage a set of SkySQL services, these accounts can be added to a Team.
+The User Management interface in the Portal is a self-service tool to manage your Team.
+A Team can be managed by the initial user on the Team or by any Administrator added to the Team.
+An email address can belong to only one SkySQL Team. If an email address is already in a Team, it cannot be added to another Team.
+To access the User Management interface:
+
User Management
+https://skysql.mariadb.com/settings/user-management
+Each Team member has one of the following roles:
+
User Management - Invite
+https://skysql.mariadb.com/settings/user-management
+From the User Management interface, an Administrator can invite someone to join a team:
+Once a user has been invited, they will appear in the Team member list in an "Invited" status until the invitation is accepted.
+An invitation is delivered by email. The user will be prompted to complete account setup when accepting the invitation.
+You can withdraw the invitation before it is accepted by clicking on the "Cancel Invitation" link in the Team member list.
+From the User Management interface, an Administrator can remove a team member:
+From the User Management interface, an Administrator can change a team member's role:
+By default, authentication to the SkySQL Portal is performed with MariaDB ID credentials.
+For Power Tier customers, the SkySQL Portal can be configured to accept authentication with your SAML 2.0 IDP (identity provider). Google G Suite, Auth0, and Azure AD have been tested.
+Users with personal or business Google G Suite accounts can authenticate via social login. This ability does not depend on enterprise authentication configuration.
+Contact SkySQL Support for more information on enabling enterprise authentication.
+ + + + + + + + + + + + + +Some customers may have regulatory requirements or information security policies which prohibit the default database connections over the public internet.
+SkySQL services can optionally be configured for private connections using cloud provider-specific features - See here for details on how to set this up.
+By default, client traffic to SkySQL services may transit the public internet and is protected with TLS/SSL and a firewall configured by IP allowlist.
+ + + + + + + + + + + + + +Note
+TODO - describe security properly - things like how storage is encrypted, between zones, etc
+SkySQL takes security very seriously and provides security at all levels - encryption on-the-wire, encrypted storage, guarded compute, multiple levels of authentication and Authorization.
+It complies with several security standards like SOC2, GDPR, ISO ….
+ + + + + + + + + + + + + + + + + + +Note
+AWS PrivateLink is used for private connections within the same AWS region.
+Prior to configuring AWS PrivateLink on a SkySQL service, you must have created a VPC with a private subnet that will be used to communicate with private IP addresses.
+For detailed information about AWS PrivateLink, see "AWS PrivateLink" (Amazon documentation).
+The default endpoint mechanism is "nlb", which supports accessing the SkySQL service via the public internet. Use of AWS PrivateLink occurs when the endpoint mechanism is changed to "privateconnect".
AWS PrivateLink can be enabled using the SkySQL Portal, SkySQL DBaaS API, or SkySQL Terraform Provider.
+privateconnect endpoint mechanism, all connections occur through private endpoints. SkySQL does offer users to setup a “secondary” public IP endpoint also (available in the Portal UI when you provision a new service).AWS PrivateLink supports DNS propagation which can be configured to resolve the Database FQDN to the private IP for an internal DNS request. The private DNS names feature must be enabled on the customer's VPC.
+The SkySQL IP Allowlist is not used with the privateconnect endpoint mechanism.
nlb and privateconnect will result in a service interruption.To enable AWS PrivateLink when launching a new service via the SkySQL Portal all you need to do is select the 'Enable Private link' option in the 'Security' section.
+For the next step, see the AWS Endpoint Setup section on this page.
+To enable AWS PrivateLink for an existing service via the SkySQL Portal:
+For the next step, see the AWS Endpoint Setup section on this page.
+To disable AWS PrivateLink via the SkySQL Portal:
+In addition to switching the SkySQL service to the privateconnect endpoint mechanism, an AWS Endpoint must be created using the customer's AWS account in order for the SkySQL service to become accessible.
The newly created endpoint now authorizes the internal IPs or security groups that you specified in the Source values to access the SkySQL service's connection port. When testing a client connection, ensure that the client host is authorized by the security group's Source settings and that you're using the "readwrite" port plus the appropriate username and password (either the default values or the value for any user you have created).
To enable AWS PrivateLink when launching a new service via the SkySQL DBaaS API:
+When you are creating the request, add the "endpoint_mechanism" and "endpoint_allowed_accounts" attributes to the JSON payload:
"endpoint_mechanism": "privateconnect",
+"endpoint_allowed_accounts": [
+ "AWS-ACCOUNT-ID-1",
+ "AWS-ACCOUNT-ID-2"
+]
+"endpoint_mechanism" to "privateconnect""endpoint_allowed_accounts" to a JSON array of one or more customer account IDs in AWS that will be allowed to establish a private connection to the SkySQL serviceFor the next step, go through the AWS Endpoint setup section.
+To enable AWS PrivateLink on an existing service via the SkySQL DBaaS API, create a JSON payload such as:
+[
+ {
+ "mechanism": "privateconnect",
+ "allowed_accounts": [
+ "AWS-ACCOUNT-ID-1",
+ "AWS-ACCOUNT-ID-2"
+ ]
+ }
+]
+"mechanism" to "privateconnect""allowed_accounts" to a JSON array of one or more customer account IDs in AWS that will be allowed to establish a private connection to the SkySQL service.And then use the API to update the endpoints information of the service. The following example of using curl expects the above payload to be in a file named data.json and also expects the variables API_KEY and SERVICE_ID to be set:
curl -H "X-API-Key: ${API_KEY}" \
+ -X PATCH -d @data.json \
+ https://api.skysql.com/provisioning/v1/services/${SERVICE_ID}/endpoints \
+ | jq .
+We will need the endpoint's service name later on in the setup, so use the API to query the endpoint once the service has finished its modifications and is back to "ready":
+curl -H "X-API-Key: ${API_KEY}" -X GET \
+ https://api.skysql.com/provisioning/v1/services/${SERVICE_ID} \
+ | jq '.status,.endpoints[0].ports,.endpoints[0].endpoint_service'
+Note that the jq command is filtering the returned JSON data to extract three things (which are separated by commas in the command above):
ready" status means that the PrivateLink endpoint setup is complete.pending_upgrade" is reflected while PrivateLink endpoint setup is in-progress.endpoints array.readwrite".endpoint_service value for the first item in the endpoints array.The output will look something like this, though your values will vary:
+"ready"
+[
+ {
+ "name": "readwrite",
+ "port": 3306,
+ "purpose": "readwrite"
+ }
+]
+"com.amazonaws.vpce.AWS_REGION.vpce-svc-AWS_SERVICE_ID"
+If you are not using jq, scan (or parse) the full returned JSON data to ensure the service status is "ready" and find the associated values described above.
For the next step, go through the AWS Endpoint Setup section.
+To disable AWS PrivateLink via the SkySQL DBaaS API, create a JSON payload such as:
+[
+ {
+ "mechanism": "nlb"
+ }
+]
+Set "mechanism" to "nlb"
And then use the API to update the endpoints information of the service. The following example of using curl expects the above payload to be in a file named data.json and also expects the variables API_KEY and SERVICE_ID to be set:
curl -H "X-API-Key: ${API_KEY}" \
+ -X PATCH -d @data.json \
+ https://api.skysql.com/provisioning/v1/services/${SERVICE_ID}/endpoints \
+ | jq .
+We will need the endpoint's service name later on in the setup, so use the API to query the endpoint once the service has finished its modifications and is back to "ready":
+curl -H "X-API-Key: ${API_KEY}" -X GET \
+ https://api.skysql.com/provisioning/v1/services/${SERVICE_ID} \
+ | jq '.status,.endpoints[0].ports,.endpoints[0].endpoint_service'
+Note that the jq command is filtering the returned JSON data to extract three things (which are separated by commas in the command above):
ready" status means that the endpoint modification is complete.pending_upgrade" is reflected while PrivateLink is being disabled.endpoints array.readwrite".endpoint_service value for the first item in the endpoints array.The output will look something like this, though your values will vary:
+"ready"
+[
+ {
+ "name": "readwrite",
+ "port": 3306,
+ "purpose": "readwrite"
+ }
+]
+"com.amazonaws.vpce.AWS_REGION.vpce-svc-AWS_SERVICE_ID"
+If you are not using jq, scan (or parse) the full returned JSON data to ensure the service status is "ready" and find the associated values described above.
Since the service's allowlist was cleared when AWS PrivateLink was previously enabled, you will need to update the allowlist to allow clients to connect after disabling PrivateLink.
+To add an address to the allowlist via the SkySQL DBaaS API, create a JSON payload such as:
+**{** **"ip_address":** "192.0.2.10/32"**}**
+And then use the API to update the allowlist information of the service. The following example of using curl expects the above payload to be in a file named data.json and also expects the variables API_KEY and SERVICE_ID to be set:
curl -H "X-API-Key: ${API_KEY}" \
+ -X POST -d @data.json \
+ https://api.skysql.com/provisioning/v1/services/${SERVICE_ID}/security/allowlist \
+ | jq .
+For general instructions on using the SkySQL Terraform Provider, see "Terraform Launch Walkthrough
+For an example Terraform configuration that enables AWS PrivateLink, see Resources section here.
+To enable AWS PrivateLink when launching a new service via the SkySQL Terraform provider:
+When you are configuring the skysql_service resource, add the endpoint_mechanism and endpoint_allowed_accounts attributes.
For example, the attributes can be placed after ssl_enabled:
ssl_enabled = var.ssl_enabled
+endpoint_mechanism = "privateconnect"
+endpoint_allowed_accounts = ["AWS-ACCOUNT-ID-1","AWS-ACCOUNT-ID-2"]
+endpoint_mechanism to "privateconnect"endpoint_allowed_accounts to a comma-separated list of one or more customer account IDs in AWS that will be allowed to establish a private connection to the SkySQL serviceFor the next step, see the AWS Endpoint Setup section on this page.
+To enable AWS PrivateLink for an existing service via the SkySQL Terraform provider:
+Alter the skysql_service resource configuration by adding the endpoint_mechanism and endpoint_allowed_accounts attributes.
Follow the same instructions as above.
+Execute the [terraform apply command](https://developer.hashicorp.com/terraform/cli/commands/apply):
$ terraform apply -var-file="skysql-nr-quickstart.tfvars"
+For the next step, see the AWS Endpoint Setup section on this page.
+To disable AWS PrivateLink via the SkySQL Terraform provider:
+Alter the skysql_service resource configuration by doing the following:
endpoint_mechanism attribute to "nlb"endpoint_allowed_accounts attributeallow_list attributeFor example, if you started with the following attributes after ssl_enabled:
ssl_enabled = var.ssl_enabled
+endpoint_mechanism = "privateconnect"
+endpoint_allowed_accounts = ["AWS-ACCOUNT-ID-1","AWS-ACCOUNT-ID-2"]
+You could disable AWS PrivateLink by changing the attributes to the following:
+ssl_enabled = var.ssl_enabled
+endpoint_mechanism = "nlb"
+allow_list = [
+ {
+ "ip" : var.ip_address,
+ "comment" : var.ip_address_comment
+ }
+]
+Execute the [terraform apply command](https://developer.hashicorp.com/terraform/cli/commands/apply):
Note
+GCP Private Service Connect (PSC) is used for private connections within the same GCP region.
+Prior to configuring PSC on a SkySQL service, you must have created a VPC with a private subnet that will be used to communicate with private IP addresses.
+For detailed information about GCP PSC, see "Private Service Connect" (Google documentation).
+The default endpoint mechanism is "nlb", which supports accessing the SkySQL service via the public internet. Use of GCP PSC occurs when the endpoint mechanism is changed to "privateconnect".
GCP PSC can be enabled using the SkySQL Portal, SkySQL DBaaS API, or SkySQL Terraform Provider.
+privateconnect endpoint mechanism, all connections occur through private endpoints. SkySQL does offer users to setup a “secondary” public IP endpoint also (available in the Portal UI when you provision a new service).nlb and privateconnect will result in a service interruption.To enable GCP Private Service Connect when launching a new service via the SkySQL Portal:
+For the next step, see the GCP Endpoint Setup sections on this page.
+To enable GCP Private Service Connect for an existing service via the SkySQL Portal:
+For the next step, see the GCP Endpoint Setup sections on this page.
+To disable GCP Private Service Connect via the SkySQL Portal:
+Endpoint setup is performed using the customer's GCP account.
+We recommend use of a subnet dedicated to Private Service Connect endpoints in the same VPC where the application is running.
+In the GCP console, navigate Network services → Private Service Connect → CONNECTED ENDPOINTS → CONNECT ENDPOINT.
+Configure the endpoint connection:
+To enable GCP Private Service Connect when launching a new service via the SkySQL DBaaS API:
+When you are creating the request, add the "endpoint_mechanism" and "endpoint_allowed_accounts" attributes to the JSON payload:
"endpoint_mechanism": "privateconnect",
+"endpoint_allowed_accounts": [
+ "GCP-PROJECT-ID-1",
+ "GCP-PROJECT-ID-2"
+]
+"endpoint_mechanism" to "privateconnect""endpoint_allowed_accounts" to a JSON array of one or more customer project IDs in GCP that will be allowed to establish a private connection to the SkySQL serviceFor the next step, see the GCP Endpoint Setup sections on this page.
+To enable GCP Private Service Connect on an existing service via the SkySQL DBaaS API, create a JSON payload such as:
+[
+ {
+ "mechanism": "privateconnect",
+ "allowed_accounts": [
+ "GCP-PROJECT-ID-1",
+ "GCP-PROJECT-ID-2"
+ ]
+ }
+]
+"mechanism" to "privateconnect""allowed_accounts" to a JSON array of one or more customer project IDs in GCP that will be allowed to establish a private connection to the SkySQL serviceAnd then use the API to update the endpoints information of the service. The following example of using curl expects the above payload to be in a file named data.json and also expects the variables API_KEY and SERVICE_ID to be set:
curl -H "X-API-Key: ${API_KEY}" \
+ -X PATCH -d @data.json \
+ https://api.skysql.com/provisioning/v1/services/${SERVICE_ID}/endpoints \
+ | jq .
+We will need the endpoint's service name later on in the setup, so use the API to query the endpoint once the service has finished its modifications and is back to "ready":
+curl -H "X-API-Key: ${API_KEY}" -X GET \
+ https://api.skysql.com/provisioning/v1/services/${SERVICE_ID} \
+ | jq '.status,.endpoints[0].ports,.endpoints[0].endpoint_service'
+Note that the jq command is filtering the returned JSON data to extract three things (which are separated by commas in the command above):
ready" status means that the Private Service Connect endpoint setup is complete.pending_upgrade" is reflected while Private Service Connect endpoint setup is in-progress.endpoints array.readwrite".endpoint_service value for the first item in the endpoints array.The output will look something like this, though your values will vary:
+"ready"
+[
+ {
+ "name": "readwrite",
+ "port": 3306,
+ "purpose": "readwrite"
+ }
+]
+"GCP_ENDPOINT_HOSTNAME"
+If you are not using jq, scan (or parse) the full returned JSON data to ensure the service status is "ready" and find the associated values described above.
For the next step, see the GCP Endpoint Setup sections on this page.
+To disable GCP Private Service Connect via the SkySQL DBaaS API, create a JSON payload such as:
+[
+ {
+ "mechanism": "nlb"
+ }
+]
+"mechanism" to "nlb"And then use the API to update the endpoints information of the service. The following example of using curl expects the above payload to be in a file named data.json and also expects the variables API_KEY and SERVICE_ID to be set:
curl -H "X-API-Key: ${API_KEY}" \
+ -X PATCH -d @data.json \
+ https://api.skysql.com/provisioning/v1/services/${SERVICE_ID}/endpoints \
+ | jq .
+We will need the endpoint's service name later on in the setup, so use the API to query the endpoint once the service has finished its modifications and is back to "ready":
+curl -H "X-API-Key: ${API_KEY}" -X GET \
+ https://api.skysql.com/provisioning/v1/services/${SERVICE_ID} \
+ | jq '.status,.endpoints[0].ports,.endpoints[0].endpoint_service'
+Note that the jq command is filtering the returned JSON data to extract three things (which are separated by commas in the command above):
ready" status means that the endpoint modification is complete.pending_upgrade" is reflected while Private Service Connect is being disabled.endpoints array.readwrite".endpoint_service value for the first item in the endpoints array.The output will look something like this, though your values will vary:
+"ready"
+[
+ {
+ "name": "readwrite",
+ "port": 3306,
+ "purpose": "readwrite"
+ }
+]
+"GCP_ENDPOINT_HOSTNAME"
+If you are not using jq, scan (or parse) the full returned JSON data to ensure the service status is "ready" and find the associated values described above.
Since the service's allowlist was cleared when GCP Private Service Connect was previously enabled, you will need to update the allowlist to allow clients to connect after disabling Private Service Connect.
+To add an address to the allowlist via the SkySQL DBaaS API, create a JSON payload such as:
+**{** **"ip_address":** "192.0.2.10/32"**}**
+And then use the API to update the allowlist information of the service. The following example of using curl expects the above payload to be in a file named data.json and also expects the variables API_KEY and SERVICE_ID to be set:
curl -H "X-API-Key: ${API_KEY}" \
+ -X POST -d @data.json \
+ https://api.skysql.com/provisioning/v1/services/${SERVICE_ID}/security/allowlist \
+ | jq .
+GCP Private Service Connect can be enabled with Terraform using the SkySQL Terraform provider.
+For general instructions on using the SkySQL Terraform Provider, see "Terraform Launch Walkthrough .
+For an example Terraform configuration that enables GCP Private Service Connect, see Resources section here .
+To enable GCP Private Service Connect when launching a new service via the SkySQL Terraform provider:
+When you are configuring the skysql_service resource, add the endpoint_mechanism and endpoint_allowed_accounts attributes:
For example, the attributes can be placed after ssl_enabled:
ssl_enabled = var.ssl_enabled
+endpoint_mechanism = "privateconnect"
+endpoint_allowed_accounts = ["GCP-PROJECT-ID-1","GCP-PROJECT-ID-2"]
+endpoint_mechanism to "privateconnect"endpoint_allowed_accounts to a comma-separated list of one or more customer project IDs in GCP that will be allowed to establish a private connection to the SkySQL serviceFor the next step, see the Connectivity, Controls, & GCP Endpoint Setup sections on this page.
+To enable GCP Private Service Connect for an existing service via the SkySQL Terraform provider:
+Alter the skysql_service resource configuration by adding the endpoint_mechanism and endpoint_allowed_accounts attributes.
For example, the attributes can be placed after ssl_enabled:
ssl_enabled = var.ssl_enabled
+endpoint_mechanism = "privateconnect"
+endpoint_allowed_accounts = ["GCP-PROJECT-ID-1","GCP-PROJECT-ID-2"]
+endpoint_mechanism to "privateconnect"endpoint_allowed_accounts to a comma-separated list of one or more customer project IDs in GCP that will be allowed to establish a private connection to the SkySQL service[terraform apply command](https://developer.hashicorp.com/terraform/cli/commands/apply):$ terraform apply -var-file="skysql-nr-quickstart.tfvars"
+For the next step, see the GCP Endpoint Setup sections on this page.
+To disable GCP Private Service Connect via the SkySQL Terraform provider:
+Alter the skysql_service resource configuration by doing the following:
endpoint_mechanism attribute to "nlb"endpoint_allowed_accounts attributeallow_list attributeFor example, if you started with the following attributes after ssl_enabled:
ssl_enabled = var.ssl_enabled
+endpoint_mechanism = "privateconnect"
+endpoint_allowed_accounts = ["GCP-PROJECT-ID-1","GCP-PROJECT-ID-2"]
+You could disable GCP Private Service Connect by changing the attributes to the following:
+ssl_enabled = var.ssl_enabled
+endpoint_mechanism = "nlb"
+allow_list = [
+ {
+ "ip" : var.ip_address,
+ "comment" : var.ip_address_comment
+ }
+]
+Execute the [terraform apply command](https://developer.hashicorp.com/terraform/cli/commands/apply):
$ terraform apply -var-file="skysql-nr-quickstart.tfvars"
+By default, connections to SkySQL cloud databases occur with TLS/SSL encryption and can be initiated only from allowlisted IP addresses.
+Some customers have regulatory requirements or information security policies that prohibit database connections over the public internet, and result in a requirement for private connections.
+SkySQL cloud databases can optionally be configured for private connections between your VPC (virtual private clouds) and SkySQL cloud databases:
+