Custom Database Storage for Django
Project description
django-db-storage2
.. image:: https://travis-ci.org/derekkwok/django-db-storage.svg?branch=master :target: https://travis-ci.org/derekkwok/django-db-storage
.. image:: https://coveralls.io/repos/github/derekkwok/django-db-storage/badge.svg?branch=master :target: https://coveralls.io/github/derekkwok/django-db-storage?branch=master
.. image:: https://badge.fury.io/py/django-db-storage.svg :target: https://badge.fury.io/py/django-db-storage
Overview
Warning: In many cases, storing files in the database is a BAD idea. Your database will easily become bloated and the performance can degrade rapidly. See this StackExchange post
_ for more information.
.. _StackExchange post: http://programmers.stackexchange.com/questions/150669/is-it-a-bad-practice-to-store-large-files-10-mb-in-a-database
This is a custom storage backend for storing files in the database instead of the file system and is a drop-in replacement for Django's FileSystemStorage. Some benefits of this application:
- no changes needed to existing models, it just works (and if it doesn't, open a ticket!)
- django-admin is implemented and can be used to search, upload, download and manage files
- 100% code coverage with unit tests
.. image:: http://i.imgur.com/4g9tmEZt.png :target: http://i.imgur.com/4g9tmEZ.png
.. image:: http://i.imgur.com/A2F8xlrt.png :target: http://i.imgur.com/A2F8xlr.png
Requirements
- Python (3.5+)
- Django (1.11.17+)
Installation
Installation using pip::
$ pip install django-db-storage2
Update settings.py
.. code-block:: python
# Add 'dbstorage' to INSTALLED_APPS
INSTALLED_APPS = [
'dbstorage',
]
# Optionally set DEFAULT_FILE_STORAGE
DEFAULT_FILE_STORAGE = 'dbstorage.storage.DBStorage'
# Choose a root url for uploaded files
MEDIA_URL = '/media/'
Update urls.py
.. code-block:: python
urlpatterns = [
...
dbstorage_url(),
]
Run database migrations
::
$ python manage.py migrate
How to Use
No modification are needed for models to work properly.
.. code-block:: python
def user_directory_path(instance, filename):
return 'user_{0}/{1}'.format(instance.user.id, filename)
class MyModel(models.Model):
file_field1 = models.FileField()
file_field2 = models.FileField(upload_to='uploads/%Y/%m/%d/')
file_field3 = models.FileField(upload_to=user_directory_path)
Bugs?
Create an issue at https://github.com/derekkwok/django-db-storage/issues
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-db-storage2-2.0.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e35a9265fb4e7b77d8a530fd674f37e575b5f18b63dcfe6109989c7cb878b4c |
|
MD5 | c17cb08ab5900f170f69f8680e8a6256 |
|
BLAKE2b-256 | 4f6f6789a041779da4be43746a6ac66ca3ec0bed238b0e881cbe00e3066e85e7 |
Hashes for django_db_storage2-2.0.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0d297825de2e77557ea15cb48811ec0948af90fa2f20d7c3c7159d6df4cc4ed |
|
MD5 | 9a8d36bdcf0c45102c00a8cff334a995 |
|
BLAKE2b-256 | 3c5a3dc62b9293b2a0aff57fc143a1489e868b8c6d2c57386ddc6857911eaf13 |