From 4d2f1a64c4c24f871908122c2d3d6590a166d81f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9sar=20Rom=C3=A1n?= Date: Fri, 2 Sep 2022 18:08:18 -0700 Subject: [PATCH] docs(db): fix docstrings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: César Román --- src/incendium/db.py | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/src/incendium/db.py b/src/incendium/db.py index 81b4cf0..c9218f1 100644 --- a/src/incendium/db.py +++ b/src/incendium/db.py @@ -309,7 +309,8 @@ def execute_non_query( connection will be used. Optional. transaction: A transaction identifier. If omitted, the call will be executed in its own transaction. Optional. - params: A Dictionary containing all INPUT parameters. Optional. + params: A list containing all INPUT parameters as InParam + objects. Optional. Returns: The number of rows modified by the stored procedure, or -1 if @@ -339,7 +340,8 @@ def get_data( database: The name of the database connection to execute against. If omitted or "", the project's default database connection will be used. Optional. - params: A Dictionary containing all INPUT parameters. Optional. + params: A list containing all INPUT parameters as InParam + objects. Optional. Returns: A Dataset that is the resulting data of the stored procedure @@ -367,16 +369,21 @@ def get_output_params( Args: stored_procedure: The name of the stored procedure to execute. - output: A Dictionary containing all OUTPUT parameters. + output: A list containing all OUTPUT parameters as OutParam + objects. database: The name of the database connection to execute against. If omitted or "", the project's default database connection will be used. Optional. transaction: A transaction identifier. If omitted, the call will be executed in its own transaction. Optional. - params: A Dictionary containing all INPUT parameters. Optional. + params: A list containing all INPUT parameters as InParam + objects. Optional. + get_update_count: A flag indicating whether to return the number + of rows modified by the stored procedure, or -1 if not + applicable. Defaults to False. Optional. Returns: - Result's output_params. + A Python dictionary of OUTPUT paramaters. """ result = _execute_sp( stored_procedure, @@ -408,7 +415,8 @@ def get_return_value( connection will be used. Optional. transaction: A transaction identifier. If omitted, the call will be executed in its own transaction. Optional. - params: A Dictionary containing all INPUT parameters. Optional. + params: A list containing all INPUT parameters as InParam + objects. Optional. Returns: The return value.