Skip to content

Commit 4ddf6e9

Browse files
committed
docs: add overview section
1 parent 28e1bd0 commit 4ddf6e9

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@
1010
A flexible toolkit for customize how Django creates the databse objects for the
1111
application schema
1212

13+
# Overview
14+
Django DB adapter is a flexible schema editor backend built to solve the following problems:
15+
16+
- Generate SQL statements for projects working on database-first approach
17+
- All objects created (including created from Django) must have a particular name pattern, like add prefixes and suffixes
18+
- All table columns should be commented
19+
- Inline constraints (primary/foreign keys, unique/check constraints and indexes) are not allowed
20+
- The database user of application is not the owner of the objects and has no privilege to create/alter/drop them (`python manage.py migrate` will not work for this user). All DDL statements generated should include a grant of manipulation privileges (select/insert/update/delete) on created objects for this user/role
21+
- The order of SQL statements matters
22+
23+
1324
# Requirements
1425
- Python (3.6, 3.7, 3.8, 3.9)
1526
- Django (1.11, 2.2)
@@ -106,7 +117,6 @@ DB_ADAPTER = {
106117
'CONTROL', # Grant/revoke table privileges for specified role (if exists)
107118
'AUTOINCREMENT', # Sequence and triggers for auto-incremented fields
108119
]
109-
110120
}
111121
```
112122

0 commit comments

Comments
 (0)