Skip to content

Throw error when mysql_stmt_data_seek fails #10419

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kamil-tekiela
Copy link
Member

According to the MySQL standard mysql_stmt_data_seek should be a void function, but in mysqlnd it was always returning bool. In this case, it makes sense to check for an error condition and inform the mysqli user about incorrect usage.
The only time this function returns false is if it's used on PS without a buffered result set, hence the text of the error message.

Copy link
Member

@cmb69 cmb69 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! Since this is a programmer error, it makes sense to throw an Exception, but that might be too strong to introduce in a minor version. What happens currently in this case? Just nothing?

@@ -1513,7 +1513,10 @@ PHP_FUNCTION(mysqli_stmt_data_seek)

MYSQLI_FETCH_RESOURCE_STMT(stmt, mysql_stmt, MYSQLI_STATUS_VALID);

mysql_stmt_data_seek(stmt->stmt, offset);
if (mysql_stmt_data_seek(stmt->stmt, offset)) {
zend_throw_error(NULL, "The result set buffer is empty");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure about the wording; is there even a buffer in this case. Maybe "Result set is not buffered" (or something like that) gives a better clue about what's wrong.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, currently nothing happens. This is because until now we supported libmysql, which as stated above has this function implemented as void. Now, we are no longer limited by libmysql and we can start throwing an error.
I could also change this to a warning, but I don't see this happening very often and I don't it would be too much to have an error here.

In regards to the text, I wanted to find something rather vague. The error could happen because someone forgot to call store_result(), the PS has only been prepared but not yet executed, or the PS didn't produce any result set. Your suggestion fits the first reason, but not so much the rest. I welcome some brainstorming here.

@kamil-tekiela
Copy link
Member Author

Could I ask for additional opinions on this PR so it can land in 8.3? @bukka @ericmann @adoy

@bukka
Copy link
Member

bukka commented Aug 24, 2023

I think it's too late for 8.3 as we are well past feature freeze and this is behaviour changes that should at least be emailed to internals. I think it makes sense to do it but might be better to target 8.4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants