- 20.10.7 C API Prepared Statement Function Descriptions
- 20.10.7.1 mysql_stmt_affected_rows()
- 20.10.7.2 mysql_stmt_attr_get()
- 20.10.7.3 mysql_stmt_attr_set()
- 20.10.7.4 mysql_stmt_bind_param()
- 20.10.7.5 mysql_stmt_bind_result()
- 20.10.7.6 mysql_stmt_close()
- 20.10.7.7 mysql_stmt_data_seek()
- 20.10.7.8 mysql_stmt_errno()
- 20.10.7.9 mysql_stmt_error()
- 20.10.7.10 mysql_stmt_execute()
- 20.10.7.11 mysql_stmt_fetch()
- 20.10.7.12 mysql_stmt_fetch_column()
- 20.10.7.13 mysql_stmt_field_count()
- 20.10.7.14 mysql_stmt_free_result()
- 20.10.7.15 mysql_stmt_init()
- 20.10.7.16 mysql_stmt_insert_id()
- 20.10.7.17 mysql_stmt_num_rows()
- 20.10.7.18 mysql_stmt_param_count()
- 20.10.7.19 mysql_stmt_param_metadata()
- 20.10.7.20 mysql_stmt_prepare()
- 20.10.7.21 mysql_stmt_reset()
- 20.10.7.22 mysql_stmt_result_metadata()
- 20.10.7.23 mysql_stmt_row_seek()
- 20.10.7.24 mysql_stmt_row_tell()
- 20.10.7.25 mysql_stmt_send_long_data()
- 20.10.7.26 mysql_stmt_sqlstate()
- 20.10.7.27 mysql_stmt_store_result()
int mysql_stmt_prepare(MYSQL_STMT *stmt, const char
*stmt_str, unsigned long length)
Description
Given the statement handle returned by
mysql_stmt_init(), prepares the
SQL statement pointed to by the string
stmt_str and returns a status value. The
string length should be given by the length
argument. The string must consist of a single SQL statement. You
should not add a terminating semicolon
(“;”) or \g
to the statement.
The application can include one or more parameter markers in the
SQL statement by embedding question mark
(“?”) characters into the SQL
string at the appropriate positions.
The markers are legal only in certain places in SQL statements.
For example, they are allowed in the VALUES()
list of an INSERT statement (to
specify column values for a row), or in a comparison with a
column in a WHERE clause to specify a
comparison value. However, they are not allowed for identifiers
(such as table or column names), or to specify both operands of
a binary operator such as the = equal sign.
The latter restriction is necessary because it would be
impossible to determine the parameter type. In general,
parameters are legal only in Data Manipulation Language (DML)
statements, and not in Data Definition Language (DDL)
statements.
The parameter markers must be bound to application variables
using mysql_stmt_bind_param()
before executing the statement.
Return Values
Zero if the statement was prepared successfully. Nonzero if an error occurred.
Errors
-
Commands were executed in an improper order.
-
Out of memory.
-
The MySQL server has gone away.
-
The connection to the server was lost during the query
-
An unknown error occurred.
If the prepare operation was unsuccessful (that is,
mysql_stmt_prepare() returns
nonzero), the error message can be obtained by calling
mysql_stmt_error().
Example
For the usage of
mysql_stmt_prepare(), refer to
the Example from Section 20.10.7.10, “mysql_stmt_execute()”.
User Comments
For those of you suffering from a "1047: Unknown command" error, ensure your client and server side MySQL versions are compatible.
Add your own comment.