Make table_info available as top-level import

BritishGeologicalSurvey · May 22, 2022 · 2e93885 · 2e93885
1 parent 263ce43
commit 2e93885
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/etlhelper/__init__.py b/etlhelper/__init__.py
@@ -26,6 +26,9 @@
     get_connection_string,
     get_sqlalchemy_connection_string,
 )
+from etlhelper.utils import (
+    table_info,
+)
 
 from . import _version
 __version__ = _version.get_versions()['version']

diff --git a/etlhelper/utils.py b/etlhelper/utils.py
@@ -12,11 +12,12 @@
 
 def table_info(table, conn, schema=None):
     """
-    Describe the name and data type for columns in a table.
+    Return basic metadata for each of the columns of 'table' on 'conn'.
 
     :param table: str, the table to describe
     :param conn: dbapi connection
     :param schema: str, optional name of schema for table
+    :returns columns: list, tuples of (name, type, not_null, has_default)
     """
     helper = DB_HELPER_FACTORY.from_conn(conn)