5.6.1 Installing and Uninstalling Loadable Functions (original) (raw)

5.6.1 Installing and Uninstalling Loadable Functions

Loadable functions, as the name implies, must be loaded into the server before they can be used. MySQL supports automatic function loading during server startup and manual loading thereafter.

While a loadable function is loaded, information about it is available as described inSection 5.6.2, “Obtaining Information About Loadable Functions”.

Installing Loadable Functions

To load a loadable function manually, use theCREATE FUNCTION statement. For example:

CREATE FUNCTION metaphon
  RETURNS STRING
  SONAME 'udf_example.so';

The file base name depends on your platform. Common suffixes are.so for Unix and Unix-like systems,.dll for Windows.

CREATE FUNCTION has these effects:

It loads the function into the server to make it available immediately.
It registers the function in themysql.func system table to make it persistent across server restarts. For this reason,CREATE FUNCTION requires theINSERT privilege for themysql system database.

Automatic loading of loadable functions occurs during the normal server startup sequence. The server loads functions registered in the mysql.func table. If the server is started with the--skip-grant-tables option, functions registered in the table are not loaded and are unavailable.

Uninstalling Loadable Functions

To remove a loadable function, use theDROP FUNCTION statement. For example:

DROP FUNCTION metaphon;

DROP FUNCTION has these effects:

It unloads the function to make it unavailable.
It removes the function from themysql.func system table. For this reason,DROP FUNCTION requires theDELETE privilege for themysql system database. With the function no longer registered in the mysql.func table, the server does not load the function during subsequent restarts.

While a loadable function is loaded, information about it is available from the mysql.func system table. See Section 5.6.2, “Obtaining Information About Loadable Functions”.CREATE FUNCTION adds the function to the table andDROP FUNCTION removes it.

Reinstalling or Upgrading Loadable Functions

To reinstall or upgrade the shared library associated with a loadable function, issue aDROP FUNCTION statement, upgrade the shared library, and then issue aCREATE FUNCTION statement. If you upgrade the shared library first and then useDROP FUNCTION, the server may unexpectedly shut down.