Skip to content

Commit 4d2f1a6

Browse files
author
César Román
committed
docs(db): fix docstrings
Signed-off-by: César Román <[email protected]>
1 parent 2562208 commit 4d2f1a6

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

Diff for: src/incendium/db.py

+14-6
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,8 @@ def execute_non_query(
309309
connection will be used. Optional.
310310
transaction: A transaction identifier. If omitted, the call will
311311
be executed in its own transaction. Optional.
312-
params: A Dictionary containing all INPUT parameters. Optional.
312+
params: A list containing all INPUT parameters as InParam
313+
objects. Optional.
313314
314315
Returns:
315316
The number of rows modified by the stored procedure, or -1 if
@@ -339,7 +340,8 @@ def get_data(
339340
database: The name of the database connection to execute
340341
against. If omitted or "", the project's default database
341342
connection will be used. Optional.
342-
params: A Dictionary containing all INPUT parameters. Optional.
343+
params: A list containing all INPUT parameters as InParam
344+
objects. Optional.
343345
344346
Returns:
345347
A Dataset that is the resulting data of the stored procedure
@@ -367,16 +369,21 @@ def get_output_params(
367369
368370
Args:
369371
stored_procedure: The name of the stored procedure to execute.
370-
output: A Dictionary containing all OUTPUT parameters.
372+
output: A list containing all OUTPUT parameters as OutParam
373+
objects.
371374
database: The name of the database connection to execute
372375
against. If omitted or "", the project's default database
373376
connection will be used. Optional.
374377
transaction: A transaction identifier. If omitted, the call will
375378
be executed in its own transaction. Optional.
376-
params: A Dictionary containing all INPUT parameters. Optional.
379+
params: A list containing all INPUT parameters as InParam
380+
objects. Optional.
381+
get_update_count: A flag indicating whether to return the number
382+
of rows modified by the stored procedure, or -1 if not
383+
applicable. Defaults to False. Optional.
377384
378385
Returns:
379-
Result's output_params.
386+
A Python dictionary of OUTPUT paramaters.
380387
"""
381388
result = _execute_sp(
382389
stored_procedure,
@@ -408,7 +415,8 @@ def get_return_value(
408415
connection will be used. Optional.
409416
transaction: A transaction identifier. If omitted, the call will
410417
be executed in its own transaction. Optional.
411-
params: A Dictionary containing all INPUT parameters. Optional.
418+
params: A list containing all INPUT parameters as InParam
419+
objects. Optional.
412420
413421
Returns:
414422
The return value.

0 commit comments

Comments
 (0)