updated README w/ burnettk

README.md

@@ -1,2 +1,239 @@
-# connector-http
-Make HTTP Requests available to SpiffWorkflow Service Tasks
+# Postgres Connector
+
+## Commands
+
+All commands require passing in the postgress connection string:
+
+```
+database_connection_str: str
+```
+
+Which is passed directly to `pyscopg2`. eg: `dbname=dev user=dev password=dev host=postgres-db port=5432`
+
+All commands except for `DoSQL` require `table_name: str` as well.
+
+### CreateTable
+
+Additional parameters:
+
+```
+schema: Dict[str, Any]
+```
+
+Creates a table with the provided column names and their [types](https://www.postgresql.org/docs/current/datatype.html).
+
+The schema parameter expects a key called `column_definitions`. The value associated with this key is a list of dictionaries, each containing the `name` and `type` of a column.
+
+As an example, to create a table like:
+
+```
+dev=# \d states;
+                       Table "public.states"
+ Column  |          Type          | Collation | Nullable | Default 
+---------+------------------------+-----------+----------+---------
+ country | character varying(255) |           |          | 
+ state   | character varying(13)  |           |          | 
+ abbrev  | character(2)           |           |          | 
+ somenum | integer                |           |          | 
+
+```
+
+The schema passed to the connector would be:
+
+```
+{
+  "column_definitions": [
+    {
+        "name": "country",
+        "type": "varchar(255)",
+    },
+    {
+        "name": "state",
+        "type": "varchar(13)",
+    },
+    {
+        "name": "abbrev",
+        "type": "char(2)",
+    },
+    {
+        "name": "somenum",
+        "type": "int",
+    }
+  ]
+}
+```
+
+### DropTable
+
+Drops a table.
+
+### InsertValues
+
+Additional parameters:
+
+```
+schema: Dict[str, Any]
+```
+
+Inserts values into a table with the provided column names and their values. Multiple records can be inserted per call.
+
+The schema parameter expects:
+
+| Key | Value |
+|-----|-------|
+| `columns` | A list of column names |
+| `values` | A list of lists of the values to insert. Order must match column order. |
+
+As an example, to insert the following data:
+
+```
+dev=# select * from states;
+ country |  state   | abbrev | somenum 
+---------+----------+--------+---------
+ USA     | Georgia  | GA     |      33
+ USA     | Virginia | VA     |      55
+(2 rows)
+
+```
+
+The schema passed to the connector would be:
+
+```
+{
+  "columns": [
+    "country",
+    "state",
+    "abbrev",
+    "somenum"
+  ], 
+  "values": [
+    ["USA", "Georgia", "GA", 33], 
+    ["USA", "Virginia", "VA", 55]
+  ]
+}
+```
+### SelectValues
+
+Additional parameters:
+
+```
+schema: Dict[str, Any]
+```
+
+Selects values from a table with the provided column names and optional where clause.
+
+The schema parameter expects:
+
+| Key | Value |
+|-----|-------|
+| `columns` | A list of column names |
+| `where` | (optional) A list of lists of the column names, operator and values to filter the select. |
+
+Operators supported for where clauses are: `=, !=, <, >`
+
+As an example, to mimic the following select:
+
+```
+dev=# select * from states;
+ country |  state   | abbrev | somenum 
+---------+----------+--------+---------
+ USA     | Georgia  | GA     |      33
+ USA     | Virginia | VA     |      55
+(2 rows)
+
+```
+
+The schema passed to the connector would be:
+
+```
+{
+  "columns": [
+    "country",
+    "state",
+    "abbrev",
+    "somenum"
+  ]
+}
+```
+
+To mimic the following select:
+
+```
+dev=# select * from states where somenum = 33;
+ country |  state   | abbrev | somenum 
+---------+----------+--------+---------
+ USA     | Georgia  | GA     |      33
+(2 rows)
+
+```
+
+The schema passed to the connector would be:
+
+```
+{
+  "columns": [
+    "country",
+    "state",
+    "abbrev",
+    "somenum"
+  ],
+  "where": [
+    ["somenum", "=", 33]
+  ]
+}
+```
+
+### DeleteValues
+
+Additional parameters:
+
+```
+schema: Dict[str, Any]
+```
+
+Deletes rows from a table with the provided optional where clause. The where clause is specified, and works, the same as described in `SelectValues`.
+
+
+### UpdateValues
+
+Additional parameters:
+
+```
+schema: Dict[str, Any]
+```
+
+Updates columns a table with the provided value and optional where clause. The where clause is specified, and works, the same as described in `SelectValues`.
+
+The schema expcets a `set` key with a value that is a dictionary. The keys in this dictionary are the column names and the values are the new value to set. 
+
+For example:
+
+```
+{
+  "set": {
+    "abbrev": "ZZ"
+  }, 
+  "where": [
+    ["abbrev", "=", "VA"]
+  ]
+}
+```
+
+### DoSQL
+
+Additional parameters:
+
+```
+schema: Dict[str, Any]
+```
+
+Performs a SQL statement of your chosing.
+
+The schema parameter expects:
+
+| Key | Value |
+|-----|-------|
+| `sql` | The SQL to `do`. Uses `%s` for variable bindings. |
+| `values` | (optional) A list of values to bind. |
+| `fetch_results` | (options) Bool to indicate if a list of results should be returned. |
+