alanorth/dspace-statistics-api
1
0
Fork 0
mirror of https://github.com/ilri/dspace-statistics-api.git synced 2024-12-23 21:14:30 +01:00
Code Releases Activity
be94c94433
dspace-statistics-api/dspace_statistics_api/database.py

31 lines
1003 B
Python
Raw Normal View History

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
dspace_statistics_api/database.py: Raise HTTP 500 on error Properly except on database connection error and raise an HTTP 500 instead of spamming the console/log with twenty lines of text.
2018-11-10 22:58:58 +01:00
import falcon
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
Refactor database code to use a context manager Instead of opening one global persistent database connection when the application I am now abstracting it to a class that I can use in combination with Python's "with" context. Both connections and cursors are kept for the context of each "with" block and closed automatically when exiting. See: https://alysivji.github.io/managing-resources-with-context-managers-pythonic.html See: http://initd.org/psycopg/docs/connection.html#connection.close
2018-11-07 16:41:21 +01:00
class DatabaseManager():
'''Manage database connection.'''
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
Refactor database code to use a context manager Instead of opening one global persistent database connection when the application I am now abstracting it to a class that I can use in combination with Python's "with" context. Both connections and cursors are kept for the context of each "with" block and closed automatically when exiting. See: https://alysivji.github.io/managing-resources-with-context-managers-pythonic.html See: http://initd.org/psycopg/docs/connection.html#connection.close
2018-11-07 16:41:21 +01:00
def __init__(self):
self._connection_uri = 'dbname={} user={} password={} host={} port={}'.format(DATABASE_NAME, DATABASE_USER, DATABASE_PASS, DATABASE_HOST, DATABASE_PORT)
def __enter__(self):
dspace_statistics_api/database.py: Raise HTTP 500 on error Properly except on database connection error and raise an HTTP 500 instead of spamming the console/log with twenty lines of text.
2018-11-10 22:58:58 +01:00
try:
self._connection = psycopg2.connect(self._connection_uri, cursor_factory=psycopg2.extras.DictCursor)
except psycopg2.OperationalError:
title = '500 Internal Server Error'
description = 'Could not connect to database'
raise falcon.HTTPInternalServerError(title, description)
Refactor database code to use a context manager Instead of opening one global persistent database connection when the application I am now abstracting it to a class that I can use in combination with Python's "with" context. Both connections and cursors are kept for the context of each "with" block and closed automatically when exiting. See: https://alysivji.github.io/managing-resources-with-context-managers-pythonic.html See: http://initd.org/psycopg/docs/connection.html#connection.close
2018-11-07 16:41:21 +01:00
return self._connection
def __exit__(self, exc_type, exc_value, exc_traceback):
self._connection.close()
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
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:
Copy Permalink