Changed inputs to not have _data attached to them. Changed connection to database to be a contextmanager. Updated config to have a base of connections instead of sql. Made all necessary updates to readme and tests.

Author: bishopbm2

README.md

@@ -40,7 +40,7 @@ It can contain an array of one or more sets of SQL connection parameters, like t
 
 ``` yaml
 ---
-sql:
+connections:
   postgresql:
     host: postgresql_db.domain.tld
     username: [email protected]
@@ -75,7 +75,9 @@ Alternatively, when running an action, you can pass in the host, username, passw
 
 **Note** : When modifying the configuration in `/opt/stackstorm/configs/` please remember to tell StackStorm to load these new values by running `st2ctl reload --register-configs`
 
-# Actions
+# Usage
+
+## Actions
 
 | Action | Description |
 |--------|-------------|
@@ -84,3 +86,20 @@ Alternatively, when running an action, you can pass in the host, username, passw
 | insert_bulk | Bulk insert data into a database table. Insert data is passed as an array of objects. |
 | update | Update data in a database table. |
 | delete | Delete data from a database table. |
+
+## Where statements
+
+The Update and Delete actions give the option to include where data into the query. This only works for AND statements.
+
+Example:
+```
+where = {
+    'column_1': 'value_1',
+    'column_2': 'value_2'
+}
+
+Produces the statement:
+WHERE column_1 == 'value_1' AND column_2 == 'value_2'
+```
+
+For more complicated queries please use the query action.

actions/delete.py

@@ -17,29 +17,24 @@ def run(self, **kwargs):
         """
         kwargs_dict = dict(kwargs)
 
-        where_dict = self.get_del_arg('where_data', kwargs_dict, True)
-        table = self.get_del_arg('table', kwargs_dict, True)
+        where_dict = self.get_del_arg('where', kwargs_dict)
+        table = self.get_del_arg('table', kwargs_dict)
 
-        # Get the connection details from either config or from action params
-        connection_details = self.resolve_connection(kwargs_dict)
+        with self.db_connection(kwargs_dict) as conn:
+            # Get the SQL table
+            sql_table = sqlalchemy.Table(table,
+                                        self.meta,
+                                        autoload=True,
+                                        autoload_with=self.engine)
 
-        # Connect to the Database
-        self.connect_to_db(connection_details)
+            # Intantiate delete object
+            delete = sql_table.delete()  # pylint: disable-msg=no-value-for-parameter
 
-        # Get the SQL table
-        sql_table = sqlalchemy.Table(table, self.meta, autoload=True, autoload_with=self.engine)
+            # Generate Where Statement
+            if where_dict:
+                delete, where_dict = self.generate_where_clause(sql_table, delete, where_dict)
 
-        # Intantiate delete object
-        delete = sql_table.delete()  # pylint: disable-msg=no-value-for-parameter
-
-        # Generate Where Statement
-        if where_dict:
-            delete, where_dict = self.generate_where_clause(sql_table, delete, where_dict)
-
-        # Execute query
-        result = self.conn.execute(delete, where_dict)
-
-        # Disconnect from the database
-        self.conn.close()
+            # Execute query
+            result = conn.execute(delete, where_dict)
 
         return {'affected_rows': result.rowcount}

actions/delete.yaml

@@ -47,7 +47,7 @@
       type: string
       description: "Database table to DELETE."
       required: true
-    where_data:
+    where:
       type: object
       description: >
         Dictionary of data to be used to create a WHERE clause for the DELETE statement

actions/generic_query.py

@@ -16,26 +16,19 @@ def run(self, **kwargs):
         """
         kwargs_dict = dict(kwargs)
 
-        query = self.get_del_arg('query', kwargs_dict, True)
+        query = self.get_del_arg('query', kwargs_dict)
 
-        # Get the connection details from either config or from action params
-        connection_details = self.resolve_connection(kwargs_dict)
-
-        # Connect to the Database
-        self.connect_to_db(connection_details)
-
-        # Execute the query
-        query_result = self.conn.execute(query)
+        with self.db_connection(kwargs_dict) as conn:
+            # Execute the query
+            query_result = conn.execute(query)
 
         return_result = {'affected_rows': query_result.rowcount}
         if query_result.returns_rows:
             return_result = []
             all_results = query_result.fetchall()
             for row in all_results:
-                # Rows are returned as tuples with keys. Convert that to a dictionary for return
+                # Rows are returned as tuples with keys.
+                # Convert that to a dictionary for return
                 return_result.append(self.row_to_dict(row))
 
-        # Disconnect from the database
-        self.conn.close()
-
         return return_result

actions/insert.py

@@ -17,29 +17,21 @@ def run(self, **kwargs):
         """
         kwargs_dict = dict(kwargs)
 
-        insert_data = self.get_del_arg('data', kwargs_dict, True)
-        insert_table = self.get_del_arg('table', kwargs_dict, True)
+        insert_data = self.get_del_arg('data', kwargs_dict)
+        insert_table = self.get_del_arg('table', kwargs_dict)
 
         if not isinstance(insert_data, list):
             insert_data = [insert_data]
 
-        # Get the connection details from either config or from action params
-        connection_details = self.resolve_connection(kwargs_dict)
+        with self.db_connection(kwargs_dict) as conn:
+            # Get the Table to insert data into
+            sql_table = sqlalchemy.Table(insert_table,
+                                        self.meta,
+                                        autoload=True,
+                                        autoload_with=self.engine)
 
-        # Connect to the Database
-        self.connect_to_db(connection_details)
-
-        # Get the Table to insert data into
-        sql_table = sqlalchemy.Table(insert_table,
-                                    self.meta,
-                                    autoload=True,
-                                    autoload_with=self.engine)
-
-        # Execute the insert query
-        self.conn.execute(sql_table.insert(),  # pylint: disable-msg=no-value-for-parameter
-                         insert_data)
-
-        # Disconnect from the database
-        self.conn.close()
+            # Execute the insert query
+            conn.execute(sql_table.insert(),  # pylint: disable-msg=no-value-for-parameter
+                        insert_data)
 
         return True

actions/lib/base_action.py

@@ -3,6 +3,7 @@
 from sqlalchemy.engine.url import URL
 import decimal
 import datetime
+from contextlib import contextmanager
 
 #                         (key, required, default)
 CONFIG_CONNECTION_KEYS = [('host', False, ""),
@@ -97,17 +98,25 @@ def generate_values(self, sql_obj, data_dict):
 
         return sql_obj
 
-    def connect_to_db(self, connection):
+    @contextmanager
+    def db_connection(self, kwargs_dict):
         """Connect to the database and instantiate necessary methods to be used
         later.
         """
+        # Get the connection details from either config or from action params
+        connection = self.resolve_connection(kwargs_dict)
+
+        # Format the connection string
         database_connection_string = URL(**connection)
 
         self.engine = sqlalchemy.create_engine(database_connection_string, echo=False)
-        self.conn = self.engine.connect()
         self.meta = sqlalchemy.MetaData()
+        conn = self.engine.connect()
 
-        return True
+        try:
+            yield conn
+        finally:
+            conn.close()
 
     def validate_connection(self, connection, connection_name):
         """Ensures that all required parameters are in the connection. If a
@@ -144,7 +153,7 @@ def resolve_connection(self, kwargs_dict):
         connection_name = self.get_del_arg('connection', kwargs_dict, True)
         config_connection = None
         if connection_name:
-            config_connection = self.config['sql'].get(connection_name)
+            config_connection = self.config['connections'].get(connection_name)
             if not config_connection:
                 raise KeyError("config.yaml missing connection: sql:{0}"
                                .format(connection_name))

actions/update.py

@@ -17,35 +17,30 @@ def run(self, **kwargs):
         """
         kwargs_dict = dict(kwargs)
 
-        where_dict = self.get_del_arg('where_data', kwargs_dict, True)
-        update_dict = self.get_del_arg('update_data', kwargs_dict, True)
-        table = self.get_del_arg('table', kwargs_dict, True)
+        where_dict = self.get_del_arg('where', kwargs_dict)
+        update_dict = self.get_del_arg('update', kwargs_dict)
+        table = self.get_del_arg('table', kwargs_dict)
 
-        # Get the connection details from either config or from action params
-        connection_details = self.resolve_connection(kwargs_dict)
+        with self.db_connection(kwargs_dict) as conn:
+            # Get the SQL table
+            sql_table = sqlalchemy.Table(table,
+                                        self.meta,
+                                        autoload=True,
+                                        autoload_with=self.engine)
 
-        # Connect to the Database
-        self.connect_to_db(connection_details)
+            # Intantiate update object
+            updates = sql_table.update()  # pylint: disable-msg=no-value-for-parameter
 
-        # Get the SQL table
-        sql_table = sqlalchemy.Table(table, self.meta, autoload=True, autoload_with=self.engine)
+            # Generate Where Statement
+            if where_dict:
+                updates, where_dict = self.generate_where_clause(sql_table, updates, where_dict)
 
-        # Intantiate update object
-        updates = sql_table.update()  # pylint: disable-msg=no-value-for-parameter
+            updates = self.generate_values(updates, update_dict)
 
-        # Generate Where Statement
-        if where_dict:
-            updates, where_dict = self.generate_where_clause(sql_table, updates, where_dict)
+            # Combine Dictionaries
+            query_dict = self.merge_dicts([where_dict, update_dict])
 
-        updates = self.generate_values(updates, update_dict)
-
-        # Combine Dictionaries
-        query_dict = self.merge_dicts([where_dict, update_dict])
-
-        # Execute query
-        result = self.conn.execute(updates, query_dict)
-
-        # Disconnect from the database
-        self.conn.close()
+            # Execute query
+            result = conn.execute(updates, query_dict)
 
         return {'affected_rows': result.rowcount}

actions/update.yaml

@@ -47,7 +47,7 @@
       type: string
       description: "Database table to UPDATE."
       required: true
-    where_data:
+    where:
       type: object
       description: >
         Dictionary of data to be used to create a WHERE clause for the UPDATE statement
@@ -59,7 +59,7 @@
         }
       required: false
       default: {}
-    update_data:
+    update:
       type: object
       description: >
         Dictionary of data to be used to as Values to update for the UPDATE statement

config.schema.yaml

@@ -1,6 +1,6 @@
 ---
 
-sql:
+connections:
   type: "object"
   required: true
   patternProperties:
@@ -44,4 +44,4 @@ connection:
         - firebird
         - sybase
       required: true
-  additionalProperties: false
+  additionalProperties: false

sql.yaml.example

@@ -1,5 +1,5 @@
 ---
-sql:
+connections:
   postgresql:
     host: postgresql_db.domain.tld
     username: [email protected]