php/doc-en

SQLite3::busyTimeout documentation incomplete

開放

#3,196 建立於 2024年2月19日

 (1 則留言) (2 個反應) (0 位負責人)XML (882 個分叉)auto 404
Extension: sqlite3enhancementgood first issue

倉庫指標

星標
 (596 顆星)
PR 合併指標
 (平均合併 99天 23小時) (30 天內合併 90 個 PR)

描述

From manual page: https://php.net/sqlite3.busytimeout


SQLite3::busyTimeout — Sets the busy connection handler

Sets a busy handler that will sleep until the database is not locked or the timeout is reached.

"busy connection handler" is not adequately explained on the documentation web-page. Is the handler a callback the user must implement? Is it a built-in feature? How do we interact with this handler? What happens if the database is still locked after the timeout? Is an exception thrown? What is the default timeout value? These important details were omitted from this documentation page. Respectfully, please understand that not everyone has the detailed knowledge of SQLite3 or PHP internals to fully understand the PHP source code.

Returns true on success, or false on failure.

This also could be clearer. Does this mean:

"Returns true if timeout is successfully set, or false on failure" ?

Thanks.

貢獻者指南