php/doc-en

SQLite3::busyTimeout documentation incomplete

Aberta

#3.196 aberto em 19 de fev. de 2024

 (1 comentário) (2 reações) (0 responsável)XML (882 forks)auto 404
Extension: sqlite3enhancementgood first issue

Métricas do repositório

Stars
 (596 estrelas)
Métricas de merge de PR
 (Mesclagem média 99d 23h) (90 fundiu PRs em 30d)

Description

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.

Guia do colaborador