updated README

chimpler · Apr 29, 2015 · 754b7d0 · 754b7d0
1 parent e539f95
commit 754b7d0
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -98,13 +98,15 @@ Options:
         name VARCHAR(20) DEFAULT '(no name)' NOT NULL, 
         dept CHAR(2), 
         age INT, 
-        height DOUBLE(2,1)
+        height DOUBLE(2,1),
+        created_on TIMESTAMP DEFAULT CURRENT_TIMESTAMP
     );
 
-    mysql> INSERT INTO employee VALUES (1, 'John Doe', 'IT', 28, 6.3),(1, 'Mary Gray', 'IT', 30, 6.8);
+    mysql> INSERT INTO employee(id, name, dept, age, height) VALUES (1, 'John Doe', 'IT', 28, 6.3),(1, 'Mary Gray', 'IT', 30, 6.8);
 
 **Export the DDL definition**
 
+    ```json
     $ catdb ddl -d my_testdb -t employee -e /tmp/employee.json
     $ cat /tmp/employee.json
     {
@@ -144,12 +146,19 @@ Options:
                         "scale": 1,
                         "size": 2,
                         "type": "real"
+                    },
+                    {
+                        "column": "created_on",
+                        "default": "current_timestamp",
+                        "nullable": false,
+                        "type": "timestamp"
                     }
                 ],
                 "name": "employee"
             }
         ]
     }
+    ```
 
 **Convert DDL definition to CREATE TABLE statement for Postgres**
 
@@ -160,23 +169,24 @@ Options:
         name character varying(20) DEFAULT '(no name)',
         dept character(2),
         age integer,
-        height real
+        height real,
+        created_on timestamp without time zone DEFAULT now()
     );
-
+    
 **Export data**
 
     $ catdb data -d my_testdb -t employee -e /tmp/export.csv
     $ cat /tmp/export.csv
-    id|name|dept|age|height
-    1|John Doe|IT|28|6.3
-    1|Mary Gray|IT|30|6.8
-        
+    id|name|dept|age|height|created_on
+    1|John Doe|IT|28|6.3|2015-04-28 22:17:57
+    1|Mary Gray|IT|30|6.8|2015-04-28 22:17:57        
+
 **Import data (dry-run)**
 
     $ catdb data -d pg_testdb -t employee -i /tmp/export.csv -dr
-    INSERT INTO employee (id,name,dept,age,height)
-    VALUES('1','John Doe','IT','28','6.3'),
-    ('1','Mary Gray','IT','30','6.8');    
+    INSERT INTO employee (id,name,dept,age,height,created_on)
+    VALUES('1','John Doe','IT','28','6.3','2015-04-28 22:17:57'),
+    ('1','Mary Gray','IT','30','6.8','2015-04-28 22:17:57');
 
 ### TODO
 
@@ -201,4 +211,5 @@ Elastic Search                         | :x:
 MongoDB                                | :x:
 Export to S3                           | :x:
 Import from S3                         | :x:
+Compatible with Turbine XML format     | :x:
 Common console                         | :x:
diff --git a/catdb/__init__.py b/catdb/__init__.py
@@ -0,0 +1,2 @@
+class CatDbException(Exception):
+    pass
diff --git a/catdb/db.py b/catdb/db.py
@@ -3,6 +3,7 @@
 import importlib
 import pkg_resources
 from pyhocon import ConfigFactory
+from catdb import CatDbException
 
 
 class Db(object):
@@ -41,14 +42,22 @@ def get_ddl(self, schema=None, table_filter=None):
         def get_default(col_type, value):
             return self._rev_mappings[col_type]['defaults'].get(value, value)
 
+        def get_rev_mapping(col_type):
+            rev_mapping = self._rev_mappings.get(col_type)
+            if rev_mapping is None:
+                raise CatDbException('Cannot find reverse mapping {col_type}. ' \
+                                     'Please submit an issue at https://github.com/chimpler/catdb/issues.'.format(col_type=col_type))
+            else:
+                return rev_mapping
+
         def get_column_def(entry):
             row = {
                 'column': entry['column'],
                 'nullable': entry['nullable'],
                 'radix': entry['radix'],
                 'scale': entry['scale'],
                 'size': entry['size'],
-                'type': self._rev_mappings[entry['type']]['type'],
+                'type': get_rev_mapping(entry['type'])['type'],
                 'default': get_default(entry['type'], entry['default'])
             }
 

diff --git a/catdb/main.py b/catdb/main.py
@@ -21,7 +21,7 @@ def main():
     data_parser = subparsers.add_parser('data', help='data', parents=[parent_parser])
     data_parser.add_argument('-e', '--export', dest='export_file', help='export', required=False, action='store')
     data_parser.add_argument('-i', '--import', dest='import_file', help='import', required=False)
-    list_parser = subparsers.add_parser('list', help='list', parents=[parent_parser])
+    subparsers.add_parser('list', help='list', parents=[parent_parser])
 
     args = argparser.parse_args()
     config = ConfigFactory.parse_file('.catdb')