Merge pull request #598 from kuba--/fix-594/show-create-table

Support SQLAlchemy syntax for show create table

Author: ajnavarro

SUPPORTED_CLIENTS.md

@@ -5,6 +5,7 @@ These are the clients we actively test against to check are compatible with go-m
 - Python
   - [pymysql](#pymysql)
   - [mysql-connector](#python-mysql-connector)
+  - [sqlalchemy](#python-sqlalchemy)
 - Ruby
   - [ruby-mysql](#ruby-mysql)
 - [PHP](#php)
@@ -65,6 +66,19 @@ finally:
     connection.close()
 ```
 
+### Python sqlalchemy
+
+```python
+import pandas as pd
+import sqlalchemy
+
+engine = sqlalchemy.create_engine('mysql+pymysql://user:[email protected]:3306/dbname')
+with engine.connect() as conn:
+     repo_df = pd.read_sql_table("mytable", con=conn)
+     for table_name in repo_df.to_dict():
+        print(table_name)
+```
+
 ### ruby-mysql
 
 ```ruby

_integration/python-sqlalchemy/Makefile

@@ -0,0 +1,7 @@
+dependencies:
+	python -m pip install -r requirements.txt
+
+test: dependencies
+	python -m unittest discover
+
+.PHONY: dependencies test

_integration/python-sqlalchemy/requirements.txt

@@ -0,0 +1,2 @@
+pandas
+sqlalchemy

_integration/python-sqlalchemy/test.py

@@ -0,0 +1,24 @@
+import unittest
+import pandas as pd
+import sqlalchemy
+
+
+class TestMySQL(unittest.TestCase):
+
+    def test_connect(self):
+        engine = sqlalchemy.create_engine('mysql+pymysql://user:[email protected]:3306/test')
+        with engine.connect() as conn:
+            expected = {
+                "name":  {0: 'John Doe', 1: 'John Doe', 2: 'Jane Doe', 3: 'Evil Bob'},
+                "email": {0: '[email protected]', 1: '[email protected]', 2: '[email protected]', 3: '[email protected]'},
+                "phone_numbers": {0: '["555-555-555"]', 1: '[]', 2: '[]', 3: '["555-666-555","666-666-666"]'},
+                "created_at": {0: pd.Timestamp('2019-01-28 15:35:51'), 1: pd.Timestamp('2019-01-28 15:35:51'), 2: pd.Timestamp('2019-01-28 15:35:51'), 3: pd.Timestamp('2019-01-28 15:35:51')},
+            }
+
+            repo_df = pd.read_sql_table("mytable", con=conn)
+
+            self.assertEqual(expected, repo_df.to_dict())
+
+
+if __name__ == '__main__':
+    unittest.main()

sql/plan/show_create_table.go

@@ -89,7 +89,7 @@ func produceCreateStatement(table sql.Table) string {
 
 	// Statement creation parts for each column
 	for indx, col := range schema {
-		createStmtPart := fmt.Sprintf("`%s` %s", col.Name, col.Type.Type())
+		createStmtPart := fmt.Sprintf("  `%s` %s", col.Name, col.Type.Type())
 
 		if !col.Nullable {
 			createStmtPart = fmt.Sprintf("%s NOT NULL", createStmtPart)
@@ -111,7 +111,7 @@ func produceCreateStatement(table sql.Table) string {
 
 	prettyColCreateStmts := strings.Join(colCreateStatements, ",\n")
 	composedCreateTableStatement :=
-		fmt.Sprintf("CREATE TABLE `%s` (%s) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4", table.Name(), prettyColCreateStmts)
+		fmt.Sprintf("CREATE TABLE `%s` (\n%s\n) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4", table.Name(), prettyColCreateStmts)
 
 	return composedCreateTableStatement
 }

sql/plan/show_create_table_test.go

@@ -37,9 +37,9 @@ func TestShowCreateTable(t *testing.T) {
 
 	expected := sql.NewRow(
 		table.Name(),
-		"CREATE TABLE `test-table` (`baz` TEXT NOT NULL,\n"+
-			"`zab` INT32 DEFAULT 0,\n"+
-			"`bza` INT64 DEFAULT 0) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4",
+		"CREATE TABLE `test-table` (\n  `baz` TEXT NOT NULL,\n"+
+			"  `zab` INT32 DEFAULT 0,\n"+
+			"  `bza` INT64 DEFAULT 0\n) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4",
 	)
 
 	require.Equal(expected, row)