Skip to content

Commit 3cb8b04

Browse files
committed
Update REAMDE on back-end changes
1 parent 3f8fc77 commit 3cb8b04

File tree

1 file changed

+9
-17
lines changed

1 file changed

+9
-17
lines changed

README.rst

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,14 @@ Installation
3535
'localized_fields'
3636
]
3737
38-
3. Set the database engine to ``localized_fields.db_backend``:
38+
3. Set the database engine to ``psqlextra.backend``:
3939

4040
.. code-block:: python
4141
4242
DATABASES = {
4343
'default': {
4444
...
45-
'ENGINE': 'localized_fields.db_backend'
45+
'ENGINE': 'psqlextra.backend'
4646
}
4747
}
4848
@@ -247,34 +247,26 @@ Besides ``LocalizedField``, there's also:
247247
Frequently asked questions (FAQ)
248248
--------------------------------
249249

250-
1. Why do I need to change the database back-end/engine?
251-
252-
We utilize PostgreSQL's `hstore` data type, which allows you to store key-value pairs in a column. In order to create `UNIQUE` constraints on specific key, we need to create a special type of index. We could do this without a custom database back-end, but it would require everyone to manually write their migrations. By using a custom database back-end, we added support for this. When changing the `uniqueness` constraint on a `LocalizedField`, our custom database back-end takes care of creating, updating and deleting these constraints/indexes in the database.
253-
254-
2. I am already using a custom database back-end, can I still use yours?
255-
256-
Yes. You can set the ``LOCALIZED_FIELDS_DB_BACKEND_BASE`` setting to your current back-end. This will instruct our custom database back-end to inherit from the database back-end you specified. **Warning**: this will only work if the base you specified indirectly inherits from the standard PostgreSQL database back-end.
257-
258-
3. Does this package work with Python 2?
250+
1. Does this package work with Python 2?
259251

260252
No. Only Python 3.5 or newer is supported. We're using type hints. These do not work well under older versions of Python.
261253

262-
4. Does this package work with Django 1.X?
254+
2. Does this package work with Django 1.X?
263255

264256
No. Only Django 1.10 or newer is supported. This is because we rely on Django's ``HStoreField``.
265257

266-
5. Does this package come with support for Django Admin?
258+
3. Does this package come with support for Django Admin?
267259

268260
Yes. Our custom fields come with a special form that will automatically be used in Django Admin if the field is of ``LocalizedField``.
269261

270-
7. Why should I pick this over any of the other translation packages out there?
262+
4. Why should I pick this over any of the other translation packages out there?
271263

272264
You should pick whatever you feel comfortable with. This package stores translations in your database without having to have translation tables. It however only works on PostgreSQL.
273265

274-
8. I am using PostgreSQL <8.4, can I use this?
266+
5. I am using PostgreSQL <9.6, can I use this?
275267

276-
No. The ``hstore`` data type was introduced in PostgreSQL 8.4.
268+
No. The ``hstore`` data type was introduced in PostgreSQL 9.6.
277269

278-
9. I am using this package. Can I give you some beer?
270+
6. I am using this package. Can I give you some beer?
279271

280272
Yes! If you're ever in the area of Cluj-Napoca, Romania, swing by :)

0 commit comments

Comments
 (0)