Opened 21 months ago

Last modified 7 months ago

#34636 assigned New feature

Add documentation for Query's function `sql_with_params`

Reported by: Paolo Melchiorre Owned by: Alex
Component: Database layer (models, ORM) Version: dev
Severity: Normal Keywords: async, orm, sql, params, documentation
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no
Pull Requests:How to create a pull request

Description

The sql_with_params Query's function can be very useful to generate SQL code and params for asynchronous execution, so it will be very useful to explicitly document it.

According to the ticket's flags, the next step(s) to move this issue forward are:

  • To provide a patch by sending a pull request. Claim the ticket when you start working so that someone else doesn't duplicate effort. Before sending a pull request, review your work against the patch review checklist. Check the "Has patch" flag on the ticket after sending a pull request and include a link to the pull request in the ticket comment when making that update. The usual format is: [https://github.com/django/django/pull/#### PR].

Change History (3)

comment:1 by Mariusz Felisiak, 21 months ago

Resolution: wontfix
Status: newclosed

Thanks for the ticket, however, we don't want to encourage users to use raw SQL queries.

comment:2 by Simon Charette, 7 months ago

Resolution: wontfix
Status: closednew
Triage Stage: UnreviewedAccepted

Re-opening per these discussions.

A point that was brought up is that we should likely allow alias to be passed to sql_with_params to be truly useful in multi-db setups.

comment:3 by Alex, 7 months ago

Owner: changed from nobody to Alex
Status: newassigned
Note: See TracTickets for help on using tickets.
Back to Top