Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3YOURMIND/django-add-default-value
This django Migration Operation can be used to transfer a Fields default value to the database scheme.
https://github.com/3YOURMIND/django-add-default-value
database django mysql postgresql python
Last synced: 3 months ago
JSON representation
This django Migration Operation can be used to transfer a Fields default value to the database scheme.
- Host: GitHub
- URL: https://github.com/3YOURMIND/django-add-default-value
- Owner: 3YOURMIND
- License: apache-2.0
- Created: 2018-01-15T11:41:13.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T15:30:26.000Z (9 months ago)
- Last Synced: 2024-09-19T16:36:01.643Z (3 months ago)
- Topics: database, django, mysql, postgresql, python
- Language: Python
- Size: 87.9 KB
- Stars: 138
- Watchers: 8
- Forks: 19
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE.txt
Awesome Lists containing this project
- stars - 3YOURMIND/django-add-default-value - This django Migration Operation can be used to transfer a Fields default value to the database scheme. (Python)
- stars - 3YOURMIND/django-add-default-value - This django Migration Operation can be used to transfer a Fields default value to the database scheme. (Python)
README
Django Add Default Value
========================
Django Migration Operation that can be used to transfer a field's default value
to the database scheme.
[](https://pypi.python.org/pypi/django-add-default-value/)
[](./LICENSE)
[](https://github.com/3YOURMIND/django-add-default-value/pulls)
[](https://www.3yourmind.com/career)
[](https://github.com/3YOURMIND/django-add-default-value/stargazers)
Supported Databases
------------
* MySQL (or compatible)
* PostgreSQL
* MSSQL (currently not tested)
* CockroachDB
Installation
------------
`pip install django-add-default-value`
You can then use ``AddDefaultValue`` in your migration file to transfer the default
values to your database. Afterwards, it's just the usual ``./manage.py migrate``.
Usage
-----
Add this manually to a autogenerated Migration, that adds a new field
```python
AddDefaultValue(
model_name='my_model',
name='my_field',
value='my_default'
)
```
### Example
Given the following migration:
**BEFORE**
```python
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
...
]
operations = [
migrations.AddField(
field=models.CharField(default='my_default', max_length=255),
model_name='my_model',
name='my_field',
),
]
```
Modify the migration to add a default value:
**AFTER**
```python
from django.db import migrations, models
from django_add_default_value import AddDefaultValue
class Migration(migrations.Migration):
dependencies = [
...
]
operations = [
migrations.AddField(
field=models.CharField(default='my_default', max_length=255),
model_name='my_model',
name='my_field',
),
AddDefaultValue(
model_name='my_model',
name='my_field',
value='my_default'
)
]
```
If you check ``python manage.py sqlmigrate [app name] [migration]``,
you will see that the default value now gets set.
Contributing
------------
First of all, thank you very much for contributing to this project. Please base
your work on the ``master`` branch and target ``master`` in your pull request.
To succesfully use the `dbshell` management command (very useful for debugging),
the client binaries for the respective database engines are needed.
Then install [pipenv](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv).
Edit the `Pipfile` to select your Django version and the accompanying MS-SQL
driver. Make sure you don't commit this change in any pull request - we always
set it to the oldest supported version.
Once you've updated the Pipfile, run `pipenv install --python 3 --dev`. You
should now have a working development environment as a virtualenv. To access it,
run `pipenv shell` or prefix commands with `pipenv run`. For more information
see the [pipenv documentation](https://pipenv.readthedocs.io/en/latest/basics/).
### Testing
Copy the relevant sample settings file in `test_project` to the file without
`.sample` in it. Adjust the values to match your environment (or match your
environment to the values).
You should now be able to run the tests using `tox`. Select your environment
when needed, using the `-e` command line flag. See
[Tox's excellent documentation](https://tox.readthedocs.io/en/latest/).
License
-------
``django-add-default-value`` is released under the Apache 2.0 License.