git merge conflicts with our database file (multiple developers)

Question

A buddy and I are developing a Django app and are using git.

As we work, we make fake accounts on our site, login, and upload content to the database, etc..for testing purposes. Every time we merge branches, we get merge conflicts in our database file. The database file is in the repository, and, since we're testing separately, the local copies of the file develop differently.

How do I prevent the database file from being tracked, so we can each keep our local copies?

With the following, we've been able to avoid using a local path:

## settings.py


from os.path import dirname, join

PROJECT_DIR = dirname(__file__)

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': join(PROJECT_DIR, 'foo.db'),
        'USER': '',
        'PASSWORD': '',
        'HOST': '',
        'PORT': '',
    }
}

What would be ideal, is something like:

## settings.py


from os.path import dirname, join

PROJECT_DIR = dirname(__file__)

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': join('../../../', PROJECT_DIR, 'foo.db'), # this path is outside the repository (ie, 'Users/sgarza62/foo.db')
        'USER': '',
        'PASSWORD': '',
        'HOST': '',
        'PORT': '',
    }
}

How can we keep our database files from being committed?

score 14 · Accepted Answer · answered Feb 02 '13 at 19:42

14

Add your database file to .gitignore. Then you can keep it in its current location, but it will not be under version control.

answered Feb 02 '13 at 19:42

Alex Krauss

9,438
4
27
31

1

+1, git is designed to deal with this kind of thing. You should not need to mess with your project to get it to work with SCC. – Gareth Latty Feb 02 '13 at 19:46
@Lattyware: how do you deal with absolute paths that must be in settings with git? – Rafał Łużyński Feb 02 '13 at 19:54
@RafałŁużyński The settings file should be ignored. (If you have some settings that you need to share, and some that need to be different, they need to be in separate files, but that's good design anyway). – Gareth Latty Feb 02 '13 at 20:49

Garrett Hyde · Answer 2 · 2013-02-02T21:35:13.510

First off, you'll want to remove the database file from your git repository.

git rm <database_file>

To prevent the file from being added to your repository, create a file named ".gitignore" inside your checkout of the repository, add the database file to .gitignore, and add .gitignore to your repository. (Documentation)

To prevent conflicts with settings.py, I also add settings.py to .gitignore. I then create a file called "settings.production.py", which contains all of the settings for the production server, and add it to the repository. On my local checkout, I simply copy this file into settings.py and modify variables as needed. On my production server, I make a symlink to settings.production.py.

ln -s settings.production.py settings.py

WARNING:

If your repository is public, it should never store secret keys, passwords, certificates, etc. You don't want others to have access to these files.
You should also verify that your web server does not serve ".git" folders. A hacker could gain access to your source code if http://example.com/.git is accessible.

If the repo is public, versionning the settings file can lead to trouble (leaked secret key). Good answer nonetheless! — Thomas Orozco, Feb 02 '13 at 21:16

Rafał Łużyński · Answer 3 · 2013-02-02T19:50:19.553

When you work on projects with other ppl sharing repo, you have to make local_settings.py and keep there all local settings :) Then in settings.py just add from local_settings import *. And add local_settings.py and database file to .gitignore file.

In example if your file name is database.db then in directory with this file create file with name .gitignore and write in it database.db or *.db to ignore all db files.

score 1 · Answer 4 · edited May 23 '17 at 11:46

This is a common problem. I would recommend not checking in the database and loading and saving data fixtures as needed. (https://docs.djangoproject.com/en/dev/howto/initial-data/)

Create a test_data directory and run the following commands to export your database to a database agnostic json file: ./manage.py dumpdata > test_data/test_file_1.json

Check that file in to source. At any point if you want to restore the database to that point simply run: ./manage.py loaddata test_data/test_file_1.json

This also has the advantage of being used for unit tests (read Loading fixtures in django unit tests)

from django.test import TestCase
class MyTestCase(TestCase):
    fixtures = ['/myapp/fixtures/dump.json',]

git merge conflicts with our database file (multiple developers)

4 Answers4