MySQL API
C API Data Structures
- MYSQL
This structure represents handler for one database connection. It is used for almost all MySQL functions. Do not try to make a copy of a MYSQL structure. There is no guarantee that such a copy will be usable.
- MYSQL_RES
This structure represents the result of a query that returns rows (SELECT, SHOW, DESCRIBE, EXPLAIN). The information returned from a query is called the result set in the remainder of this section.
- MYSQL_ROW
This is a type-safe representation of one row of data. It is currently implemented as an array of counted byte strings. (You cannot treat these as null-terminated strings if field values may contain binary data, because such values may contain null bytes internally.) Rows are obtained by calling mysql_fetch_row().
- MYSQL_FIELD
This structure contains metadata: information about a field, such as the field`s name, type, and size. Its members are described in more detail later in this section. You may obtain the MYSQL_FIELD structures for each field by calling mysql_fetch_field() repeatedly. Field values are not part of this structure; they are contained in a MYSQL_ROW structure.
- MYSQL_FIELD_OFFSET
This is a type-safe representation of an offset into a MySQL field list. (Used by mysql_field_seek().) Offsets are field numbers within a row, beginning at zero.
- my_ulonglong
- The type used for the number of rows and for mysql_affected_rows(), mysql_num_rows(), and mysql_insert_id(). This type provides a range of 0 to 1.84e19.
- Some functions that return a row count using this type return -1 as an unsigned value to indicate an error or exceptional condition. You can check for -1 by comparing the return value to (my_ulonglong)-1 (or to (my_ulonglong)~0, which is equivalent).
- On some systems, attempting to print a value of type my_ulonglong does not work. To print such a value, convert it to unsigned long and use a %lu print format. Example:
printf ("Number of rows: %lu
",
(unsigned long) mysql_num_rows(result));- my_bool
- A boolean type, for values that are true (nonzero) or false (zero).
- The MYSQL_FIELD structure contains the members described in the following list. The definitions apply primarily for columns of result sets such as those produced by SELECT statements. MYSQL_FIELD structures are also used to provide metadata for OUT and INOUT parameters returned from stored procedures executed using prepared CALL statements. For such parameters, some of the structure members have a meaning different from the meaning for column values.
- char * name
The name of the field, as a null-terminated string. If the field was given an alias with an AS clause, the value of name is the alias. For a procedure parameter, the parameter name.
- char * org_name
The name of the field, as a null-terminated string. Aliases are ignored. For expressions, the value is an empty string. For a procedure parameter, the parameter name.
- char * table
The name of the table containing this field, if it is not a calculated field. For calculated fields, the table value is an empty string. If the column is selected from a view, table names the view. If the table or view was given an alias with an AS clause, the value of table is the alias. For a UNION, the value is the empty string. For a procedure parameter, the procedure name.
- char * org_table
The name of the table, as a null-terminated string. Aliases are ignored. If the column is selected from a view, org_table names the view. For a UNION, the value is the empty string. For a procedure parameter, the procedure name.
- char * db
The name of the database that the field comes from, as a null-terminated string. If the field is a calculated field, db is an empty string. For a UNION, the value is the empty string. For a procedure parameter, the name of the database containing the procedure.
- char * catalog
The catalog name. This value is always “def”.
- char * def
The default value of this field, as a null-terminated string. This is set only if you use mysql_list_fields().
- unsigned long length
- The width of the field. This corresponds to the display length, in bytes.
- The server determines the length value before it generates the result set, so this is the minimum length required for a data type capable of holding the largest possible value from the result column, without knowing in advance the actual values that will be produced by the query for the result set.
- unsigned long max_length
- The maximum width of the field for the result set (the length in bytes of the longest field value for the rows actually in the result set). If you use mysql_store_result() or mysql_list_fields(), this contains the maximum length for the field. If you use mysql_use_result(), the value of this variable is zero.
- The value of max_length is the length of the string representation of the values in the result set. For example, if you retrieve a FLOAT column and the “widest” value is -12.345, max_length is 7 (the length of `-12.345`).
- If you are using prepared statements, max_length is not set by default because for the binary protocol the lengths of the values depend on the types of the values in the result set. (See Section 23.8.9, “C API Prepared Statement Data Structures”.) If you want the max_length values anyway, enable the STMT_ATTR_UPDATE_MAX_LENGTH option with mysql_stmt_attr_set() and the lengths will be set when you call mysql_stmt_store_result(). (See Section 23.8.11.3, “mysql_stmt_attr_set()”, and Section 23.8.11.28, “mysql_stmt_store_result()”.)
- unsigned int name_length
The length of name.
- unsigned int org_name_length
The length of org_name.
- unsigned int table_length
The length of table.
- unsigned int org_table_length
The length of org_table.
- unsigned int db_length
The length of db.
- unsigned int catalog_length
The length of catalog.
- unsigned int def_length
The length of def.
- unsigned int flags
Bit-flags that describe the field. The flags value may have zero or more of the bits set that are shown in the following table.
C API Function Overview
my_init()
//Initialize global variables, and thread handler in thread-safe programs
mysql_affected_rows()
//Returns the number of rows changed/deleted/inserted by the last UPDATE, DELETE, or INSERT query
//返回被最新的UPDATE, DELETE或INSERT查詢影響的行數。
mysql_autocommit()
//Toggles autocommit mode on/off
mysql_change_user()
//Changes user and database on an open connection
//改變在一個開啟的連線上的使用者和資料庫。
mysql_character_set_name()
// Return default character set name for current connection
mysql_client_find_plugin()
// Return pointer to plugin
mysql_client_register_plugin()
// Register a plugin
mysql_close()
// Closes a server connection
//關閉一個伺服器連線。
mysql_commit()
// Commits the transaction
mysql_connect()
// Connects to a MySQL server (this function is deprecated; use mysql_real_connect() instead)
//連線一個MySQL伺服器。該函式不推薦；使用mysql_real_connect()代替。
mysql_create_db()
// Creates a database (this function is deprecated; use the SQL statement CREATE DATABASE instead)
// 建立一個資料庫。該函式不推薦；而使用SQL命令CREATE DATABASE。
mysql_data_seek()
// Seeks to an arbitrary row number in a query result set
//在一個查詢結果集合中搜尋一任意行。
mysql_debug()
// Does a DBUG_PUSH with the given string
//用給定字串做一個DBUG_PUSH。
mysql_drop_db()
// Drops a database (this function is deprecated; use the SQL statement DROP DATABASE instead)
//拋棄一個資料庫。該函式不推薦；而使用SQL命令DROP DATABASE。
mysql_dump_debug_info()
// Makes the server write debug information to the log
//讓伺服器將除錯資訊寫入日誌檔案。
mysql_eof()
// Determines whether the last row of a result set has been read (this function is deprecated; mysql_errno() or mysql_error() may be used instead)
//確定是否已經讀到一個結果集合的最後一行。這功能被反對; mysql_errno()或mysql_error()可以相反被使用。
mysql_errno()
// Returns the error number for the most recently invoked MySQL function
//返回最近被呼叫的MySQL函式的出錯編號。
mysql_error()
// Returns the error message for the most recently invoked MySQL function
//返回最近被呼叫的MySQL函式的出錯訊息。
mysql_escape_string()
// Escapes special characters in a string for use in an SQL statement
//用在SQL語句中的字串的轉義特殊字元。
mysql_fetch_field()
// Returns the type of the next table field
//返回下一個表欄位的型別。
mysql_fetch_field_direct()
//Returns the type of a table field, given a field number
//返回一個表欄位的型別，給出一個欄位編號。
mysql_fetch_fields()
// Returns an array of all field structures
//返回一個所有欄位結構的陣列。
mysql_fetch_lengths()
// Returns the lengths of all columns in the current row
// /返回當前行中所有列的長度。
mysql_fetch_row()
// Fetches the next row from the result set
//從結果集合中取得下一行。
mysql_field_count()
// Returns the number of result columns for the most recent statement
//返回最近查詢的結果列的數量。
mysql_field_seek()
// Puts the column cursor on a specified column
//把列游標放在一個指定的列上。
mysql_field_tell()
// Returns the position of the field cursor used for the last mysql_fetch_field()
//返回用於最後一個mysql_fetch_field()的欄位游標的位置。
mysql_free_result()
// Frees memory used by a result set
// /釋放一個結果集合使用的記憶體。
mysql_get_character_set_info()
// Return information about default character set
mysql_get_client_info()
// Returns client version information as a string
//返回客戶版本資訊。
mysql_get_client_version()
// Returns client version information as an integer
mysql_get_host_info()
// Returns a string describing the connection
//返回一個描述連線的字串。
mysql_get_proto_info()
// Returns the protocol version used by the connection
//返回連線使用的協議版本。
mysql_get_server_info()
// Returns the server version number
//返回伺服器版本號。
mysql_get_server_version()
// Returns version number of server as an integer
mysql_get_ssl_cipher()
// Return current SSL cipher
mysql_hex_string()
// Encode string in hexadecimal format
mysql_info()
// Returns information about the most recently executed query
//返回關於最近執行得查詢的資訊。
mysql_init()
// Gets or initializes a MYSQL structure
//獲得或初始化一個MYSQL結構。
mysql_insert_id()
// Returns the ID generated for an AUTO_INCREMENT column by the previous query
//返回有前一個查詢為一個AUTO_INCREMENT列生成的ID。
mysql_kill()
// Kills a given thread
//殺死一個給定的執行緒。
mysql_library_end()
// Finalize the MySQL C API library
mysql_library_init()
// Initialize the MySQL C API library
mysql_list_dbs()
// Returns database names matching a simple regular expression
//返回匹配一個簡單的正規表示式的資料庫名。
mysql_list_fields()
// Returns field names matching a simple regular expression
//返回匹配一個簡單的正規表示式的列名。
mysql_list_processes()
// Returns a list of the current server threads
//返回當前伺服器執行緒的一張表。
mysql_list_tables()
// Returns table names matching a simple regular expression
//返回匹配一個簡單的正規表示式的表名。
mysql_load_plugin()
// Load a plugin
mysql_load_plugin_v()
// Load a plugin
mysql_more_results()
// Checks whether any more results exist
mysql_next_result()
//Returns/initiates the next result in multiple-result executions
mysql_num_fields()
// Returns the number of columns in a result set
//返回一個結果集合重的列的數量。
mysql_num_rows()
// Returns the number of rows in a result set
//返回一個結果集合中的行的數量。
mysql_options()
// Sets connect options for mysql_real_connect()
//設定對mysql_connect()的連線選項。
mysql_ping() Checks
// whether the connection to the server is working, reconnecting as necessary
//檢查對伺服器的連線是否正在工作，必要時重新連線。
mysql_plugin_options()
// Set a plugin option
mysql_query()
// Executes an SQL query specified as a null-terminated string
//執行指定為一個空結尾的字串的SQL查詢。
mysql_real_connect()
// Connects to a MySQL server
// 連線一個MySQL伺服器。
mysql_real_escape_string()
// Escapes special characters in a string for use in an SQL statement, taking into account the current character set of the connection
mysql_real_query()
// Executes an SQL query specified as a counted string
//執行指定為帶計數的字串的SQL查詢。
mysql_refresh()
// Flush or reset tables and caches
mysql_reload()
// Tells the server to reload the grant tables
//告訴伺服器重灌授權表。
mysql_rollback()
//Rolls back the transaction
mysql_row_seek()
// Seeks to a row offset in a result set, using value returned from mysql_row_tell()
//搜尋在結果集合中的行，使用從mysql_row_tell()返回的值。
mysql_row_tell()
// Returns the row cursor position
//返回行游標位置。
mysql_select_db()
// Selects a database
//連線一個資料庫。
mysql_server_end()
// Finalize the MySQL C API library
mysql_server_init()
// Initialize the MySQL C API library
mysql_set_character_set()
// Set default character set for current connection
mysql_set_local_infile_default()
// Set the LOAD DATA LOCAL INFILE handler callbacks to their default values
mysql_set_local_infile_handler()
// Install application-specific LOAD DATA LOCAL INFILE handler callbacks
mysql_set_server_option()
// Sets an option for the connection (like multi-statements)
mysql_sqlstate()
// Returns the SQLSTATE error code for the last error
mysql_shutdown()
// Shuts down the database server
//關掉資料庫伺服器。
mysql_ssl_set()
// Prepare to establish SSL connection to server
mysql_stat()
// Returns the server status as a string
//返回作為字串的伺服器狀態。
mysql_store_result()
// Retrieves a complete result set to the client
//檢索一個完整的結果集合給客戶。
mysql_thread_end()
// Finalize thread handler
mysql_thread_id()
// Returns the current thread ID
//返回當前執行緒的ID。
mysql_thread_init()
// Initialize thread handler
mysql_thread_safe()
// Returns 1 if the clients are compiled as thread-safe
mysql_use_result()
// Initiates a row-by-row result set retrieval
//初始化一個一行一行地結果集合的檢索。
mysql_warning_count()
// Returns the warning count for the previous SQL statement