Commit e69bd464 authored by Broughton, Mitchell's avatar Broughton, Mitchell
Browse files

Merge branch 'feature/add-dict-option-to-postgres-queries' into 'develop' 

Feature/add dict option to postgres queries

See merge request !48
parents f231400d 58a2adbf

COMMON_VERSION

+1 −1
Original line number Diff line number Diff line 
0.3.7
 
0.3.8

README.md

+2 −2
Original line number Diff line number Diff line
@@ -22,9 +22,9 @@ Replace the above extras with the extras of your choice. 


### Installation via pip



Run this command to install version 0.3.7 (latest) via pip:

Run this command to install version 0.3.8 (latest) via pip:



`python3 -m pip --no-cache-dir install common==0.3.7 --index-url https://code.ornl.gov/api/v4/projects/10568/packages/pypi/simple  --trusted-host code.ornl.gov`

`python3 -m pip --no-cache-dir install common==0.3.8 --index-url https://code.ornl.gov/api/v4/projects/10568/packages/pypi/simple  --trusted-host code.ornl.gov`

This will install latest (not recommended):



`python3 -m pip --no-cache-dir install common --index-url https://code.ornl.gov/api/v4/projects/10568/packages/pypi/simple  --trusted-host code.ornl.gov`

RELEASE_NOTES.md

+3 −0
Original line number Diff line number Diff line 
# VERSION 0.3.8

    - Added option to PostgresMixin query function to return data as a dict instead of array of arrays



# VERSION 0.3.3

    - Fixes mssql bug so that it uses the correct db host

src/pygarden/mixins/postgres.py

+7 −4
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@ 
"""Allow opening with a psycopg2 connection."""

try:

    import psycopg2

    import psycopg2.extras

except ImportError:

    import sys
@@ -77,6 +78,7 @@ class PostgresMixin: 
            self.connection.set_client_encoding("UTF8")

            self.logger.debug("Successfully opened connection to database")

            self.cursor = self.connection.cursor()

            self.dict_cursor = self.connection.cursor(cursor_factory=psycopg2.extras.DictCursor)

            self.logger.debug("Successfully created a cursor")

            if isinstance(search_path, list):

                self.search_path = (",").join(search_path)
@@ -94,7 +96,7 @@ class PostgresMixin: 
            return False

        return True



    def query(self, query):

    def query(self, query, as_dict=False):

        """Query the database.



        :param query: A Valid SQL statement to send to the database.
@@ -107,9 +109,10 @@ class PostgresMixin: 
            self.open()  # assume that it is already open - check if it is

        self.logger.debug("Submitting user specified query to database.")

        try:

            self.cursor.execute(query)

            if self.cursor.description is not None:

                return self.cursor.fetchall()

            this_cursor = self.cursor if not as_dict else self.dict_cursor

            this_cursor.execute(query)

            if this_cursor.description is not None:

                return this_cursor.fetchall()

            return None

        except psycopg2.InterfaceError as error:

            self.logger.error(f"An unexpected InterfaceError occurred: {error}")