Appian plug-in · Smart services & functions

MariaDB Tools

Export & restore your Appian Cloud MariaDB database from a process model. One database, or just one application's tables, without touching anything else.

Why MariaDB Tools

Platform backups restore everything. Sometimes you only need one database back.

Appian Cloud's built-in backups roll back the whole platform at once. MariaDB Tools is a convenient alternative to phpMyAdmin and MySQL Dump To Document: back up and restore a single database, or only the tables that belong to one application.

Use cases

Built for the moments a restore point matters

Before a deployment

Export automatically as part of a release or data conversion, so there's a restore point if something goes wrong.

Scheduled backups

Run nightly or weekly exports from a process model, saved as Appian documents in a secured folder.

Roll back a bad change

Restore the pre-change export after a failed deployment or bad data fix, once a dry run confirms what will change.

Refresh an environment

Move data from one environment to another by exporting from one and importing into the other.

Share or archive data

Export specific tables as CSV or JSON for reporting, audits or migration.

Scoped to your app

Include or exclude specific tables, so a backup covers exactly one application's data.

Features

Two smart services, three functions

Smart services

  • MariaDB Export: exports a Data Source Connected System's database to an Appian document.
  • MariaDB Import: restores a .sql or .sql.gz export, with a safety backup before any change.

Expression functions

  • mariadbtools_exportOptions() / mariadbtools_importOptions(): build smart service options with sensible defaults.
  • mariadbtools_isEnabled(): whether imports are on, to show or hide an import button.

Compared with MySQL Dump To Document

  • Connects through a Data Source Connected System, using a!getDataSourceForPlugin(), instead of an Admin Console data source.
  • Imports SQL exports, with safety checks.
  • Gzip-compressed exports.
  • Include or exclude specific tables.
FullStructure onlyData as SQLData as CSVData as JSON
How it works

Drop it into a process model

  1. Point a Data Source Connected System at your Appian Cloud MariaDB database.
  2. Add MariaDB Export to a process model. Build its options with mariadbtools_exportOptions() and choose a mode and tables.
  3. Run it on a timer, from a release process, or from a button. The export is saved as an Appian document.
  4. When you need it back, run MariaDB Import on that document. Do a dry run first to see what will change.
Governance

Imports are switched on per environment, by admins only

Imports run only when a system administrator enables them in a Third-Party Credentials entry. It isn't deployed with the application, so production can stay off while exports keep working everywhere.

  1. In the Admin Console, go to Integration > Third-Party Credentials and click Create.
  2. Name the entry mariadbtools and add the MariaDB Tools plug-in to its Plug-ins list.
  3. Add a field named isEnabled with the value true, and save.

To switch imports off again, set isEnabled to false or delete the entry.

Give every Appian app its own restore point

Export & restore Appian Cloud MariaDB databases, from the tools you already use.