Parameter 'omitTrailingSemicolon' for explicit instruction, if the trailing semicolon (;) at the SQL string end should be removed or not

Author: amochin

src/DatabaseLibrary/query.py

@@ -356,13 +356,23 @@ def execute_sql_script(
                     db_connection.client.rollback()
 
     def execute_sql_string(
-        self, sqlString: str, sansTran: bool = False, alias: Optional[str] = None, parameters: Optional[List] = None
+        self,
+        sqlString: str,
+        sansTran: bool = False,
+        omitTrailingSemicolon: Optional[bool] = None,
+        alias: Optional[str] = None,
+        parameters: Optional[List] = None,
     ):
         """
-        Executes the sqlString as SQL commands. Useful to pass arguments to your sql.
-        SQL commands are expected to be delimited by a semicolon (';').
+        Executes the ``sqlString`` as a single SQL command.
 
-        Use optional `sansTran` to run command without an explicit transaction commit or rollback:
+        Use optional ``sansTran`` to run command without an explicit transaction commit or rollback.
+
+        Use optional ``omitTrailingSemicolon`` parameter for explicit instruction,
+        if the trailing semicolon (;) at the SQL string end should be removed or not:
+        - Some database modules (e.g. Oracle) throw an exception, if you leave a semicolon at the string end
+        - However, there are exceptional cases, when you need it even for Oracle - e.g. at the end of a PL/SQL block.
+        - If not specified, it's decided based on the current database module in use. For Oracle, the semicolon is removed by default.
 
         Use optional ``alias`` parameter to specify what connection should be used for the query if you have more
         than one connection open.
@@ -374,6 +384,7 @@ def execute_sql_string(
         | Execute Sql String | DELETE FROM person_employee_table; DELETE FROM person_table |
         | Execute Sql String | DELETE FROM person_employee_table; DELETE FROM person_table | alias=my_alias |
         | Execute Sql String | DELETE FROM person_employee_table; DELETE FROM person_table | sansTran=True |
+        | Execute Sql String | CREATE PROCEDURE proc AS BEGIN DBMS_OUTPUT.PUT_LINE('Hello!'); END; | omitTrailingSemicolon=False |
         | @{parameters} | Create List |  person_employee_table |
         | Execute Sql String | SELECT * FROM %s | parameters=${parameters} |
         """
@@ -382,7 +393,7 @@ def execute_sql_string(
         try:
             cur = db_connection.client.cursor()
             logger.info(f"Executing : Execute SQL String  |  {sqlString}")
-            self.__execute_sql(cur, sqlString, parameters=parameters)
+            self.__execute_sql(cur, sqlString, omit_trailing_semicolon=omitTrailingSemicolon, parameters=parameters)
             if not sansTran:
                 db_connection.client.commit()
         finally:

test/tests/custom_db_tests/oracle_omit_semicolon.robot

@@ -0,0 +1,27 @@
+*** Settings ***
+Documentation    Tests for the parameter _omitTrailingSemicolon_ in the keyword
+...    _Execute SQL String_ - special for the issue #184:
+...    https://github.com/MarketSquare/Robotframework-Database-Library/issues/184
+...    The _PLSQL BLOCK_ is most likely valid for Oracle DB only.
+
+Resource            ../../resources/common.resource
+Suite Setup         Connect To DB
+Suite Teardown      Disconnect From Database
+Test Setup          Create Person Table And Insert Data
+Test Teardown       Drop Tables Person And Foobar
+
+
+*** Variables ***
+${NORMAL QUERY}    SELECT * FROM person;
+${PLSQL BLOCK}    DECLARE ERRCODE NUMBER; ERRMSG VARCHAR2(200); BEGIN DBMS_OUTPUT.PUT_LINE('Hello!'); END;
+
+
+*** Test Cases ***
+Explicitely Omit Semicolon
+    [Documentation]    Check if it works for Oracle - explicitely omitting the semicolon
+    ...    is equal to the default behaviour, otherwise oracle_db throws an error
+    Execute Sql String    ${NORMAL QUERY}    omitTrailingSemicolon=True
+
+Explicitely Dont't Omit Semicolon
+    [Documentation]    Check if it works for Oracle - it throws an error without a semicolon
+    Execute Sql String    ${PLSQL BLOCK}    omitTrailingSemicolon=False