mariadb/mysql-test/suite
Alexander Barkov 385957a77c MDEV-36053 CURSOR declarations in PACKAGE BODY
This change adds CURSOR declarations inside PACKAGE BODY.

PL/SQL mode:

  SET sql_mode=ORACLE;
  CREATE PACKAGE BODY pkg AS
    CURSOR mc0 IS SELECT c0, c1 FROM t1;
    PROCEDURE p1 AS
      rec mc0%ROWTYPE;
    BEGIN
      OPEN mc0;
      FETCH mc0 INTO rec;
      CLOSE mc0
    END;
  END;
  /

SQL/PSM mode:

  SET sql_mode=DEFAULT;
  CREATE PACKAGE BODY pkg
    mc0 CURSOR FOR SELECT c0, c1 FROM t1;
    PROCEDURE p1()
    BEGIN
      DECLARE rec ROW TYPE OF mc0;
      OPEN mc0;
      FETCH mc0 INTO rec;
      CLOSE mc0
    END;
  END;
  /

PACKAGE BODY cursors like local cursors
(declared inside a FUNCTION or a PROCEDURE) support:
  - OPEN/FETCH/CLOSE
  - FOR rec IN cur - an explicit cursor loop
  - Using a cursor row as an anchored variable data type:
    * DECLARE var cur%ROWTYPE;     -- sql_mode=ORACLE
    * DECLARE var ROW TYPE OF cur; -- sql_mode=DEFAULT

The patch details:

- Changing various class members and function/method parameters which
  store a CURSOR run-time address from "uint" to sp_rcontext_addr.
  A few classes now derive from sp_rcontext_addr instead of having
  a "uint m_cursor;" member.

  This change uses the same idea with what we did for SP variables,
  when we implemented PACKAGE BODY variables a few years ago.

- Fixing the grammar in sql_yacc.yy to allow CURSOR declarations
  inside PACKAGE BODY.

- Moving the C++ code handing the "CLOSE_SYM ident" grammar
  and creating an sp_instr_cclose instance from sql_yacc.yy
  into a new method LEX::sp_close().
  This is to have the grammar file smaller.
  Also, this code has significantly changed anyway.

- Adding a new class sp_pcontext_top. It's used for the top level parse
  context (of an sp_head). Note, its children contexts still use the old
  class sp_pcontext.

  sp_pcontext_top context additionally to sp_pcontext has:

    const sp_head *m_sp; -- The pointer to the sp_head owning this context
    Dynamic_array<sp_pcursor> m_member_cursors; -- PACKAGE BODY wide cursors

  m_sp->m_parent->get_parse_context() is used to find the sp_pcontext
  belonging to the parent PACKAGE BODY from a sp_pcontext_top instance
  belonging to a PROCEDURE/FUNCTION sp_pcontext_top.

- Adding a new member in sp_rcontext:
    Dynamic_array<sp_cursor*> m_member_cursors;
  It's used to store run-time data of PACKAGE BODY wide cursors.

- Adding a new class sp_instr_copen2. It's used to open PACKAGE BODY cursors.
  Unlike the usual cursors, PACKAGE BODY cursors:
  * do not use the cursor stack (sp_rcontext::m_cstack)
  * do not need a preceeding sp_instr_cpush
  * do not need a following sp_instr_cpop

  All cursor information such as "sp_lex_cursor" resides inside
  sp_instr_copen2 itself (rather than inside sp_instr_cpush which is
  used to store "sp_lex_cursor" in case of sp_instr_copen).

  Note, the other cursor related instructions:
    sp_instr_cfetch
    sp_instr_cclose
    sp_instr_cursor_copy_struct
  do not need sp_instr_xxx2 counter-parts.
  Thy just use sp_rcontext_addr to address cursors.

- Adding Sp_rcontext_handler_member
  It's used to handle PACKAGE BODY members:
  cursors and variables declared in the PACKAGE BODY,
  when they are accessed from its executable initialization section:

    CREATE PACKAGE BODY pkg AS
      CURSOR mc0 IS SELECT c0, c1 FROM t1; -- A member (PACKAGE BODY cursor)
      mv0 mc0%ROWTYPE;                     -- A member (PACKAGE BODY variable)
      PROCEDURE p1 AS
      BEGIN
        -- Accessing members from here use sp_rcontext_handler_package_body
        -- (members of the parent PACKAGE BODY)
        OPEN mc0;
        FETCH mc0 INTO mv0;
        CLOSE mc0;
      END;
    BEGIN
      -- NEW:
      -- Accessing members from here use sp_rcontext_handler_member
      -- (PACKAGE BODY own members)
      OPEN mc0;
      FETCH mc0 INTO mv0;
      CLOSE mc0;
    END;
    /

  Member variables and cursor are now marked with the "MEMBER." prefix
  in the "SHOW PACKAGE BODY code" output.
  Some old MTR tests have been re-recorded accordingly.

- Adding new virtual methods into Sp_rcontext_handler:

  virtual const sp_variable *get_pvariable(const sp_pcontext *pctx,
                                           uint offset) const;

  virtual const sp_pcursor *get_pcursor(const sp_pcontext *pctx,
                                        uint offset) const;

  They're used from sp_instr::print() virtual implementations.
  They internally calculate a proper sp_pcontext using as a parameter
  the sp_pcontext pointed by sp_instr::m_ctx.

  For example, Sp_handler_package_body::get_pvariable()/get_pcursor()
  accesses to this sp_pcontext:
      m_ctx->top_context()->m_sp->m_parent->get_parse_context(),
  i.e. the parse context of the PACKAGE BODY which is the parent for
   the current package PROCEDURE of FUNCTION an sp_instr belongs to.

- Adding a new method LEX::find_cursor(). It searches for a cursor in
  this order:
  * Local cursors in the nearst upper BEGIN/END block.
  * A member cursor of the current PACKAGE BODY
    (used from the PACKAGE BODY initialization section)
  * A member cursor of the parrent PACKAGE BODY
    (used from a package PROCEDURE or a package FUNCTION)

  Adding a new method LEX::find_cursor_with_error().
  In case when a cursor is not found, it automatically
  raises the ER_SP_CURSOR_MISMATCH SQL condition into
  the diagnostics area.

- Adding a new method sp_head::add_instr_copenX().
  It creates sp_instr_copen for local cursors,
  or sp_instr_copen2 for non-local cursors.

- Adding a new abstract class sp_lex_cursor_instr.
  It's used a common parent class for a few sp_instr_xxx classes,
  including the new sp_instr_copen2.
  This change is needed to avoid code duplication.

- Adding a new protected method sp_instr::print_cmd_and_var(), to print
  an instruction using this format: "command name@offset".
  It's used from a few implementations of sp_instr_xxx::print(),
  including sp_instr_copen2::print().
  This change is also needed to avoid code duplication.

- Moving the definition of "class Sp_rcontext_handler" from item.h
  into a new file sp_rcontext_handler.h
  This is to maitain header dependencies easier, as well as to move
  declarations not directly related to "class Item" outside of item.h

- Adding a new method sp_pcontext::frame_for_members(), to distinguish
  easier between local cursors/variables and PACKAGE BODY cursors/variables.

- Fixing "struct Lex_for_loop_st" to addionally store
  a const pointer to Sp_rcontext_handler, to distinguish between:
    * FOR rec IN local_cursor
    * FOR rec IN package_body_cursor
2025-06-27 11:17:19 +04:00
..
archive Merge branch '10.11' into 11.4 2025-04-26 10:53:02 +02:00
atomic Merge branch '10.11' into 11.4 2025-04-26 10:53:02 +02:00
binlog Merge branch '10.11' into 11.4 2025-04-26 10:53:02 +02:00
binlog_encryption MDEV-36424: binlog_encryption.encrypted_master_switch_to_unencrypted_gtid Fails in BB 11.4+ 2025-03-28 19:20:16 +01:00
client
compat MDEV-36053 CURSOR declarations in PACKAGE BODY 2025-06-27 11:17:19 +04:00
csv
encryption Merge 10.11 into 11.4 2025-03-28 13:55:21 +02:00
engines Merge 10.11 into 11.4 2025-03-28 13:55:21 +02:00
events Merge 10.11 into 11.4 2024-12-02 11:35:34 +02:00
federated Merge branch '10.11' into 11.4 2025-04-26 10:53:02 +02:00
funcs_1 Merge branch '10.11' into 11.4 2025-06-17 09:50:22 +02:00
funcs_2 Merge 10.5 into 10.6 2025-03-26 17:09:57 +02:00
galera Merge branch '10.11' into 11.4 2025-06-17 09:50:22 +02:00
galera_3nodes Merge branch '10.11' into 11.4 2025-06-17 09:50:22 +02:00
galera_3nodes_sr galera mtr tests: synchronization between branches and editions 2025-04-02 04:50:11 +02:00
galera_sr Merge branch '10.6' into '10.11' 2025-04-02 06:33:39 +02:00
gcol Merge branch '10.11' into 11.4 2025-04-26 10:53:02 +02:00
handler Merge 10.11 into 11.4 2025-01-09 07:58:08 +02:00
heap Merge branch '10.11 into 11.4 2025-01-30 12:01:11 +01:00
innodb Merge branch '10.11' into 11.4 2025-06-17 09:50:22 +02:00
innodb_fts Merge 10.11 into 11.4 2025-03-28 13:55:21 +02:00
innodb_gis Merge branch '10.11' into 11.4 2025-06-17 09:50:22 +02:00
innodb_i_s
innodb_zip Merge branch '10.11 into 11.4 2025-01-30 12:01:11 +01:00
jp
json Merge branch '10.11' into 11.4 2025-04-26 10:53:02 +02:00
large_tests
maria Merge branch '10.11' into 11.4 2025-06-17 09:50:22 +02:00
mariabackup mtr backup tests should not read local .my.cnf files 2025-04-20 12:56:15 +03:00
merge Merge branch '10.11' into 11.4 2025-04-26 10:53:02 +02:00
mtr/t Remove dates from all rdiff files 2025-01-05 16:40:11 +02:00
mtr2
multi_source MDEV-36238 11.4 follow-up: Master_SSL_Verify_Server_Cert=0 2025-04-16 14:12:57 -06:00
optimizer_unfixed_bugs
parts Merge 10.11 into 11.4 2025-03-28 13:55:21 +02:00
perfschema MDEV-36053 CURSOR declarations in PACKAGE BODY 2025-06-27 11:17:19 +04:00
perfschema_stress
period Merge branch '10.11' into 11.4 2025-01-14 23:45:41 +01:00
plugins Merge branch '10.11' into 11.4 2025-04-26 10:53:02 +02:00
roles Merge branch '10.11 into 11.4 2025-01-30 12:01:11 +01:00
rpl Merge 10.11 into 11.4 2025-05-13 13:44:58 +03:00
s3 Merge branch '10.11' into 11.4 2025-06-17 09:50:22 +02:00
sql_sequence MDEV-35856 Remove error code introduced to 10.11 in MDEV-36032 2025-06-05 11:07:18 +10:00
storage_engine
stress MDEV-34453 Trying to read 16384 bytes at 70368744161280 outside the bounds of the file: ./ibdata1 2024-09-20 20:26:43 +05:30
sys_vars Merge branch '10.11' into 11.4 2025-06-17 09:50:22 +02:00
sysschema
unit
vcol Merge branch '10.11' into 11.4 2025-06-17 09:50:22 +02:00
versioning Merge branch '10.11' into 11.4 2025-06-17 09:50:22 +02:00
wsrep Merge branch '10.5' into '10.6' 2025-04-02 04:43:24 +02:00