6.4.11 mysql_stmt_fetch()

int
mysql_stmt_fetch(MYSQL_STMT *stmt)

描述

mysql_stmt_fetch()返回结果集中的下一行。只能在结果集存在时调用;也就是说,在调用 mysql_stmt_execute()for 语句之后SELECT会生成一个结果集。

mysql_stmt_fetch()使用由 绑定的缓冲区返回行数据 mysql_stmt_bind_result()。它为当前行集中的所有列返回这些缓冲区中的数据,并将长度返回给 length指针。所有列必须在应用程序调用之前由应用程序绑定 mysql_stmt_fetch()

mysql_stmt_fetch()通常发生在一个循环中,以确保获取所有结果集行。例如:

int status;

while (1)
{
  status = mysql_stmt_fetch(stmt);

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

  /* handle current row here */
}

/* if desired, handle status == 1 case and display error here */

默认情况下,结果集是一次从服务器中无缓冲地获取一行。要在客户端缓冲整个结果集,请 mysql_stmt_store_result() 在绑定数据缓冲区之后调用 mysql_stmt_fetch().

如果获取的数据值是一个NULL值,*is_null则相应 MYSQL_BIND结构的值包含 TRUE (1)。 否则,根据应用程序指定的缓冲区类型在*buffer和元素中返回数据及其长度 。*length每种数字和时间类型都有固定的长度,如下表所列。字符串类型的长度取决于实际数据值的长度,如 所示data_length

类型 长度
MYSQL_TYPE_TINY 1个
MYSQL_TYPE_SHORT 2个
MYSQL_TYPE_LONG 4个
MYSQL_TYPE_LONGLONG 8个
MYSQL_TYPE_FLOAT 4个
MYSQL_TYPE_DOUBLE 8个
MYSQL_TYPE_TIME sizeof(MYSQL_TIME)
MYSQL_TYPE_DATE sizeof(MYSQL_TIME)
MYSQL_TYPE_DATETIME sizeof(MYSQL_TIME)
MYSQL_TYPE_STRING data length
MYSQL_TYPE_BLOB data_length

在某些情况下,您可能希望在使用 获取列值之前确定列值的长度 mysql_stmt_fetch()。例如,该值可能是一个长字符串或 BLOB您想知道必须为其分配多少空间的值。为此,请使用以下策略之一:

  • 在调用 mysql_stmt_fetch()以检索单个行之前,传递 STMT_ATTR_UPDATE_MAX_LENGTHmysql_stmt_attr_set(),然后调用 mysql_stmt_store_result() 以在客户端缓冲整个结果。设置该STMT_ATTR_UPDATE_MAX_LENGTH 属性会导致列值的最大长度由max_length返回的结果集元数据的成员 指示mysql_stmt_result_metadata()

  • mysql_stmt_fetch() 使用相关列的零长度缓冲区和可以存储实际长度的指针 调用。然后使用实际长度 mysql_stmt_fetch_column()

    real_length= 0;
    
    bind[0].buffer= 0;
    bind[0].buffer_length= 0;
    bind[0].length= &real_length
    mysql_stmt_bind_result(stmt, bind);
    
    mysql_stmt_fetch(stmt);
    if (real_length > 0)
    {
      data= malloc(real_length);
      bind[0].buffer= data;
      bind[0].buffer_length= real_length;
      mysql_stmt_fetch_column(stmt, bind, 0, 0);
    }

返回值

返回值 描述
0 成功,数据已被提取到应用程序数据缓冲区。
1个 发生了错误。错误码和错误消息可以通过调用 mysql_stmt_errno()和 获取mysql_stmt_error()
MYSQL_NO_DATA 成功,没有更多数据存在
MYSQL_DATA_TRUNCATED 发生数据截断

MYSQL_DATA_TRUNCATED启用截断报告时返回。要确定返回此值时截断了哪些列值,请检查 用于获取值error的结构的成员 。MYSQL_BIND默认情况下启用截断报告,但可以通过 mysql_options()使用 MYSQL_REPORT_DATA_TRUNCATION选项调用来控制。

错误

例子

以下示例演示了如何使用 mysql_stmt_result_metadata()mysql_stmt_bind_result()和 来从表中获取数据mysql_stmt_fetch()(此示例期望检索第 6.4.10 节“mysql_stmt_execute()”中所示示例插入的两行。)假设该 mysql变量是有效的连接处理程序。

#define STRING_SIZE 50

#define SELECT_SAMPLE "SELECT col1, col2, col3, col4 \
                       FROM test_table"

MYSQL_STMT    *stmt;
MYSQL_BIND    bind[4];
MYSQL_RES     *prepare_meta_result;
MYSQL_TIME    ts;
unsigned long length[4];
int           param_count, column_count, row_count;
short         small_data;
int           int_data;
char          str_data[STRING_SIZE];
bool          is_null[4];
bool          error[4];

/* Prepare a SELECT query to fetch data from test_table */
stmt = mysql_stmt_init(mysql);
if (!stmt)
{
  fprintf(stderr, " mysql_stmt_init(), out of memory\n");
  exit(0);
}
if (mysql_stmt_prepare(stmt, SELECT_SAMPLE, strlen(SELECT_SAMPLE)))
{
  fprintf(stderr, " mysql_stmt_prepare(), SELECT failed\n");
  fprintf(stderr, " %s\n", mysql_stmt_error(stmt));
  exit(0);
}
fprintf(stdout, " prepare, SELECT successful\n");

/* Get the parameter count from the statement */
param_count= mysql_stmt_param_count(stmt);
fprintf(stdout, " total parameters in SELECT: %d\n", param_count);

if (param_count != 0) /* validate parameter count */
{
  fprintf(stderr, " invalid parameter count returned by MySQL\n");
  exit(0);
}

/* Execute the SELECT query */
if (mysql_stmt_execute(stmt))
{
  fprintf(stderr, " mysql_stmt_execute(), failed\n");
  fprintf(stderr, " %s\n", mysql_stmt_error(stmt));
  exit(0);
}

/* Fetch result set meta information */
prepare_meta_result = mysql_stmt_result_metadata(stmt);
if (!prepare_meta_result)
{
  fprintf(stderr,
         " mysql_stmt_result_metadata(), \
           returned no meta information\n");
  fprintf(stderr, " %s\n", mysql_stmt_error(stmt));
  exit(0);
}

/* Get total columns in the query */
column_count= mysql_num_fields(prepare_meta_result);
fprintf(stdout,
        " total columns in SELECT statement: %d\n",
        column_count);

if (column_count != 4) /* validate column count */
{
  fprintf(stderr, " invalid column count returned by MySQL\n");
  exit(0);
}

/* Bind the result buffers for all 4 columns before fetching them */

memset(bind, 0, sizeof(bind));

/* INTEGER COLUMN */
bind[0].buffer_type= MYSQL_TYPE_LONG;
bind[0].buffer= (char *)&int_data;
bind[0].is_null= &is_null[0];
bind[0].length= &length[0];
bind[0].error= &error[0];

/* STRING COLUMN */
bind[1].buffer_type= MYSQL_TYPE_STRING;
bind[1].buffer= (char *)str_data;
bind[1].buffer_length= STRING_SIZE;
bind[1].is_null= &is_null[1];
bind[1].length= &length[1];
bind[1].error= &error[1];

/* SMALLINT COLUMN */
bind[2].buffer_type= MYSQL_TYPE_SHORT;
bind[2].buffer= (char *)&small_data;
bind[2].is_null= &is_null[2];
bind[2].length= &length[2];
bind[2].error= &error[2];

/* TIMESTAMP COLUMN */
bind[3].buffer_type= MYSQL_TYPE_TIMESTAMP;
bind[3].buffer= (char *)&ts;
bind[3].is_null= &is_null[3];
bind[3].length= &length[3];
bind[3].error= &error[3];

/* Bind the result buffers */
if (mysql_stmt_bind_result(stmt, bind))
{
  fprintf(stderr, " mysql_stmt_bind_result() failed\n");
  fprintf(stderr, " %s\n", mysql_stmt_error(stmt));
  exit(0);
}

/* Now buffer all results to client (optional step) */
if (mysql_stmt_store_result(stmt))
{
  fprintf(stderr, " mysql_stmt_store_result() failed\n");
  fprintf(stderr, " %s\n", mysql_stmt_error(stmt));
  exit(0);
}

/* Fetch all rows */
row_count= 0;
fprintf(stdout, "Fetching results ...\n");
while (!mysql_stmt_fetch(stmt))
{
  row_count++;
  fprintf(stdout, "  row %d\n", row_count);

  /* column 1 */
  fprintf(stdout, "   column1 (integer)  : ");
  if (is_null[0])
    fprintf(stdout, " NULL\n");
  else
    fprintf(stdout, " %d(%ld)\n", int_data, length[0]);

  /* column 2 */
  fprintf(stdout, "   column2 (string)   : ");
  if (is_null[1])
    fprintf(stdout, " NULL\n");
  else
    fprintf(stdout, " %s(%ld)\n", str_data, length[1]);

  /* column 3 */
  fprintf(stdout, "   column3 (smallint) : ");
  if (is_null[2])
    fprintf(stdout, " NULL\n");
  else
    fprintf(stdout, " %d(%ld)\n", small_data, length[2]);

  /* column 4 */
  fprintf(stdout, "   column4 (timestamp): ");
  if (is_null[3])
    fprintf(stdout, " NULL\n");
  else
    fprintf(stdout, " %04d-%02d-%02d %02d:%02d:%02d (%ld)\n",
                     ts.year, ts.month, ts.day,
                     ts.hour, ts.minute, ts.second,
                     length[3]);
  fprintf(stdout, "\n");
}

/* Validate rows fetched */
fprintf(stdout, " total rows fetched: %d\n", row_count);
if (row_count != 2)
{
  fprintf(stderr, " MySQL failed to return all rows\n");
  exit(0);
}

/* Free the prepared result metadata */
mysql_free_result(prepare_meta_result);


/* Close the statement */
if (mysql_stmt_close(stmt))
{
  /* mysql_stmt_close() invalidates stmt, so call          */
  /* mysql_error(mysql) rather than mysql_stmt_error(stmt) */
  fprintf(stderr, " failed while closing the statement\n");
  fprintf(stderr, " %s\n", mysql_error(mysql));
  exit(0);
}