Mariadb REST Service Show

Browsing a MariaDB REST Service with SHOW REST

SHOW REST ... statements list the REST objects that exist; SHOW CREATE REST ... reproduces the DDL for a single object. Both are read-only and run in mariadb-shell. Use them to discover what is deployed, audit access, or recover the exact statement that created an endpoint before altering it.

Assume MariaDB 11.8 if not told otherwise.

Set a default context first (optional)

Most SHOW statements take an explicit ON/FROM SERVICE ... (and SCHEMA ...) clause. Setting a default context with USE lets you omit it on the statements that follow:

USE REST SERVICE /myService;
USE REST SCHEMA /sakila;
-- or both at once:
USE REST SERVICE /myService SCHEMA /sakila;

Overall status

SHOW REST STATUS;

Reports basic information about the current state of the MariaDB REST Service (whether it is configured/enabled, metadata version, etc.).

Listing objects

Work top-down: services → schemas → objects. The service/schema clause is optional once a default context is set with USE.

-- All REST services
SHOW REST SERVICES;

-- Schemas of a service
SHOW REST SCHEMAS FROM SERVICE /myService;

-- Data mapping views, procedures and functions of a schema
SHOW REST VIEWS FROM SERVICE /myService SCHEMA /sakila;
SHOW REST PROCEDURES FROM SERVICE /myService SCHEMA /sakila;
SHOW REST FUNCTIONS FROM SERVICE /myService SCHEMA /sakila;

-- Static content
SHOW REST CONTENT SETS FROM SERVICE /myService;
SHOW REST CONTENT FILES FROM SERVICE /myService CONTENT SET /myContentSet;

ON and FROM are interchangeable in these statements (... ON SERVICE ... == ... FROM SERVICE ...). After a USE, the clause can be dropped entirely, e.g. SHOW REST VIEWS;.

Listing authorization objects

-- Auth apps linked to a service
SHOW REST AUTH APPS FROM SERVICE /myService;

-- Roles (optionally scoped, or filtered to a user's granted roles)
SHOW REST ROLES;
SHOW REST ROLES ON SERVICE /myService;
SHOW REST ROLES ON ANY SERVICE;
SHOW REST ROLES FOR "alice"@"MRS";

-- The privileges granted to a role
SHOW REST GRANTS FOR "reader";
SHOW REST GRANTS FOR "reader" ON SERVICE /myService;

See mariadb-rest-service-authorization for what these roles and grants mean.

Dumping DDL with SHOW CREATE REST

SHOW CREATE REST ... returns the DDL statement that recreates a single object — the reliable way to see an endpoint's exact definition (field mapping, CRUD flags, options) before editing or cloning it.

-- Service; add INCLUDING SCHEMA ENDPOINTS to also emit all nested endpoint DDL
SHOW CREATE REST SERVICE /myService;
SHOW CREATE REST SERVICE /myService INCLUDING SCHEMA ENDPOINTS;

SHOW CREATE REST SCHEMA /sakila FROM SERVICE /myService;

SHOW CREATE REST VIEW /city ON SERVICE /myService SCHEMA /sakila;
SHOW CREATE REST PROCEDURE /filmInStock ON SERVICE /myService SCHEMA /sakila;
SHOW CREATE REST FUNCTION /maxRate ON SERVICE /myService SCHEMA /sakila;

SHOW CREATE REST CONTENT SET /myContentSet FROM SERVICE /myService;
SHOW CREATE REST CONTENT FILE /index.html FROM SERVICE /myService CONTENT SET /myContentSet;

-- Authorization objects
SHOW CREATE REST AUTH APP "MRS" FROM SERVICE /myService;
SHOW CREATE REST ROLE "editor" ON SERVICE /myService;
SHOW CREATE REST USER "alice"@"MRS";

SHOW CREATE REST VIEW is especially useful: creating a REST view without an explicit GraphQL block auto-expands to all columns, and SHOW CREATE REST VIEW reveals the generated field mapping so you can copy and refine it.

Typical browse workflow

SHOW REST STATUS;                                    -- is MRS configured/enabled?
SHOW REST SERVICES;                                  -- pick a service
USE REST SERVICE /myService;
SHOW REST SCHEMAS;                                   -- its schemas
SHOW REST VIEWS FROM SCHEMA /sakila;                 -- its views
SHOW CREATE REST VIEW /city FROM SCHEMA /sakila;     -- inspect one in detail

See Also

• mariadb-rest-service-create — creating the objects these statements list.
• mariadb-rest-service-update-endpoints — using SHOW CREATE REST output as the baseline before ALTER/DROP.
• mariadb-rest-service-authorization — meaning of auth apps, roles and grants.
• mariadb-show — the underlying MariaDB SHOW statements.