MySQL :: MySQL 8.4 C API 开发人员指南 :: 3.6.5 预备 CALL 语句支持

版本 8.4

9.0
8.0
5.7

MySQL 8.4 C API 开发人员指南 / ... / 准备好的 CALL 语句支持

3.6.5 准备好的 CALL 语句支持

本节介绍 C API 中对使用 CALL 语句执行存储过程的准备好的语句支持

可以使用以下方法执行使用准备好的 CALL 语句的存储过程

存储过程可以产生任意数量的结果集。所有结果集的列数和列数据类型不必相同。
在过程返回后，调用应用程序可以获得 OUT 和 INOUT 参数的最终值。这些参数以额外的单行结果集的形式返回，该结果集位于过程本身产生的任何结果集之后。该行按在过程参数列表中声明的顺序包含 OUT 和 INOUT 参数的值。

有关未处理的条件对过程参数的影响的信息，请参见条件处理和 OUT 或 INOUT 参数。

以下讨论展示了如何通过 C API 使用这些功能来准备好的语句。要通过 PREPARE 和 EXECUTE 语句使用准备好的 CALL 语句，请参见 CALL 语句。

执行准备好的 CALL 语句的应用程序应使用一个循环来获取结果，然后调用 mysql_stmt_next_result() 来确定是否有更多结果。结果包括存储过程产生的任何结果集，以及一个指示过程是否成功终止的最终状态值。

如果过程具有 OUT 或 INOUT 参数，则在最终状态值之前的结果集包含它们的值。要确定结果集是否包含参数值，请测试 SERVER_PS_OUT_PARAMS 位是否在 MYSQL 连接处理程序的 server_status 成员中设置

Press CTRL+C to copy
 
mysql->server_status & SERVER_PS_OUT_PARAMS

以下示例使用准备好的 CALL 语句来执行一个存储过程，该过程产生多个结果集，并通过 OUT 和 INOUT 参数将参数值返回给调用者。该过程接受所有三种类型（IN、OUT、INOUT）的参数，显示它们的初始值，分配新值，显示更新的值，然后返回。因此，从该过程预期返回的信息应包括多个结果集和一个最终状态

来自一个 SELECT 的一个结果集，显示初始参数值：10、NULL、30。（OUT 参数由调用者分配一个值，但此分配预期无效：在过程中，OUT 参数被视为 NULL，直到在过程中被分配一个值。）
来自一个 SELECT 的一个结果集，显示修改后的参数值：100、200、300。
包含最终 OUT 和 INOUT 参数值的一个结果集：200、300。
一个最终状态数据包。

执行该过程的代码

Press CTRL+C to copy
 
MYSQL_STMT *stmt;
MYSQL_BIND ps_params[3];  /* input parameter buffers */
int        int_data[3];   /* input/output values */
bool       is_null[3];    /* output value nullability */
int        status;

/* set up stored procedure */
status = mysql_query(mysql, "DROP PROCEDURE IF EXISTS p1");
test_error(mysql, status);

status = mysql_query(mysql,
  "CREATE PROCEDURE p1("
  "  IN p_in INT, "
  "  OUT p_out INT, "
  "  INOUT p_inout INT) "
  "BEGIN "
  "  SELECT p_in, p_out, p_inout; "
  "  SET p_in = 100, p_out = 200, p_inout = 300; "
  "  SELECT p_in, p_out, p_inout; "
  "END");
test_error(mysql, status);

/* initialize and prepare CALL statement with parameter placeholders */
stmt = mysql_stmt_init(mysql);
if (!stmt)
{
  printf("Could not initialize statement\n");
  exit(1);
}
status = mysql_stmt_prepare(stmt, "CALL p1(?, ?, ?)", 16);
test_stmt_error(stmt, status);

/* initialize parameters: p_in, p_out, p_inout (all INT) */
memset(ps_params, 0, sizeof (ps_params));

ps_params[0].buffer_type = MYSQL_TYPE_LONG;
ps_params[0].buffer = (char *) &int_data[0];
ps_params[0].length = 0;
ps_params[0].is_null = 0;

ps_params[1].buffer_type = MYSQL_TYPE_LONG;
ps_params[1].buffer = (char *) &int_data[1];
ps_params[1].length = 0;
ps_params[1].is_null = 0;

ps_params[2].buffer_type = MYSQL_TYPE_LONG;
ps_params[2].buffer = (char *) &int_data[2];
ps_params[2].length = 0;
ps_params[2].is_null = 0;

/* bind parameters */
status = mysql_stmt_bind_param(stmt, ps_params);
test_stmt_error(stmt, status);

/* assign values to parameters and execute statement */
int_data[0]= 10;  /* p_in */
int_data[1]= 20;  /* p_out */
int_data[2]= 30;  /* p_inout */

status = mysql_stmt_execute(stmt);
test_stmt_error(stmt, status);

/* process results until there are no more */
do {
  int i;
  int num_fields;       /* number of columns in result */
  MYSQL_FIELD *fields;  /* for result set metadata */
  MYSQL_BIND *rs_bind;  /* for output buffers */

  /* the column count is > 0 if there is a result set */
  /* 0 if the result is only the final status packet */
  num_fields = mysql_stmt_field_count(stmt);

  if (num_fields > 0)
  {
    /* there is a result set to fetch */
    printf("Number of columns in result: %d\n", (int) num_fields);

    /* what kind of result set is this? */
    printf("Data: ");
    if(mysql->server_status & SERVER_PS_OUT_PARAMS)
      printf("this result set contains OUT/INOUT parameters\n");
    else
      printf("this result set is produced by the procedure\n");

    MYSQL_RES *rs_metadata = mysql_stmt_result_metadata(stmt);
    test_stmt_error(stmt, rs_metadata == NULL);

    fields = mysql_fetch_fields(rs_metadata);

    rs_bind = (MYSQL_BIND *) malloc(sizeof (MYSQL_BIND) * num_fields);
    if (!rs_bind)
    {
      printf("Cannot allocate output buffers\n");
      exit(1);
    }
    memset(rs_bind, 0, sizeof (MYSQL_BIND) * num_fields);

    /* set up and bind result set output buffers */
    for (i = 0; i < num_fields; ++i)
    {
      rs_bind[i].buffer_type = fields[i].type;
      rs_bind[i].is_null = &is_null[i];

      switch (fields[i].type)
      {
        case MYSQL_TYPE_LONG:
          rs_bind[i].buffer = (char *) &(int_data[i]);
          rs_bind[i].buffer_length = sizeof (int_data);
          break;

        default:
          fprintf(stderr, "ERROR: unexpected type: %d.\n", fields[i].type);
          exit(1);
      }
    }

    status = mysql_stmt_bind_result(stmt, rs_bind);
    test_stmt_error(stmt, status);

    /* fetch and display result set rows */
    while (1)
    {
      status = mysql_stmt_fetch(stmt);

      if (status == 1 || status == MYSQL_NO_DATA)
        break;

      for (i = 0; i < num_fields; ++i)
      {
        switch (rs_bind[i].buffer_type)
        {
          case MYSQL_TYPE_LONG:
            if (*rs_bind[i].is_null)
              printf(" val[%d] = NULL;", i);
            else
              printf(" val[%d] = %ld;",
                     i, (long) *((int *) rs_bind[i].buffer));
            break;

          default:
            printf("  unexpected type (%d)\n",
              rs_bind[i].buffer_type);
        }
      }
      printf("\n");
    }

    mysql_free_result(rs_metadata); /* free metadata */
    free(rs_bind);                  /* free output buffers */
  }
  else
  {
    /* no columns = final status packet */
    printf("End of procedure output\n");
  }

  /* more results? -1 = no, >0 = error, 0 = yes (keep looking) */
  status = mysql_stmt_next_result(stmt);
  if (status > 0)
    test_stmt_error(stmt, status);
} while (status == 0);

mysql_stmt_close(stmt);

执行该过程应产生以下输出

Press CTRL+C to copy
 
Number of columns in result: 3
Data: this result set is produced by the procedure
 val[0] = 10; val[1] = NULL; val[2] = 30;
Number of columns in result: 3
Data: this result set is produced by the procedure
 val[0] = 100; val[1] = 200; val[2] = 300;
Number of columns in result: 2
Data: this result set contains OUT/INOUT parameters
 val[0] = 200; val[1] = 300;
End of procedure output

该代码使用两个实用程序例程 test_error() 和 test_stmt_error() 来检查错误，如果发生错误，则在打印诊断信息后终止

Press CTRL+C to copy
 
static void test_error(MYSQL *mysql, int status)
{
  if (status)
  {
    fprintf(stderr, "Error: %s (errno: %d)\n",
            mysql_error(mysql), mysql_errno(mysql));
    exit(1);
  }
}

static void test_stmt_error(MYSQL_STMT *stmt, int status)
{
  if (status)
  {
    fprintf(stderr, "Error: %s (errno: %d)\n",
            mysql_stmt_error(stmt), mysql_stmt_errno(stmt));
    exit(1);
  }
}