[MDEV-33403] Document stored packages overview Created: 2024-02-07  Updated: 2024-02-07

Status: Open
Project: MariaDB Server
Component/s: Documentation, Stored routines
Fix Version/s: 10.5

Type: Task Priority: Critical
Reporter: Alexander Barkov Assignee: Joe Cotellese
Resolution: Unresolved Votes: 0
Labels: None

Issue Links:
Relates
relates to MDEV-10591 Oracle-style packages Closed
relates to MDEV-32101 CREATE PACKAGE [BODY] for sql_mode=DE... Closed

 Description   

For now we have a few pages on the manual telling about PACKAGE related statements:

  • CREATE PACKAGE
  • DROP PACKAGE
  • CREATE PACKAGE BODY
  • DROP PACKAGE BODY

However, the manual misses an overview page similar to what we for stored procedures and functions.

The overview page should explain:

  • What is a package. Why use packages.
  • How packages are different from the SQL Standard modules.
  • Package variables
  • Public and private routines
  • Executable initialization section
  • Stored package privileges
  • SHOW CREATE PACKAGE [BODY]
  • SHOW PACKAGE [BODY] CODE
  • SHOW PACKAGE [BODY] STATUS
  • Name resolution order - resolving ambiguities:

      SELECT pkg.f1(); -- Schema `pkg`, schema function `f1`
      SELECT pkg.f1(); -- Current schema, package `pkg`, package function `f1`
    

  • Stored package internals

Generated at Thu Feb 08 10:38:38 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.