Chapter 27 Stored Objects

Table of Contents

27.1 Defining Stored Programs

27.2 Using Stored Routines

27.2.1 Stored Routine Syntax

27.2.2 Stored Routines and MySQL Privileges

27.2.3 Stored Routine Metadata

27.2.4 Stored Procedures, Functions, Triggers, and LAST_INSERT_ID()

27.3 JavaScript Stored Programs

27.3.1 JavaScript Stored Program Creation and Management

27.3.2 Obtaining Information About JavaScript Stored Programs

27.3.3 JavaScript Stored Program Language Support

27.3.4 JavaScript Stored Program Data Types and Argument Handling

27.3.5 JavaScript Stored Programs—Session Information and Options

27.3.6 JavaScript SQL API

27.3.7 Using the JavaScript SQL API

27.3.8 JavaScript GenAI API

27.3.9 JavaScript Stored Program Limitations and Restrictions

27.3.10 JavaScript Stored Program Examples

27.4 Using Triggers

27.4.1 Trigger Syntax and Examples

27.4.2 Trigger Metadata

27.5 Using the Event Scheduler

27.5.1 Event Scheduler Overview

27.5.2 Event Scheduler Configuration

27.5.3 Event Syntax

27.5.4 Event Metadata

27.5.5 Event Scheduler Status

27.5.6 The Event Scheduler and MySQL Privileges

27.6 Using Views

27.6.1 View Syntax

27.6.2 View Processing Algorithms

27.6.3 Updatable and Insertable Views

27.6.4 The View WITH CHECK OPTION Clause

27.6.5 View Metadata

27.7 Stored Object Access Control

27.8 Stored Program Binary Logging

27.9 Restrictions on Stored Programs

27.10 Restrictions on Views

This chapter discusses stored database objects that are defined in terms of SQL code that is stored on the server for later execution.

Stored objects include these object types:

• Stored procedure: An object created with CREATE PROCEDURE and invoked using the CALL statement. A procedure does not have a return value but can modify its parameters for later inspection by the caller. It can also generate result sets to be returned to the client program.

• Stored function: An object created with CREATE FUNCTION and used much like a built-in function. You invoke it in an expression and it returns a value during expression evaluation.

• Trigger: An object created with CREATE TRIGGER that is associated with a table. A trigger is activated when a particular event occurs for the table, such as an insert or update.

• Event: An object created with CREATE EVENT and invoked by the server according to schedule.

• View: An object created with CREATE VIEW that when referenced produces a result set. A view acts as a virtual table.

Terminology used in this document reflects the stored object hierarchy:

• Stored routines include stored procedures and functions.

• Stored programs include stored routines, triggers, and events.

• Stored objects include stored programs and views.

This chapter describes how to use stored objects. The following sections provide additional information about SQL syntax for statements related to these objects, and about object processing:

• For each object type, there are CREATE, ALTER, and DROP statements that control which objects exist and how they are defined. See Section 15.1, “Data Definition Statements”.

• The CALL statement is used to invoke stored procedures. See Section 15.2.1, “CALL Statement”.

• Stored program definitions include a body that may use compound statements, loops, conditionals, and declared variables. See Section 15.6, “Compound Statement Syntax”.

• Metadata changes to objects referred to by stored programs are detected and cause automatic reparsing of the affected statements when the program is next executed. For more information, see Section 10.10.3, “Caching of Prepared Statements and Stored Programs”.