ENH: support index=True/False keyword for io.sql.get_schema

doc/source/whatsnew/v1.1.0.rst

@@ -329,6 +329,7 @@ Other enhancements
 - :meth:`DataFrame.to_excel` can now also write OpenOffice spreadsheet (.ods) files (:issue:`27222`)
 - :meth:`~Series.explode` now accepts ``ignore_index`` to reset the index, similarly to :meth:`pd.concat` or :meth:`DataFrame.sort_values` (:issue:`34932`).
 - :meth:`read_csv` now accepts string values like "0", "0.0", "1", "1.0" as convertible to the nullable boolean dtype (:issue:`34859`)
+- :meth:`~pandas.io.sql.get_schema` now accepts `index` parameter to include index of the DataFrame in the schema (:issue:`9084`).
 
 .. ---------------------------------------------------------------------------
 

pandas/io/sql.py

@@ -1454,9 +1454,9 @@ def drop_table(self, table_name, schema=None):
             self.get_table(table_name, schema).drop()
             self.meta.clear()
 
-    def _create_sql_schema(self, frame, table_name, keys=None, dtype=None):
+    def _create_sql_schema(self, frame, table_name, keys=None, dtype=None, index=False):
         table = SQLTable(
-            table_name, self, frame=frame, index=False, keys=keys, dtype=dtype
+            table_name, self, frame=frame, index=index, keys=keys, dtype=dtype
         )
         return str(table.sql_schema())
 
@@ -1844,14 +1844,14 @@ def drop_table(self, name, schema=None):
         drop_sql = f"DROP TABLE {_get_valid_sqlite_name(name)}"
         self.execute(drop_sql)
 
-    def _create_sql_schema(self, frame, table_name, keys=None, dtype=None):
+    def _create_sql_schema(self, frame, table_name, keys=None, dtype=None, index=False):
         table = SQLiteTable(
-            table_name, self, frame=frame, index=False, keys=keys, dtype=dtype
+            table_name, self, frame=frame, index=index, keys=keys, dtype=dtype
         )
         return str(table.sql_schema())
 
 
-def get_schema(frame, name, keys=None, con=None, dtype=None):
+def get_schema(frame, name, keys=None, con=None, dtype=None, index=False):
     """
     Get the SQL db table schema for the given frame.
 
@@ -1869,7 +1869,12 @@ def get_schema(frame, name, keys=None, con=None, dtype=None):
     dtype : dict of column name to SQL type, default None
         Optional specifying the datatype for columns. The SQL type should
         be a SQLAlchemy type, or a string for sqlite3 fallback connection.
+    index : boolean, default: False
+         Whether to include the index of the DataFrame in the sql schema
+         New in version 1.1.0.
 
     """
     pandas_sql = pandasSQL_builder(con=con)
-    return pandas_sql._create_sql_schema(frame, name, keys=keys, dtype=dtype)
+    return pandas_sql._create_sql_schema(
+        frame, name, keys=keys, dtype=dtype, index=index
+    )

pandas/tests/io/test_sql.py

@@ -887,6 +887,20 @@ def test_get_schema_keys(self):
         constraint_sentence = 'CONSTRAINT test_pk PRIMARY KEY ("A", "B")'
         assert constraint_sentence in create_sql
 
+    def test_get_schema_with_index(self):
+        # GH 9084
+        df = pd.DataFrame({"one": [1, 2, 3], "two": [1, 2, 3]}, index=list("abc"))
+
+        schema_without_index = sql.get_schema(df, "test", con=self.conn)
+        assert "index TEXT" not in schema_without_index
+
+        schema_with_index = sql.get_schema(df, "test", index=True, con=self.conn)
+        assert '"index" TEXT' in schema_with_index
+
+        df.index.name = "new_index"
+        schema_with_index_rename = sql.get_schema(df, "test", index=True, con=self.conn)
+        assert df.index.name in schema_with_index_rename
+
     def test_chunksize_read(self):
         df = DataFrame(np.random.randn(22, 5), columns=list("abcde"))
         df.to_sql("test_chunksize", self.conn, index=False)