Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SQLite3::busyTimeout documentation incomplete #3196

Open
willbprog127 opened this issue Feb 19, 2024 · 0 comments
Open

SQLite3::busyTimeout documentation incomplete #3196

willbprog127 opened this issue Feb 19, 2024 · 0 comments
Labels
enhancement New feature or request Extension: sqlite3

Comments

@willbprog127
Copy link

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.

@Girgias Girgias added enhancement New feature or request Extension: sqlite3 labels Feb 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Extension: sqlite3
Projects
None yet
Development

No branches or pull requests

2 participants