SQLite3Stmt::setExplain

(PHP 8 >= 8.5.0)

SQLite3Stmt::setExplain — Changes the explain mode of the statement

Description

public function 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

Returns true on success or false on failure.

Errors/Exceptions

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

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.