Proposal for a few new features.

* use a line starting with ".." or "__" to insert a separator in a class / table description, and ignore it when generating SQL code;
* use HTML tags in comments (e.g. use italic to emphasis them in the graphical view), and remove them in the SQL code;
* avoid conflict with reserved words in mySQL;
* add a time-stamp and original file name at the top of the generated SQL code;
* table name are converted to lower case;
* add a minimal help and guide for users;
* README.md updated accordingly.

Author: bbailleux

README.md

@@ -4,8 +4,9 @@ I liked `plantuml` tool for UML diagrams but use it
 also for visualizing structure of relational database.
 This script loads plantuml class diagram and generates
 DDL for MySQL SQL dialect. You may define primary keys
-with `#` prefix in field name (it mean protected field
-in PlantUML) and define index fields with `+` prefix.
+with `#` prefix in field name (it means protected field
+in PlantUML) and define index fields with `+` (public field
+in PlantUML) prefix.
 
 Field type noted after field name as is. Also you may
 use comments after `--`.
@@ -17,37 +18,45 @@ For example class definition:
     class dummy {
       Sample table.
       ==
-      #id int(10)
+      #id int(10) -- A comment
       field1 int(10)
+      .. Comment line, ignored ..
       field2 varchar(128)
     }
 
     @enduml
 
 will be converted to SQL:
 
-    CREATE TABLE IF NOT EXISTS Dummy (
-      id               INT(10),
+    CREATE TABLE IF NOT EXISTS `dummy` (
+      id               INT(10) COMMENT 'A comment',
       field1           INT(10),
       field2           VARCHAR(128),
       PRIMARY KEY (id));
 
 Text between class name and `==` is table description.
 The description of the table is mandatory.
 I was too lazy to check for absence of descriptions but
-I not lazy to write them in each table of my databases.
+not lazy to write them in each table of my databases.
 
-See below result of more complicated sample from [database.plu](database.plu):
+A line starting with `..` or `__`, used as a separator
+into a class definition, will be ignored.
+
+The HTML markup in comments (after `--`) is stripped.
+
+See below the result of a more complicated sample from [database.plu](database.plu):
 
 ![database.png](database.png)
 
-```./plantuml2mysql.py database.plu sampledb```
+```bash
+    ./plantuml2mysql.py database.plu sampledb
+```
 
 ```sql
     CREATE DATABASE sampledb CHARACTER SET = utf8 COLLATE = utf8_unicode_ci;
     USE sampledb;                                                           
 
-    CREATE TABLE IF NOT EXISTS user (                                       
+    CREATE TABLE IF NOT EXISTS `user` (                                       
       id               SERIAL,                                              
       login            VARCHAR(16),                                         
       mail             VARCHAR(64),                                         
@@ -59,7 +68,7 @@ See below result of more complicated sample from [database.plu](database.plu):
       INDEX (mail)                                                          
     );                                                                      
 
-    CREATE TABLE IF NOT EXISTS session (                                    
+    CREATE TABLE IF NOT EXISTS `session` (                                    
       id               SERIAL,                                              
       uid              INT(10) UNSIGNED,                                    
       remoteip         INT(10) UNSIGNED,                                    
@@ -71,7 +80,7 @@ See below result of more complicated sample from [database.plu](database.plu):
       INDEX (lastseen)                                                      
     );                                                                      
 
-    CREATE TABLE IF NOT EXISTS docs (                                       
+    CREATE TABLE IF NOT EXISTS `docs` (                                       
       id               INT(10),                                             
       fid              INT(10) COMMENT 'link to a file',                    
       aunthorid        INT(10),                                             
@@ -81,7 +90,7 @@ See below result of more complicated sample from [database.plu](database.plu):
       INDEX (created)                                                       
     );                                                                      
 
-    CREATE TABLE IF NOT EXISTS files (                                      
+    CREATE TABLE IF NOT EXISTS `files` (                                      
       id               SERIAL,                                              
       docId            INT(10),                                             
       title            VARCHAR(255),                                        

plantuml2mysql.py

@@ -2,20 +2,45 @@
 #-*-coding:utf-8-*-
 # Usage: ./plantuml2mysql <dbsource.plu> <dbname>
 # Author: Alexander I.Grafov <[email protected]>
+# See https://github.com/grafov/plantuml2mysql
 # The code is public domain.
 
 CHARSET="utf8_unicode_ci"
 
 import sys
+import re
+import time
+
+# PlantUML allows some HTML tags in comments.
+# We don't want them anymore here...
+TAG_RE = re.compile(r'<[^>]+>')
+def strip_html_tags(t):
+    return TAG_RE.sub('', t)
+
+# A minimal help
+def print_usage():
+  print("Convert PlantUML classes schema into mySQL database creation script")
+  print("Usage:\n", sys.argv[0], "<dbsource.plu> <dbname>")
+  print("\nSee https://github.com/grafov/plantuml2mysql for details\n")
 
 def main():
+    # Check arguments (exactly 1 + 2):
+    if len(sys.argv) != 3:
+        print_usage()
+        sys.exit()
+    try: # Avoid exception on STDOUT
+        with open(sys.argv[1]) as src:
+            data = src.readlines()
+    except:
+        print("Cannot open file: '" + sys.argv[1] + "'")
+        sys.exit()
+    # Add information for future self ;-)
+    print("# Database created on", time.strftime('%d/%m/%y %H:%M',time.localtime()), "from", sys.argv[1])
     print("CREATE DATABASE %s CHARACTER SET = utf8 COLLATE = %s;" % (sys.argv[2], CHARSET))
     print("USE %s;\n" % sys.argv[2])
     uml = False; table = False; field = False
     pk = False; idx = False
     primary = []; index = ""
-    with open(sys.argv[1]) as src:
-        data = src.readlines()
     for l in data:
         l = l.strip()
         if not l:
@@ -25,15 +50,17 @@ def main():
             continue
         if not uml:
             continue
-        if l == "--":
-            continue        
+        if l == "--": # Separator
+            continue
         comment = ""
         i = l.split()
-        fname = i[0]        
+        fname = i[0]
+        if fname == ".." or fname == "__": # Separators in table definition
+            continue
         if field and ("--" in l):
             i, comment = l.split("--", 2)
             i = i.split()
-        pk = False; idx = False            
+        pk = False; idx = False
         if fname[0] in ("+", "#"):
             if fname[0] == "#":
                 pk = True
@@ -48,9 +75,10 @@ def main():
         if l.startswith("class"):
             table = True; field = False
             primary = []; index = ""
-            print("CREATE TABLE IF NOT EXISTS", i[1], "(")
+            # Table names are quoted and lower cased to avoid conflict with a mySQL reserved word
+            print("CREATE TABLE IF NOT EXISTS `" + i[1].lower() + "` (")
             continue
-        if table and not field and l == "==":
+        if table and not field and l == "==": # Seperator after table description
             field = True
             continue
         if field and l == "}":
@@ -66,7 +94,8 @@ def main():
         if field and l != "#id":
             print("  %-16s %s" % (fname, " ".join(i[2:]).upper()), end="")
             if comment:
-                print(" COMMENT '%s'" % comment.strip(), end="")
+                # Avoid conflict with apostrophes (use double quotation marks)
+                print(" COMMENT \"%s\"" % strip_html_tags(comment.strip()), end="")
             print(",")
         if field and pk:
             primary.append(fname)