dspace-statistics-api/dspace_statistics_api/database.py

from .config import DATABASE_NAME
from .config import DATABASE_USER
from .config import DATABASE_PASS
from .config import DATABASE_HOST
from .config import DATABASE_PORT
import psycopg2
import psycopg2.extras


def database_connection():
    connection = psycopg2.connect("dbname={} user={} password={} host={} port={}".format(DATABASE_NAME, DATABASE_USER, DATABASE_PASS, DATABASE_HOST, DATABASE_PORT), cursor_factory=psycopg2.extras.DictCursor)

    return connection

# vim: set sw=4 ts=4 expandtab:
Refactor project structure This follows guidance from several well-known Python best practices guides. Basically, the idea is create a package for the application that is comprised of several re-usable modules. See: https://docs.python-guide.org/writing/structure/ See: https://realpython.com/python-application-layouts/ 2018-10-26 18:14:27 +02:00			`from .config import DATABASE_NAME`
			`from .config import DATABASE_USER`
			`from .config import DATABASE_PASS`
			`from .config import DATABASE_HOST`
Allow configuration of PostgreSQL port Defaults to port 5432, but can be overridden with DATABASE_PORT. 2018-11-03 21:40:45 +01:00			`from .config import DATABASE_PORT`
Correct issues highlighted by Flake8 Flake8 validates code style against PEP 8 in order to encourage the writing of idiomatic Python. For reference, I am currently ignoring errors about line length (E501) because I feel it makes code harder to read. This is the invocation I am using: $ flake8 --ignore E501 dspace_statistics_api 2018-11-03 22:55:23 +01:00			`import psycopg2`
			`import psycopg2.extras`

Use PostgreSQL instead of SQLite I was very surprised how easy and fast and robust SQLite was, but in the end I realized that its UPSERT support only came in version 3.24 and both Ubuntu 16.04 and 18.04 have older versions than that! I did manage to install libsqlite3-0 from Ubuntu 18.04 cosmic on my xenial host, but that feels dirty. PostgreSQL has support for UPSERT since 9.5, not to mention the same nice LIMIT and OFFSET clauses. 2018-09-24 23:49:47 +02:00
			`def database_connection():`
dspace_statistics_api/database.py: Don't quote host in connect() 2018-11-03 21:43:05 +01:00			`connection = psycopg2.connect("dbname={} user={} password={} host={} port={}".format(DATABASE_NAME, DATABASE_USER, DATABASE_PASS, DATABASE_HOST, DATABASE_PORT), cursor_factory=psycopg2.extras.DictCursor)`
Split database access into RW and RO The indexer need to be able to write to the database, but the API only needs to read it. 2018-09-23 23:00:05 +02:00
			`return connection`

app.py: Get item statistics from SQLite database It is much more efficient to cache view and download statistics in a database than to query Solr on demand (not to mention that it is not possible to page easily with facets in Solr). I decided to use SQLite because it is fast, native in Python 3, and doesn't require any extra steps during provisioning (assuming permissions are ok). 2018-09-23 15:47:00 +02:00			`# vim: set sw=4 ts=4 expandtab:`