<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Predefined Constants</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mysqli.persistconns.html">The mysqli Extension and Persistent Connections</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysqli.notes.html">Notes</a></div> <div class="up"><a href="book.mysqli.html">Mysqli</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mysqli.constants" class="appendix"> <h1>Predefined Constants</h1> <p class="simpara"> The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime. </p> <dl> <dt id="constantmysqli-read-default-group"> <span class="term"><strong><code>MYSQLI_READ_DEFAULT_GROUP</code></strong></span> <dd> <p class="para"> Read options from the named group from <var class="filename">my.cnf</var> or the file specified with <strong><code>MYSQLI_READ_DEFAULT_FILE</code></strong> </p> </dd> </dt> <dt id="constantmysqli-read-default-file"> <span class="term"><strong><code>MYSQLI_READ_DEFAULT_FILE</code></strong></span> <dd> <p class="para"> Read options from the named option file instead of from <var class="filename">my.cnf</var> </p> </dd> </dt> <dt id="constantmysqli-opt-connect-timeout"> <span class="term"><strong><code>MYSQLI_OPT_CONNECT_TIMEOUT</code></strong></span> <dd> <p class="para"> Connect timeout in seconds </p> </dd> </dt> <dt id="constantmysqli-opt-local-infile"> <span class="term"><strong><code>MYSQLI_OPT_LOCAL_INFILE</code></strong></span> <dd> <p class="para"> Enables command <em>LOAD LOCAL INFILE</em> </p> </dd> </dt> <dt id="constantmysqli-init-command"> <span class="term"><strong><code>MYSQLI_INIT_COMMAND</code></strong></span> <dd> <p class="para"> Command to execute when connecting to MySQL server. Will automatically be re-executed when reconnecting. </p> </dd> </dt> <dt id="constantmysqli-client-ssl"> <span class="term"><strong><code>MYSQLI_CLIENT_SSL</code></strong></span> <dd> <p class="para"> Use SSL (encrypted protocol). This option should not be set by application programs; it is set internally in the MySQL client library </p> </dd> </dt> <dt id="constantmysqli-client-compress"> <span class="term"><strong><code>MYSQLI_CLIENT_COMPRESS</code></strong></span> <dd> <p class="para"> Use compression protocol </p> </dd> </dt> <dt id="constantmysqli-client-interactive"> <span class="term"><strong><code>MYSQLI_CLIENT_INTERACTIVE</code></strong></span> <dd> <p class="para"> Allow <em>interactive_timeout</em> seconds (instead of <em>wait_timeout</em> seconds) of inactivity before closing the connection. The client's session <em>wait_timeout</em> variable will be set to the value of the session <em>interactive_timeout</em> variable. </p> </dd> </dt> <dt id="constantmysqli-client-ignore-space"> <span class="term"><strong><code>MYSQLI_CLIENT_IGNORE_SPACE</code></strong></span> <dd> <p class="para"> Allow spaces after function names. Makes all functions names reserved words. </p> </dd> </dt> <dt id="constantmysqli-client-no-schema"> <span class="term"><strong><code>MYSQLI_CLIENT_NO_SCHEMA</code></strong></span> <dd> <p class="para"> Don't allow the <em>db_name.tbl_name.col_name</em> syntax. </p> </dd> </dt> <dt id="constantmysqli-client-multi-queries"> <span class="term"><strong><code>MYSQLI_CLIENT_MULTI_QUERIES</code></strong></span> <dd> <p class="para"> Allows multiple semicolon-delimited queries in a single <span class="function"><a href="mysqli.query.html" class="function">mysqli_query()</a></span> call. </p> </dd> </dt> <dt id="constantmysqli-store-result"> <span class="term"><strong><code>MYSQLI_STORE_RESULT</code></strong></span> <dd> <p class="para"> For using buffered resultsets </p> </dd> </dt> <dt id="constantmysqli-use-result"> <span class="term"><strong><code>MYSQLI_USE_RESULT</code></strong></span> <dd> <p class="para"> For using unbuffered resultsets </p> </dd> </dt> <dt id="constantmysqli-assoc"> <span class="term"><strong><code>MYSQLI_ASSOC</code></strong></span> <dd> <p class="para"> Columns are returned into the array having the fieldname as the array index. </p> </dd> </dt> <dt id="constantmysqli-num"> <span class="term"><strong><code>MYSQLI_NUM</code></strong></span> <dd> <p class="para"> Columns are returned into the array having an enumerated index. </p> </dd> </dt> <dt id="constantmysqli-both"> <span class="term"><strong><code>MYSQLI_BOTH</code></strong></span> <dd> <p class="para"> Columns are returned into the array having both a numerical index and the fieldname as the associative index. </p> </dd> </dt> <dt id="constantmysqli-not-null-flag"> <span class="term"><strong><code>MYSQLI_NOT_NULL_FLAG</code></strong></span> <dd> <p class="para"> Indicates that a field is defined as <em>NOT NULL</em> </p> </dd> </dt> <dt id="constantmysqli-pri-key-flag"> <span class="term"><strong><code>MYSQLI_PRI_KEY_FLAG</code></strong></span> <dd> <p class="para"> Field is part of a primary index </p> </dd> </dt> <dt id="constantmysqli-unique-key-flag"> <span class="term"><strong><code>MYSQLI_UNIQUE_KEY_FLAG</code></strong></span> <dd> <p class="para"> Field is part of a unique index. </p> </dd> </dt> <dt id="constantmysqli-multiple-key-flag"> <span class="term"><strong><code>MYSQLI_MULTIPLE_KEY_FLAG</code></strong></span> <dd> <p class="para"> Field is part of an index. </p> </dd> </dt> <dt id="constantmysqli-blob-flag"> <span class="term"><strong><code>MYSQLI_BLOB_FLAG</code></strong></span> <dd> <p class="para"> Field is defined as <em>BLOB</em> </p> </dd> </dt> <dt id="constantmysqli-unsigned-flag"> <span class="term"><strong><code>MYSQLI_UNSIGNED_FLAG</code></strong></span> <dd> <p class="para"> Field is defined as <em>UNSIGNED</em> </p> </dd> </dt> <dt id="constantmysqli-zerofill-flag"> <span class="term"><strong><code>MYSQLI_ZEROFILL_FLAG</code></strong></span> <dd> <p class="para"> Field is defined as <em>ZEROFILL</em> </p> </dd> </dt> <dt id="constantmysqli-auto-increment-flag"> <span class="term"><strong><code>MYSQLI_AUTO_INCREMENT_FLAG</code></strong></span> <dd> <p class="para"> Field is defined as <em>AUTO_INCREMENT</em> </p> </dd> </dt> <dt id="constantmysqli-timestamp-flag"> <span class="term"><strong><code>MYSQLI_TIMESTAMP_FLAG</code></strong></span> <dd> <p class="para"> Field is defined as <em>TIMESTAMP</em> </p> </dd> </dt> <dt id="constantmysqli-set-flag"> <span class="term"><strong><code>MYSQLI_SET_FLAG</code></strong></span> <dd> <p class="para"> Field is defined as <em>SET</em> </p> </dd> </dt> <dt id="constantmysqli-num-flag"> <span class="term"><strong><code>MYSQLI_NUM_FLAG</code></strong></span> <dd> <p class="para"> Field is defined as <em>NUMERIC</em> </p> </dd> </dt> <dt id="constantmysqli-part-key-flag"> <span class="term"><strong><code>MYSQLI_PART_KEY_FLAG</code></strong></span> <dd> <p class="para"> Field is part of an multi-index </p> </dd> </dt> <dt id="constantmysqli-group-flag"> <span class="term"><strong><code>MYSQLI_GROUP_FLAG</code></strong></span> <dd> <p class="para"> Field is part of <em>GROUP BY</em> </p> </dd> </dt> <dt id="constantmysqli-type-decimal"> <span class="term"><strong><code>MYSQLI_TYPE_DECIMAL</code></strong></span> <dd> <p class="para"> Field is defined as <em>DECIMAL</em> </p> </dd> </dt> <dt id="constantmysqli-type-newdecimal"> <span class="term"><strong><code>MYSQLI_TYPE_NEWDECIMAL</code></strong></span> <dd> <p class="para"> Precision math <em>DECIMAL</em> or <em>NUMERIC</em> field (MySQL 5.0.3 and up) </p> </dd> </dt> <dt id="constantmysqli-type-bit"> <span class="term"><strong><code>MYSQLI_TYPE_BIT</code></strong></span> <dd> <p class="para"> Field is defined as <em>BIT</em> (MySQL 5.0.3 and up) </p> </dd> </dt> <dt id="constantmysqli-type-tiny"> <span class="term"><strong><code>MYSQLI_TYPE_TINY</code></strong></span> <dd> <p class="para"> Field is defined as <em>TINYINT</em> </p> </dd> </dt> <dt id="constantmysqli-type-short"> <span class="term"><strong><code>MYSQLI_TYPE_SHORT</code></strong></span> <dd> <p class="para"> Field is defined as <em>SMALLINT</em> </p> </dd> </dt> <dt id="constantmysqli-type-long"> <span class="term"><strong><code>MYSQLI_TYPE_LONG</code></strong></span> <dd> <p class="para"> Field is defined as <em>INT</em> </p> </dd> </dt> <dt id="constantmysqli-type-fload"> <span class="term"><strong><code>MYSQLI_TYPE_FLOAT</code></strong></span> <dd> <p class="para"> Field is defined as <em>FLOAT</em> </p> </dd> </dt> <dt id="constantmysqli-type-double"> <span class="term"><strong><code>MYSQLI_TYPE_DOUBLE</code></strong></span> <dd> <p class="para"> Field is defined as <em>DOUBLE</em> </p> </dd> </dt> <dt id="constantmysqli-type-null"> <span class="term"><strong><code>MYSQLI_TYPE_NULL</code></strong></span> <dd> <p class="para"> Field is defined as <em>DEFAULT NULL</em> </p> </dd> </dt> <dt id="constantmysqli-type-timestamp"> <span class="term"><strong><code>MYSQLI_TYPE_TIMESTAMP</code></strong></span> <dd> <p class="para"> Field is defined as <em>TIMESTAMP</em> </p> </dd> </dt> <dt id="constantmysqli-type-longlong"> <span class="term"><strong><code>MYSQLI_TYPE_LONGLONG</code></strong></span> <dd> <p class="para"> Field is defined as <em>BIGINT</em> </p> </dd> </dt> <dt id="constantmysqli-type-int24"> <span class="term"><strong><code>MYSQLI_TYPE_INT24</code></strong></span> <dd> <p class="para"> Field is defined as <em>MEDIUMINT</em> </p> </dd> </dt> <dt id="constantmysqli-type-date"> <span class="term"><strong><code>MYSQLI_TYPE_DATE</code></strong></span> <dd> <p class="para"> Field is defined as <em>DATE</em> </p> </dd> </dt> <dt id="constantmysqli-type-time"> <span class="term"><strong><code>MYSQLI_TYPE_TIME</code></strong></span> <dd> <p class="para"> Field is defined as <em>TIME</em> </p> </dd> </dt> <dt id="constantmysqli-type-datetime"> <span class="term"><strong><code>MYSQLI_TYPE_DATETIME</code></strong></span> <dd> <p class="para"> Field is defined as <em>DATETIME</em> </p> </dd> </dt> <dt id="constantmysqli-type-year"> <span class="term"><strong><code>MYSQLI_TYPE_YEAR</code></strong></span> <dd> <p class="para"> Field is defined as <em>YEAR</em> </p> </dd> </dt> <dt id="constantmysqli-type-newdate"> <span class="term"><strong><code>MYSQLI_TYPE_NEWDATE</code></strong></span> <dd> <p class="para"> Field is defined as <em>DATE</em> </p> </dd> </dt> <dt id="constantmysqli-type-interval"> <span class="term"><strong><code>MYSQLI_TYPE_INTERVAL</code></strong></span> <dd> <p class="para"> Field is defined as <em>INTERVAL</em> </p> </dd> </dt> <dt id="constantmysqli-type-enum"> <span class="term"><strong><code>MYSQLI_TYPE_ENUM</code></strong></span> <dd> <p class="para"> Field is defined as <em>ENUM</em> </p> </dd> </dt> <dt id="constantmysqli-type-set"> <span class="term"><strong><code>MYSQLI_TYPE_SET</code></strong></span> <dd> <p class="para"> Field is defined as <em>SET</em> </p> </dd> </dt> <dt id="constantmysqli-type-tiny-blob"> <span class="term"><strong><code>MYSQLI_TYPE_TINY_BLOB</code></strong></span> <dd> <p class="para"> Field is defined as <em>TINYBLOB</em> </p> </dd> </dt> <dt id="constantmysqli-type-medium-blob"> <span class="term"><strong><code>MYSQLI_TYPE_MEDIUM_BLOB</code></strong></span> <dd> <p class="para"> Field is defined as <em>MEDIUMBLOB</em> </p> </dd> </dt> <dt id="constantmysqli-type-long-blob"> <span class="term"><strong><code>MYSQLI_TYPE_LONG_BLOB</code></strong></span> <dd> <p class="para"> Field is defined as <em>LONGBLOB</em> </p> </dd> </dt> <dt id="constantmysqli-type-blob"> <span class="term"><strong><code>MYSQLI_TYPE_BLOB</code></strong></span> <dd> <p class="para"> Field is defined as <em>BLOB</em> </p> </dd> </dt> <dt id="constantmysqli-type-var-string"> <span class="term"><strong><code>MYSQLI_TYPE_VAR_STRING</code></strong></span> <dd> <p class="para"> Field is defined as <em>VARCHAR</em> </p> </dd> </dt> <dt id="constantmysqli-type-string"> <span class="term"><strong><code>MYSQLI_TYPE_STRING</code></strong></span> <dd> <p class="para"> Field is defined as <em>CHAR</em> or <em>BINARY</em> </p> </dd> </dt> <dt id="constantmysqli-type-char"> <span class="term"><strong><code>MYSQLI_TYPE_CHAR</code></strong></span> <dd> <p class="para"> Field is defined as <em>TINYINT</em>. For <em>CHAR</em>, see <em>MYSQLI_TYPE_STRING</em> </p> </dd> </dt> <dt id="constantmysqli-type-geometry"> <span class="term"><strong><code>MYSQLI_TYPE_GEOMETRY</code></strong></span> <dd> <p class="para"> Field is defined as <em>GEOMETRY</em> </p> </dd> </dt> <dt id="constantmysqli-need-data"> <span class="term"><strong><code>MYSQLI_NEED_DATA</code></strong></span> <dd> <p class="para"> More data available for bind variable </p> </dd> </dt> <dt id="constantmysqli-no-data"> <span class="term"><strong><code>MYSQLI_NO_DATA</code></strong></span> <dd> <p class="para"> No more data available for bind variable </p> </dd> </dt> <dt id="constantmysqli-data-truncated"> <span class="term"><strong><code>MYSQLI_DATA_TRUNCATED</code></strong></span> <dd> <p class="para"> Data truncation occurred. Available since PHP 5.1.0 and MySQL 5.0.5. </p> </dd> </dt> <dt id="constantmysqli-enum-flag"> <span class="term"><strong><code>MYSQLI_ENUM_FLAG</code></strong></span> <dd> <p class="para"> Field is defined as <em>ENUM</em>. Available since PHP 5.3.0. </p> </dd> </dt> <dt id="constantmysqli-binary-flag"> <span class="term"><strong><code>MYSQLI_BINARY_FLAG</code></strong></span> <dd> <p class="para"> Field is defined as <em>BINARY</em>. Available since PHP 5.3.0. </p> </dd> </dt> <dt id="constantmysqli-cursor-type-for-update"> <span class="term"><strong><code>MYSQLI_CURSOR_TYPE_FOR_UPDATE</code></strong></span> <dd> <p class="para"> </p> </dd> </dt> <dt id="constantmysqli-cursor-type-no-cursor"> <span class="term"><strong><code>MYSQLI_CURSOR_TYPE_NO_CURSOR</code></strong></span> <dd> <p class="para"> </p> </dd> </dt> <dt id="constantmysqli-cursor-type-read-only"> <span class="term"><strong><code>MYSQLI_CURSOR_TYPE_READ_ONLY</code></strong></span> <dd> <p class="para"> </p> </dd> </dt> <dt id="constantmysqli-cursor-type-scrollable"> <span class="term"><strong><code>MYSQLI_CURSOR_TYPE_SCROLLABLE</code></strong></span> <dd> <p class="para"> </p> </dd> </dt> <dt id="constantmysqli-stmt-attr-cursor-type"> <span class="term"><strong><code>MYSQLI_STMT_ATTR_CURSOR_TYPE</code></strong></span> <dd> <p class="para"> </p> </dd> </dt> <dt id="constantmysqli-stmt-attr-prefetch-rows"> <span class="term"><strong><code>MYSQLI_STMT_ATTR_PREFETCH_ROWS</code></strong></span> <dd> <p class="para"> </p> </dd> </dt> <dt id="constantmysqli-stmt-attr-update-max-length"> <span class="term"><strong><code>MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH</code></strong></span> <dd> <p class="para"> </p> </dd> </dt> <dt id="constantmysqli-set-charset-name"> <span class="term"><strong><code>MYSQLI_SET_CHARSET_NAME</code></strong></span> <dd> <p class="para"> </p> </dd> </dt> <dt id="constantmysqli-report-index"> <span class="term"><strong><code>MYSQLI_REPORT_INDEX</code></strong></span> <dd> <p class="para"> Report if no index or bad index was used in a query. </p> </dd> </dt> <dt id="constantmysqli-report-error"> <span class="term"><strong><code>MYSQLI_REPORT_ERROR</code></strong></span> <dd> <p class="para"> Report errors from mysqli function calls. </p> </dd> </dt> <dt id="constantmysqli-report-strict"> <span class="term"><strong><code>MYSQLI_REPORT_STRICT</code></strong></span> <dd> <p class="para"> Throw a <em>mysqli_sql_exception</em> for errors instead of warnings. </p> </dd> </dt> <dt id="constantmysqli-report-all"> <span class="term"><strong><code>MYSQLI_REPORT_ALL</code></strong></span> <dd> <p class="para"> Set all options on (report all). </p> </dd> </dt> <dt id="constantmysqli-report-off"> <span class="term"><strong><code>MYSQLI_REPORT_OFF</code></strong></span> <dd> <p class="para"> Turns reporting off. </p> </dd> </dt> <dt id="constantmysqli-debug-trace-enabled"> <span class="term"><strong><code>MYSQLI_DEBUG_TRACE_ENABLED</code></strong></span> <dd> <p class="para"> Is set to 1 if <span class="function"><a href="mysqli.debug.html" class="function">mysqli_debug()</a></span> functionality is enabled. </p> </dd> </dt> <dt id="constantmysqli-server-query-no-good-index-used"> <span class="term"><strong><code>MYSQLI_SERVER_QUERY_NO_GOOD_INDEX_USED</code></strong></span> <dd> <p class="para"> </p> </dd> </dt> <dt id="constantmysqli-server-query-no-index-used"> <span class="term"><strong><code>MYSQLI_SERVER_QUERY_NO_INDEX_USED</code></strong></span> <dd> <p class="para"> </p> </dd> </dt> <dt id="constantmysqli-refresh-grant"> <span class="term"><strong><code>MYSQLI_REFRESH_GRANT</code></strong></span> <dd> <p class="para"> Refreshes the grant tables. </p> </dd> </dt> <dt id="constantmysqli-refresh-log"> <span class="term"><strong><code>MYSQLI_REFRESH_LOG</code></strong></span> <dd> <p class="para"> Flushes the logs, like executing the <em>FLUSH LOGS</em> <acronym>SQL</acronym> statement. </p> </dd> </dt> <dt id="constantmysqli-refresh-tables"> <span class="term"><strong><code>MYSQLI_REFRESH_TABLES</code></strong></span> <dd> <p class="para"> Flushes the table cache, like executing the <em>FLUSH TABLES</em> <acronym>SQL</acronym> statement. </p> </dd> </dt> <dt id="constantmysqli-refresh-hosts"> <span class="term"><strong><code>MYSQLI_REFRESH_HOSTS</code></strong></span> <dd> <p class="para"> Flushes the host cache, like executing the <em>FLUSH HOSTS</em> <acronym>SQL</acronym> statement. </p> </dd> </dt> <dt id="constantmysqli-refresh-status"> <span class="term"><strong><code>MYSQLI_REFRESH_STATUS</code></strong></span> <dd> <p class="para"> Reset the status variables, like executing the <em>FLUSH STATUS</em> <acronym>SQL</acronym> statement. </p> </dd> </dt> <dt id="constantmysqli-refresh-threads"> <span class="term"><strong><code>MYSQLI_REFRESH_THREADS</code></strong></span> <dd> <p class="para"> Flushes the thread cache. </p> </dd> </dt> <dt id="constantmysqli-refresh-slave"> <span class="term"><strong><code>MYSQLI_REFRESH_SLAVE</code></strong></span> <dd> <p class="para"> On a slave replication server: resets the master server information, and restarts the slave. Like executing the <em>RESET SLAVE</em> <acronym>SQL</acronym> statement. </p> </dd> </dt> <dt id="constantmysqli-refresh-master"> <span class="term"><strong><code>MYSQLI_REFRESH_MASTER</code></strong></span> <dd> <p class="para"> On a master replication server: removes the binary log files listed in the binary log index, and truncates the index file. Like executing the <em>RESET MASTER</em> <acronym>SQL</acronym> statement. </p> </dd> </dt> <dt id="constantmysqli-trans-cor-and-chain"> <span class="term"><strong><code>MYSQLI_TRANS_COR_AND_CHAIN</code></strong></span> <dd> <p class="para"> Appends "AND CHAIN" to <span class="function"><a href="mysqli.commit.html" class="function">mysqli_commit()</a></span> or <span class="function"><a href="mysqli.rollback.html" class="function">mysqli_rollback()</a></span>. </p> </dd> </dt> <dt id="constantmysqli-trans-cor-and-no-chain"> <span class="term"><strong><code>MYSQLI_TRANS_COR_AND_NO_CHAIN</code></strong></span> <dd> <p class="para"> Appends "AND NO CHAIN" to <span class="function"><a href="mysqli.commit.html" class="function">mysqli_commit()</a></span> or <span class="function"><a href="mysqli.rollback.html" class="function">mysqli_rollback()</a></span>. </p> </dd> </dt> <dt id="constantmysqli-trans-cor-release"> <span class="term"><strong><code>MYSQLI_TRANS_COR_RELEASE</code></strong></span> <dd> <p class="para"> Appends "RELEASE" to <span class="function"><a href="mysqli.commit.html" class="function">mysqli_commit()</a></span> or <span class="function"><a href="mysqli.rollback.html" class="function">mysqli_rollback()</a></span>. </p> </dd> </dt> <dt id="constantmysqli-trans-cor-no-release"> <span class="term"><strong><code>MYSQLI_TRANS_COR_NO_RELEASE</code></strong></span> <dd> <p class="para"> Appends "NO RELEASE" to <span class="function"><a href="mysqli.commit.html" class="function">mysqli_commit()</a></span> or <span class="function"><a href="mysqli.rollback.html" class="function">mysqli_rollback()</a></span>. </p> </dd> </dt> </dl> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mysqli.persistconns.html">The mysqli Extension and Persistent Connections</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysqli.notes.html">Notes</a></div> <div class="up"><a href="book.mysqli.html">Mysqli</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>