Opened 10 years ago

Closed 7 years ago

Last modified 7 years ago

#23766 closed Cleanup/optimization (fixed)

Documentation and tests for cursor.callproc()

Reported by: Shai Berger Owned by: Mariusz Felisiak
Component: Database layer (models, ORM) Version: dev
Severity: Normal Keywords:
Cc: averybigant Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


This is a spin off #23546 -- actually, a requirement for that ticket.

Quoting my message to -developers on the subject (the thread trails off to discussions of higher-level interfaces, but the following seems to be in consensus):

For a very long time -- as far as I'm aware, forever -- we've had, in our cursor classes, a callproc() method that follows the callproc() definition of pep249; this allows database stored procedures to be called.

Recently [...] we found that

  1. cursor.callproc() is not documented
  2. cursor.callproc() is not tested (except for one Oracle-specific test that uses it to test something else)

Which means, essentially, that it is treated as an intenal API.

I see no reason that we shouldn't make it public.

Change History (7)

comment:1 by Michael Manfre, 10 years ago

Triage Stage: UnreviewedAccepted

Agreed. This should be documented and tested.

comment:2 by Mariusz Felisiak, 7 years ago

Owner: changed from nobody to Mariusz Felisiak
Status: newassigned

comment:3 by Mariusz Felisiak, 7 years ago

I would like to resolve this issue, but it seems that we don't have appropriate place for cursor.callproc in the documentation. Any suggestions?

comment:4 by Tim Graham, 7 years ago

Perhaps near the Connections and cursors section? Anyway, getting a draft of the content is most of the work; it can be moved if needed.

comment:5 by GitHub <noreply@…>, 7 years ago

In 3189a93c:

Refs #23766 -- Added tests for CursorWrapper.callproc().

Thanks Tim Graham for the review.

comment:6 by GitHub <noreply@…>, 7 years ago

Resolution: fixed
Status: assignedclosed

In 660d5080:

Fixed #23766 -- Doc'd CursorWrapper.callproc().

Thanks Tim Graham for the review.

comment:7 by Mariusz Felisiak <felisiak.mariusz@…>, 7 years ago

In fe51017e:

[1.11.x] Fixed #23766 -- Doc'd CursorWrapper.callproc().

Thanks Tim Graham for the review.
Backport of 660d50805b6788d592b4f1fae706b725baf0195c from master

Note: See TracTickets for help on using tickets.
Back to Top