[Django] #22673: inspectdb not support database schema on postgresql with name different of "public"

Django

unread,

May 21, 2014, 1:30:13 PM5/21/14

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> | Status: new
Type: New feature | Version: 1.6
Component: Uncategorized | Keywords: inspectdb,
Severity: Normal | introspection, postgresql, schema
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
I have a legacy database in PostgreSQL, which is still in production.
I want to migrate it to Django.
I tried to do the reverse engineering of the database using inspectdb to
generate models classes, however, this does not work.

'''The problem is Django not provides way to use inspectdb in a schema
with name different of "public"'''

If you do not know the concept of postgresql schema, please read:

http://www.postgresql.org/docs/9.3/static/ddl-schemas.html

To explain this, I created a database based on "pulls" app from the basic
tutorial.

The backup of database I used is attached.

* It would facilitate integration with legacy database

I found these tickets dealing with similar things but different this

https://code.djangoproject.com/ticket/1051
https://code.djangoproject.com/ticket/6148

I set my settings like this:

{{{#!python

DATABASES = {
# new blank database
# this read/write into "public" postgresql schema
'default': {
'ENGINE': 'django.db.backends.postgresql_psycopg2',
'NAME': 'neweposse',
'USER': 'postgres',
'PASSWORD': 'postgres',
'HOST': '127.0.0.1',
'PORT': '5432',
},
# legacy database
# the postgresql schema is named "legacyschema1"
'eposse': {
'ENGINE': 'django.db.backends.postgresql_psycopg2',
'NAME': 'eposse',
'USER': 'postgres',
'PASSWORD': 'postgres',
'HOST': '127.0.0.1',
'PORT': '5432',
}
}

}}}

'''in terminal:'''

{{{#!bash

(django1.7b4)oficina@oficina:~/schematest$ python manage.py inspectdb
...
from __future__ import unicode_literals

from django.db import models

(django1.7b4)oficina@oficina:~/schematest$ python manage.py inspectdb
--database=eposse
...
from __future__ import unicode_literals

from django.db import models

}}}

'''Tests using dbshell, was recommended to me by Russell Keith-Magee this
topic: https://groups.google.com/forum/#!topic/django-
developers/lSHrDFZM4lQ'''

{{{#!bash

(django1.7b4)oficina@oficina:~/schematest$ python manage.py dbshell
--database=eposse
psql (9.3.4)
SSL connection (cipher: DHE-RSA-AES256-SHA, bits: 256)
Type "help" for help.

eposse=# \dt
No relations found.

}}}

{{{#!bash

eposse=# \dn
List of schemas
Name | Owner
---------------+----------
legacyschema1 | postgres
public | postgres
(2 rows)

}}}

{{{#!bash

}}}

{{{#!bash

eposse=# \d legacyschema1.*
Table "legacyschema1.choice"
Column | Type |
Modifiers
-------------+------------------------+-------------------------------------------------------------------
id | integer | not null default
nextval('legacyschema1.choice_id_seq'::regclass)
poll_id | integer | not null
choice_text | character varying(200) | not null
votes | integer | not null
Indexes:
"choice_pkey" PRIMARY KEY, btree (id)
"choice_582e9e5a" btree (poll_id)
Foreign-key constraints:
"choice_poll_id_3d0280c389b7efa_fk_pull_id" FOREIGN KEY (poll_id)
REFERENCES legacyschema1.pull(id) DEFERRABLE INITIALLY DEFERRED

Index "legacyschema1.choice_582e9e5a"
Column | Type | Definition
---------+---------+------------
poll_id | integer | poll_id
btree, for table "legacyschema1.choice"

Index "legacyschema1.choice_pkey"
Column | Type | Definition
--------+---------+------------
id | integer | id
primary key, btree, for table "legacyschema1.choice"

Table "legacyschema1.pull"
Column | Type |
Modifiers
----------+--------------------------+-----------------------------------------------------------------
id | integer | not null default
nextval('legacyschema1.pull_id_seq'::regclass)
question | character varying(200) | not null
pub_date | timestamp with time zone | not null
Indexes:
"pull_pkey" PRIMARY KEY, btree (id)
Referenced by:
TABLE "legacyschema1.choice" CONSTRAINT
"choice_poll_id_3d0280c389b7efa_fk_pull_id" FOREIGN KEY (poll_id)
REFERENCES legacyschema1.pull(id) DEFERRABLE INITIALLY DEFERRED

Index "legacyschema1.pull_pkey"
Column | Type | Definition
--------+---------+------------
id | integer | id
primary key, btree, for table "legacyschema1.pull"

}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/22673>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,

May 21, 2014, 1:37:57 PM5/21/14

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> | Status: new
Type: New feature | Version: 1.6

Component: Uncategorized | Resolution:
Severity: Normal | Triage Stage:
Keywords: inspectdb, | Unreviewed
introspection, postgresql, schema | Needs documentation: 0
Has patch: 0 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 0 |
-------------------------------------+-------------------------------------
Changes (by Fabio Caritas Barrionuevo da Luz <bnafta@…>):

* cc: bnafta@… (added)
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/22673#comment:1>

Django

unread,

May 21, 2014, 2:44:36 PM5/21/14

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> | Status: new

Type: New feature | Version: master

Changes (by luzfcb):

* version: 1.6 => master

--
Ticket URL: <https://code.djangoproject.com/ticket/22673#comment:2>

Django

unread,

May 21, 2014, 3:14:33 PM5/21/14

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> | Status: new

Comment (by andrewgodwin):

As per #6148, Django doesn't actually support schemas, so I'm not sure we
can resolve this until that's fixed.

Schema support is a big task for us and hopefully one we can support soon,
but it's not a quick thing to implement! The only workaround I could think
of would be using set_search_path in initial connection SQL (some comments
on that in the ticket above or google around for how other people have
done it) to make sure the other schema is included and then inspectdb
might see the tables in it.

--
Ticket URL: <https://code.djangoproject.com/ticket/22673#comment:3>

Django

unread,

May 21, 2014, 4:48:20 PM5/21/14

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> | Status: new

Type: New feature | Version: master
Component: Uncategorized | Resolution:
Severity: Normal | Triage Stage:
Keywords: inspectdb, | Unreviewed

* keywords: inspectdb, introspection, postgresql, schema => inspectdb,
introspection, postgresql, schema, oracle

Comment:

Replying to [comment:3 andrewgodwin]:

Thanks for the quick reply.

Due to this being a very old request (#1051 #6148 ), I believe that the
indicated provisory solution should be described step by step in the
documentation, including citing that it is a provisory solution and are
still searching for a permanent solution, indicating their respective
tickets.

At the moment I do not possess necessary knowledge to solve this, but I
think explicit the problems to django-community is good, because at some
point someone will arrive at a good solution for this.

I really like the pep 20
"Explicit is better than implicit."

This feature would be especially useful for me because I need to integrate
the system that I am developing with django with other systems already in
operation at least 10 years, and made with ASP.net, Java and C++, using
Oracle and PostgreSQL schema with name different of "public".

Thanks for the hard work

--
Ticket URL: <https://code.djangoproject.com/ticket/22673#comment:4>

Django

unread,

Jun 2, 2014, 11:41:43 AM6/2/14

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> | Status: new

Needs tests: 0 |
Easy pickings: 0 |
-------------------------------------+-------------------------------------

Changes (by timo):

* component: Uncategorized => Database layer (models, ORM)
* stage: Unreviewed => Accepted

--
Ticket URL: <https://code.djangoproject.com/ticket/22673#comment:5>

Django

unread,

Jun 9, 2014, 4:27:30 PM6/9/14

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> | Status: new

Comment (by shai):

Oracle doesn't have schemas in the sense of PG; @luzfcb -- are you sure
Oracle is related here?

--
Ticket URL: <https://code.djangoproject.com/ticket/22673#comment:6>

Django

unread,

Dec 29, 2014, 12:16:28 PM12/29/14

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> |

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by luzfcb):

Is there anybody working on something that makes this possible in a future
version of django(1.8, 1.9, 2.0)?

--
Ticket URL: <https://code.djangoproject.com/ticket/22673#comment:7>

Django

unread,

Jun 4, 2015, 6:15:13 AM6/4/15

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> |

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by shaib):

* keywords: inspectdb, introspection, postgresql, schema, oracle =>
inspectdb, introspection, postgresql, schema

Comment:

(No response to my question of a year ago, oracle keyword removed)

--
Ticket URL: <https://code.djangoproject.com/ticket/22673#comment:8>

Django

unread,

Mar 10, 2017, 11:14:24 AM3/10/17

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> |

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Jaap Vermeulen):

With a simple code change, schemas in postgres work fine (but not for
inspectdb). I will paste the change here and if I find time later on will
create a pull request and also add the second change in there (from
#27908) for inspectdb. In db/backends/postgresql/operations.py replace
the following method:
{{{
def quote_name(self, name):
if name.startswith('"') and name.endswith('"'):
return name # Quoting once is enough.
# Quote schema and db seperately
parts = name.split('.')
return '"' + '"."'.join(parts) + '"'

}}}
If and when I have time, I'll see if I can look at the other DBs.

--
Ticket URL: <https://code.djangoproject.com/ticket/22673#comment:9>

Django

unread,

Jun 14, 2018, 9:43:37 AM6/14/18

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> |

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carlton Gibson):

Related report #29494

--
Ticket URL: <https://code.djangoproject.com/ticket/22673#comment:10>

Django

unread,

Apr 12, 2019, 4:58:29 AM4/12/19

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> |

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Erik Cederstrand):

I just stumbled into this because I have similar requirements, and ended
up creating a custom
`django.db.backends.postgresql.introspection.DatabaseIntrospection` class
that respects the schema specified by `inspectdb --database=my_schema`. I
also implemented a new optional `SCHEMA` entry in the postgres
`settings.DATABASES` option dict so the inspection can pick up that value.

The changes to the `DatabaseIntrospection` and `DatabaseWrapper` classes
are minimal. Fallback would be to the point to the `public` schema.

Would you be interested in patches?

It's a bit more involved to support multiple schemas in parallel, but
solveable by creating a custom DB router and an extra `db_schema` Meta
option.

--
Ticket URL: <https://code.djangoproject.com/ticket/22673#comment:11>

Django

unread,

Mar 12, 2024, 2:20:34 AMMar 12

to django-...@googlegroups.com

#22673: inspectdb not support database schema on postgresql with name different of
"public"
-------------------------------------+-------------------------------------
Reporter: Fabio Caritas | Owner: nobody
Barrionuevo da Luz <bnafta@…> |

Type: New feature | Status: new

Component: Database layer | Version: dev

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Ülgen Sarıkavak):

* cc: Ülgen Sarıkavak (added)

--
Ticket URL: <https://code.djangoproject.com/ticket/22673#comment:12>

Reply all

Reply to author

Forward