[PATCH] Allow to use comments in the "initial sql data" files.

[Pawel J. Sawicki (http://pjs.name)]

In order to allow comments to be placed in the initial sql data files (​http://www.djangoproject.com/documentation/model_api/#providing-initial-sql-data) the following patch may be used:

$ svn diff management.py
Index: management.py
===================================================================
--- management.py       (revision 3496)
+++ management.py       (working copy)
@@ -499,7 +499,9 @@
                     print "Installing initial data for %s model" % model._meta.object_name
                     try:
                         for sql in initial_sql:
-                            cursor.execute(sql)
+                               # Allow to use comments in the initial sql data files.
+                               if not sql.strip().startswith('--'):
+                                   cursor.execute(sql)
                     except Exception, e:
                         sys.stderr.write("Failed to install initial SQL data for %s model: %s" % \
                                             (model._meta.object_name, e))

[Simon Willison]

I haven't tried this patch, but from looking at it it doesn't seem to take differences in SQL comments betweeen databases in to account. Should this be handled at by code in the individual database adapters?

[Pawel J. Sawicki (http://pjs.name)]

Isn't the '--' prefix an "ISO way" to make comments in the SQL language? I'm not a DB expert - just asking just out of curiosity.

[Adrian Holovaty]

I believe the -- will take care of comments on all database backends we support.

[Malcolm Tredinnick]

We unfortunately need to revisit the initial SQL parsing again and probably come up with something that is much more holistic. The current line-by-line stuff has no end of corner-cases it can't handle, no matter how we implement it. Tickets #2284 and #2444 are related to this.

[Pawel J. Sawicki (http://pjs.name)]

Ok - I get it. Nevertheless this is quite enough for me, for the time being.

I need to version the sql files and add $Id$ "svn:keywords" ("-- $Id$\n" line). Since the patch is a one-liner I'll stick with it until the initial sql parsing procedures are revisited.

[anonymous]

wouldn't it just be easier to not try and parse these at all?
just read the files and dump them to stdout

[Pawel J. Sawicki (http://pjs.name)]

Patch that correctly removes any comments presented within any initial sql data files.

[Pawel J. Sawicki (http://pjs.name)]

I've fixed the patch since the previous one didn't work as it should (under some conditions).

[Jacob]

(In [4040]) Fixed #2452: comments can now be put within initial SQL files. Thanks, Pawel J. Sawicki.