Allow different 'omit trailing semicolon' behavior pro connection

Author: amochin

src/DatabaseLibrary/connection_manager.py

@@ -28,6 +28,7 @@
 class Connection:
     client: Any
     module_name: str
+    omit_trailing_semicolon: bool
 
 
 class ConnectionStore:
@@ -36,13 +37,13 @@ def __init__(self, warn_on_overwrite=True):
         self.default_alias: str = "default"
         self.warn_on_overwrite = warn_on_overwrite
 
-    def register_connection(self, client: Any, module_name: str, alias: str):
+    def register_connection(self, client: Any, module_name: str, alias: str, omit_trailing_semicolon=False):
         if alias in self._connections and self.warn_on_overwrite:
             if alias == self.default_alias:
                 logger.warn("Overwriting not closed connection.")
             else:
                 logger.warn(f"Overwriting not closed connection for alias = '{alias}'")
-        self._connections[alias] = Connection(client, module_name)
+        self._connections[alias] = Connection(client, module_name, omit_trailing_semicolon)
 
     def get_connection(self, alias: Optional[str]) -> Connection:
         """
@@ -142,7 +143,6 @@ class ConnectionManager:
     """
 
     def __init__(self, warn_on_connection_overwrite=True):
-        self.omit_trailing_semicolon: bool = False
         self.connection_store: ConnectionStore = ConnectionStore(warn_on_overwrite=warn_on_connection_overwrite)
         self.ibmdb_driver_already_added_to_path: bool = False
 
@@ -320,6 +320,8 @@ def _arg_or_config(arg_value, param_name, *, old_param_name=None, mandatory=Fals
         if other_config_file_params:
             logger.info(f"Other params from configuration file: {list(other_config_file_params.keys())}")
 
+        omit_trailing_semicolon = False
+
         if db_module == "excel" or db_module == "excelrw":
             db_api_module_name = "pyodbc"
         else:
@@ -444,7 +446,7 @@ def _arg_or_config(arg_value, param_name, *, old_param_name=None, mandatory=Fals
             con_params = _build_connection_params(user=db_user, password=db_password, dsn=oracle_dsn)
             _log_all_connection_params(**con_params)
             db_connection = db_api_2.connect(**con_params)
-            self.omit_trailing_semicolon = True
+            omit_trailing_semicolon = True
 
         elif db_module in ["oracledb"]:
             db_port = db_port or 1521
@@ -473,7 +475,7 @@ def _arg_or_config(arg_value, param_name, *, old_param_name=None, mandatory=Fals
                 f"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
+            omit_trailing_semicolon = True
 
         elif db_module in ["teradata"]:
             db_port = db_port or 1025
@@ -505,7 +507,7 @@ def _arg_or_config(arg_value, param_name, *, old_param_name=None, mandatory=Fals
             _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)
+        self.connection_store.register_connection(db_connection, db_api_module_name, alias, omit_trailing_semicolon)
 
     @renamed_args(mapping={"dbapiModuleName": "db_module"})
     def connect_to_database_using_custom_params(

src/DatabaseLibrary/query.py

@@ -81,7 +81,12 @@ def query(
         cur = None
         try:
             cur = db_connection.client.cursor()
-            self._execute_sql(cur, select_statement, parameters=parameters)
+            self._execute_sql(
+                cur,
+                select_statement,
+                parameters=parameters,
+                omit_trailing_semicolon=db_connection.omit_trailing_semicolon,
+            )
             all_rows = cur.fetchall()
             col_names = [c[0] for c in cur.description]
             self._log_query_results(col_names, all_rows)
@@ -130,7 +135,12 @@ def row_count(
         cur = None
         try:
             cur = db_connection.client.cursor()
-            self._execute_sql(cur, select_statement, parameters=parameters)
+            self._execute_sql(
+                cur,
+                select_statement,
+                parameters=parameters,
+                omit_trailing_semicolon=db_connection.omit_trailing_semicolon,
+            )
             data = cur.fetchall()
             col_names = [c[0] for c in cur.description]
             if db_connection.module_name in ["sqlite3", "ibm_db", "ibm_db_dbi", "pyodbc", "jaydebeapi"]:
@@ -182,7 +192,12 @@ def description(
         cur = None
         try:
             cur = db_connection.client.cursor()
-            self._execute_sql(cur, select_statement, parameters=parameters)
+            self._execute_sql(
+                cur,
+                select_statement,
+                parameters=parameters,
+                omit_trailing_semicolon=db_connection.omit_trailing_semicolon,
+            )
             description = list(cur.description)
             if sys.version_info[0] < 3:
                 for row in range(0, len(description)):
@@ -276,7 +291,11 @@ def execute_sql_script(
                 cur = db_connection.client.cursor()
                 if not split:
                     logger.info("Statements splitting disabled - pass entire script content to the database module")
-                    self._execute_sql(cur, sql_file.read())
+                    self._execute_sql(
+                        cur,
+                        sql_file.read(),
+                        omit_trailing_semicolon=db_connection.omit_trailing_semicolon,
+                    )
                 else:
                     logger.info("Splitting script file into statements...")
                     statements_to_execute = []
@@ -377,11 +396,7 @@ def execute_sql_string(
         Use ``parameters`` for query variable substitution (variable substitution syntax may be different
         depending on the database client).
 
-        Use ``omit_trailing_semicolon`` 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 explicitly specified, it's decided based on the current database module in use. For Oracle, the semicolon is removed by default.
+        Set the ``omit_trailing_semicolon`` to explicitly control the `Omitting trailing semicolon behavior` for the command.
 
         === Some parameters were renamed in version 2.0 ===
         The old parameters ``sqlString``, ``sansTran`` and ``omitTrailingSemicolon`` are *deprecated*,
@@ -401,6 +416,8 @@ def execute_sql_string(
         cur = None
         try:
             cur = db_connection.client.cursor()
+            if omit_trailing_semicolon is None:
+                omit_trailing_semicolon = db_connection.omit_trailing_semicolon
             self._execute_sql(cur, sql_string, omit_trailing_semicolon=omit_trailing_semicolon, parameters=parameters)
             self._commit_if_needed(db_connection, no_transaction)
         except Exception as e:
@@ -734,7 +751,7 @@ def _execute_sql(
         self,
         cur,
         sql_statement: str,
-        omit_trailing_semicolon: Optional[bool] = None,
+        omit_trailing_semicolon: Optional[bool] = False,
         parameters: Optional[Tuple] = None,
     ):
         """
@@ -744,8 +761,6 @@ def _execute_sql(
         won't be executed by some databases (e.g. Oracle).
         Otherwise, it's decided based on the current database module in use.
         """
-        if omit_trailing_semicolon is None:
-            omit_trailing_semicolon = self.omit_trailing_semicolon
         if omit_trailing_semicolon:
             sql_statement = sql_statement.rstrip(";")
         if parameters is None: