We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 6780772 commit 96db359Copy full SHA for 96db359
1 file changed
src/DatabaseLibrary/query.py
@@ -34,8 +34,12 @@ def query(
34
parameters: Optional[List] = None,
35
):
36
"""
37
- Uses the input ``selectStatement`` to query for the values that will be returned as a list of tuples.
38
- Set optional input ``returnAsDict`` to True to return values as a list of dictionaries.
+ Runs a query with the ``selectStatement`` and returns the result as a list of rows.
+ The type of row values depends on the database module -
39
+ usually they are tuples or tuple-like objects.
40
+
41
+ Set optional input ``returnAsDict`` to _True_ to explicitely convert the return values
42
+ into a list of dictionaries.
43
44
Use optional ``alias`` parameter to specify what connection should be used for the query if you have more
45
than one connection open.
0 commit comments