New keyword 'Set Omit Trailing Semicolon'

Author: amochin

README.md

@@ -367,7 +367,7 @@ The retry mechanism is disabled by default - ``retry_timeout`` is set to ``0``.
 ${sql}=   Catenate    SELECT first_name FROM person
 Check Row Count     ${sql}  ==        2      retry_timeout=10 seconds
 Check Query Result  ${sql}  contains  Allan  retry_timeout=5s  retry_pause=1s
-````
+```
 
 # Logging query results
 Keywords, that fetch results of a SQL query, print the result rows as a table in RF log.
@@ -389,7 +389,7 @@ Library    DatabaseLibrary    log_query_results_head=10
 
 # Logging of query results is enabled (default), log head limit is disabled (log all rows).
 Library    DatabaseLibrary    log_query_results_head=0
-````
+```
 
 # Commit behavior
 While creating a database connection, the library doesn't explicitly set the _autocommit_ behavior -
@@ -408,6 +408,19 @@ It's also possible to explicitly set the _autocommit_ behavior on the Python DB
 using the `Set Auto Commit` keyword.
 This has no impact on the automatic commit/rollback behavior in library keywords (described above).
 
+# Omitting trailing semicolon behavior
+Some databases (e.g. Oracle) throw an exception, if you leave a semicolon (;) at the SQL string end.     
+However, there are exceptional cases, when you need it even for Oracle - e.g. at the end of a PL/SQL block.
+
+The library can handle it for you and remove the semicolon at the end of the SQL string.
+By default, it's decided based on the current database module in use:
+- For `oracle_db` and `cx_Oracle`, the trailing semicolon is removed
+- For other modules, the trailing semicolon is left as it is
+
+You can also set this behavior explicitly:
+- Using the `Set Omit Trailing Semicolon` keyword
+- Using the `omit_trailing_semicolon` parameter in the `Execute SQL String` keyword.
+
 # Database modules compatibility
 > Looking for [Connection examples for different DB modules](#connection-examples-for-different-db-modules)?   
 

doc/index.html

@@ -363,6 +363,19 @@ class DatabaseLibrary(ConnectionManager, Query, Assertion):
     using the `Set Auto Commit` keyword.
     This has no impact on the automatic commit/rollback behavior in library keywords (described above).
 
+    = Omitting trailing semicolon behavior =
+    Some databases (e.g. Oracle) throw an exception, if you leave a semicolon (;) at the SQL string end.
+    However, there are exceptional cases, when you need it even for Oracle - e.g. at the end of a PL/SQL block.
+
+    The library can handle it for you and remove the semicolon at the end of the SQL string.
+    By default, it's decided based on the current database module in use:
+    - For `oracle_db` and `cx_Oracle`, the trailing semicolon is removed
+    - For other modules, the trailing semicolon is left as it is
+
+    You can also set this behavior explicitly:
+    - Using the `Set Omit Trailing Semicolon` keyword
+    - Using the `omit_trailing_semicolon` parameter in the `Execute SQL String` keyword.
+
     = Database modules compatibility =
     The library is basically compatible with any [https://peps.python.org/pep-0249|Python Database API Specification 2.0] module.
 

src/DatabaseLibrary/__init__.py

@@ -655,3 +655,16 @@ def switch_database(self, alias: str):
         | Switch Database | alias=my_alias |
         """
         self.connection_store.switch(alias)
+
+    def set_omit_trailing_semicolon(self, omit=True, alias: Optional[str] = None):
+        """
+        Set the ``omit_trailing_semicolon`` to control the `Omitting trailing semicolon behavior` for the connection.
+
+        Use ``alias`` to specify what connection should be used if `Handling multiple database connections`.
+
+        Examples:
+        | Set Omit Trailing Semicolon | True |
+        | Set Omit Trailing Semicolon | False | alias=my_alias |
+        """
+        db_connection = self.connection_store.get_connection(alias)
+        db_connection.omit_trailing_semicolon = omit

src/DatabaseLibrary/connection_manager.py

@@ -1,27 +1,67 @@
 *** 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.
+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;
+${NORMAL QUERY}             SELECT * FROM person;
+${PLSQL BLOCK}              DECLARE ERRCODE NUMBER; ERRMSG VARCHAR2(200); BEGIN DBMS_OUTPUT.PUT_LINE('Hello!'); END;
+
+${ERROR SIMPLE QUERY}       *ORA-03048: SQL reserved word ';' is not syntactically valid following*
+${ERROR PLSQL}              *PLS-00103: Encountered the symbol "end-of-file" when expecting one of the following*
 
 
 *** 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
+Explicitely Omit Semicolon - Simple Query
+    [Documentation]    Check if it works for Oracle - explicitly omitting the semicolon
+    ...    is equal to the default behavior
     Execute Sql String    ${NORMAL QUERY}    omit_trailing_semicolon=True
 
-Explicitely Dont't Omit Semicolon
-    [Documentation]    Check if it works for Oracle - it throws an error without a semicolon
+Explicitely Don't Omit Semicolon - Simple Query
+    [Documentation]    Check if Oracle throws an error
+
+    Run Keyword And Expect Error    ${ERROR SIMPLE QUERY}
+    ...    Execute Sql String    ${NORMAL QUERY}    omit_trailing_semicolon=False
+
+Explicitely Omit Semicolon - PLSQL Block
+    [Documentation]    Check if Oracle throws an error
+    Run Keyword And Expect Error    ${ERROR PLSQL}
+    ...    Execute Sql String    ${PLSQL BLOCK}    omit_trailing_semicolon=True
+
+Explicitely Don't Omit Semicolon - PLSQL Block
+    [Documentation]    Should run without errors, because the semicolon is needed
+    ...    at the end of the PLSQL block even with Oracle
     Execute Sql String    ${PLSQL BLOCK}    omit_trailing_semicolon=False
+
+Explicitely Omit Semicolon With Keyword - Simple Query
+    [Documentation]    Check if it works for Oracle - explicitly omitting the semicolon
+    ...    is equal to the default behavior
+    Set Omit Trailing Semicolon    True
+    Execute Sql String    ${NORMAL QUERY}
+
+Explicitely Don't Omit Semicolon With Keyword - Simple Query
+    [Documentation]    Check if Oracle throws an error
+    Set Omit Trailing Semicolon    False    
+    Run Keyword And Expect Error    ${ERROR SIMPLE QUERY}
+    ...    Execute Sql String    ${NORMAL QUERY}
+
+Explicitely Omit Semicolon With Keyword - PLSQL Block
+    [Documentation]    Check if Oracle throws an error
+    Set Omit Trailing Semicolon    True    
+    Run Keyword And Expect Error    ${ERROR PLSQL}
+    ...    Execute Sql String    ${PLSQL BLOCK}
+
+Explicitely Don't Omit Semicolon With Keyword - PLSQL Block
+    [Documentation]    Should run without errors, because the semicolon is needed
+    ...    at the end of the PLSQL block even with Oracle
+    Set Omit Trailing Semicolon    False
+    Execute Sql String    ${PLSQL BLOCK}