From c044109e6e85535ef9604a43b26fa87a07b833ed Mon Sep 17 00:00:00 2001
From: Andre Mochinin <35140131+amochin@users.noreply.github.com>
Date: Fri, 27 Sep 2024 12:49:49 +0200
Subject: [PATCH] Allow custom params for keyword "Connect To Database" (#220)

The entire connection logic and implementation was refactored

* There is only one mandatory parameter left - dbapiModuleName, it must be set - either as keyword argument or in config file.
* All other parameters are optional now. So if some connection data was missing, the error would come not from the Database Library, but from the Python DB module.
* If some params are not provided, they are not set to None - they are just not passed to the Python DB module at all.
* Other custom params from keyword arguments and config file are passed to the Python DB module as provided
* All parameters can be now set in a config file - including any custom params
* If same custom parameter is provided both as a keyword argument and in config file, the keyword argument value takes precedence.

Other changes

* Deprecate the Connect To Database Using Custom Params Keyword - it's not needed anymore, the updated Connect To Database keyword replaces it fully
* Stop using localhost as fallback value for DB host
* Stop using {SQL Server} as fallback value for pyodbc driver
* Update docs for the Connect To Database keyword, move docs for using the config file in a separate section
---
 doc/index.html                                |  51 ++-
 src/DatabaseLibrary/__init__.py               |  49 +++
 src/DatabaseLibrary/connection_manager.py     | 384 +++++++++++-------
 test/resources/common.resource                |  19 +-
 .../config_files/connect_config_file.resource |  11 +
 .../oracledb/custom_param_password.cfg        |   6 +
 .../oracledb/invalid_custom_params.cfg        |   8 +
 .../oracledb/simple_default_alias.cfg         |   8 +
 .../oracledb/some_basic_params_missing.cfg    |   3 +
 .../config_files/oracledb/thick_mode.cfg      |   8 +
 .../oracledb/valid_custom_params.cfg          |   7 +
 .../config_files/oracledb/wrong_password.cfg  |   7 +
 .../psycopg2/custom_param_password.cfg        |   6 +
 .../psycopg2/invalid_custom_params.cfg        |   8 +
 .../psycopg2/simple_default_alias.cfg         |   7 +
 .../psycopg2/some_basic_params_missing.cfg    |   3 +
 .../psycopg2/valid_custom_params.cfg          |   7 +
 .../config_files/psycopg2/wrong_password.cfg  |   7 +
 .../config_files/pymssql/charset_invalid.cfg  |   8 +
 .../pymssql/custom_param_password.cfg         |   6 +
 .../pymssql/invalid_custom_params.cfg         |   8 +
 .../pymssql/simple_default_alias.cfg          |   7 +
 .../pymssql/some_basic_params_missing.cfg     |   3 +
 .../pymssql/valid_custom_params.cfg           |   7 +
 .../config_files/pymssql/wrong_password.cfg   |   7 +
 .../config_files/pymysql/charset_invalid.cfg  |   8 +
 .../pymysql/custom_param_password.cfg         |   6 +
 .../pymysql/invalid_custom_params.cfg         |   8 +
 .../pymysql/simple_default_alias.cfg          |   7 +
 .../pymysql/some_basic_params_missing.cfg     |   3 +
 .../pymysql/valid_custom_params.cfg           |   7 +
 .../config_files/pymysql/wrong_password.cfg   |   7 +
 .../config_files/pyodbc/charset_invalid.cfg   |   9 +
 .../pyodbc/custom_param_password.cfg          |   7 +
 .../pyodbc/invalid_custom_params.cfg          |   9 +
 .../pyodbc/simple_default_alias.cfg           |   8 +
 .../pyodbc/some_basic_params_missing.cfg      |   3 +
 .../pyodbc/valid_custom_params.cfg            |   8 +
 .../config_files/pyodbc/wrong_password.cfg    |   8 +
 .../sqlite3/simple_default_alias.cfg          |   4 +
 .../common_tests/connection_params.robot      | 171 ++++++++
 test/tests/utests/test_connection_manager.py  |  15 +-
 42 files changed, 749 insertions(+), 184 deletions(-)
 create mode 100644 test/resources/config_files/connect_config_file.resource
 create mode 100644 test/resources/config_files/oracledb/custom_param_password.cfg
 create mode 100644 test/resources/config_files/oracledb/invalid_custom_params.cfg
 create mode 100644 test/resources/config_files/oracledb/simple_default_alias.cfg
 create mode 100644 test/resources/config_files/oracledb/some_basic_params_missing.cfg
 create mode 100644 test/resources/config_files/oracledb/thick_mode.cfg
 create mode 100644 test/resources/config_files/oracledb/valid_custom_params.cfg
 create mode 100644 test/resources/config_files/oracledb/wrong_password.cfg
 create mode 100644 test/resources/config_files/psycopg2/custom_param_password.cfg
 create mode 100644 test/resources/config_files/psycopg2/invalid_custom_params.cfg
 create mode 100644 test/resources/config_files/psycopg2/simple_default_alias.cfg
 create mode 100644 test/resources/config_files/psycopg2/some_basic_params_missing.cfg
 create mode 100644 test/resources/config_files/psycopg2/valid_custom_params.cfg
 create mode 100644 test/resources/config_files/psycopg2/wrong_password.cfg
 create mode 100644 test/resources/config_files/pymssql/charset_invalid.cfg
 create mode 100644 test/resources/config_files/pymssql/custom_param_password.cfg
 create mode 100644 test/resources/config_files/pymssql/invalid_custom_params.cfg
 create mode 100644 test/resources/config_files/pymssql/simple_default_alias.cfg
 create mode 100644 test/resources/config_files/pymssql/some_basic_params_missing.cfg
 create mode 100644 test/resources/config_files/pymssql/valid_custom_params.cfg
 create mode 100644 test/resources/config_files/pymssql/wrong_password.cfg
 create mode 100644 test/resources/config_files/pymysql/charset_invalid.cfg
 create mode 100644 test/resources/config_files/pymysql/custom_param_password.cfg
 create mode 100644 test/resources/config_files/pymysql/invalid_custom_params.cfg
 create mode 100644 test/resources/config_files/pymysql/simple_default_alias.cfg
 create mode 100644 test/resources/config_files/pymysql/some_basic_params_missing.cfg
 create mode 100644 test/resources/config_files/pymysql/valid_custom_params.cfg
 create mode 100644 test/resources/config_files/pymysql/wrong_password.cfg
 create mode 100644 test/resources/config_files/pyodbc/charset_invalid.cfg
 create mode 100644 test/resources/config_files/pyodbc/custom_param_password.cfg
 create mode 100644 test/resources/config_files/pyodbc/invalid_custom_params.cfg
 create mode 100644 test/resources/config_files/pyodbc/simple_default_alias.cfg
 create mode 100644 test/resources/config_files/pyodbc/some_basic_params_missing.cfg
 create mode 100644 test/resources/config_files/pyodbc/valid_custom_params.cfg
 create mode 100644 test/resources/config_files/pyodbc/wrong_password.cfg
 create mode 100644 test/resources/config_files/sqlite3/simple_default_alias.cfg
 create mode 100644 test/tests/common_tests/connection_params.robot

diff --git a/doc/index.html b/doc/index.html
index 3e685f3..bed2160 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -6,9 +6,9 @@
 <meta http-equiv="Pragma" content="no-cache">
 <meta http-equiv="Expires" content="-1">
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
-<meta content="Robot Framework 6.1.1 (Python 3.11.4 on darwin)" name="Generator">
+<meta content="Robot Framework 7.0.1 (Python 3.12.4 on darwin)" name="Generator">
 <link rel="icon" type="image/x-icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKcAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAAqAAAAAAAAAAAAAAAAAAAALIAAAD/AAAA4AAAANwAAADcAAAA3AAAANwAAADcAAAA3AAAANwAAADcAAAA4AAAAP8AAACxAAAAAAAAAKYAAAD/AAAAuwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAC/AAAA/wAAAKkAAAD6AAAAzAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN8AAAD/AAAA+gAAAMMAAAAAAAAAAgAAAGsAAABrAAAAawAAAGsAAABrAAAAawAAAGsAAABrAAAADAAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAAIsAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAANEAAAAAAAAA2gAAAP8AAAD6AAAAwwAAAAAAAAAAAAAAMgAAADIAAAAyAAAAMgAAADIAAAAyAAAAMgAAADIAAAAFAAAAAAAAANoAAAD/AAAA+gAAAMMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAADwAAAB8AAAAAAAAAGAAAABcAAAAAAAAAH8AAABKAAAAAAAAAAAAAAAAAAAA2gAAAP8AAAD6AAAAwwAAAAAAAADCAAAA/wAAACkAAADqAAAA4QAAAAAAAAD7AAAA/wAAALAAAAAGAAAAAAAAANoAAAD/AAAA+gAAAMMAAAAAAAAAIwAAAP4AAAD/AAAA/wAAAGAAAAAAAAAAAAAAAMkAAAD/AAAAigAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAAAAAAAAIAAAAcAAAABkAAAAAAAAAAAAAAAAAAAAAAAAAEgAAAAAAAAAAAAAA2gAAAP8AAAD7AAAAywAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN4AAAD/AAAAqwAAAP8AAACvAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAALIAAAD/AAAAsgAAAAAAAAC5AAAA/wAAAMoAAADAAAAAwAAAAMAAAADAAAAAwAAAAMAAAADAAAAAwAAAAMkAAAD/AAAAvAAAAAAAAAAAAAAAAAAAAKwAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAArQAAAAAAAAAAwAMAAIABAAAf+AAAP/wAAD/8AAAgBAAAP/wAAD/8AAA//AAAJIwAADHEAAA//AAAP/wAAB/4AACAAQAAwAMAAA==">
-<style media="all" type="text/css">
+<style media="all">
 :root {
     --background-color: white;
     --text-color: black;
@@ -253,6 +253,7 @@
 }
 .arguments-list-container {
     overflow-y: auto;
+    margin-bottom: 1.33rem;
 }
 .arguments-list {
     display: -ms-inline-grid;
@@ -294,7 +295,8 @@
     display: flex;
     min-width: 150px;
 }
-.arguments-list .arg-type {
+.arguments-list .arg-type,
+.return-type .arg-type {
     margin-left: 2rem;
     -ms-grid-column: 3;
     grid-column: 3;
@@ -302,6 +304,10 @@
     white-space: nowrap;
     -webkit-text-size-adjust: none;
 }
+.tags .kw-tags {
+    margin-left: 2rem;
+    display: flex;
+}
 .arguments-list .arg-kind {
   color: transparent;
   text-shadow: 0 0 0 var(--less-important-text-color);
@@ -511,6 +517,7 @@
 }
 .enum-type-members span,
 .args span,
+.return-type span,
 .args a
  {
     font-family: monospace;
@@ -546,7 +553,7 @@
     background: var(--highlighted-background-color);
     color: var(--highlighted-color);
 }
-.tags {
+.tags, .return-type {
     display: flex;
     align-items: baseline;
 }
@@ -651,7 +658,7 @@
     display: none;
 }
 </style>
-<style media="all" type="text/css">
+<style media="all">
 /* Pygments 'default' style sheet. Generated with Pygments 2.1.3 using:
     pygmentize -S default -f html -a .code > src/robot/htmldata/libdoc/pygments.css
     and added for dark mode
@@ -808,7 +815,7 @@
     .code .il { color: #2aa198 } /* Literal.Number.Integer.Long */
 }
 </style>
-<style media="print" type="text/css">
+<style media="print">
 body {
     margin: 0;
     padding: 0;
@@ -821,7 +828,7 @@
     display: none;
 }
 </style>
-<style media="all" type="text/css">
+<style media="all">
 #javascript-disabled {
     width: 600px;
     margin: 100px auto 0 auto;
@@ -844,7 +851,7 @@
     font-style: italic;
 }
 </style>
-<style media="all" type="text/css">
+<style media="all">
 #introduction-container > h2,
 .doc > h1,
 .doc > h2,
@@ -921,7 +928,8 @@
     var prefix = 'robot-framework-';
     var storage;
     function init(user) {
-        prefix += user + '-';
+        if (user)
+            prefix += user + '-';
         storage = getStorage();
     }
     function getStorage() {
@@ -935,16 +943,19 @@
             return {};
         }
     }
-    function get(name, defaultValue) {
-        var value = storage[prefix + name];
+    function get(key, defaultValue) {
+        var value = storage[fullKey(key)];
         if (typeof value === 'undefined')
             return defaultValue;
         return value;
     }
-    function set(name, value) {
-        storage[prefix + name] = value;
+    function set(key, value) {
+        storage[fullKey(key)] = value;
     }
-    return {init: init, get: get, set: set};
+    function fullKey(key) {
+        return prefix + key;
+    }
+    return {init: init, get: get, set: set, fullKey: fullKey};
 }();
 </script>
 <script type="text/javascript">
@@ -1180,7 +1191,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"specversion": 2, "name": "DatabaseLibrary", "doc": "<p>The Database Library for <a href=\"https://robotframework.org\">Robot Framework</a> allows you to query a database and verify the results. It requires an appropriate <b>Python module to be installed separately</b> - depending on your database, like e.g. <span class=\"name\">oracledb</span> or <span class=\"name\">pymysql</span>.</p>\n<h3 id=\"Requirements\">Requirements</h3>\n<ul>\n<li>Python</li>\n<li>Robot Framework</li>\n<li>Python database module you're going to use - e.g. <span class=\"name\">oracledb</span></li>\n</ul>\n<h3 id=\"Installation\">Installation</h3>\n<pre>\npip install robotframework-databaselibrary\n</pre>\n<p>Don't forget to install the required Python database module!</p>\n<h3 id=\"Usage example\">Usage example</h3>\n<h4 id=\"Basic usage\">Basic usage</h4>\n<pre>\n<b>*</b> Settings <b>*</b>\nLibrary       DatabaseLibrary\nTest Setup    Connect To My Oracle DB\n\n<b>*</b> Keywords <b>*</b>\nConnect To My Oracle DB\n    Connect To Database\n    ...    oracledb\n    ...    dbName=db\n    ...    dbUsername=my_user\n    ...    dbPassword=my_pass\n    ...    dbHost=127.0.0.1\n    ...    dbPort=1521\n\n<b>*</b> Test Cases <b>*</b>\nPerson Table Contains Expected Records\n    ${output}=    Query    select LAST_NAME from person\n    Length Should Be    ${output}    2\n    Should Be Equal    ${output}[0][0]    See\n    Should Be Equal    ${output}[1][0]    Schneider\n\nPerson Table Contains No Joe\n    ${sql}=    Catenate    SELECT id FROM person\n    ...                    WHERE FIRST_NAME= 'Joe'\n    Check If Not Exists In Database    ${sql}\n\n</pre>\n<h4 id=\"Handling multiple database connections\">Handling multiple database connections</h4>\n<pre>\n<b>*</b> Settings <b>*</b>\nLibrary          DatabaseLibrary\nTest Setup       Connect To All Databases\nTest Teardown    Disconnect From All Databases\n\n<b>*</b> Keywords <b>*</b>\nConnect To All Databases\n    Connect To Database    psycopg2    db    db_user    pass    127.0.0.1    5432\n    ...    alias=postgres\n    Connect To Database    pymysql    db    db_user    pass    127.0.0.1    3306\n    ...    alias=mysql\n\n<b>*</b> Test Cases <b>*</b>\nUsing Aliases\n    ${names}=    Query    select LAST_NAME from person    alias=postgres\n    Execute Sql String    drop table XYZ                  alias=mysql\n\nSwitching Default Alias\n    Switch Database    postgres\n    ${names}=    Query    select LAST_NAME from person\n    Switch Database    mysql\n    Execute Sql String    drop table XYZ\n\n</pre>\n<h3 id=\"Database modules compatibility\">Database modules compatibility</h3>\n<p>The library is basically compatible with any <a href=\"https://peps.python.org/pep-0249\">Python Database API Specification 2.0</a> module.</p>\n<p>However, the actual implementation in existing Python modules is sometimes quite different, which requires custom handling in the library. Therefore, there are some modules, which are \"natively\" supported in the library - and others, which may work and may not.</p>\n<p>See more on the <a href=\"https://github.com/MarketSquare/Robotframework-Database-Library\">project page on GitHub</a>.</p>", "version": "1.4.3", "generated": "2023-12-19T20:25:22+00:00", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/__init__.py", "lineno": 25, "tags": [], "inits": [], "keywords": [{"name": "Call Stored Procedure", "args": [{"name": "spName", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "spName: str"}, {"name": "spParams", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["List[str]", "None"], "typedocs": {"List": "list", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "spParams: List[str] | None = None"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}], "doc": "<p>Calls a stored procedure <span class=\"name\">spName</span> with the <span class=\"name\">spParams</span> - a <b>list</b> of parameters the procedure requires. Use the special <b>CURSOR</b> value for OUT params, which should receive result sets - they will be converted to appropriate DB variables before calling the procedure. This is necessary only for some databases (e.g. Oracle or PostgreSQL).</p>\n<p>The keywords always <b>returns two lists</b>:</p>\n<ul>\n<li><b>Param values</b> - the copy of procedure parameters (modified, if the procedure changes the OUT params).</li>\n</ul>\n<p>The list is empty, if procedures receives no params.</p>\n<ul>\n<li><b>Result sets</b> - the list of lists, each of them containing results of some query, if the procedure</li>\n</ul>\n<p>returns them or put them in the OUT params of type <b>CURSOR</b> (like in Oracle or PostgreSQL).</p>\n<p>It also depends on the database, how the procedure returns the values - as params or as result sets. E.g. calling a procedure in <b>PostgreSQL</b> returns even a single value of an OUT param as a result set.</p>\n<p>Simple example:</p>\n<table border=\"1\">\n<tr>\n<td>@{Params} =</td>\n<td>Create List</td>\n<td>Jerry</td>\n<td>out_second_name</td>\n</tr>\n<tr>\n<td>@{Param values}    @{Result sets} =</td>\n<td>Call Stored Procedure</td>\n<td>Get_second_name</td>\n<td>${Params}</td>\n</tr>\n<tr>\n<td># ${Param values} = ['Jerry', 'Schneider']</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td># ${result sets} = []</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Example with a single CURSOR parameter (Oracle DB):</p>\n<table border=\"1\">\n<tr>\n<td>@{Params} =</td>\n<td>Create List</td>\n<td>CURSOR</td>\n<td></td>\n</tr>\n<tr>\n<td>@{Param values}    @{Result sets} =</td>\n<td>Call Stored Procedure</td>\n<td>Get_all_second_names</td>\n<td>${Params}</td>\n</tr>\n<tr>\n<td># ${Param values} = [&lt;oracledb.Cursor on &lt;oracledb.Connection ...&gt;&gt;]</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td># ${result sets} = [[('See',), ('Schneider',)]]</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Example with multiple CURSOR parameters (Oracle DB):</p>\n<table border=\"1\">\n<tr>\n<td>@{Params} =</td>\n<td>Create List</td>\n<td>CURSOR</td>\n<td>CURSOR</td>\n</tr>\n<tr>\n<td>@{Param values}    @{Result sets} =</td>\n<td>Call Stored Procedure</td>\n<td>Get_all_first_and_second_names</td>\n<td>${Params}</td>\n</tr>\n<tr>\n<td># ${Param values} = [&lt;oracledb.Cursor on &lt;oracledb.Connection ...&gt;&gt;, &lt;oracledb.Cursor on &lt;oracledb.Connection ...&gt;&gt;]</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td># ${result sets} = [[('Franz Allan',), ('Jerry',)], [('See',), ('Schneider',)]]</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <span class=\"name\">sansTran</span> to run command without an explicit transaction commit or rollback:</p>\n<table border=\"1\">\n<tr>\n<td>@{Param values}    @{Result sets} =</td>\n<td>Call Stored Procedure</td>\n<td>DBName.SchemaName.StoredProcName</td>\n<td>${Params}</td>\n<td>True</td>\n</tr>\n</table>", "shortdoc": "Calls a stored procedure `spName` with the `spParams` - a *list* of parameters the procedure requires. Use the special *CURSOR* value for OUT params, which should receive result sets - they will be converted to appropriate DB variables before calling the procedure. This is necessary only for some databases (e.g. Oracle or PostgreSQL).", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 407}, {"name": "Check If Exists In Database", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["List", "None"], "typedocs": {"List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: List | None = None"}], "doc": "<p>Check if any row would be returned by given the input <code>selectStatement</code>. If there are no results, then this will throw an AssertionError.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>The default error message can be overridden with the <code>msg</code> argument.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Check If Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'Franz Allan'</td>\n<td></td>\n</tr>\n<tr>\n<td>Check If Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Check If Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'Franz Allan'</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Check If Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n</tr>\n<tr>\n<td>Check If Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "Check if any row would be returned by given the input ``selectStatement``. If there are no results, then this will throw an AssertionError.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 24}, {"name": "Check If Not Exists In Database", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["List", "None"], "typedocs": {"List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: List | None = None"}], "doc": "<p>This is the negation of <span class=\"name\">check_if_exists_in_database</span>.</p>\n<p>Check if no rows would be returned by given the input <code>selectStatement</code>. If there are any results, then this will throw an AssertionError.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>The default error message can be overridden with the <code>msg</code> argument.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Check If Not Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td></td>\n</tr>\n<tr>\n<td>Check If Not Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'Franz Allan'</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Check If Not Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'Franz Allan'</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Check If Not Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n</tr>\n<tr>\n<td>Check If Not Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "This is the negation of `check_if_exists_in_database`.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 61}, {"name": "Connect To Database", "args": [{"name": "dbapiModuleName", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbapiModuleName: str | None = None"}, {"name": "dbName", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbName: str | None = None"}, {"name": "dbUsername", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbUsername: str | None = None"}, {"name": "dbPassword", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbPassword: str | None = None"}, {"name": "dbHost", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbHost: str | None = None"}, {"name": "dbPort", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbPort: int | None = None"}, {"name": "dbCharset", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbCharset: str | None = None"}, {"name": "dbDriver", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbDriver: str | None = None"}, {"name": "dbConfigFile", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbConfigFile: str | None = None"}, {"name": "driverMode", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "driverMode: str | None = None"}, {"name": "alias", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "default", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str = default"}], "doc": "<p>Loads the DB API 2.0 module given <code>dbapiModuleName</code> then uses it to connect to the database using provided parameters such as <code>dbName</code>, <code>dbUsername</code>, and <code>dbPassword</code>.</p>\n<p>Optional <code>alias</code> parameter can be used for creating multiple open connections, even for different databases. If the same alias is given twice then previous connection will be overriden.</p>\n<p>The <code>driverMode</code> is used to select the <b>oracledb</b> client mode. Allowed values are:</p>\n<ul>\n<li><i>thin</i> (default if omitted)</li>\n<li><i>thick</i></li>\n<li><i>thick,lib_dir=&lt;PATH_TO_ORACLE_CLIENT&gt;</i></li>\n</ul>\n<p>Optionally, you can specify a <code>dbConfigFile</code> wherein it will load the alias (or alias will be \"default\") property values for <code>dbapiModuleName</code>, <code>dbName</code> <code>dbUsername</code> and <code>dbPassword</code> (note: specifying <code>dbapiModuleName</code>, <code>dbName</code> <span class=\"name\">dbUsername</span> or <span class=\"name\">dbPassword</span> directly will override the properties of the same key in <span class=\"name\">dbConfigFile</span>). If no <span class=\"name\">dbConfigFile</span> is specified, it defaults to <span class=\"name\">./resources/db.cfg</span>.</p>\n<p>The <span class=\"name\">dbConfigFile</span> is useful if you don't want to check into your SCM your database credentials.</p>\n<p>Example db.cfg file</p>\n<pre>\n[alias]\ndbapiModuleName=pymysqlforexample\ndbName=yourdbname\ndbUsername=yourusername\ndbPassword=yourpassword\ndbHost=yourhost\ndbPort=yourport\n</pre>\n<p>Example usage:</p>\n<table border=\"1\">\n<tr>\n<td># explicitly specifies all db property values</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Connect To Database</td>\n<td>psycopg2</td>\n<td>my_db</td>\n<td>postgres</td>\n<td>s3cr3t</td>\n<td>tiger.foobar.com</td>\n<td>5432</td>\n<td></td>\n</tr>\n<tr>\n<td>Connect To Database</td>\n<td>psycopg2</td>\n<td>my_db</td>\n<td>postgres</td>\n<td>s3cr3t</td>\n<td>tiger.foobar.com</td>\n<td>5432</td>\n<td>alias=my_alias</td>\n</tr>\n</table>\n<table border=\"1\">\n<tr>\n<td># loads all property values from default.cfg</td>\n<td></td>\n</tr>\n<tr>\n<td>Connect To Database</td>\n<td>dbConfigFile=default.cfg</td>\n</tr>\n</table>\n<table border=\"1\">\n<tr>\n<td># loads all property values from ./resources/db.cfg</td>\n</tr>\n<tr>\n<td>Connect To Database</td>\n</tr>\n</table>\n<table border=\"1\">\n<tr>\n<td># uses explicit <span class=\"name\">dbapiModuleName</span> and <span class=\"name\">dbName</span> but uses the <span class=\"name\">dbUsername</span> and <span class=\"name\">dbPassword</span> in 'default.cfg'</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Connect To Database</td>\n<td>psycopg2</td>\n<td>my_db_test</td>\n<td>dbConfigFile=default.cfg</td>\n</tr>\n</table>\n<table border=\"1\">\n<tr>\n<td># uses explicit <span class=\"name\">dbapiModuleName</span> and <span class=\"name\">dbName</span> but uses the <span class=\"name\">dbUsername</span> and <span class=\"name\">dbPassword</span> in './resources/db.cfg'</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Connect To Database</td>\n<td>psycopg2</td>\n<td>my_db_test</td>\n</tr>\n</table>", "shortdoc": "Loads the DB API 2.0 module given ``dbapiModuleName`` then uses it to connect to the database using provided parameters such as ``dbName``, ``dbUsername``, and ``dbPassword``.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 119}, {"name": "Connect To Database Using Custom Connection String", "args": [{"name": "dbapiModuleName", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbapiModuleName: str | None = None"}, {"name": "db_connect_string", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "db_connect_string: str = "}, {"name": "alias", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "default", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str = default"}], "doc": "<p>Loads the DB API 2.0 module given <span class=\"name\">dbapiModuleName</span> then uses it to connect to the database using the <span class=\"name\">db_connect_string</span> (parsed as single connection string or URI).</p>\n<p>Use <span class=\"name\">connect_to_database_using_custom_params</span> for passing connection params as named arguments.</p>\n<p>Example usage:</p>\n<table border=\"1\">\n<tr>\n<td>Connect To Database Using Custom Connection String</td>\n<td>psycopg2</td>\n<td><a href=\"postgresql://postgres:s3cr3t@tiger.foobar.com:5432/my_db_test\">postgresql://postgres:s3cr3t@tiger.foobar.com:5432/my_db_test</a></td>\n</tr>\n<tr>\n<td>Connect To Database Using Custom Connection String</td>\n<td>oracledb</td>\n<td>username/pass@localhost:1521/orclpdb</td>\n</tr>\n</table>", "shortdoc": "Loads the DB API 2.0 module given `dbapiModuleName` then uses it to connect to the database using the `db_connect_string` (parsed as single connection string or URI).", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 386}, {"name": "Connect To Database Using Custom Params", "args": [{"name": "dbapiModuleName", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbapiModuleName: str | None = None"}, {"name": "db_connect_string", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "db_connect_string: str = "}, {"name": "alias", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "default", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str = default"}], "doc": "<p>Loads the DB API 2.0 module given <span class=\"name\">dbapiModuleName</span> then uses it to connect to the database using the map string <span class=\"name\">db_connect_string</span> (parsed as a list of named arguments).</p>\n<p>Use <span class=\"name\">connect_to_database_using_custom_connection_string</span> for passing all params in a single connection string or URI.</p>\n<p>Example usage:</p>\n<table border=\"1\">\n<tr>\n<td>Connect To Database Using Custom Params</td>\n<td>psycopg2</td>\n<td>database='my_db_test', user='postgres', password='s3cr3t', host='tiger.foobar.com', port=5432</td>\n</tr>\n<tr>\n<td>Connect To Database Using Custom Params</td>\n<td>jaydebeapi</td>\n<td>'oracle.jdbc.driver.OracleDriver', 'my_db_test', 'system', 's3cr3t'</td>\n</tr>\n<tr>\n<td>Connect To Database Using Custom Params</td>\n<td>oracledb</td>\n<td>user=\"username\", password=\"pass\", dsn=\"localhost/orclpdb\"</td>\n</tr>\n<tr>\n<td>Connect To Database Using Custom Params</td>\n<td>sqlite3</td>\n<td>database=\"./my_database.db\", isolation_level=None</td>\n</tr>\n</table>", "shortdoc": "Loads the DB API 2.0 module given `dbapiModuleName` then uses it to connect to the database using the map string `db_connect_string` (parsed as a list of named arguments).", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 348}, {"name": "Delete All Rows From Table", "args": [{"name": "tableName", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "tableName: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}], "doc": "<p>Delete all the rows within a given table.</p>\n<p>Use optional <span class=\"name\">sansTran</span> to run command without an explicit transaction commit or rollback.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Delete All Rows From Table</td>\n<td>person</td>\n<td></td>\n</tr>\n<tr>\n<td>Delete All Rows From Table</td>\n<td>person</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Delete All Rows From Table</td>\n<td>person</td>\n<td>sansTran=True</td>\n</tr>\n</table>", "shortdoc": "Delete all the rows within a given table.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 185}, {"name": "Description", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["List", "None"], "typedocs": {"List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: List | None = None"}], "doc": "<p>Uses the input <code>selectStatement</code> to query a table in the db which will be used to determine the description.</p>\n<p>For example, given we have a table <span class=\"name\">person</span> with the following data:</p>\n<table border=\"1\">\n<tr>\n<td>id</td>\n<td>first_name</td>\n<td>last_name</td>\n</tr>\n<tr>\n<td>1</td>\n<td>Franz Allan</td>\n<td>See</td>\n</tr>\n</table>\n<p>When you do the following:</p>\n<table border=\"1\">\n<tr>\n<td>@{queryResults}</td>\n<td>Description</td>\n<td>SELECT * FROM person</td>\n<td></td>\n</tr>\n<tr>\n<td>@{queryResults}</td>\n<td>Description</td>\n<td>SELECT * FROM person</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Log Many</td>\n<td>@{queryResults}</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>You will get the following: [Column(name='id', type_code=1043, display_size=None, internal_size=255, precision=None, scale=None, null_ok=None)] [Column(name='first_name', type_code=1043, display_size=None, internal_size=255, precision=None, scale=None, null_ok=None)] [Column(name='last_name', type_code=1043, display_size=None, internal_size=255, precision=None, scale=None, null_ok=None)]</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client):</p>\n<table border=\"1\">\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>person</td>\n<td></td>\n</tr>\n<tr>\n<td>${desc}</td>\n<td>Description</td>\n<td>SELECT * FROM %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>\n<p>Using optional <span class=\"name\">sansTran</span> to run command without an explicit transaction commit or rollback:</p>\n<table border=\"1\">\n<tr>\n<td>@{queryResults}</td>\n<td>Description</td>\n<td>SELECT * FROM person</td>\n<td>True</td>\n</tr>\n</table>", "shortdoc": "Uses the input ``selectStatement`` to query a table in the db which will be used to determine the description.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 135}, {"name": "Disconnect From All Databases", "args": [], "doc": "<p>Disconnects from all the databases - useful when testing with multiple database connections (aliases).</p>\n<p>For example:</p>\n<table border=\"1\">\n<tr>\n<td>Disconnect From All Databases</td>\n<td># Closes connections to all databases</td>\n</tr>\n</table>", "shortdoc": "Disconnects from all the databases - useful when testing with multiple database connections (aliases).", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 432}, {"name": "Disconnect From Database", "args": [{"name": "error_if_no_connection", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error_if_no_connection: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}], "doc": "<p>Disconnects from the database.</p>\n<p>By default, it's not an error if there was no open database connection - suitable for usage as a teardown. However, you can enforce it using the <span class=\"name\">error_if_no_connection</span> parameter.</p>\n<p>Example usage:</p>\n<table border=\"1\">\n<tr>\n<td>Disconnect From Database</td>\n<td># disconnects from current connection to the database</td>\n<td></td>\n</tr>\n<tr>\n<td>Disconnect From Database</td>\n<td>alias=my_alias</td>\n<td># disconnects from current connection to the database</td>\n</tr>\n</table>", "shortdoc": "Disconnects from the database.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 410}, {"name": "Execute Sql Script", "args": [{"name": "sqlScriptFileName", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "sqlScriptFileName: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "split", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "split: bool = True"}], "doc": "<p>Executes the content of the <span class=\"name\">sqlScriptFileName</span> as SQL commands. Useful for setting the database to a known state before running your tests, or clearing out your test data after running each a test.</p>\n<p>SQL commands are expected to be delimited by a semicolon (';') - they will be split and executed separately. You can disable this behaviour setting the parameter <span class=\"name\">split</span> to <i>False</i> - in this case the entire script content will be passed to the database module for execution.</p>\n<p>Sample usage :</p>\n<table border=\"1\">\n<tr>\n<td>Execute Sql Script</td>\n<td>${EXECDIR}${/}resources${/}DDL-setup.sql</td>\n<td></td>\n</tr>\n<tr>\n<td>Execute Sql Script</td>\n<td>${EXECDIR}${/}resources${/}DML-setup.sql</td>\n<td></td>\n</tr>\n<tr>\n<td>Execute Sql Script</td>\n<td>${EXECDIR}${/}resources${/}DDL-setup.sql</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>#interesting stuff here</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Execute Sql Script</td>\n<td>${EXECDIR}${/}resources${/}DML-teardown.sql</td>\n<td></td>\n</tr>\n<tr>\n<td>Execute Sql Script</td>\n<td>${EXECDIR}${/}resources${/}DDL-teardown.sql</td>\n<td></td>\n</tr>\n</table>\n<p>For example: DELETE FROM person_employee_table; DELETE FROM person_table; DELETE FROM employee_table;</p>\n<p>Also, the last SQL command can optionally omit its trailing semi-colon.</p>\n<p>For example: DELETE FROM person_employee_table; DELETE FROM person_table; DELETE FROM employee_table</p>\n<p>Given this, that means you can create spread your SQL commands in several lines.</p>\n<p>For example: DELETE FROM person_employee_table; DELETE FROM person_table; DELETE FROM employee_table</p>\n<p>However, lines that starts with a number sign (<span class=\"name\">#</span>) or a double dash (\"--\") are treated as a commented line. Thus, none of the contents of that line will be executed.</p>\n<p>For example: # Delete the bridging table first... DELETE FROM person_employee_table; # ...and then the bridged tables. DELETE FROM person_table; DELETE FROM employee_table</p>\n<p>The slash signs (\"/\") are always ignored and have no impact on execution order.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <span class=\"name\">sansTran</span> to run command without an explicit transaction commit or rollback:</p>\n<table border=\"1\">\n<tr>\n<td>Execute Sql Script</td>\n<td>${EXECDIR}${/}resources${/}DDL-setup.sql</td>\n<td>True</td>\n</tr>\n</table>", "shortdoc": "Executes the content of the `sqlScriptFileName` as SQL commands. Useful for setting the database to a known state before running your tests, or clearing out your test data after running each a test.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 216}, {"name": "Execute Sql String", "args": [{"name": "sqlString", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "sqlString: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["List", "None"], "typedocs": {"List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: List | None = None"}, {"name": "omitTrailingSemicolon", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["bool", "None"], "typedocs": {"bool": "boolean", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "omitTrailingSemicolon: bool | None = None"}], "doc": "<p>Executes the <code>sqlString</code> as a single SQL command.</p>\n<p>Use optional <code>sansTran</code> to run command without an explicit transaction commit or rollback.</p>\n<p>Use optional <code>omitTrailingSemicolon</code> parameter for explicit instruction, if the trailing semicolon (;) at the SQL string end should be removed or not:</p>\n<ul>\n<li>Some database modules (e.g. Oracle) throw an exception, if you leave a semicolon at the string end</li>\n<li>However, there are exceptional cases, when you need it even for Oracle - e.g. at the end of a PL/SQL block.</li>\n<li>If not specified, it's decided based on the current database module in use. For Oracle, the semicolon is removed by default.</li>\n</ul>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>For example:</p>\n<table border=\"1\">\n<tr>\n<td>Execute Sql String</td>\n<td>DELETE FROM person_employee_table; DELETE FROM person_table</td>\n<td></td>\n</tr>\n<tr>\n<td>Execute Sql String</td>\n<td>DELETE FROM person_employee_table; DELETE FROM person_table</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Execute Sql String</td>\n<td>DELETE FROM person_employee_table; DELETE FROM person_table</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>Execute Sql String</td>\n<td>CREATE PROCEDURE proc AS BEGIN DBMS_OUTPUT.PUT_LINE('Hello!'); END;</td>\n<td>omitTrailingSemicolon=False</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>person_employee_table</td>\n</tr>\n<tr>\n<td>Execute Sql String</td>\n<td>SELECT * FROM %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "Executes the ``sqlString`` as a single SQL command.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 362}, {"name": "Query", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "returnAsDict", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "returnAsDict: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["List", "None"], "typedocs": {"List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: List | None = None"}], "doc": "<p>Runs a query with the <code>selectStatement</code> and returns the result as a list of rows. The type of row values depends on the database module - usually they are tuples or tuple-like objects.</p>\n<p>Set optional input <code>returnAsDict</code> to <i>True</i> to explicitely convert the return values into a list of dictionaries.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client):</p>\n<table border=\"1\">\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>person</td>\n</tr>\n<tr>\n<td>Query</td>\n<td>SELECT * FROM %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>\n<p>Use optional <code>sansTran</code> to run command without an explicit transaction commit or rollback:</p>\n<table border=\"1\">\n<tr>\n<td>@{queryResults}</td>\n<td>Query</td>\n<td>SELECT * FROM person</td>\n<td>True</td>\n</tr>\n</table>\n<p>Tip: Unless you want to log all column values of the specified rows, try specifying the column names in your select statements as much as possible to prevent any unnecessary surprises with schema changes and to easily see what your [] indexing is trying to retrieve (i.e. instead of <span class=\"name\">\"select * from my_table\"</span>, try <span class=\"name\">\"select id, col_1, col_2 from my_table\"</span>).</p>\n<p>For example, given we have a table <span class=\"name\">person</span> with the following data:</p>\n<table border=\"1\">\n<tr>\n<td>id</td>\n<td>first_name</td>\n<td>last_name</td>\n</tr>\n<tr>\n<td>1</td>\n<td>Franz Allan</td>\n<td>See</td>\n</tr>\n</table>\n<p>When you do the following:</p>\n<table border=\"1\">\n<tr>\n<td>@{queryResults}</td>\n<td>Query</td>\n<td>SELECT * FROM person</td>\n<td></td>\n</tr>\n<tr>\n<td>@{queryResults}</td>\n<td>Query</td>\n<td>SELECT * FROM person</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Log Many</td>\n<td>@{queryResults}</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>You will get the following: [1, 'Franz Allan', 'See']</p>\n<p>Also, you can do something like this:</p>\n<table border=\"1\">\n<tr>\n<td>${queryResults}</td>\n<td>Query</td>\n<td>SELECT first_name, last_name FROM person</td>\n</tr>\n<tr>\n<td>Log</td>\n<td>${queryResults[0][1]}, ${queryResults[0][0]}</td>\n<td></td>\n</tr>\n</table>\n<p>And get the following See, Franz Allan</p>", "shortdoc": "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 - usually they are tuples or tuple-like objects.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 28}, {"name": "Row Count", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["List", "None"], "typedocs": {"List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: List | None = None"}], "doc": "<p>Uses the input <code>selectStatement</code> to query the database and returns the number of rows from the query.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>sansTran</code> to run command without an explicit transaction commit or rollback:</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client):</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>${rowCount}</td>\n<td>Row Count</td>\n<td>SELECT * FROM person</td>\n<td></td>\n</tr>\n<tr>\n<td>${rowCount}</td>\n<td>Row Count</td>\n<td>SELECT * FROM person</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>${rowCount}</td>\n<td>Row Count</td>\n<td>SELECT * FROM person</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>person</td>\n<td></td>\n</tr>\n<tr>\n<td>${rowCount}</td>\n<td>Row Count</td>\n<td>SELECT * FROM %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "Uses the input ``selectStatement`` to query the database and returns the number of rows from the query.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 96}, {"name": "Row Count Is 0", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["List", "None"], "typedocs": {"List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: List | None = None"}], "doc": "<p>Check if any rows are returned from the submitted <code>selectStatement</code>. If there are, then this will throw an AssertionError.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>The default error message can be overridden with the <code>msg</code> argument.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Row Count is 0</td>\n<td>SELECT id FROM person WHERE first_name = 'Franz Allan'</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count is 0</td>\n<td>SELECT id FROM person WHERE first_name = 'Franz Allan'</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Row Count is 0</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Row Count is 0</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n</tr>\n<tr>\n<td>Row Count is 0</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "Check if any rows are returned from the submitted ``selectStatement``. If there are, then this will throw an AssertionError.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 100}, {"name": "Row Count Is Equal To X", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "numRows", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "numRows: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["List", "None"], "typedocs": {"List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: List | None = None"}], "doc": "<p>Check if the number of rows returned from <code>selectStatement</code> is equal to the value submitted. If not, then this will throw an AssertionError.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>The default error message can be overridden with the <code>msg</code> argument.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Row Count Is Equal To X</td>\n<td>SELECT id FROM person</td>\n<td>1</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count Is Equal To X</td>\n<td>SELECT id FROM person</td>\n<td>3</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Row Count Is Equal To X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>0</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Row Count Is Equal To X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>0</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count Is Equal To X</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td>0</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "Check if the number of rows returned from ``selectStatement`` is equal to the value submitted. If not, then this will throw an AssertionError.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 136}, {"name": "Row Count Is Greater Than X", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "numRows", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "numRows: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["List", "None"], "typedocs": {"List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: List | None = None"}], "doc": "<p>Check if the number of rows returned from <code>selectStatement</code> is greater than the value submitted. If not, then this will throw an AssertionError.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>The default error message can be overridden with the <code>msg</code> argument.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Row Count Is Greater Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>0</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count Is Greater Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>0</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Row Count Is Greater Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>0</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Row Count Is Greater Than X</td>\n<td>SELECT id FROM person</td>\n<td>1</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count Is Greater Than X</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td>0</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "Check if the number of rows returned from ``selectStatement`` is greater than the value submitted. If not, then this will throw an AssertionError.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 174}, {"name": "Row Count Is Less Than X", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "numRows", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "numRows: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["List", "None"], "typedocs": {"List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: List | None = None"}], "doc": "<p>Check if the number of rows returned from <code>selectStatement</code> is less than the value submitted. If not, then this will throw an AssertionError.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>Using optional <code>msg</code> to override the default error message:</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Row Count Is Less Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>1</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count Is Less Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>2</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Row Count Is Less Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>3</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Row Count Is Less Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>4</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count Is Less Than X</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td>5</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "Check if the number of rows returned from ``selectStatement`` is less than the value submitted. If not, then this will throw an AssertionError.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 212}, {"name": "Set Auto Commit", "args": [{"name": "autoCommit", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "autoCommit: bool = True"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}], "doc": "<p>Turn the autocommit on the database connection ON or OFF.</p>\n<p>The default behaviour on a newly created database connection is to automatically start a transaction, which means that database actions that won't work if there is an active transaction will fail. Common examples of these actions are creating or deleting a database or database snapshot. By turning on auto commit on the database connection these actions can be performed.</p>\n<p>Example usage:</p>\n<pre>\n# Default behaviour, sets auto commit to true\nSet Auto Commit\nSet Auto Commit | alias=my_alias |\n# Explicitly set the desired state\nSet Auto Commit | False\n</pre>", "shortdoc": "Turn the autocommit on the database connection ON or OFF.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 445}, {"name": "Switch Database", "args": [{"name": "alias", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "alias: str"}], "doc": "<p>Switch the default database connection to <code>alias</code>.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Switch Database</td>\n<td>my_alias</td>\n</tr>\n<tr>\n<td>Switch Database</td>\n<td>alias=my_alias</td>\n</tr>\n</table>", "shortdoc": "Switch the default database connection to ``alias``.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 466}, {"name": "Table Must Exist", "args": [{"name": "tableName", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "tableName: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}], "doc": "<p>Check if the given table exists in the database.</p>\n<p>Set optional input <code>sansTran</code> to True to run command without an explicit transaction commit or rollback.</p>\n<p>The default error message can be overridden with the <code>msg</code> argument.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Table Must Exist</td>\n<td>person</td>\n<td></td>\n</tr>\n<tr>\n<td>Table Must Exist</td>\n<td>person</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Table Must Exist</td>\n<td>person</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Table Must Exist</td>\n<td>person</td>\n<td>sansTran=True</td>\n</tr>\n</table>", "shortdoc": "Check if the given table exists in the database.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 250}], "dataTypes": {"enums": [], "typedDicts": []}, "typedocs": [{"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["Call Stored Procedure", "Check If Exists In Database", "Check If Not Exists In Database", "Delete All Rows From Table", "Description", "Disconnect From Database", "Execute Sql Script", "Execute Sql String", "Query", "Row Count", "Row Count Is 0", "Row Count Is Equal To X", "Row Count Is Greater Than X", "Row Count Is Less Than X", "Set Auto Commit", "Table Must Exist"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["Connect To Database"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["Call Stored Procedure", "Check If Exists In Database", "Check If Not Exists In Database", "Description", "Execute Sql String", "Query", "Row Count", "Row Count Is 0", "Row Count Is Equal To X", "Row Count Is Greater Than X", "Row Count Is Less Than X"], "accepts": ["string", "Sequence"]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["Call Stored Procedure", "Check If Exists In Database", "Check If Not Exists In Database", "Connect To Database", "Connect To Database Using Custom Connection String", "Connect To Database Using Custom Params", "Delete All Rows From Table", "Description", "Disconnect From Database", "Execute Sql Script", "Execute Sql String", "Query", "Row Count", "Row Count Is 0", "Row Count Is Equal To X", "Row Count Is Greater Than X", "Row Count Is Less Than X", "Set Auto Commit", "Table Must Exist"], "accepts": ["string"]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["Call Stored Procedure", "Check If Exists In Database", "Check If Not Exists In Database", "Connect To Database", "Connect To Database Using Custom Connection String", "Connect To Database Using Custom Params", "Delete All Rows From Table", "Description", "Disconnect From Database", "Execute Sql Script", "Execute Sql String", "Query", "Row Count", "Row Count Is 0", "Row Count Is Equal To X", "Row Count Is Greater Than X", "Row Count Is Less Than X", "Set Auto Commit", "Switch Database", "Table Must Exist"], "accepts": ["Any"]}]}
+libdoc = {"specversion": 3, "name": "DatabaseLibrary", "doc": "<p>The Database Library for <a href=\"https://robotframework.org\">Robot Framework</a> allows you to query a database and verify the results. It requires an appropriate <b>Python module to be installed separately</b> - depending on your database, like e.g. <span class=\"name\">oracledb</span> or <span class=\"name\">pymysql</span>.</p>\n<h3 id=\"Table of contents\">Table of contents</h3>\n<ul>\n<li><a href=\"#Requirements\" class=\"name\">Requirements</a></li>\n<li><a href=\"#Installation\" class=\"name\">Installation</a></li>\n<li><a href=\"#Usage%20example\" class=\"name\">Usage example</a></li>\n<li><a href=\"#Using%20configuration%20file\" class=\"name\">Using configuration file</a></li>\n<li><a href=\"#Inline%20assertions\" class=\"name\">Inline assertions</a></li>\n<li><a href=\"#Retry%20mechanism\" class=\"name\">Retry mechanism</a></li>\n<li><a href=\"#Logging%20query%20results\" class=\"name\">Logging query results</a></li>\n<li><a href=\"#Database%20modules%20compatibility\" class=\"name\">Database modules compatibility</a></li>\n<li><a href=\"#Importing\" class=\"name\">Importing</a></li>\n<li><a href=\"#Keywords\" class=\"name\">Keywords</a></li>\n</ul>\n<h2 id=\"Requirements\">Requirements</h2>\n<ul>\n<li>Python</li>\n<li>Robot Framework</li>\n<li>Python database module you're going to use - e.g. <span class=\"name\">oracledb</span></li>\n</ul>\n<h2 id=\"Installation\">Installation</h2>\n<pre>\npip install robotframework-databaselibrary\n</pre>\n<p>Don't forget to install the required Python database module!</p>\n<h2 id=\"Usage example\">Usage example</h2>\n<h3 id=\"Basic usage\">Basic usage</h3>\n<pre>\n<b>*</b> Settings <b>*</b>\nLibrary       DatabaseLibrary\nTest Setup    Connect To My Oracle DB\n\n<b>*</b> Keywords <b>*</b>\nConnect To My Oracle DB\n    Connect To Database\n    ...    oracledb\n    ...    dbName=db\n    ...    dbUsername=my_user\n    ...    dbPassword=my_pass\n    ...    dbHost=127.0.0.1\n    ...    dbPort=1521\n\n<b>*</b> Test Cases <b>*</b>\nPerson Table Contains Expected Records\n    ${output}=    Query    select LAST_NAME from person\n    Length Should Be    ${output}    2\n    Should Be Equal    ${output}[0][0]    See\n    Should Be Equal    ${output}[1][0]    Schneider\n\nPerson Table Contains No Joe\n    ${sql}=    Catenate    SELECT id FROM person\n    ...                    WHERE FIRST_NAME= 'Joe'\n    Check If Not Exists In Database    ${sql}\n\n</pre>\n<h3 id=\"Handling multiple database connections\">Handling multiple database connections</h3>\n<pre>\n<b>*</b> Settings <b>*</b>\nLibrary          DatabaseLibrary\nTest Setup       Connect To All Databases\nTest Teardown    Disconnect From All Databases\n\n<b>*</b> Keywords <b>*</b>\nConnect To All Databases\n    Connect To Database    psycopg2    db    db_user    pass    127.0.0.1    5432\n    ...    alias=postgres\n    Connect To Database    pymysql    db    db_user    pass    127.0.0.1    3306\n    ...    alias=mysql\n\n<b>*</b> Test Cases <b>*</b>\nUsing Aliases\n    ${names}=    Query    select LAST_NAME from person    alias=postgres\n    Execute Sql String    drop table XYZ                  alias=mysql\n\nSwitching Default Alias\n    Switch Database    postgres\n    ${names}=    Query    select LAST_NAME from person\n    Switch Database    mysql\n    Execute Sql String    drop table XYZ\n\n</pre>\n<h2 id=\"Using configuration file\">Using configuration file</h2>\n<p>The <a href=\"#Connect%20To%20Database\" class=\"name\">Connect To Database</a> keyword allows providing the connection parameters in two ways:</p>\n<ul>\n<li>As keyword arguments</li>\n<li>In a configuration file - a simple list of <i>key=value</i> pairs, set inside an <i>alias</i> section.</li>\n</ul>\n<p>You can use only one way or you can combine them:</p>\n<ul>\n<li>The keyword arguments are taken by default</li>\n<li>If no keyword argument is provided, a parameter value is searched in the config file</li>\n</ul>\n<p>Along with commonly used connection parameters, named exactly as keyword arguments, a config file can contain any other DB module specific parameters as key/value pairs. If same custom parameter is provided both as a keyword argument <b>and</b> in config file, the <b>keyword argument value takes precedence</b>.</p>\n<p>The path to the config file is set by default to <span class=\"name\">./resources/db.cfg</span>. You can change it using an according parameter in the <a href=\"#Connect%20To%20Database\" class=\"name\">Connect To Database</a> keyword.</p>\n<p>A config file <b>must</b> contain at least one section name - the connection alias, if used (see <a href=\"#Handling%20multiple%20database%20connections\" class=\"name\">Handling multiple database connections</a>), or <span class=\"name\">[default]</span> if no aliases are used.</p>\n<h3 id=\"Config file examples\">Config file examples</h3>\n<h4 id=\"Config file with default alias (equal to using no aliases at all)\">Config file with default alias (equal to using no aliases at all)</h4>\n<pre>\n[default]\ndbapiModuleName=psycopg2\ndbName=yourdbname\ndbUsername=yourusername\ndbPassword=yourpassword\ndbHost=yourhost\ndbPort=yourport\n</pre>\n<h4 id=\"Config file with a specific alias\">Config file with a specific alias</h4>\n<pre>\n[myoracle]\ndbapiModuleName=oracledb\ndbName=yourdbname\ndbUsername=yourusername\ndbPassword=yourpassword\ndbHost=yourhost\ndbPort=yourport\n</pre>\n<h4 id=\"Config file with some params only\">Config file with some params only</h4>\n<pre>\n[default]\ndbPassword=mysecret\n</pre>\n<h4 id=\"Config file with some custom DB module specific params\">Config file with some custom DB module specific params</h4>\n<pre>\n[default]\nmy_custom_param=value\n</pre>\n<h2 id=\"Inline assertions\">Inline assertions</h2>\n<p>Keywords, that accept arguments <code>assertion_operator</code> &lt;<a href=\"#type-AssertionOperator\" class=\"name\">AssertionOperator</a>&gt; and <code>expected_value</code>, perform a check according to the specified condition - using the <a href=\"https://github.com/MarketSquare/AssertionEngine\">Assertion Engine</a>.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Check Row Count</td>\n<td>SELECT id FROM person</td>\n<td><b>==</b></td>\n<td>2</td>\n</tr>\n<tr>\n<td>Check Query Result</td>\n<td>SELECT first_name FROM person</td>\n<td><b>contains</b></td>\n<td>Allan</td>\n</tr>\n</table>\n<h2 id=\"Retry mechanism\">Retry mechanism</h2>\n<p>Assertion keywords, that accept arguments <code>retry_timeout</code> and <code>retry_pause</code>, support waiting for assertion to pass.</p>\n<p>Setting the <code>retry_timeout</code> argument enables the mechanism - in this case the SQL request and the assertion are executed in a loop, until the assertion is passed or the <code>retry_timeout</code> is reached. The pause between the loop iterations is set using the <code>retry_pause</code> argument.</p>\n<p>The argument values are set in <a href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#time-format\">Robot Framework time format</a> - e.g. <code>5 seconds</code>.</p>\n<p>The retry mechanism is disabled by default - the <code>retry_timeout</code> is set to <code>0</code>.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Check Row Count</td>\n<td>SELECT id FROM person</td>\n<td><b>==</b></td>\n<td>2</td>\n<td>retry_timeout=10 seconds</td>\n<td></td>\n</tr>\n<tr>\n<td>Check Query Result</td>\n<td>SELECT first_name FROM person</td>\n<td><b>contains</b></td>\n<td>Allan</td>\n<td>retry_timeout=5s</td>\n<td>retry_timeout=1s</td>\n</tr>\n</table>\n<h2 id=\"Logging query results\">Logging query results</h2>\n<p>Keywords, that fetch results of a SQL query, print the result rows as a table in RF log.</p>\n<ul>\n<li>A log head limit of <b>50 rows</b> is applied, other table rows are truncated in the log message.</li>\n<li>The limit and the logging in general can be adjusted any time in your tests using the Keyword <a href=\"#Set%20Logging%20Query%20Results\" class=\"name\">Set Logging Query Results</a>.</li>\n</ul>\n<p>You can also setup the limit or disable the logging during the library import. Examples:</p>\n<pre>\n# Default behavior - logging of query results is enabled, log head is 50 rows.\n<b>*</b> Settings <b>*</b>\nLibrary    DatabaseLibrary\n\n# Logging of query results is disabled, log head is 50 rows (default).\nLibrary    DatabaseLibrary    log_query_results=False\n\n# Logging of query results is enabled (default), log head is 10 rows.\nLibrary    DatabaseLibrary    log_query_results_head=10\n\n# Logging of query results is enabled (default), log head limit is disabled (log all rows).\nLibrary    DatabaseLibrary    log_query_results_head=0\n</pre>\n<h2 id=\"Database modules compatibility\">Database modules compatibility</h2>\n<p>The library is basically compatible with any <a href=\"https://peps.python.org/pep-0249\">Python Database API Specification 2.0</a> module.</p>\n<p>However, the actual implementation in existing Python modules is sometimes quite different, which requires custom handling in the library. Therefore, there are some modules, which are \"natively\" supported in the library - and others, which may work and may not.</p>\n<p>See more on the <a href=\"https://github.com/MarketSquare/Robotframework-Database-Library\">project page on GitHub</a>.</p>", "version": "", "generated": "2024-09-25T10:59:34+00:00", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/__init__.py", "lineno": 25, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "log_query_results", "type": null, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "log_query_results=True"}, {"name": "log_query_results_head", "type": null, "defaultValue": "50", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "log_query_results_head=50"}], "returnType": null, "doc": "<p>The library can be imported without any arguments:</p>\n<pre>\n<b>*</b> Settings <b>*</b>\nLibrary    DatabaseLibrary\n</pre>\n<p>Use optional library import parameters to disable <a href=\"#Logging%20query%20results\" class=\"name\">Logging query results</a> or setup the log head.</p>", "shortdoc": "The library can be imported without any arguments: | *** Settings *** | Library    DatabaseLibrary Use optional library import parameters to disable `Logging query results` or setup the log head.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/__init__.py", "lineno": 202}], "keywords": [{"name": "Call Stored Procedure", "args": [{"name": "spName", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "spName: str"}, {"name": "spParams", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "spParams: List | None = None"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "additional_output_params", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "additional_output_params: List | None = None"}], "returnType": null, "doc": "<p>Calls a stored procedure <span class=\"name\">spName</span> with the <span class=\"name\">spParams</span> - a <b>list</b> of parameters the procedure requires. <b>Returns two lists</b> - the <i>parameter values</i> and the <i>result sets</i>.</p>\n<p>Use the special <b>CURSOR</b> value for OUT params, which should receive result sets - relevant only for some databases (e.g. Oracle or PostgreSQL).</p>\n<p>Use the <span class=\"name\">additional_output_params</span> list for OUT params of a procedure in MSSQL.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <span class=\"name\">sansTran</span> to run command without an explicit transaction commit or rollback.</p>\n<h2>Handling parameters and result sets</h2>\n<p>Handling the input and output parameters and the result sets is very different depending on the database itself and on the Python database driver - i.e. how it implements the <span class=\"name\">cursor.callproc()</span> function.</p>\n<h3>Common case (e.g. MySQL)</h3>\n<p>Generally a procedure call requires all parameter values (IN and OUT) put together in a list - <span class=\"name\">spParams</span>.</p>\n<p>Calling the procedure returns <b>two lists</b>:</p>\n<ul>\n<li><b>Param values</b> - the copy of procedure parameters (modified, if the procedure changes the OUT params). The list is empty, if procedures receives no params.</li>\n<li><b>Result sets</b> - the list of lists, each of them containing results of some query, if the procedure returns them.</li>\n</ul>\n<h3>Oracle (oracledb, cx_Oracle)</h3>\n<p>Oracle procedures work fine with simple IN and OUT params, but require some special handling of result sets.</p>\n<h4>Simple case with IN and OUT params (no result sets)</h4>\n<p>Consider the following procedure:</p>\n<pre>\nCREATE OR REPLACE PROCEDURE\nget_second_name (person_first_name IN VARCHAR, person_second_name OUT VARCHAR) AS\nBEGIN\n  SELECT last_name\n  INTO person_second_name\n  FROM person\n  WHERE first_name = person_first_name;\nEND;\n</pre>\n<p>Calling the procedure in Robot Framework:</p>\n<pre>\n@{params}=         Create List    Jerry    OUTPUT\n# Second parameter value can be anything, it will be replaced anyway\n\n${param values}    ${result sets}=    Call Stored Procedure    get_second_name    ${params}\n# ${param values} = ['Jerry', 'Schneider']\n# ${result sets} = []\n</pre>\n<h4>Oracle procedure returning a result set</h4>\n<p>If a procedure in Oracle should return a result set, it must take OUT parameters of a special type - <i>SYS_REFCURSOR</i>.</p>\n<p>Consider the following procedure:</p>\n<pre>\nget_all_second_names (second_names_cursor OUT SYS_REFCURSOR) AS\nBEGIN\n  OPEN second_names_cursor for\n  SELECT LAST_NAME FROM person;\nEND;\n</pre>\n<p>Calling the procedure in Robot Framework requires the special value <b>CURSOR</b> for the OUT parameters, they will be converted to appropriate DB variables before calling the procedure.</p>\n<pre>\n@{params}=    Create List    CURSOR\n# The parameter must have this special value CURSOR\n\n${param values}    ${result sets}=    Call Stored Procedure    get_all_second_names    ${params}\n# ${param values} = [&lt;oracledb.Cursor on &lt;oracledb.Connection ...&gt;&gt;]\n# ${result sets} = [[('Franz Allan',), ('Jerry',)], [('See',), ('Schneider',)]]\n</pre>\n<h4>Oracle procedure returning multiple result sets</h4>\n<p>If a procedure takes multiple OUT parameters of the <i>SYS_REFCURSOR</i> type, they all must have the special <b>CURSOR</b> value when calling the procedure:</p>\n<pre>\n@{params} =        Create List         CURSOR    CURSOR\n${param values}    ${result sets} =    Call Stored Procedure    Get_all_first_and_second_names    ${params}\n# ${param values} = [&lt;oracledb.Cursor on &lt;oracledb.Connection ...&gt;&gt;, &lt;oracledb.Cursor on &lt;oracledb.Connection ...&gt;&gt;]\n# ${result sets}  = [[('Franz Allan',), ('Jerry',)], [('See',), ('Schneider',)]]\n</pre>\n<h3>PostgreSQL (psycopg2, psycopg3)</h3>\n<p>PostgreSQL doesn't return single values as params, only as result sets. It also supports special handling of result sets over OUT params of a special type (like Oracle).</p>\n<h4>Simple case with IN and OUT params (no CURSOR parameters)</h4>\n<p>Consider the following procedure:</p>\n<pre>\nCREATE FUNCTION\nget_second_name (IN person_first_name VARCHAR(20),\nOUT person_second_name VARCHAR(20))\nLANGUAGE plpgsql\nAS\n'\nBEGIN\n  SELECT LAST_NAME INTO person_second_name\n  FROM person\n  WHERE FIRST_NAME = person_first_name;\nEND\n';\n</pre>\n<p>Calling the procedure in Robot Framework:</p>\n<pre>\n@{params}=    Create List    Jerry\n${param values}    ${result sets}=    Call Stored Procedure    get_second_name    ${params}\n# ${param values} = ['Jerry']\n# ${result sets} = [[('Schneider',)]]\n</pre>\n<h4>PostgreSQL procedure with CURSOR parameters</h4>\n<p>If a procedure in PostgreSQL should return a proper result set, it must take OUT parameters of a special type - <i>refcursor</i>.</p>\n<p>Consider the following procedure:</p>\n<pre>\nCREATE FUNCTION\nget_all_first_and_second_names(result1 refcursor, result2 refcursor)\nRETURNS SETOF refcursor\nLANGUAGE plpgsql\nAS\n'\nBEGIN\n  OPEN result1 FOR SELECT FIRST_NAME FROM person;\n  RETURN NEXT result1;\n  OPEN result2 FOR SELECT LAST_NAME FROM person;\n  RETURN NEXT result2;\nEND\n';\n</pre>\n<p>Calling the procedure in Robot Framework requires the special value <b>CURSOR</b> for the OUT parameters, they will be converted to appropriate DB variables before calling the procedure.</p>\n<pre>\n@{params}=    Create List    CURSOR    CURSOR\n# The parameters must have this special value CURSOR\n\n${param values}    ${result sets}=    Call Stored Procedure    get_all_first_and_second_names    ${params}\n# ${param values} = ['CURSOR_0', 'CURSOR_1']\n# ${result sets} = [[('Franz Allan',), ('Jerry',)], [('See',), ('Schneider',)]\n</pre>\n<h3>MS SQL Server (pymssql)</h3>\n<p>The <i>pymssql</i> driver doesn't natively support getting the OUT parameter values after calling a procedure.</p>\n<ul>\n<li>This requires special handling of OUT parameters using the <span class=\"name\">additional_output_params</span> argument.</li>\n<li>Furthermore, it's not possible to fetch the OUT parameter values for a procedure, which returns a result set AND has OUT parameters.</li>\n</ul>\n<h4>Simple case with IN and OUT params (no result sets)</h4>\n<p>Consider the following procedure:</p>\n<pre>\nCREATE PROCEDURE\nreturn_out_param_without_result_sets\n@my_input VARCHAR(20),\n@my_output INT OUTPUT\nAS\nBEGIN\n IF @my_input = 'give me 1'\n    BEGIN\n        SELECT @my_output = 1;\n    END\n    ELSE\n    BEGIN\n        SELECT @my_output = 0;\n    END\nEND;\n</pre>\n<p>Calling the procedure in Robot Framework requires putting the IN parameters as usual in the <span class=\"name\">spParams</span> argument, but the sample values of OUT parameters must be put in the argument <span class=\"name\">additional_output_params</span>.</p>\n<pre>\n@{params}=    Create List    give me 1\n@{out_params}=    Create List    ${9}\n${param values}    ${result sets}=    Call Stored Procedure    return_out_param_without_result_sets\n...    ${params}    additional_output_params=${out_params}\n# ${result sets} = []\n# ${param values} = ('give me 1', 1)\n</pre>\n<p>The library uses the sample values in the <span class=\"name\">additional_output_params</span> list to determine the number and the type of OUT parameters - so they are type-sensitive, the type must be the same as in the procedure itself.</p>\n<h4>MS SQL procedure returning a result set (no OUT params)</h4>\n<p>If a procedure doesn't have any OUT params and returns only result sets, they are handled in a normal way. Consider the following procedure:</p>\n<pre>\nCREATE PROCEDURE get_all_first_and_second_names\nAS\nBEGIN\n  SELECT FIRST_NAME FROM person;\n  SELECT LAST_NAME FROM person;\n  RETURN;\nEND;\n</pre>\n<p>Calling the procedure in Robot Framework:</p>\n<pre>\n${param values}    ${result sets}=    Call Stored Procedure    get_all_first_and_second_names\n${param values} = ()\n${result sets} = [[('Franz Allan',), ('Jerry',)], [('See',), ('Schneider',)]]\n</pre>\n<h4>MS SQL procedure returning result sets AND OUT params</h4>\n<p>This case is <b>not fully supported</b> by the library - the OUT params won't be fetched.</p>", "shortdoc": "Calls a stored procedure `spName` with the `spParams` - a *list* of parameters the procedure requires. *Returns two lists* - the _parameter values_ and the _result sets_.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 411}, {"name": "Check If Exists In Database", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: Tuple | None = None"}], "returnType": null, "doc": "<p><b>DEPRECATED</b> Use new <a href=\"#Check%20Row%20Count\" class=\"name\">Check Row Count</a> keyword with assertion engine instead. The deprecated keyword will be removed in future versions.</p>\n<p>Check if any row would be returned by given the input <code>selectStatement</code>. If there are no results, then this will throw an AssertionError.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>The default error message can be overridden with the <code>msg</code> argument.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Check If Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'Franz Allan'</td>\n<td></td>\n</tr>\n<tr>\n<td>Check If Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Check If Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'Franz Allan'</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Check If Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n</tr>\n<tr>\n<td>Check If Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "*DEPRECATED* Use new `Check Row Count` keyword with assertion engine instead. The deprecated keyword will be removed in future versions.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 27, "deprecated": true}, {"name": "Check If Not Exists In Database", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: Tuple | None = None"}], "returnType": null, "doc": "<p><b>DEPRECATED</b> Use new <a href=\"#Check%20Row%20Count\" class=\"name\">Check Row Count</a> keyword with assertion engine instead. The deprecated keyword will be removed in future versions.</p>\n<p>This is the negation of <span class=\"name\">check_if_exists_in_database</span>.</p>\n<p>Check if no rows would be returned by given the input <code>selectStatement</code>. If there are any results, then this will throw an AssertionError.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>The default error message can be overridden with the <code>msg</code> argument.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Check If Not Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td></td>\n</tr>\n<tr>\n<td>Check If Not Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'Franz Allan'</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Check If Not Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'Franz Allan'</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Check If Not Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n</tr>\n<tr>\n<td>Check If Not Exists In Database</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "*DEPRECATED* Use new `Check Row Count` keyword with assertion engine instead. The deprecated keyword will be removed in future versions.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 66, "deprecated": true}, {"name": "Check Query Result", "args": [{"name": "selectStatement", "type": null, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement"}, {"name": "assertion_operator", "type": {"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "assertion_operator: AssertionOperator"}, {"name": "expected_value", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_value: Any"}, {"name": "row", "type": null, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "row=0"}, {"name": "col", "type": null, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "col=0"}, {"name": "assertion_message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_message: str | None = None"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: Tuple | None = None"}, {"name": "retry_timeout", "type": null, "defaultValue": "0 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "retry_timeout=0 seconds"}, {"name": "retry_pause", "type": null, "defaultValue": "0.5 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "retry_pause=0.5 seconds"}], "returnType": null, "doc": "<p>Check value in query result returned from <code>selectStatement</code> using <code>assertion_operator</code> and <code>expected_value</code>. The value position in results can be adjusted using <code>row</code> and <code>col</code> parameters (0-based). See <a href=\"#Inline%20assertions\" class=\"name\">Inline assertions</a> for more details.</p>\n<p><b>The assertion in this keyword is type sensitive!</b> The <code>expected_value</code> is taken as a string, no argument conversion is performed. Use RF syntax like <code>${1}</code> for numeric values.</p>\n<p>Use optional <code>assertion_message</code> to override the default error message.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Use <code>retry_timeout</code> and <code>retry_pause</code> parameters to enable waiting for assertion to pass. See <a href=\"#Retry%20mechanism\" class=\"name\">Retry mechanism</a> for more details.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Check Query Result</td>\n<td>SELECT first_name FROM person</td>\n<td><b>contains</b></td>\n<td>Allan</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Check Query Result</td>\n<td>SELECT first_name, last_name FROM person</td>\n<td><b>==</b></td>\n<td>Schneider</td>\n<td>row=1</td>\n<td>col=1</td>\n</tr>\n<tr>\n<td>Check Query Result</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td><b>==</b></td>\n<td>2</td>\n<td># Fails, if query returns an integer value</td>\n<td></td>\n</tr>\n<tr>\n<td>Check Query Result</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td><b>==</b></td>\n<td>${2}</td>\n<td># Works, if query returns an integer value</td>\n<td></td>\n</tr>\n<tr>\n<td>Check Query Result</td>\n<td>SELECT first_name FROM person</td>\n<td><b>equal</b></td>\n<td>Franz Allan</td>\n<td>assertion_message=my error message</td>\n<td></td>\n</tr>\n<tr>\n<td>Check Query Result</td>\n<td>SELECT first_name FROM person</td>\n<td><b>inequal</b></td>\n<td>John</td>\n<td>alias=my_alias</td>\n<td></td>\n</tr>\n<tr>\n<td>Check Query Result</td>\n<td>SELECT first_name FROM person</td>\n<td><b>contains</b></td>\n<td>Allan</td>\n<td>sansTran=True</td>\n<td></td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Check Query Result</td>\n<td>SELECT first_name FROM person</td>\n<td><b>contains</b></td>\n<td>Allan</td>\n<td>parameters=${parameters}</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Check value in query result returned from ``selectStatement`` using ``assertion_operator`` and ``expected_value``. The value position in results can be adjusted using ``row`` and ``col`` parameters (0-based). See `Inline assertions` for more details.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 316}, {"name": "Check Row Count", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "assertion_operator", "type": {"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "assertion_operator: AssertionOperator"}, {"name": "expected_value", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_value: int"}, {"name": "assertion_message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_message: str | None = None"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: Tuple | None = None"}, {"name": "retry_timeout", "type": null, "defaultValue": "0 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "retry_timeout=0 seconds"}, {"name": "retry_pause", "type": null, "defaultValue": "0.5 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "retry_pause=0.5 seconds"}], "returnType": null, "doc": "<p>Check the number of rows returned from <code>selectStatement</code> using <code>assertion_operator</code> and <code>expected_value</code>. See <a href=\"#Inline%20assertions\" class=\"name\">Inline assertions</a> for more details.</p>\n<p>Use optional <code>assertion_message</code> to override the default error message.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Use <code>retry_timeout</code> and <code>retry_pause</code> parameters to enable waiting for assertion to pass. See <a href=\"#Retry%20mechanism\" class=\"name\">Retry mechanism</a> for more details.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Check Row Count</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td><b>==</b></td>\n<td>1</td>\n<td></td>\n</tr>\n<tr>\n<td>Check Row Count</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td><b>&gt;=</b></td>\n<td>2</td>\n<td>assertion_message=my error message</td>\n</tr>\n<tr>\n<td>Check Row Count</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td><b>inequal</b></td>\n<td>3</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Check Row Count</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td><b>less than</b></td>\n<td>4</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Check Row Count</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td><b>equals</b></td>\n<td>5</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "Check the number of rows returned from ``selectStatement`` using ``assertion_operator`` and ``expected_value``. See `Inline assertions` for more details.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 265}, {"name": "Connect To Database", "args": [{"name": "dbapiModuleName", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbapiModuleName: str | None = None"}, {"name": "dbName", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbName: str | None = None"}, {"name": "dbUsername", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbUsername: str | None = None"}, {"name": "dbPassword", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbPassword: str | None = None"}, {"name": "dbHost", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbHost: str | None = None"}, {"name": "dbPort", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbPort: int | None = None"}, {"name": "dbCharset", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbCharset: str | None = None"}, {"name": "dbDriver", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbDriver: str | None = None"}, {"name": "dbConfigFile", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbConfigFile: str | None = None"}, {"name": "driverMode", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "driverMode: str | None = None"}, {"name": "alias", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "default", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str = default"}, {"name": "custom_connection_params", "type": null, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**custom_connection_params"}], "returnType": null, "doc": "<p>Creates a database connection using the DB API 2.0 module <code>dbapiModuleName</code> and the parameters provided. Along with listed commonly used arguments (<span class=\"name\">dbName</span>, <span class=\"name\">dbHost</span> etc.) you can set any other DB module specific parameters as key/value pairs.</p>\n<p>Use <code>dbConfigFile</code> to provide a path to configuration file with connection parameters to be used along with / instead of keyword arguments. If no specified, it defaults to <span class=\"name\">./resources/db.cfg</span>. See <a href=\"#Using%20configuration%20file\" class=\"name\">Using configuration file</a> for more details.</p>\n<p>All params are optional, although <code>dbapiModuleName</code> must be set - either as keyword argument or in config file. If some of the listed keyword arguments (<span class=\"name\">dbName</span>, <span class=\"name\">dbHost</span> etc.) are not provided (i.e. left on dafault value <a href=\"#type-None\" class=\"name\">None</a>), they are normally not passed to the Python DB module at all, except:</p>\n<ul>\n<li><i>dbPort</i> - commonly used port number for known databases is set as fallback</li>\n<li><i>dbCharset</i> - <i>UTF8</i> is used as fallback for <i>pymysql</i>, <i>pymssql</i> and <i>pyodbc</i></li>\n<li><i>driverMode</i> - <i>thin</i> is used as fallback for <i>oracledb</i></li>\n</ul>\n<p>Other custom params from keyword arguments and config file are passed to the Python DB module as provided - normally as arguments for the <i>connect()</i> function. However, when using <b>pyodbc</b>, the connection is established using a connection string - so all the custom params are added into it instead of function arguments.</p>\n<p>Optional <code>alias</code> parameter can be used for creating multiple open connections, even for different databases. If the same alias is given twice then previous connection will be overridden.</p>\n<p>The <code>driverMode</code> is used to select the <b>oracledb</b> client mode. Allowed values are:</p>\n<ul>\n<li><i>thin</i> (default if omitted)</li>\n<li><i>thick</i></li>\n<li><i>thick,lib_dir=&lt;PATH_TO_ORACLE_CLIENT&gt;</i></li>\n</ul>\n<p>Examples</p>\n<table border=\"1\">\n<tr>\n<td>Connect To Database</td>\n<td>psycopg2</td>\n<td>my_db</td>\n<td>user</td>\n<td>pass</td>\n<td>tiger.foobar.com</td>\n<td>5432</td>\n<td></td>\n</tr>\n<tr>\n<td>Connect To Database</td>\n<td>psycopg2</td>\n<td>my_db</td>\n<td>user</td>\n<td>pass</td>\n<td>tiger.foobar.com</td>\n<td>5432</td>\n<td>my_custom_param=value</td>\n</tr>\n<tr>\n<td>Connect To Database</td>\n<td>psycopg2</td>\n<td>my_db</td>\n<td>user</td>\n<td>pass</td>\n<td>tiger.foobar.com</td>\n<td>5432</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Connect To Database</td>\n<td>dbConfigFile=my_db_params.cfg</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Creates a database connection using the DB API 2.0 module ``dbapiModuleName`` and the parameters provided. Along with listed commonly used arguments (`dbName`, `dbHost` etc.) you can set any other DB module specific parameters as key/value pairs.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 159}, {"name": "Connect To Database Using Custom Connection String", "args": [{"name": "dbapiModuleName", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbapiModuleName: str | None = None"}, {"name": "db_connect_string", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "db_connect_string: str = "}, {"name": "alias", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "default", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str = default"}], "returnType": null, "doc": "<p>Loads the DB API 2.0 module given <span class=\"name\">dbapiModuleName</span> then uses it to connect to the database using the <span class=\"name\">db_connect_string</span> (parsed as single connection string or URI).</p>\n<p>Use <span class=\"name\">connect_to_database_using_custom_params</span> for passing connection params as named arguments.</p>\n<p>Example usage:</p>\n<table border=\"1\">\n<tr>\n<td>Connect To Database Using Custom Connection String</td>\n<td>psycopg2</td>\n<td><a href=\"postgresql://postgres:s3cr3t@tiger.foobar.com:5432/my_db_test\">postgresql://postgres:s3cr3t@tiger.foobar.com:5432/my_db_test</a></td>\n</tr>\n<tr>\n<td>Connect To Database Using Custom Connection String</td>\n<td>oracledb</td>\n<td>username/pass@localhost:1521/orclpdb</td>\n</tr>\n</table>", "shortdoc": "Loads the DB API 2.0 module given `dbapiModuleName` then uses it to connect to the database using the `db_connect_string` (parsed as single connection string or URI).", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 466}, {"name": "Connect To Database Using Custom Params", "args": [{"name": "dbapiModuleName", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dbapiModuleName: str | None = None"}, {"name": "db_connect_string", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "db_connect_string: str = "}, {"name": "alias", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "default", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str = default"}], "returnType": null, "doc": "<p><b>DEPRECATED</b> Use new <a href=\"#Connect%20To%20Database\" class=\"name\">Connect To Database</a> keyword with custom parameters instead. The deprecated keyword will be removed in future versions.</p>\n<p>Loads the DB API 2.0 module given <span class=\"name\">dbapiModuleName</span> then uses it to connect to the database using the map string <span class=\"name\">db_connect_string</span> (parsed as a list of named arguments).</p>\n<p>Use <span class=\"name\">connect_to_database_using_custom_connection_string</span> for passing all params in a single connection string or URI.</p>\n<p>Example usage:</p>\n<table border=\"1\">\n<tr>\n<td>Connect To Database Using Custom Params</td>\n<td>psycopg2</td>\n<td>database='my_db_test', user='postgres', password='s3cr3t', host='tiger.foobar.com', port=5432</td>\n</tr>\n<tr>\n<td>Connect To Database Using Custom Params</td>\n<td>jaydebeapi</td>\n<td>'oracle.jdbc.driver.OracleDriver', 'my_db_test', 'system', 's3cr3t'</td>\n</tr>\n<tr>\n<td>Connect To Database Using Custom Params</td>\n<td>oracledb</td>\n<td>user=\"username\", password=\"pass\", dsn=\"localhost/orclpdb\"</td>\n</tr>\n<tr>\n<td>Connect To Database Using Custom Params</td>\n<td>sqlite3</td>\n<td>database=\"./my_database.db\", isolation_level=None</td>\n</tr>\n</table>", "shortdoc": "*DEPRECATED* Use new `Connect To Database` keyword with custom parameters instead. The deprecated keyword will be removed in future versions.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 435, "deprecated": true}, {"name": "Delete All Rows From Table", "args": [{"name": "tableName", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "tableName: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}], "returnType": null, "doc": "<p>Delete all the rows within a given table.</p>\n<p>Use optional <span class=\"name\">sansTran</span> to run command without an explicit transaction commit or rollback.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Delete All Rows From Table</td>\n<td>person</td>\n<td></td>\n</tr>\n<tr>\n<td>Delete All Rows From Table</td>\n<td>person</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Delete All Rows From Table</td>\n<td>person</td>\n<td>sansTran=True</td>\n</tr>\n</table>", "shortdoc": "Delete all the rows within a given table.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 193}, {"name": "Description", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: Tuple | None = None"}], "returnType": null, "doc": "<p>Uses the input <code>selectStatement</code> to query a table in the db which will be used to determine the description.</p>\n<p>For example, given we have a table <span class=\"name\">person</span> with the following data:</p>\n<table border=\"1\">\n<tr>\n<td>id</td>\n<td>first_name</td>\n<td>last_name</td>\n</tr>\n<tr>\n<td>1</td>\n<td>Franz Allan</td>\n<td>See</td>\n</tr>\n</table>\n<p>When you do the following:</p>\n<table border=\"1\">\n<tr>\n<td>@{queryResults}</td>\n<td>Description</td>\n<td>SELECT * FROM person</td>\n<td></td>\n</tr>\n<tr>\n<td>@{queryResults}</td>\n<td>Description</td>\n<td>SELECT * FROM person</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Log Many</td>\n<td>@{queryResults}</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>You will get the following: [Column(name='id', type_code=1043, display_size=None, internal_size=255, precision=None, scale=None, null_ok=None)] [Column(name='first_name', type_code=1043, display_size=None, internal_size=255, precision=None, scale=None, null_ok=None)] [Column(name='last_name', type_code=1043, display_size=None, internal_size=255, precision=None, scale=None, null_ok=None)]</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client):</p>\n<table border=\"1\">\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>person</td>\n<td></td>\n</tr>\n<tr>\n<td>${desc}</td>\n<td>Description</td>\n<td>SELECT * FROM %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>\n<p>Using optional <span class=\"name\">sansTran</span> to run command without an explicit transaction commit or rollback:</p>\n<table border=\"1\">\n<tr>\n<td>@{queryResults}</td>\n<td>Description</td>\n<td>SELECT * FROM person</td>\n<td>True</td>\n</tr>\n</table>", "shortdoc": "Uses the input ``selectStatement`` to query a table in the db which will be used to determine the description.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 144}, {"name": "Disconnect From All Databases", "args": [], "returnType": null, "doc": "<p>Disconnects from all the databases - useful when testing with multiple database connections (aliases).</p>\n<p>For example:</p>\n<table border=\"1\">\n<tr>\n<td>Disconnect From All Databases</td>\n<td># Closes connections to all databases</td>\n</tr>\n</table>", "shortdoc": "Disconnects from all the databases - useful when testing with multiple database connections (aliases).", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 511}, {"name": "Disconnect From Database", "args": [{"name": "error_if_no_connection", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error_if_no_connection: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}], "returnType": null, "doc": "<p>Disconnects from the database.</p>\n<p>By default, it's not an error if there was no open database connection - suitable for usage as a teardown. However, you can enforce it using the <span class=\"name\">error_if_no_connection</span> parameter.</p>\n<p>Example usage:</p>\n<table border=\"1\">\n<tr>\n<td>Disconnect From Database</td>\n<td># disconnects from current connection to the database</td>\n<td></td>\n</tr>\n<tr>\n<td>Disconnect From Database</td>\n<td>alias=my_alias</td>\n<td># disconnects from current connection to the database</td>\n</tr>\n</table>", "shortdoc": "Disconnects from the database.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 490}, {"name": "Execute Sql Script", "args": [{"name": "sqlScriptFileName", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "sqlScriptFileName: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "split", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "split: bool = True"}], "returnType": null, "doc": "<p>Executes the content of the <span class=\"name\">sqlScriptFileName</span> as SQL commands. Useful for setting the database to a known state before running your tests, or clearing out your test data after running each a test.</p>\n<p>SQL commands are expected to be delimited by a semicolon (';') - they will be split and executed separately. You can disable this behaviour setting the parameter <span class=\"name\">split</span> to <i>False</i> - in this case the entire script content will be passed to the database module for execution.</p>\n<p>Sample usage :</p>\n<table border=\"1\">\n<tr>\n<td>Execute Sql Script</td>\n<td>${EXECDIR}${/}resources${/}DDL-setup.sql</td>\n<td></td>\n</tr>\n<tr>\n<td>Execute Sql Script</td>\n<td>${EXECDIR}${/}resources${/}DML-setup.sql</td>\n<td></td>\n</tr>\n<tr>\n<td>Execute Sql Script</td>\n<td>${EXECDIR}${/}resources${/}DDL-setup.sql</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>#interesting stuff here</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Execute Sql Script</td>\n<td>${EXECDIR}${/}resources${/}DML-teardown.sql</td>\n<td></td>\n</tr>\n<tr>\n<td>Execute Sql Script</td>\n<td>${EXECDIR}${/}resources${/}DDL-teardown.sql</td>\n<td></td>\n</tr>\n</table>\n<p>For example: DELETE FROM person_employee_table; DELETE FROM person_table; DELETE FROM employee_table;</p>\n<p>Also, the last SQL command can optionally omit its trailing semi-colon.</p>\n<p>For example: DELETE FROM person_employee_table; DELETE FROM person_table; DELETE FROM employee_table</p>\n<p>Given this, that means you can create spread your SQL commands in several lines.</p>\n<p>For example: DELETE FROM person_employee_table; DELETE FROM person_table; DELETE FROM employee_table</p>\n<p>However, lines that starts with a number sign (<span class=\"name\">#</span>) or a double dash (\"--\") are treated as a commented line. Thus, none of the contents of that line will be executed.</p>\n<p>For example: # Delete the bridging table first... DELETE FROM person_employee_table; # ...and then the bridged tables. DELETE FROM person_table; DELETE FROM employee_table</p>\n<p>The slash signs (\"/\") are always ignored and have no impact on execution order.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <span class=\"name\">sansTran</span> to run command without an explicit transaction commit or rollback:</p>\n<table border=\"1\">\n<tr>\n<td>Execute Sql Script</td>\n<td>${EXECDIR}${/}resources${/}DDL-setup.sql</td>\n<td>True</td>\n</tr>\n</table>", "shortdoc": "Executes the content of the `sqlScriptFileName` as SQL commands. Useful for setting the database to a known state before running your tests, or clearing out your test data after running each a test.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 223}, {"name": "Execute Sql String", "args": [{"name": "sqlString", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "sqlString: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: Tuple | None = None"}, {"name": "omitTrailingSemicolon", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "omitTrailingSemicolon: bool | None = None"}], "returnType": null, "doc": "<p>Executes the <code>sqlString</code> as a single SQL command.</p>\n<p>Use optional <code>sansTran</code> to run command without an explicit transaction commit or rollback.</p>\n<p>Use optional <code>omitTrailingSemicolon</code> parameter for explicit instruction, if the trailing semicolon (;) at the SQL string end should be removed or not:</p>\n<ul>\n<li>Some database modules (e.g. Oracle) throw an exception, if you leave a semicolon at the string end</li>\n<li>However, there are exceptional cases, when you need it even for Oracle - e.g. at the end of a PL/SQL block.</li>\n<li>If not specified, it's decided based on the current database module in use. For Oracle, the semicolon is removed by default.</li>\n</ul>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>For example:</p>\n<table border=\"1\">\n<tr>\n<td>Execute Sql String</td>\n<td>DELETE FROM person_employee_table; DELETE FROM person_table</td>\n<td></td>\n</tr>\n<tr>\n<td>Execute Sql String</td>\n<td>DELETE FROM person_employee_table; DELETE FROM person_table</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Execute Sql String</td>\n<td>DELETE FROM person_employee_table; DELETE FROM person_table</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>Execute Sql String</td>\n<td>CREATE PROCEDURE proc AS BEGIN DBMS_OUTPUT.PUT_LINE('Hello!'); END;</td>\n<td>omitTrailingSemicolon=False</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>person_employee_table</td>\n</tr>\n<tr>\n<td>Execute Sql String</td>\n<td>SELECT * FROM %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "Executes the ``sqlString`` as a single SQL command.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 367}, {"name": "Query", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "returnAsDict", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "returnAsDict: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: Tuple | None = None"}], "returnType": null, "doc": "<p>Runs a query with the <code>selectStatement</code> and returns the result as a list of rows. The type of row values depends on the database module - usually they are tuples or tuple-like objects.</p>\n<p>Set optional input <code>returnAsDict</code> to <i>True</i> to explicitely convert the return values into a list of dictionaries.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client):</p>\n<table border=\"1\">\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>person</td>\n</tr>\n<tr>\n<td>Query</td>\n<td>SELECT * FROM %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>\n<p>Use optional <code>sansTran</code> to run command without an explicit transaction commit or rollback:</p>\n<table border=\"1\">\n<tr>\n<td>@{queryResults}</td>\n<td>Query</td>\n<td>SELECT * FROM person</td>\n<td>True</td>\n</tr>\n</table>\n<p>Tip: Unless you want to log all column values of the specified rows, try specifying the column names in your select statements as much as possible to prevent any unnecessary surprises with schema changes and to easily see what your [] indexing is trying to retrieve (i.e. instead of <span class=\"name\">\"select * from my_table\"</span>, try <span class=\"name\">\"select id, col_1, col_2 from my_table\"</span>).</p>\n<p>For example, given we have a table <span class=\"name\">person</span> with the following data:</p>\n<table border=\"1\">\n<tr>\n<td>id</td>\n<td>first_name</td>\n<td>last_name</td>\n</tr>\n<tr>\n<td>1</td>\n<td>Franz Allan</td>\n<td>See</td>\n</tr>\n</table>\n<p>When you do the following:</p>\n<table border=\"1\">\n<tr>\n<td>@{queryResults}</td>\n<td>Query</td>\n<td>SELECT * FROM person</td>\n<td></td>\n</tr>\n<tr>\n<td>@{queryResults}</td>\n<td>Query</td>\n<td>SELECT * FROM person</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Log Many</td>\n<td>@{queryResults}</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>You will get the following: [1, 'Franz Allan', 'See']</p>\n<p>Also, you can do something like this:</p>\n<table border=\"1\">\n<tr>\n<td>${queryResults}</td>\n<td>Query</td>\n<td>SELECT first_name, last_name FROM person</td>\n</tr>\n<tr>\n<td>Log</td>\n<td>${queryResults[0][1]}, ${queryResults[0][0]}</td>\n<td></td>\n</tr>\n</table>\n<p>And get the following See, Franz Allan</p>", "shortdoc": "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 - usually they are tuples or tuple-like objects.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 33}, {"name": "Row Count", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: Tuple | None = None"}], "returnType": null, "doc": "<p>Uses the input <code>selectStatement</code> to query the database and returns the number of rows from the query.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>sansTran</code> to run command without an explicit transaction commit or rollback:</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client):</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>${rowCount}</td>\n<td>Row Count</td>\n<td>SELECT * FROM person</td>\n<td></td>\n</tr>\n<tr>\n<td>${rowCount}</td>\n<td>Row Count</td>\n<td>SELECT * FROM person</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>${rowCount}</td>\n<td>Row Count</td>\n<td>SELECT * FROM person</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>person</td>\n<td></td>\n</tr>\n<tr>\n<td>${rowCount}</td>\n<td>Row Count</td>\n<td>SELECT * FROM %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "Uses the input ``selectStatement`` to query the database and returns the number of rows from the query.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 101}, {"name": "Row Count Is 0", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: Tuple | None = None"}], "returnType": null, "doc": "<p><b>DEPRECATED</b> Use new <a href=\"#Check%20Row%20Count\" class=\"name\">Check Row Count</a> keyword with assertion engine instead. The deprecated keyword will be removed in future versions.</p>\n<p>Check if any rows are returned from the submitted <code>selectStatement</code>. If there are, then this will throw an AssertionError.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>The default error message can be overridden with the <code>msg</code> argument.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Row Count is 0</td>\n<td>SELECT id FROM person WHERE first_name = 'Franz Allan'</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count is 0</td>\n<td>SELECT id FROM person WHERE first_name = 'Franz Allan'</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Row Count is 0</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Row Count is 0</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n</tr>\n<tr>\n<td>Row Count is 0</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "*DEPRECATED* Use new `Check Row Count` keyword with assertion engine instead. The deprecated keyword will be removed in future versions.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 107, "deprecated": true}, {"name": "Row Count Is Equal To X", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "numRows", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "numRows: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: Tuple | None = None"}], "returnType": null, "doc": "<p><b>DEPRECATED</b> Use new <a href=\"#Check%20Row%20Count\" class=\"name\">Check Row Count</a> keyword with assertion engine instead. The deprecated keyword will be removed in future versions.</p>\n<p>Check if the number of rows returned from <code>selectStatement</code> is equal to the value submitted. If not, then this will throw an AssertionError.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>The default error message can be overridden with the <code>msg</code> argument.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Row Count Is Equal To X</td>\n<td>SELECT id FROM person</td>\n<td>1</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count Is Equal To X</td>\n<td>SELECT id FROM person</td>\n<td>3</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Row Count Is Equal To X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>0</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Row Count Is Equal To X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>0</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count Is Equal To X</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td>0</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "*DEPRECATED* Use new `Check Row Count` keyword with assertion engine instead. The deprecated keyword will be removed in future versions.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 145, "deprecated": true}, {"name": "Row Count Is Greater Than X", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "numRows", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "numRows: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: Tuple | None = None"}], "returnType": null, "doc": "<p><b>DEPRECATED</b> Use new <a href=\"#Check%20Row%20Count\" class=\"name\">Check Row Count</a> keyword with assertion engine instead. The deprecated keyword will be removed in future versions.</p>\n<p>Check if the number of rows returned from <code>selectStatement</code> is greater than the value submitted. If not, then this will throw an AssertionError.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>The default error message can be overridden with the <code>msg</code> argument.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Row Count Is Greater Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>0</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count Is Greater Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>0</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Row Count Is Greater Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>0</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Row Count Is Greater Than X</td>\n<td>SELECT id FROM person</td>\n<td>1</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count Is Greater Than X</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td>0</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "*DEPRECATED* Use new `Check Row Count` keyword with assertion engine instead. The deprecated keyword will be removed in future versions.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 185, "deprecated": true}, {"name": "Row Count Is Less Than X", "args": [{"name": "selectStatement", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selectStatement: str"}, {"name": "numRows", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "numRows: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "parameters", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parameters: Tuple | None = None"}], "returnType": null, "doc": "<p><b>DEPRECATED</b> Use new <a href=\"#Check%20Row%20Count\" class=\"name\">Check Row Count</a> keyword with assertion engine instead. The deprecated keyword will be removed in future versions.</p>\n<p>Check if the number of rows returned from <code>selectStatement</code> is less than the value submitted. If not, then this will throw an AssertionError.</p>\n<p>Set optional input <code>sansTran</code> to <i>True</i> to run command without an explicit transaction commit or rollback.</p>\n<p>Using optional <code>msg</code> to override the default error message:</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Use optional <code>parameters</code> for query variable substitution (variable substitution syntax may be different depending on the database client).</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Row Count Is Less Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>1</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count Is Less Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>2</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Row Count Is Less Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>3</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Row Count Is Less Than X</td>\n<td>SELECT id FROM person WHERE first_name = 'John'</td>\n<td>4</td>\n<td>sansTran=True</td>\n</tr>\n<tr>\n<td>@{parameters}</td>\n<td>Create List</td>\n<td>John</td>\n<td></td>\n</tr>\n<tr>\n<td>Row Count Is Less Than X</td>\n<td>SELECT id FROM person WHERE first_name = %s</td>\n<td>5</td>\n<td>parameters=${parameters}</td>\n</tr>\n</table>", "shortdoc": "*DEPRECATED* Use new `Check Row Count` keyword with assertion engine instead. The deprecated keyword will be removed in future versions.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 225, "deprecated": true}, {"name": "Set Auto Commit", "args": [{"name": "autoCommit", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "autoCommit: bool = True"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}], "returnType": null, "doc": "<p>Turn the autocommit on the database connection ON or OFF.</p>\n<p>The default behaviour on a newly created database connection is to automatically start a transaction, which means that database actions that won't work if there is an active transaction will fail. Common examples of these actions are creating or deleting a database or database snapshot. By turning on auto commit on the database connection these actions can be performed.</p>\n<p>Example usage:</p>\n<pre>\n# Default behaviour, sets auto commit to true\nSet Auto Commit\nSet Auto Commit | alias=my_alias |\n# Explicitly set the desired state\nSet Auto Commit | False\n</pre>", "shortdoc": "Turn the autocommit on the database connection ON or OFF.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 523}, {"name": "Set Logging Query Results", "args": [{"name": "enabled", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "enabled: bool | None = None"}, {"name": "log_head", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "log_head: int | None = None"}], "returnType": null, "doc": "<p>Allows to enable/disable logging of query results and to adjust the log head value.</p>\n<ul>\n<li>Overrides the values, which were set during the library import.</li>\n<li>See <a href=\"#Logging%20query%20results\" class=\"name\">Logging query results</a> for details.</li>\n</ul>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Set Logging Query Results</td>\n<td>enabled=False</td>\n<td></td>\n</tr>\n<tr>\n<td>Set Logging Query Results</td>\n<td>enabled=True</td>\n<td>log_head=0</td>\n</tr>\n<tr>\n<td>Set Logging Query Results</td>\n<td>log_head=10</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Allows to enable/disable logging of query results and to adjust the log head value. - Overrides the values, which were set during the library import. - See `Logging query results` for details.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/query.py", "lineno": 708}, {"name": "Switch Database", "args": [{"name": "alias", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "alias: str"}], "returnType": null, "doc": "<p>Switch the default database connection to <code>alias</code>.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Switch Database</td>\n<td>my_alias</td>\n</tr>\n<tr>\n<td>Switch Database</td>\n<td>alias=my_alias</td>\n</tr>\n</table>", "shortdoc": "Switch the default database connection to ``alias``.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/connection_manager.py", "lineno": 543}, {"name": "Table Must Exist", "args": [{"name": "tableName", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "tableName: str"}, {"name": "sansTran", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sansTran: bool = False"}, {"name": "msg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "msg: str | None = None"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}], "returnType": null, "doc": "<p>Check if the given table exists in the database.</p>\n<p>Set optional input <code>sansTran</code> to True to run command without an explicit transaction commit or rollback.</p>\n<p>The default error message can be overridden with the <code>msg</code> argument.</p>\n<p>Use optional <code>alias</code> parameter to specify what connection should be used for the query if you have more than one connection open.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Table Must Exist</td>\n<td>person</td>\n<td></td>\n</tr>\n<tr>\n<td>Table Must Exist</td>\n<td>person</td>\n<td>msg=my error message</td>\n</tr>\n<tr>\n<td>Table Must Exist</td>\n<td>person</td>\n<td>alias=my_alias</td>\n</tr>\n<tr>\n<td>Table Must Exist</td>\n<td>person</td>\n<td>sansTran=True</td>\n</tr>\n</table>", "shortdoc": "Check if the given table exists in the database.", "tags": [], "source": "/Users/andremochinin/DEV/Robotframework-Database-Library/src/DatabaseLibrary/assertion.py", "lineno": 388}], "typedocs": [{"type": "Standard", "name": "Any", "doc": "<p>Any value is accepted. No conversion is done.</p>", "usages": ["Check Query Result"], "accepts": ["Any"]}, {"type": "Enum", "name": "AssertionOperator", "doc": "<p>Currently supported assertion operators are:</p>\n<table border=\"1\">\n<tr>\n<th>Operator</th>\n<th>Alternative Operators</th>\n<th>Description</th>\n<th>Validate Equivalent</th>\n</tr>\n<tr>\n<td><code>==</code></td>\n<td><code>equal</code>, <code>equals</code>, <code>should be</code></td>\n<td>Checks if returned value is equal to expected value.</td>\n<td><code>value == expected</code></td>\n</tr>\n<tr>\n<td><code>!=</code></td>\n<td><code>inequal</code>, <code>should not be</code></td>\n<td>Checks if returned value is not equal to expected value.</td>\n<td><code>value != expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;</code></td>\n<td><code>greater than</code></td>\n<td>Checks if returned value is greater than expected value.</td>\n<td><code>value &gt; expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;=</code></td>\n<td></td>\n<td>Checks if returned value is greater than or equal to expected value.</td>\n<td><code>value &gt;= expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;</code></td>\n<td><code>less than</code></td>\n<td>Checks if returned value is less than expected value.</td>\n<td><code>value &lt; expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;=</code></td>\n<td></td>\n<td>Checks if returned value is less than or equal to expected value.</td>\n<td><code>value &lt;= expected</code></td>\n</tr>\n<tr>\n<td><code>*=</code></td>\n<td><code>contains</code></td>\n<td>Checks if returned value contains expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td></td>\n<td><code>not contains</code></td>\n<td>Checks if returned value does not contain expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td><code>^=</code></td>\n<td><code>should start with</code>, <code>starts</code></td>\n<td>Checks if returned value starts with expected value.</td>\n<td><code>re.search(f\"^{expected}\", value)</code></td>\n</tr>\n<tr>\n<td><code>$=</code></td>\n<td><code>should end with</code>, <code>ends</code></td>\n<td>Checks if returned value ends with expected value.</td>\n<td><code>re.search(f\"{expected}$\", value)</code></td>\n</tr>\n<tr>\n<td><code>matches</code></td>\n<td></td>\n<td>Checks if given RegEx matches minimum once in returned value.</td>\n<td><code>re.search(expected, value)</code></td>\n</tr>\n<tr>\n<td><code>validate</code></td>\n<td></td>\n<td>Checks if given Python expression evaluates to <code>True</code>.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>evaluate</code></td>\n<td><code>then</code></td>\n<td>When using this operator, the keyword does return the evaluated Python expression.</td>\n<td></td>\n</tr>\n</table>\n<p>Currently supported formatters for assertions are:</p>\n<table border=\"1\">\n<tr>\n<th>Formatter</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>normalize spaces</code></td>\n<td>Substitutes multiple spaces to single space from the value</td>\n</tr>\n<tr>\n<td><code>strip</code></td>\n<td>Removes spaces from the beginning and end of the value</td>\n</tr>\n<tr>\n<td><code>case insensitive</code></td>\n<td>Converts value to lower case before comparing</td>\n</tr>\n<tr>\n<td><code>apply to expected</code></td>\n<td>Applies rules also for the expected value</td>\n</tr>\n</table>\n<p>Formatters are applied to the value before assertion is performed and keywords returns a value where rule is applied. Formatter is only applied to the value which keyword returns and not all rules are valid for all assertion operators. If <code>apply to expected</code> formatter is defined, then formatters are then formatter are also applied to expected value.</p>", "usages": ["Check Query Result", "Check Row Count"], "accepts": ["string"], "members": [{"name": "equal", "value": "=="}, {"name": "equals", "value": "=="}, {"name": "==", "value": "=="}, {"name": "should be", "value": "=="}, {"name": "inequal", "value": "!="}, {"name": "!=", "value": "!="}, {"name": "should not be", "value": "!="}, {"name": "less than", "value": "<"}, {"name": "<", "value": "<"}, {"name": "greater than", "value": ">"}, {"name": ">", "value": ">"}, {"name": "<=", "value": "<="}, {"name": ">=", "value": ">="}, {"name": "contains", "value": "*="}, {"name": "not contains", "value": "not contains"}, {"name": "*=", "value": "*="}, {"name": "starts", "value": "^="}, {"name": "^=", "value": "^="}, {"name": "should start with", "value": "^="}, {"name": "ends", "value": "$="}, {"name": "should end with", "value": "$="}, {"name": "$=", "value": "$="}, {"name": "matches", "value": "$"}, {"name": "validate", "value": "validate"}, {"name": "then", "value": "then"}, {"name": "evaluate", "value": "then"}]}, {"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["Call Stored Procedure", "Check If Exists In Database", "Check If Not Exists In Database", "Check Query Result", "Check Row Count", "Delete All Rows From Table", "Description", "Disconnect From Database", "Execute Sql Script", "Execute Sql String", "Query", "Row Count", "Row Count Is 0", "Row Count Is Equal To X", "Row Count Is Greater Than X", "Row Count Is Less Than X", "Set Auto Commit", "Set Logging Query Results", "Table Must Exist"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["Check Row Count", "Connect To Database", "Set Logging Query Results"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["Call Stored Procedure"], "accepts": ["string", "Sequence"]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["Call Stored Procedure", "Check If Exists In Database", "Check If Not Exists In Database", "Check Query Result", "Check Row Count", "Connect To Database", "Connect To Database Using Custom Connection String", "Connect To Database Using Custom Params", "Delete All Rows From Table", "Description", "Disconnect From Database", "Execute Sql Script", "Execute Sql String", "Query", "Row Count", "Row Count Is 0", "Row Count Is Equal To X", "Row Count Is Greater Than X", "Row Count Is Less Than X", "Set Auto Commit", "Set Logging Query Results", "Table Must Exist"], "accepts": ["string"]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["Call Stored Procedure", "Check If Exists In Database", "Check If Not Exists In Database", "Check Query Result", "Check Row Count", "Connect To Database", "Connect To Database Using Custom Connection String", "Connect To Database Using Custom Params", "Delete All Rows From Table", "Description", "Disconnect From Database", "Execute Sql Script", "Execute Sql String", "Query", "Row Count", "Row Count Is 0", "Row Count Is Equal To X", "Row Count Is Greater Than X", "Row Count Is Less Than X", "Set Auto Commit", "Switch Database", "Table Must Exist"], "accepts": ["Any"]}, {"type": "Standard", "name": "tuple", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#tuple\">tuple</a> literals. They are converted to actual tuples using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including tuples and other containers.</p>\n<p>If the type has nested types like <code>tuple[str, int, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>('one', 'two')</code>, <code>(('one', 1), ('two', 2))</code></p>", "usages": ["Check If Exists In Database", "Check If Not Exists In Database", "Check Query Result", "Check Row Count", "Description", "Execute Sql String", "Query", "Row Count", "Row Count Is 0", "Row Count Is Equal To X", "Row Count Is Greater Than X", "Row Count Is Less Than X"], "accepts": ["string", "Sequence"]}]}
 </script>
 <title></title>
 </head>
@@ -1699,13 +1710,23 @@ <h4>Arguments</h4>
                 </div>
               </div>
             {{/if}}
+            {{if returnType}}
+            <div class="return-type">
+              <h4>Return Type</h4>
+              <span class="arg-type">
+              {{tmpl(returnType) 'type-info-template'}}
+              </span>
+            </div>
+            {{/if}}
             {{if libdoc.tags.length && tags.length}}
               <div class="tags">
                 <h4>Tags</h4>
+                <span class="kw-tags">
                 {{each tags}}
                   <a href="javascript:tagSearch('${$value}')"
                     title="Show keywords with this tag">${$value}</a>{{if $index < tags.length-1}},<br>{{/if}}
                 {{/each}}
+                </span>
               </div>
             {{/if}}
           </div>
diff --git a/src/DatabaseLibrary/__init__.py b/src/DatabaseLibrary/__init__.py
index 6f6c986..d0a8967 100644
--- a/src/DatabaseLibrary/__init__.py
+++ b/src/DatabaseLibrary/__init__.py
@@ -93,6 +93,55 @@ class DatabaseLibrary(ConnectionManager, Query, Assertion):
     |     Execute Sql String    drop table XYZ
     |
 
+    = Using configuration file =
+    The `Connect To Database` keyword allows providing the connection parameters in two ways:
+    - As keyword arguments
+    - In a configuration file - a simple list of _key=value_ pairs, set inside an _alias_ section.
+
+    You can use only one way or you can combine them:
+    - The keyword arguments are taken by default
+    - If no keyword argument is provided, a parameter value is searched in the config file
+
+    Along with commonly used connection parameters, named exactly as keyword arguments, a config file
+    can contain any other DB module specific parameters as key/value pairs.
+    If same custom parameter is provided both as a keyword argument *and* in config file,
+    the *keyword argument value takes precedence*.
+
+    The path to the config file is set by default to `./resources/db.cfg`.
+    You can change it using an according parameter in the `Connect To Database` keyword.
+
+    A config file *must* contain at least one section name -
+    the connection alias, if used (see `Handling multiple database connections`), or
+    `[default]` if no aliases are used.
+
+    == Config file examples ==
+    === Config file with default alias (equal to using no aliases at all) ===
+    | [default]
+    | dbapiModuleName=psycopg2
+    | dbName=yourdbname
+    | dbUsername=yourusername
+    | dbPassword=yourpassword
+    | dbHost=yourhost
+    | dbPort=yourport
+
+    === Config file with a specific alias ===
+    | [myoracle]
+    | dbapiModuleName=oracledb
+    | dbName=yourdbname
+    | dbUsername=yourusername
+    | dbPassword=yourpassword
+    | dbHost=yourhost
+    | dbPort=yourport
+
+    === Config file with some params only ===
+    | [default]
+    | dbPassword=mysecret
+
+    === Config file with some custom DB module specific params ===
+    | [default]
+    | my_custom_param=value
+
+
     = Inline assertions =
     Keywords, that accept arguments ``assertion_operator`` <`AssertionOperator`> and ``expected_value``,
     perform a check according to the specified condition - using the [https://github.com/MarketSquare/AssertionEngine|Assertion Engine].
diff --git a/src/DatabaseLibrary/connection_manager.py b/src/DatabaseLibrary/connection_manager.py
index 6c5cbba..c0fe4ce 100644
--- a/src/DatabaseLibrary/connection_manager.py
+++ b/src/DatabaseLibrary/connection_manager.py
@@ -88,23 +88,48 @@ def __init__(self, config_file: Optional[str], alias: str):
     @staticmethod
     def _load_config(config_file: str) -> Optional[ConfigParser]:
         config_path = Path(config_file)
+        logger.info(f"Looking for configuration file: '{config_path}'")
         if not config_path.exists():
+            logger.info("Configuration file doesn't exist")
             return None
         config = ConfigParser()
         config.read([config_path])
+        logger.info("Successfully loaded configuration file")
         return config
 
-    def get(self, param: str) -> str:
+    def pop(self, param: str) -> Optional[str]:
+        """
+        Returns the `param` value read from the config file and deletes it from the list of all params read
+        """
         if self.config is None:
-            raise ValueError(f"Required '{param}' parameter was not provided in keyword arguments.") from None
+            logger.debug("Configuration file not loaded")
+            return None
         try:
-            return self.config.get(self.alias, param)
+            logger.debug(f"Looking for parameter '{param}' in configuration file")
+            param_value = self.config.get(self.alias, param)
+            logger.info(f"Found parameter '{param}' in configuration file")
+            self.config.remove_option(self.alias, param)
+            return param_value
         except NoSectionError:
-            raise ValueError(f"Configuration file does not have [{self.alias}] section.") from None
+            logger.debug(f"Configuration file does not have [{self.alias}] section.")
         except NoOptionError:
-            raise ValueError(
-                f"Required '{param}' parameter missing in both keyword arguments and configuration file."
-            ) from None
+            logger.debug(f"Parameter '{param}' missing in configuration file.")
+            return None
+
+    def get_all_available_params(self) -> Dict:
+        """
+        Returns a dictionary of all params read from the config file, which are currently available
+        (some of them might have been removed using the `pop` function)
+        """
+        if self.config is None:
+            logger.debug("Configuration file not loaded")
+            return {}
+        try:
+            all_options = dict(self.config.items(self.alias))
+            return all_options
+        except NoSectionError:
+            logger.debug(f"Configuration file does not have [{self.alias}] section.")
+            return {}
 
 
 class ConnectionManager:
@@ -116,6 +141,21 @@ def __init__(self):
         self.omit_trailing_semicolon: bool = False
         self.connection_store: ConnectionStore = ConnectionStore()
 
+    @staticmethod
+    def _hide_password_values(string_with_pass, params_separator=","):
+        string_with_hidden_pass = string_with_pass
+        for pass_param_name in ["pass", "passwd", "password", "pwd", "PWD"]:
+            pass_param_name += "="
+            splitted = string_with_hidden_pass.split(pass_param_name)
+            if len(splitted) < 2:
+                continue
+            splitted = splitted[1].split(params_separator)
+            value_to_hide = splitted[0]
+            string_with_hidden_pass = string_with_hidden_pass.replace(
+                f"{pass_param_name}{value_to_hide}", f"{pass_param_name}***"
+            )
+        return string_with_hidden_pass
+
     def connect_to_database(
         self,
         dbapiModuleName: Optional[str] = None,
@@ -129,13 +169,31 @@ def connect_to_database(
         dbConfigFile: Optional[str] = None,
         driverMode: Optional[str] = None,
         alias: str = "default",
+        **custom_connection_params,
     ):
         """
-        Loads the DB API 2.0 module given ``dbapiModuleName`` then uses it to
-        connect to the database using provided parameters such as ``dbName``, ``dbUsername``, and ``dbPassword``.
+        Creates a database connection using the DB API 2.0 module ``dbapiModuleName`` and the parameters provided.
+        Along with listed commonly used arguments (`dbName`, `dbHost` etc.)
+        you can set any other DB module specific parameters as key/value pairs.
+
+        Use ``dbConfigFile`` to provide a path to configuration file with connection parameters
+        to be used along with / instead of keyword arguments.
+        If no specified, it defaults to `./resources/db.cfg`.
+        See `Using configuration file` for more details.
+
+        All params are optional, although ``dbapiModuleName`` must be set - either as keyword argument or in config file.
+        If some of the listed keyword arguments (`dbName`, `dbHost` etc.) are not provided (i.e. left on default value `None`),
+        they are normally not passed to the Python DB module at all, except:
+        - _dbPort_ - commonly used port number for known databases is set as fallback
+        - _dbCharset_ - _UTF8_ is used as fallback for _pymysql_, _pymssql_ and _pyodbc_
+        - _driverMode_ - _thin_ is used as fallback for _oracledb_
+
+        Other custom params from keyword arguments and config file are passed to the Python DB module as provided -
+        normally as arguments for the _connect()_ function. However, when using *pyodbc*, the connection is established
+        using a connection string - so all the custom params are added into it instead of function arguments.
 
         Optional ``alias`` parameter can be used for creating multiple open connections, even for different databases.
-        If the same alias is given twice then previous connection will be overriden.
+        If the same alias is given twice then previous connection will be overridden.
 
         The ``driverMode`` is used to select the *oracledb* client mode.
         Allowed values are:
@@ -143,135 +201,176 @@ def connect_to_database(
         - _thick_
         - _thick,lib_dir=<PATH_TO_ORACLE_CLIENT>_
 
-        Optionally, you can specify a ``dbConfigFile`` wherein it will load the
-        alias (or alias will be "default") property values for ``dbapiModuleName``, ``dbName`` ``dbUsername``
-        and ``dbPassword`` (note: specifying ``dbapiModuleName``, ``dbName``
-        `dbUsername` or `dbPassword` directly will override the properties of
-        the same key in `dbConfigFile`). If no `dbConfigFile` is specified, it
-        defaults to `./resources/db.cfg`.
-
-        The `dbConfigFile` is useful if you don't want to check into your SCM
-        your database credentials.
-
-        Example db.cfg file
-        | [alias]
-        | dbapiModuleName=pymysqlforexample
-        | dbName=yourdbname
-        | dbUsername=yourusername
-        | dbPassword=yourpassword
-        | dbHost=yourhost
-        | dbPort=yourport
-
-        Example usage:
-        | # explicitly specifies all db property values |
-        | Connect To Database | psycopg2 | my_db | postgres | s3cr3t | tiger.foobar.com | 5432 |
-        | Connect To Database | psycopg2 | my_db | postgres | s3cr3t | tiger.foobar.com | 5432 | alias=my_alias |
-
-        | # loads all property values from default.cfg |
-        | Connect To Database | dbConfigFile=default.cfg |
-
-        | # loads all property values from ./resources/db.cfg |
-        | Connect To Database |
-
-        | # uses explicit `dbapiModuleName` and `dbName` but uses the `dbUsername` and `dbPassword` in 'default.cfg' |
-        | Connect To Database | psycopg2 | my_db_test | dbConfigFile=default.cfg |
-
-        | # uses explicit `dbapiModuleName` and `dbName` but uses the `dbUsername` and `dbPassword` in './resources/db.cfg' |
-        | Connect To Database | psycopg2 | my_db_test |
+        Examples
+        | Connect To Database | psycopg2 | my_db | user | pass | tiger.foobar.com | 5432 |
+        | Connect To Database | psycopg2 | my_db | user | pass | tiger.foobar.com | 5432 | my_custom_param=value |
+        | Connect To Database | psycopg2 | my_db | user | pass | tiger.foobar.com | 5432 | alias=my_alias |
+        | Connect To Database | dbConfigFile=my_db_params.cfg |
         """
         config = ConfigReader(dbConfigFile, alias)
 
-        dbapiModuleName = dbapiModuleName or config.get("dbapiModuleName")
-        dbName = dbName or config.get("dbName")
-        dbUsername = dbUsername or config.get("dbUsername")
-        dbPassword = dbPassword if dbPassword is not None else config.get("dbPassword")
-        dbHost = dbHost or config.get("dbHost") or "localhost"
-        dbPort = int(dbPort if dbPort is not None else config.get("dbPort"))
+        def _build_connection_params(custom_params=True, **basic_params):
+            con_params = basic_params.copy()
+            for param_name, param_val in basic_params.items():
+                if param_val is None:
+                    con_params.pop(param_name, None)
+            if custom_params:
+                con_params.update(custom_connection_params)
+                con_params.update(other_config_file_params)
+
+            return con_params
+
+        def _log_all_connection_params(*, connection_object=None, connection_string=None, **connection_params):
+            connection_object = connection_object or dbapiModuleName
+            msg = f"Connect to DB using : {connection_object}.connect("
+            params_separator = ","
+            if connection_string:
+                msg += f'"{connection_string}"'
+                params_separator = ";"
+            for param_name, param_value in connection_params.items():
+                msg += f", {param_name}="
+                if isinstance(param_value, str):
+                    msg += f"'{param_value}'"
+                else:
+                    msg += f"{param_value}"
+            if dbPassword:
+                msg = msg.replace(f"'{dbPassword}'", "***")
+            msg = self._hide_password_values(msg, params_separator)
+            msg = msg.replace("connect(, ", "connect(")
+            msg += ")"
+            logger.info(msg)
+
+        def _arg_or_config(arg_value, param_name, mandatory=False):
+            val_from_config = config.pop(param_name)
+            if arg_value is not None:
+                final_value = arg_value
+                if val_from_config is not None:
+                    logger.info(
+                        f"Parameter '{param_name}' set both as keyword argument and in config file, "
+                        "but keyword arguments take precedence"
+                    )
+            else:
+                final_value = val_from_config
+                if final_value is None and mandatory:
+                    raise ValueError(
+                        f"Required parameter '{param_name}' was not provided - "
+                        "neither in keyword arguments nor in config file"
+                    )
+            return final_value
+
+        # mandatory parameter
+        dbapiModuleName = _arg_or_config(dbapiModuleName, "dbapiModuleName", mandatory=True)
+        # optional named params - named because of custom module specific handling
+        dbName = _arg_or_config(dbName, "dbName")
+        dbUsername = _arg_or_config(dbUsername, "dbUsername")
+        dbPassword = _arg_or_config(dbPassword, "dbPassword")
+        dbHost = _arg_or_config(dbHost, "dbHost")
+        dbPort = _arg_or_config(dbPort, "dbPort")
+        if dbPort is not None:
+            dbPort = int(dbPort)
+        dbCharset = _arg_or_config(dbCharset, "dbCharset")
+        dbDriver = _arg_or_config(dbDriver, "dbDriver")
+        driverMode = _arg_or_config(driverMode, "driverMode")
+
+        for param_name, param_value in custom_connection_params.items():
+            _arg_or_config(param_value, param_name)
+        other_config_file_params = config.get_all_available_params()
+        if other_config_file_params:
+            logger.info(f"Other params from configuration file: {list(other_config_file_params.keys())}")
 
         if dbapiModuleName == "excel" or dbapiModuleName == "excelrw":
             db_api_module_name = "pyodbc"
-            db_api_2 = importlib.import_module("pyodbc")
         else:
             db_api_module_name = dbapiModuleName
-            db_api_2 = importlib.import_module(dbapiModuleName)
+        db_api_2 = importlib.import_module(db_api_module_name)
 
         if dbapiModuleName in ["MySQLdb", "pymysql"]:
             dbPort = dbPort or 3306
-            logger.info(
-                f"Connecting using : {dbapiModuleName}.connect("
-                f"db={dbName}, user={dbUsername}, passwd=***, host={dbHost}, port={dbPort}, charset={dbCharset})"
+            dbCharset = dbCharset or "utf8mb4"
+            con_params = _build_connection_params(
+                db=dbName, user=dbUsername, passwd=dbPassword, host=dbHost, port=dbPort, charset=dbCharset
             )
-            db_connection = db_api_2.connect(
-                db=dbName,
-                user=dbUsername,
-                passwd=dbPassword,
-                host=dbHost,
-                port=dbPort,
-                charset="utf8mb4" or dbCharset,
+            _log_all_connection_params(**con_params)
+            db_connection = db_api_2.connect(**con_params)
+
+        elif dbapiModuleName in ["pymssql"]:
+            dbPort = dbPort or 1433
+            dbCharset = dbCharset or "UTF-8"
+            con_params = _build_connection_params(
+                database=dbName, user=dbUsername, password=dbPassword, host=dbHost, port=dbPort, charset=dbCharset
             )
+            _log_all_connection_params(**con_params)
+            db_connection = db_api_2.connect(**con_params)
+
         elif dbapiModuleName in ["psycopg2"]:
             dbPort = dbPort or 5432
-            logger.info(
-                f"Connecting using : {dbapiModuleName}.connect("
-                f"database={dbName}, user={dbUsername}, password=***, host={dbHost}, port={dbPort})"
-            )
-            db_connection = db_api_2.connect(
-                database=dbName,
-                user=dbUsername,
-                password=dbPassword,
-                host=dbHost,
-                port=dbPort,
+            con_params = _build_connection_params(
+                database=dbName, user=dbUsername, password=dbPassword, host=dbHost, port=dbPort
             )
+            _log_all_connection_params(**con_params)
+            db_connection = db_api_2.connect(**con_params)
+
         elif dbapiModuleName in ["pyodbc", "pypyodbc"]:
             dbPort = dbPort or 1433
             dbCharset = dbCharset or "utf8mb4"
-            dbDriver = dbDriver or "{SQL Server}"
-            con_str = f"DRIVER={dbDriver};DATABASE={dbName};UID={dbUsername};PWD={dbPassword};charset={dbCharset};"
-            if "mysql" in dbDriver.lower():
-                con_str += f"SERVER={dbHost}:{dbPort}"
+
+            if dbDriver:
+                con_str = f"DRIVER={dbDriver};"
             else:
-                con_str += f"SERVER={dbHost},{dbPort}"
-            logger.info(f'Connecting using : {dbapiModuleName}.connect({con_str.replace(dbPassword, "***")})')
+                con_str = ""
+                logger.info("No ODBC driver specified")
+                logger.info(f"List of installed ODBC drivers: {db_api_2.drivers()}")
+            if dbName:
+                con_str += f"DATABASE={dbName};"
+            if dbUsername:
+                con_str += f"UID={dbUsername};"
+            if dbPassword:
+                con_str += f"PWD={dbPassword};"
+            if dbCharset:
+                con_str += f"charset={dbCharset};"
+            if dbHost and dbPort:
+                if dbDriver and "mysql" in dbDriver.lower():
+                    con_str += f"SERVER={dbHost}:{dbPort};"
+                else:
+                    con_str += f"SERVER={dbHost},{dbPort};"
+
+            for param_name, param_value in custom_connection_params.items():
+                con_str += f"{param_name}={param_value};"
+
+            for param_name, param_value in other_config_file_params.items():
+                con_str += f"{param_name}={param_value};"
+
+            _log_all_connection_params(connection_string=con_str)
             db_connection = db_api_2.connect(con_str)
-        elif dbapiModuleName in ["excel"]:
-            logger.info(
-                f"Connecting using : {dbapiModuleName}.connect("
-                f"DRIVER={{Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)}};DBQ={dbName};"
-                f'ReadOnly=1;Extended Properties="Excel 8.0;HDR=YES";)'
-            )
-            db_connection = db_api_2.connect(
-                f"DRIVER={{Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)}};DBQ={dbName};"
-                f'ReadOnly=1;Extended Properties="Excel 8.0;HDR=YES";)',
-                autocommit=True,
-            )
-        elif dbapiModuleName in ["excelrw"]:
-            logger.info(
-                f"Connecting using : {dbapiModuleName}.connect("
-                f"DRIVER={{Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)}};DBQ={dbName};"
-                f'ReadOnly=0;Extended Properties="Excel 8.0;HDR=YES";)',
-            )
-            db_connection = db_api_2.connect(
-                f"DRIVER={{Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)}};DBQ={dbName};"
-                f'ReadOnly=0;Extended Properties="Excel 8.0;HDR=YES";)',
-                autocommit=True,
-            )
+
+        elif dbapiModuleName in ["excel", "excelrw"]:
+            con_str = f"DRIVER={{Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)}};DBQ={dbName};"
+            con_str += "ReadOnly="
+            if dbapiModuleName == "excel":
+                con_str += "1;"
+            elif dbapiModuleName == "excelrw":
+                con_str += "0;"
+            con_str += 'Extended Properties="Excel 8.0;HDR=YES";)'
+            logger.info(f"Connecting using : {db_api_module_name}.connect({con_str}, autocommit=True)")
+            db_connection = db_api_2.connect(con_str, autocommit=True)
+
         elif dbapiModuleName in ["ibm_db", "ibm_db_dbi"]:
             dbPort = dbPort or 50000
-            conn_str = f"DATABASE={dbName};HOSTNAME={dbHost};PORT={dbPort};PROTOCOL=TCPIP;UID={dbUsername};"
-            logger.info(f"Connecting using : {dbapiModuleName}.connect(" f"{conn_str};PWD=***;)")
-            db_connection = db_api_2.connect(
-                f"{conn_str};PWD={dbPassword};",
-                "",
-                "",
+            con_str = (
+                f"DATABASE={dbName};HOSTNAME={dbHost};PORT={dbPort};PROTOCOL=TCPIP;UID={dbUsername};PWD={dbPassword};"
             )
+            con_params = _build_connection_params(userID="", userPassword="")
+            _log_all_connection_params(connection_string=con_str, **con_params)
+            db_connection = db_api_2.connect(con_str, **con_params)
+
         elif dbapiModuleName in ["cx_Oracle"]:
             dbPort = dbPort or 1521
             oracle_dsn = db_api_2.makedsn(host=dbHost, port=dbPort, service_name=dbName)
-            logger.info(
-                f"Connecting using: {dbapiModuleName}.connect(user={dbUsername}, password=***, dsn={oracle_dsn})"
-            )
-            db_connection = db_api_2.connect(user=dbUsername, password=dbPassword, dsn=oracle_dsn)
+            con_params = _build_connection_params(user=dbUsername, password=dbPassword, dsn=oracle_dsn)
+            _log_all_connection_params(**con_params)
+            db_connection = db_api_2.connect(**con_params)
             self.omit_trailing_semicolon = True
+
         elif dbapiModuleName in ["oracledb"]:
             dbPort = dbPort or 1521
             driverMode = driverMode or "thin"
@@ -292,24 +391,19 @@ def connect_to_database(
                 logger.info("Using thin Oracle client mode")
             else:
                 raise ValueError(f"Invalid Oracle client mode provided: {driverMode}")
-            logger.info(
-                f"Connecting using: {dbapiModuleName}.connect("
-                f"user={dbUsername}, password=***, params={oracle_connection_params})"
-            )
-            db_connection = db_api_2.connect(user=dbUsername, password=dbPassword, params=oracle_connection_params)
+            con_params = _build_connection_params(user=dbUsername, password=dbPassword, params=oracle_connection_params)
+            _log_all_connection_params(**con_params)
+            db_connection = db_api_2.connect(**con_params)
             assert db_connection.thin == oracle_thin_mode, (
                 "Expected oracledb to run in thin mode: {oracle_thin_mode}, "
                 f"but the connection has thin mode: {db_connection.thin}"
             )
             self.omit_trailing_semicolon = True
+
         elif dbapiModuleName in ["teradata"]:
             dbPort = dbPort or 1025
             teradata_udaExec = db_api_2.UdaExec(appName="RobotFramework", version="1.0", logConsole=False)
-            logger.info(
-                f"Connecting using : {dbapiModuleName}.connect("
-                f"database={dbName}, user={dbUsername}, password=***, host={dbHost}, port={dbPort})"
-            )
-            db_connection = teradata_udaExec.connect(
+            con_params = _build_connection_params(
                 method="odbc",
                 system=dbHost,
                 database=dbName,
@@ -318,37 +412,33 @@ def connect_to_database(
                 host=dbHost,
                 port=dbPort,
             )
+            _log_all_connection_params(connection_object=f"{dbapiModuleName}.UdaExec", **con_params)
+            db_connection = teradata_udaExec.connect(**con_params)
+
         elif dbapiModuleName in ["ksycopg2"]:
             dbPort = dbPort or 54321
-            logger.info(
-                f"Connecting using : {dbapiModuleName}.connect("
-                f"database={dbName}, user={dbUsername}, password=***, host={dbHost}, port={dbPort})"
-            )
-            db_connection = db_api_2.connect(
-                database=dbName,
-                user=dbUsername,
-                password=dbPassword,
-                host=dbHost,
-                port=dbPort,
+            con_params = _build_connection_params(
+                database=dbName, user=dbUsername, password=dbPassword, host=dbHost, port=dbPort
             )
+            _log_all_connection_params(**con_params)
+            db_connection = db_api_2.connect(**con_params)
+
         else:
-            logger.info(
-                f"Connecting using : {dbapiModuleName}.connect("
-                f"database={dbName}, user={dbUsername}, password=***, host={dbHost}, port={dbPort}) "
-            )
-            db_connection = db_api_2.connect(
-                database=dbName,
-                user=dbUsername,
-                password=dbPassword,
-                host=dbHost,
-                port=dbPort,
+            con_params = _build_connection_params(
+                database=dbName, user=dbUsername, password=dbPassword, host=dbHost, port=dbPort
             )
+            _log_all_connection_params(**con_params)
+            db_connection = db_api_2.connect(**con_params)
+
         self.connection_store.register_connection(db_connection, db_api_module_name, alias)
 
     def connect_to_database_using_custom_params(
         self, dbapiModuleName: Optional[str] = None, db_connect_string: str = "", alias: str = "default"
     ):
         """
+        *DEPRECATED* Use new `Connect To Database` keyword with custom parameters instead.
+        The deprecated keyword will be removed in future versions.
+
         Loads the DB API 2.0 module given `dbapiModuleName` then uses it to
         connect to the database using the map string `db_connect_string`
         (parsed as a list of named arguments).
@@ -364,20 +454,10 @@ def connect_to_database_using_custom_params(
         """
         db_api_2 = importlib.import_module(dbapiModuleName)
         db_api_module_name = dbapiModuleName
-
         db_connect_string = f"db_api_2.connect({db_connect_string})"
-
-        connection_string_with_hidden_pass = db_connect_string
-        for pass_param_name in ["pass", "passwd", "password", "pwd", "PWD"]:
-            splitted = connection_string_with_hidden_pass.split(pass_param_name + "=")
-            if len(splitted) < 2:
-                continue
-            splitted = splitted[1].split(",")
-            value_to_hide = splitted[0]
-            connection_string_with_hidden_pass = connection_string_with_hidden_pass.replace(value_to_hide, "***")
         logger.info(
             f"Executing : Connect To Database Using Custom Params : {dbapiModuleName}.connect("
-            f"{connection_string_with_hidden_pass})"
+            f"{self._hide_password_values(db_connect_string)})"
         )
 
         db_connection = eval(db_connect_string)
diff --git a/test/resources/common.resource b/test/resources/common.resource
index 0ba69a8..d98ca37 100644
--- a/test/resources/common.resource
+++ b/test/resources/common.resource
@@ -6,6 +6,7 @@ Library             Collections
 Library             OperatingSystem
 Library             DatabaseLibrary
 Library             DateTime
+Resource            config_files/connect_config_file.resource
 
 
 *** Variables ***
@@ -26,8 +27,10 @@ Connect To DB
     [Documentation]    Connects to the database based on the current DB module under test
     ...    and connection params set in global variables with alias
     [Arguments]    ${alias}=${None}
-    ${DB_KWARGS}    Create Dictionary
-    IF    $alias is not None    Set To Dictionary    ${DB_KWARGS}    alias=${alias}
+    ${DB_KWARGS}=    Create Dictionary
+    IF    $alias is not None
+        Set To Dictionary    ${DB_KWARGS}    alias=${alias}
+    END
     IF    "${DB_MODULE_MODE}" == "custom"
         IF    "${DB_MODULE}" == "sqlite3"
             Remove File    ${DBName}.db
@@ -38,8 +41,16 @@ Connect To DB
             Connect To Database Using Custom Connection String    ${DB_MODULE}    ${Connection String}    &{DB_KWARGS}
         END
     ELSE IF    "${DB_MODULE_MODE}" == "standard"
-        ${DB_ARGS}    Create List    ${DB_MODULE}    ${DB_NAME}    ${DB_USER}    ${DB_PASS}    ${DB_HOST}    ${DB_PORT}
-        IF    "${DB_MODULE}" == "pyodbc"    Set To Dictionary    ${DB_KWARGS}    dbDriver=${DB_DRIVER}
+        ${DB_ARGS}=    Create List
+        ...    ${DB_MODULE}
+        ...    ${DB_NAME}
+        ...    ${DB_USER}
+        ...    ${DB_PASS}
+        ...    ${DB_HOST}
+        ...    ${DB_PORT}
+        IF    "${DB_MODULE}" == "pyodbc"
+            Set To Dictionary    ${DB_KWARGS}    dbDriver=${DB_DRIVER}
+        END
         Connect To Database    @{DB_ARGS}    &{DB_KWARGS}
     ELSE
         Fail    Unexpected mode - ${DB_MODULE_MODE}
diff --git a/test/resources/config_files/connect_config_file.resource b/test/resources/config_files/connect_config_file.resource
new file mode 100644
index 0000000..569c1f3
--- /dev/null
+++ b/test/resources/config_files/connect_config_file.resource
@@ -0,0 +1,11 @@
+*** Settings ***
+Resource    ../common.resource
+
+
+*** Keywords ***
+Connect Using Config File
+    [Documentation]    `File name` is only name without extension,
+    ...    the path is build relative to the resource directory
+    [Arguments]    ${File name}=${None}    &{Params}
+    ${Path}=    Set Variable    ${CURDIR}/${File name}.cfg
+    Connect To Database    dbConfigFile=${Path}    &{Params}
diff --git a/test/resources/config_files/oracledb/custom_param_password.cfg b/test/resources/config_files/oracledb/custom_param_password.cfg
new file mode 100644
index 0000000..4835811
--- /dev/null
+++ b/test/resources/config_files/oracledb/custom_param_password.cfg
@@ -0,0 +1,6 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
+password=pass
+dbHost=127.0.0.1
+dbPort=1521
\ No newline at end of file
diff --git a/test/resources/config_files/oracledb/invalid_custom_params.cfg b/test/resources/config_files/oracledb/invalid_custom_params.cfg
new file mode 100644
index 0000000..3f2a48b
--- /dev/null
+++ b/test/resources/config_files/oracledb/invalid_custom_params.cfg
@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=1521
+blah=blah
\ No newline at end of file
diff --git a/test/resources/config_files/oracledb/simple_default_alias.cfg b/test/resources/config_files/oracledb/simple_default_alias.cfg
new file mode 100644
index 0000000..2d81cd4
--- /dev/null
+++ b/test/resources/config_files/oracledb/simple_default_alias.cfg
@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=1521
+driverMode=thin
\ No newline at end of file
diff --git a/test/resources/config_files/oracledb/some_basic_params_missing.cfg b/test/resources/config_files/oracledb/some_basic_params_missing.cfg
new file mode 100644
index 0000000..83454d0
--- /dev/null
+++ b/test/resources/config_files/oracledb/some_basic_params_missing.cfg
@@ -0,0 +1,3 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
\ No newline at end of file
diff --git a/test/resources/config_files/oracledb/thick_mode.cfg b/test/resources/config_files/oracledb/thick_mode.cfg
new file mode 100644
index 0000000..7878033
--- /dev/null
+++ b/test/resources/config_files/oracledb/thick_mode.cfg
@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=1521
+driverMode=thick
\ No newline at end of file
diff --git a/test/resources/config_files/oracledb/valid_custom_params.cfg b/test/resources/config_files/oracledb/valid_custom_params.cfg
new file mode 100644
index 0000000..6538367
--- /dev/null
+++ b/test/resources/config_files/oracledb/valid_custom_params.cfg
@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
+user=db_user
+password=pass
+dbHost=127.0.0.1
+dbPort=1521
\ No newline at end of file
diff --git a/test/resources/config_files/oracledb/wrong_password.cfg b/test/resources/config_files/oracledb/wrong_password.cfg
new file mode 100644
index 0000000..2b6b05d
--- /dev/null
+++ b/test/resources/config_files/oracledb/wrong_password.cfg
@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
+dbUsername=db_user
+dbPassword=wrong
+dbHost=127.0.0.1
+dbPort=1521
\ No newline at end of file
diff --git a/test/resources/config_files/psycopg2/custom_param_password.cfg b/test/resources/config_files/psycopg2/custom_param_password.cfg
new file mode 100644
index 0000000..0b0fa77
--- /dev/null
+++ b/test/resources/config_files/psycopg2/custom_param_password.cfg
@@ -0,0 +1,6 @@
+[default]
+dbapiModuleName=psycopg2
+dbName=db
+password=pass
+dbHost=127.0.0.1
+dbPort=5432
\ No newline at end of file
diff --git a/test/resources/config_files/psycopg2/invalid_custom_params.cfg b/test/resources/config_files/psycopg2/invalid_custom_params.cfg
new file mode 100644
index 0000000..343eeb4
--- /dev/null
+++ b/test/resources/config_files/psycopg2/invalid_custom_params.cfg
@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=psycopg2
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=5432
+blah=blah
\ No newline at end of file
diff --git a/test/resources/config_files/psycopg2/simple_default_alias.cfg b/test/resources/config_files/psycopg2/simple_default_alias.cfg
new file mode 100644
index 0000000..d9faef7
--- /dev/null
+++ b/test/resources/config_files/psycopg2/simple_default_alias.cfg
@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=psycopg2
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=5432
\ No newline at end of file
diff --git a/test/resources/config_files/psycopg2/some_basic_params_missing.cfg b/test/resources/config_files/psycopg2/some_basic_params_missing.cfg
new file mode 100644
index 0000000..7d82bff
--- /dev/null
+++ b/test/resources/config_files/psycopg2/some_basic_params_missing.cfg
@@ -0,0 +1,3 @@
+[default]
+dbapiModuleName=psycopg2
+dbName=db
\ No newline at end of file
diff --git a/test/resources/config_files/psycopg2/valid_custom_params.cfg b/test/resources/config_files/psycopg2/valid_custom_params.cfg
new file mode 100644
index 0000000..c143601
--- /dev/null
+++ b/test/resources/config_files/psycopg2/valid_custom_params.cfg
@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=psycopg2
+dbName=db
+user=db_user
+password=pass
+dbHost=127.0.0.1
+dbPort=5432
\ No newline at end of file
diff --git a/test/resources/config_files/psycopg2/wrong_password.cfg b/test/resources/config_files/psycopg2/wrong_password.cfg
new file mode 100644
index 0000000..074080f
--- /dev/null
+++ b/test/resources/config_files/psycopg2/wrong_password.cfg
@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=psycopg2
+dbName=db
+dbUsername=db_user
+dbPassword=wrong
+dbHost=127.0.0.1
+dbPort=5432
\ No newline at end of file
diff --git a/test/resources/config_files/pymssql/charset_invalid.cfg b/test/resources/config_files/pymssql/charset_invalid.cfg
new file mode 100644
index 0000000..c8ed37c
--- /dev/null
+++ b/test/resources/config_files/pymssql/charset_invalid.cfg
@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
+user=SA
+password=MyPass1234!
+dbHost=127.0.0.1
+dbPort=1433
+dbCharset=wrong
\ No newline at end of file
diff --git a/test/resources/config_files/pymssql/custom_param_password.cfg b/test/resources/config_files/pymssql/custom_param_password.cfg
new file mode 100644
index 0000000..e11f91b
--- /dev/null
+++ b/test/resources/config_files/pymssql/custom_param_password.cfg
@@ -0,0 +1,6 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
+password=MyPass1234!
+dbHost=127.0.0.1
+dbPort=1433
\ No newline at end of file
diff --git a/test/resources/config_files/pymssql/invalid_custom_params.cfg b/test/resources/config_files/pymssql/invalid_custom_params.cfg
new file mode 100644
index 0000000..7935942
--- /dev/null
+++ b/test/resources/config_files/pymssql/invalid_custom_params.cfg
@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
+dbUsername=SA
+dbPassword=MyPass1234!
+dbHost=127.0.0.1
+dbPort=1433
+blah=blah
\ No newline at end of file
diff --git a/test/resources/config_files/pymssql/simple_default_alias.cfg b/test/resources/config_files/pymssql/simple_default_alias.cfg
new file mode 100644
index 0000000..00a68ad
--- /dev/null
+++ b/test/resources/config_files/pymssql/simple_default_alias.cfg
@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
+dbUsername=SA
+dbPassword=MyPass1234!
+dbHost=127.0.0.1
+dbPort=1433
\ No newline at end of file
diff --git a/test/resources/config_files/pymssql/some_basic_params_missing.cfg b/test/resources/config_files/pymssql/some_basic_params_missing.cfg
new file mode 100644
index 0000000..af0f2d7
--- /dev/null
+++ b/test/resources/config_files/pymssql/some_basic_params_missing.cfg
@@ -0,0 +1,3 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
\ No newline at end of file
diff --git a/test/resources/config_files/pymssql/valid_custom_params.cfg b/test/resources/config_files/pymssql/valid_custom_params.cfg
new file mode 100644
index 0000000..4ba6dd2
--- /dev/null
+++ b/test/resources/config_files/pymssql/valid_custom_params.cfg
@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
+user=SA
+password=MyPass1234!
+dbHost=127.0.0.1
+dbPort=1433
\ No newline at end of file
diff --git a/test/resources/config_files/pymssql/wrong_password.cfg b/test/resources/config_files/pymssql/wrong_password.cfg
new file mode 100644
index 0000000..df8b822
--- /dev/null
+++ b/test/resources/config_files/pymssql/wrong_password.cfg
@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
+dbUsername=SA
+dbPassword=wrong
+dbHost=127.0.0.1
+dbPort=1433
\ No newline at end of file
diff --git a/test/resources/config_files/pymysql/charset_invalid.cfg b/test/resources/config_files/pymysql/charset_invalid.cfg
new file mode 100644
index 0000000..e64b4d8
--- /dev/null
+++ b/test/resources/config_files/pymysql/charset_invalid.cfg
@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
+user=db_user
+password=pass
+dbHost=127.0.0.1
+dbPort=3306
+dbCharset=wrong
\ No newline at end of file
diff --git a/test/resources/config_files/pymysql/custom_param_password.cfg b/test/resources/config_files/pymysql/custom_param_password.cfg
new file mode 100644
index 0000000..dd211e0
--- /dev/null
+++ b/test/resources/config_files/pymysql/custom_param_password.cfg
@@ -0,0 +1,6 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
+password=pass
+dbHost=127.0.0.1
+dbPort=3306
\ No newline at end of file
diff --git a/test/resources/config_files/pymysql/invalid_custom_params.cfg b/test/resources/config_files/pymysql/invalid_custom_params.cfg
new file mode 100644
index 0000000..31e3a20
--- /dev/null
+++ b/test/resources/config_files/pymysql/invalid_custom_params.cfg
@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=3306
+blah=blah
\ No newline at end of file
diff --git a/test/resources/config_files/pymysql/simple_default_alias.cfg b/test/resources/config_files/pymysql/simple_default_alias.cfg
new file mode 100644
index 0000000..0d73312
--- /dev/null
+++ b/test/resources/config_files/pymysql/simple_default_alias.cfg
@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=3306
\ No newline at end of file
diff --git a/test/resources/config_files/pymysql/some_basic_params_missing.cfg b/test/resources/config_files/pymysql/some_basic_params_missing.cfg
new file mode 100644
index 0000000..e341dc9
--- /dev/null
+++ b/test/resources/config_files/pymysql/some_basic_params_missing.cfg
@@ -0,0 +1,3 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
\ No newline at end of file
diff --git a/test/resources/config_files/pymysql/valid_custom_params.cfg b/test/resources/config_files/pymysql/valid_custom_params.cfg
new file mode 100644
index 0000000..4df80c1
--- /dev/null
+++ b/test/resources/config_files/pymysql/valid_custom_params.cfg
@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
+user=db_user
+password=pass
+dbHost=127.0.0.1
+dbPort=3306
\ No newline at end of file
diff --git a/test/resources/config_files/pymysql/wrong_password.cfg b/test/resources/config_files/pymysql/wrong_password.cfg
new file mode 100644
index 0000000..9ce8ca7
--- /dev/null
+++ b/test/resources/config_files/pymysql/wrong_password.cfg
@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
+dbUsername=db_user
+dbPassword=wrong
+dbHost=127.0.0.1
+dbPort=3306
\ No newline at end of file
diff --git a/test/resources/config_files/pyodbc/charset_invalid.cfg b/test/resources/config_files/pyodbc/charset_invalid.cfg
new file mode 100644
index 0000000..73a0be8
--- /dev/null
+++ b/test/resources/config_files/pyodbc/charset_invalid.cfg
@@ -0,0 +1,9 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db
+user=db_user
+password=pass
+dbHost=127.0.0.1
+dbPort=3306
+dbDriver={MySQL ODBC 8.0 ANSI Driver}
+dbCharset=wrong
\ No newline at end of file
diff --git a/test/resources/config_files/pyodbc/custom_param_password.cfg b/test/resources/config_files/pyodbc/custom_param_password.cfg
new file mode 100644
index 0000000..6021e0a
--- /dev/null
+++ b/test/resources/config_files/pyodbc/custom_param_password.cfg
@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db
+PWD=pass
+dbHost=127.0.0.1
+dbPort=3306
+dbDriver={MySQL ODBC 8.0 ANSI Driver}
\ No newline at end of file
diff --git a/test/resources/config_files/pyodbc/invalid_custom_params.cfg b/test/resources/config_files/pyodbc/invalid_custom_params.cfg
new file mode 100644
index 0000000..7fe6682
--- /dev/null
+++ b/test/resources/config_files/pyodbc/invalid_custom_params.cfg
@@ -0,0 +1,9 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=3306
+dbDriver={MySQL ODBC 8.0 ANSI Driver}
+blah=blah
\ No newline at end of file
diff --git a/test/resources/config_files/pyodbc/simple_default_alias.cfg b/test/resources/config_files/pyodbc/simple_default_alias.cfg
new file mode 100644
index 0000000..d7cf249
--- /dev/null
+++ b/test/resources/config_files/pyodbc/simple_default_alias.cfg
@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=3306
+dbDriver={MySQL ODBC 8.0 ANSI Driver}
\ No newline at end of file
diff --git a/test/resources/config_files/pyodbc/some_basic_params_missing.cfg b/test/resources/config_files/pyodbc/some_basic_params_missing.cfg
new file mode 100644
index 0000000..436ebc9
--- /dev/null
+++ b/test/resources/config_files/pyodbc/some_basic_params_missing.cfg
@@ -0,0 +1,3 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db
\ No newline at end of file
diff --git a/test/resources/config_files/pyodbc/valid_custom_params.cfg b/test/resources/config_files/pyodbc/valid_custom_params.cfg
new file mode 100644
index 0000000..eab93c8
--- /dev/null
+++ b/test/resources/config_files/pyodbc/valid_custom_params.cfg
@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db
+UID=db_user
+PWD=pass
+dbHost=127.0.0.1
+dbPort=3306
+dbDriver={MySQL ODBC 8.0 ANSI Driver}
\ No newline at end of file
diff --git a/test/resources/config_files/pyodbc/wrong_password.cfg b/test/resources/config_files/pyodbc/wrong_password.cfg
new file mode 100644
index 0000000..ac7a25c
--- /dev/null
+++ b/test/resources/config_files/pyodbc/wrong_password.cfg
@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db
+dbUsername=db_user
+dbPassword=wrong
+dbHost=127.0.0.1
+dbPort=3306
+dbDriver={MySQL ODBC 8.0 ANSI Driver}
\ No newline at end of file
diff --git a/test/resources/config_files/sqlite3/simple_default_alias.cfg b/test/resources/config_files/sqlite3/simple_default_alias.cfg
new file mode 100644
index 0000000..4a8047b
--- /dev/null
+++ b/test/resources/config_files/sqlite3/simple_default_alias.cfg
@@ -0,0 +1,4 @@
+[default]
+dbapiModuleName=sqlite3
+database=./${DBName}.db
+isolation_level=
\ No newline at end of file
diff --git a/test/tests/common_tests/connection_params.robot b/test/tests/common_tests/connection_params.robot
new file mode 100644
index 0000000..5a7f0de
--- /dev/null
+++ b/test/tests/common_tests/connection_params.robot
@@ -0,0 +1,171 @@
+*** Settings ***
+Documentation       Tests for the basic _Connect To Database_ keyword - with and without config files.
+...    The parameter handling is partly DB module specific.
+
+Resource            ../../resources/common.resource
+
+Test Setup          Skip If    $DB_MODULE == "sqlite3"
+Test Teardown       Disconnect From Database
+
+*** Variables ***
+&{Errors psycopg2}
+...    missing basic params=OperationalError: connection to server on socket *
+...    invalid custom param=ProgrammingError: invalid dsn: invalid connection option "blah"*
+&{Errors oracledb}
+...    missing basic params=DatabaseError: DPY-4001: no credentials specified
+...    invalid custom param=TypeError: connect() got an unexpected keyword argument 'blah'
+&{Errors pymssql}
+...    missing basic params=OperationalError: (20002, b'DB-Lib error message 20002, severity 9*
+...    invalid custom param=TypeError: connect() got an unexpected keyword argument 'blah'
+&{Errors pymysql}
+...    missing basic params=OperationalError: (1045, "Access denied*
+...    invalid custom param=TypeError: __init__() got an unexpected keyword argument 'blah'
+&{Errors pyodbc}
+...    missing basic params=REGEXP: InterfaceError.*Data source name not found and no default driver specified.*
+
+&{Errors}
+...    psycopg2=${Errors psycopg2}
+...    oracledb=${Errors oracledb}
+...    pymssql=${Errors pymssql}
+...    pymysql=${Errors pymysql}
+...    pyodbc=${Errors pyodbc}
+
+
+*** Test Cases ***
+Mandatory params can't be missing
+    Run Keyword And Expect Error    
+    ...    ValueError: Required parameter 'dbapiModuleName' was not provided*
+    ...    Connect To Database    dbName=${DB_NAME}
+
+All basic params, no config file
+    Connect To Database
+    ...    dbapiModuleName=${DB_MODULE}
+    ...    dbName=${DB_NAME}
+    ...    dbUsername=${DB_USER}
+    ...    dbPassword=${DB_PASS}
+    ...    dbHost=${DB_HOST}
+    ...    dbPort=${DB_PORT}
+    ...    dbDriver=${DB_DRIVER}
+
+Missing basic params are accepted, error from Python DB module
+    Run Keyword And Expect Error    
+    ...    ${Errors}[${DB_MODULE}][missing basic params]
+    ...    Connect To Database
+    ...    dbapiModuleName=${DB_MODULE}
+
+Custom params as keyword args - valid
+    Connect To Database
+    ...    dbapiModuleName=${DB_MODULE}
+    ...    dbName=${DB_NAME}    
+    ...    dbHost=${DB_HOST}
+    ...    dbPort=${DB_PORT}
+    ...    dbDriver=${DB_DRIVER}
+    ...    user=${DB_USER}
+    ...    password=${DB_PASS}
+
+Custom params as keyword args - invalid, error from Python DB module
+    Skip If    $DB_MODULE == "pyodbc"    
+    ...    pyodbc doesn't always throw an error if some wrong parameter was provided
+    Run Keyword And Expect Error    
+    ...    ${Errors}[${DB_MODULE}][invalid custom param]
+    ...    Connect To Database
+    ...    dbapiModuleName=${DB_MODULE}
+    ...    dbName=${DB_NAME}    
+    ...    dbHost=${DB_HOST}
+    ...    dbPort=${DB_PORT}
+    ...    dbUsername=${DB_USER}
+    ...    dbPassword=${DB_PASS}
+    ...    dbDriver=${DB_DRIVER}
+    ...    blah=blah
+
+All basic params in config file
+    Connect Using Config File    ${DB_MODULE}/simple_default_alias
+
+Missing basic params in config file are accepted, error from Python DB module
+    Run Keyword And Expect Error    
+    ...    ${Errors}[${DB_MODULE}][missing basic params]
+    ...    Connect Using Config File    
+    ...    ${DB_MODULE}/some_basic_params_missing
+
+Custom params from config file - valid
+    Connect Using Config File    ${DB_MODULE}/valid_custom_params
+
+Custom params from config file - invalid, error from Python DB module
+    Skip If    $DB_MODULE == "pyodbc"    
+    ...    pyodbc doesn't always throw an error if some wrong parameter was provided
+    Run Keyword And Expect Error    
+    ...    ${Errors}[${DB_MODULE}][invalid custom param]
+    ...    Connect Using Config File    ${DB_MODULE}/invalid_custom_params
+
+Custom params as keyword args combined with custom params from config file
+    Connect Using Config File    ${DB_MODULE}/custom_param_password    
+    ...    user=${DB_USER}
+    
+
+Keyword args override config file values - basic params
+    Connect Using Config File    ${DB_MODULE}/wrong_password
+    ...    dbPassword=${DB_PASS}
+
+Keyword args override config file values - custom params
+    Connect Using Config File    ${DB_MODULE}/valid_custom_params
+    ...    user=${DB_USER}
+
+Oracle specific - basic params, no config file, driverMode
+    Skip If    $DB_MODULE != "oracledb"
+    Connect To Database
+    ...    dbapiModuleName=${DB_MODULE}
+    ...    dbName=${DB_NAME}
+    ...    dbUsername=${DB_USER}
+    ...    dbPassword=${DB_PASS}
+    ...    dbHost=${DB_HOST}
+    ...    dbPort=${DB_PORT}
+    ...    driverMode=thin
+
+Oracle specific - thick mode in config file - invalid
+    [Documentation]    Invalid as mode switch during test execution is not supported
+    ...    This test must run the last one in the suite, after others used thin mode already.
+    Skip If    $DB_MODULE != "oracledb"
+    Run Keyword And Expect Error    ProgrammingError: DPY-2019: python-oracledb thick mode cannot be used because a thin mode connection has already been created
+    ...    Connect Using Config File    ${DB_MODULE}/thick_mode
+
+
+MSSQL / MySQL / PyODBC specific - charset as keyword argument
+    Skip If    $DB_MODULE not in ["pymssql", "pymysql", "pyodbc"]
+    Connect To Database
+    ...    dbapiModuleName=${DB_MODULE}
+    ...    dbName=${DB_NAME}
+    ...    dbUsername=${DB_USER}
+    ...    dbPassword=${DB_PASS}
+    ...    dbHost=${DB_HOST}
+    ...    dbPort=${DB_PORT}
+    ...    dbDriver=${DB_DRIVER}
+    ...    dbCharset=LATIN1
+
+MSSQL specific - charset in config file - invalid
+    Skip If    $DB_MODULE not in ["pymssql"]
+    Run Keyword And Expect Error    OperationalError: (20002, b'Unknown error')
+    ...    Connect Using Config File    ${DB_MODULE}/charset_invalid
+
+MySQL specific - charset in config file - invalid
+    Skip If    $DB_MODULE not in ["pymysql"]
+    Run Keyword And Expect Error    AttributeError: 'NoneType' object has no attribute 'encoding'
+    ...    Connect Using Config File    ${DB_MODULE}/charset_invalid
+
+PyODBC specific - charset in config file - invalid
+    Skip If    $DB_MODULE not in ["pyodbc"]
+    Run Keyword And Expect Error    REGEXP: .*Can't initialize character set wrong.*
+    ...    Connect Using Config File    ${DB_MODULE}/charset_invalid
+
+
+SQlite specific - connection params as custom keyword args
+    [Setup]    Skip If    $DB_MODULE != "sqlite3"
+    Remove File    ${DBName}.db
+    Connect To Database
+    ...    dbapiModuleName=${DB_MODULE}
+    ...    database=./${DBName}.db
+    ...    isolation_level=${EMPTY}
+
+SQlite specific - custom connection params in config file
+    [Setup]    Skip If    $DB_MODULE != "sqlite3"
+    Remove File    ${DBName}.db
+    Connect Using Config File    ${DB_MODULE}/simple_default_alias
diff --git a/test/tests/utests/test_connection_manager.py b/test/tests/utests/test_connection_manager.py
index bbc9ea2..1f55c45 100644
--- a/test/tests/utests/test_connection_manager.py
+++ b/test/tests/utests/test_connection_manager.py
@@ -13,22 +13,11 @@ class TestConnectWithConfigFile:
     def test_connect_with_empty_config(self):
         conn_manager = ConnectionManager()
         config_path = str(TEST_DATA / "empty.cfg")
-        with pytest.raises(ValueError, match=re.escape("Configuration file does not have [default] section.")):
-            conn_manager.connect_to_database("my_client", dbConfigFile=config_path)
-
-    def test_connect_no_params_no_config(self):
-        conn_manager = ConnectionManager()
-        with pytest.raises(ValueError, match="Required 'dbName' parameter was not provided in keyword arguments."):
-            conn_manager.connect_to_database("my_client")
-
-    def test_connect_missing_option(self):
-        conn_manager = ConnectionManager()
-        config_path = str(TEST_DATA / "no_option.cfg")
         with pytest.raises(
             ValueError,
-            match="Required 'dbPassword' parameter missing in both keyword arguments and configuration file.",
+            match="Required parameter 'dbapiModuleName' was not provided - neither in keyword arguments nor in config file",
         ):
-            conn_manager.connect_to_database("my_client", dbConfigFile=config_path)
+            conn_manager.connect_to_database(dbConfigFile=config_path)
 
     def test_aliased_section(self):
         conn_manager = ConnectionManager()