php8.5
Home/ Manual/ sqlite3 / sqlite3stmt/ SQLite3Stmt::setExplain

SQLite3Stmt::setExplain

PHP function Edit on GitHub ✎

(PHP 8 >= 8.5.0)

Changes the explain mode of the statement

Description

SQLite3Stmt::setExplain(int $mode): bool

Changes the explain mode of the statement, so that it behaves as if its SQL was prefixed with EXPLAIN or EXPLAIN QUERY PLAN, or as an ordinary statement again.

Parameters

mode

One of SQLite3Stmt::EXPLAIN_MODE_PREPARED, SQLite3Stmt::EXPLAIN_MODE_EXPLAIN, or SQLite3Stmt::EXPLAIN_MODE_EXPLAIN_QUERY_PLAN.

Return Values

Success

Errors/Exceptions

A ValueError is thrown if mode is not one of the SQLite3Stmt::EXPLAIN_MODE_* constants.

See Also

  • SQLite3Stmt::explain
  • SQLite3Stmt::execute

Source: reference/sqlite3/sqlite3stmt/setexplain.xml · from the official PHP manual (php/doc-en)