Is there some way to get the number of rows deleted by a query builder's delete method?

[jfly]

Is your feature request related to a problem?

The query builder docs mention a delete method: https://orm.masoniteproject.com/query-builder#deletes, but I don't see any way of figuring out how many rows were affected by that delete.

What do we currently have to do now?

Right now, I'm turning around and immediately doing a SELECT ROW_COUNT() query, which may be a MySQL specific solution.

Describe the solution you'd like

It would be nice to have a standard way of fetching the number of rows affected by the delete. Perhaps delete() could return the count of deleted rows? I'm not sure if that would count as a breaking change or not. The docs don't seem to mention what delete returns, but the implementation clearly does return... something:

orm/src/masoniteorm/query/QueryBuilder.py

Lines 530 to 565 in 685a304

	def delete(self, column=None, value=None, query=False):
	"""Specify the column and value to delete
	or deletes everything based on a previously used where expression.
	Keyword Arguments:
	column {string} -- The name of the column (default: {None})
	value {string|int} -- The value of the column (default: {None})
	Returns:
	self
	"""
	model = None
	self.set_action("delete")
	if self._model:
	model = self._model
	if column and value:
	if isinstance(value, (list, tuple)):
	self.where_in(column, value)
	else:
	self.where(column, value)
	if query:
	return self
	if model and model.is_loaded():
	self.where(model.get_primary_key(), model.get_primary_key_value())
	self.observe_events(model, "deleting")
	result = self.new_connection().query(self.to_qmark(), self._bindings)
	if model:
	self.observe_events(model, "deleted")
	return result

, although the docstring disagrees with the implementation: the docstring says it returns self, when it actually returns the result of self.new_connection().query...

Describe alternatives you've considered

No response

Would this be a breaking change ?

• Yes

Anything else ?

No response

[girardinsamuel]

I will let @josephmancuso answer this one.

In the meantime, could you move this issue to Masonite ORM repository ? This question belongs there. In the future it will help people with the same questions finding the answer there. 🙏

[jfly]

Oops, sorry! Reading through https://docs.github.com/en/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository, I don't think I have the power to transfer this issue. I can close this and open a new issue of you like. Or perhaps you or another admin could transfer the issue?

[josephmancuso]

Theres currently no way to do this now but it COULD be possible by getting the values from the databases cursor object

[josephmancuso]

I would assume this would be a breaking change though if we changed the delete method to return the number of rows affected

[stoutput]

Yes, for a pymysql connection you could use something like: connection.get_cursor().rowcount

[josephmancuso]

I will work on this one but it won't be available until Masonite ORM 3 around September since this is changing existing functionality in a way that could not be backwards compatable

[josephmancuso]

This wil also be a bit tricky because the SoftDeleteMixin changes the DELETE to an UPDATE. so will need to figure out how to get the results for an update clause as well