Mariadb REST Service Drop

Removing MariaDB REST Service Objects with DROP REST

DROP REST ... statements remove REST objects and their metadata. They run in mariadb-shell.

Assume MariaDB 11.8 if not told otherwise.

Two rules that always apply

1. DROP REST removes only the REST endpoint/metadata — never the underlying database object. DROP REST VIEW /city deletes the REST endpoint; the sakila.city table is untouched. The same holds for procedures, functions and schemas: the database schema and its routines remain.
2. Dropping a container drops everything beneath it. Dropping a REST service removes all its schemas and their endpoints; dropping a REST schema removes all its views/procedures/functions. There is no CASCADE/RESTRICT keyword — the hierarchical removal is implicit.

Every DROP REST statement accepts an optional IF EXISTS, which turns a "does not exist" error into a no-op (a note). Prefer it in scripts.

Endpoint objects

-- A single data mapping view / procedure / function
DROP REST VIEW IF EXISTS /city FROM SERVICE /myService SCHEMA /sakila;
DROP REST PROCEDURE IF EXISTS /filmInStock FROM SERVICE /myService SCHEMA /sakila;
DROP REST FUNCTION IF EXISTS /maxRate FROM SERVICE /myService SCHEMA /sakila;

The FROM SERVICE ... SCHEMA ... selector can be omitted when a default context has been set with USE REST SERVICE /myService SCHEMA /sakila (see mariadb-rest-service-show).

Schema and service

-- A REST schema (drops the views/procedures/functions it contains)
DROP REST SCHEMA IF EXISTS /sakila FROM SERVICE /myService;

-- A whole REST service (drops all its schemas, endpoints and roles)
DROP REST SERVICE IF EXISTS /myService;

Static content

DROP REST CONTENT FILE IF EXISTS /index.html
    FROM SERVICE /myService CONTENT SET /myContentSet;

DROP REST CONTENT SET IF EXISTS /myContentSet FROM SERVICE /myService;

Authorization objects

-- An auth app (unlink it from services first if still linked)
DROP REST AUTH APP IF EXISTS "MRS";

-- A REST user of an auth app
DROP REST USER IF EXISTS "alice"@"MRS";

-- A REST role (scope with ON SERVICE / ON ANY SERVICE when ambiguous)
DROP REST ROLE IF EXISTS "reader" ON SERVICE /myService;
DROP REST ROLE IF EXISTS "globalRole" ON ANY SERVICE;

See mariadb-rest-service-authorization for the auth app / user / role model.

Before you drop

• Dumping the DDL first lets you recreate the object if the drop was a mistake: SHOW CREATE REST VIEW /city ON SERVICE /myService SCHEMA /sakila; (see mariadb-rest-service-show).
• If the removal is only temporary, prefer disabling over dropping — ALTER REST ... DISABLED (or PRIVATE for schemas/objects) keeps the definition and is reversible, whereas a drop is permanent. See mariadb-rest-service-update-endpoints.

See Also

• mariadb-rest-service-show — dump an object's DDL with SHOW CREATE REST before dropping it.
• mariadb-rest-service-update-endpoints — disable/unpublish as a reversible alternative to dropping.
• mariadb-rest-service-create — recreating dropped objects.
• mariadb-rest-service-authorization — auth apps, users and roles.
• mariadb-drop-table — the underlying database DROP (which DROP REST does not perform).