kumoai 2.13.0.dev202512021731__cp310-cp310-win_amd64.whl → 2.13.0.dev202512041731__cp310-cp310-win_amd64.whl

kumoai/experimental/rfm/base/source.py

@@ -0,0 +1,18 @@
+from dataclasses import dataclass
+
+from kumoapi.typing import Dtype
+
+
+@dataclass
+class SourceColumn:
+    name: str
+    dtype: Dtype
+    is_primary_key: bool
+    is_unique_key: bool
+
+
+@dataclass
+class SourceForeignKey:
+    name: str
+    dst_table: str
+    primary_key: str

kumoai/experimental/rfm/base/table.py

@@ -1,15 +1,25 @@
 from abc import ABC, abstractmethod
-from typing import Dict, List, Optional, Sequence, Tuple
+from collections import defaultdict
+from functools import cached_property
+from typing import Dict, List, Optional, Sequence, Set
 
 import pandas as pd
 from kumoapi.source_table import UnavailableSourceTable
 from kumoapi.table import Column as ColumnDefinition
 from kumoapi.table import TableDefinition
-from kumoapi.typing import Dtype, Stype
+from kumoapi.typing import Stype
 from typing_extensions import Self
 
-from kumoai import in_notebook
-from kumoai.experimental.rfm.base import Column
+from kumoai import in_notebook, in_snowflake_notebook
+from kumoai.experimental.rfm.base import Column, SourceColumn, SourceForeignKey
+from kumoai.experimental.rfm.infer import (
+    contains_categorical,
+    contains_id,
+    contains_multicategorical,
+    contains_timestamp,
+    infer_primary_key,
+    infer_time_column,
+)
 
 
 class Table(ABC):
@@ -39,8 +49,30 @@ class Table(ABC):
         self._time_column: Optional[str] = None
         self._end_time_column: Optional[str] = None
 
+        if len(self._source_column_dict) == 0:
+            raise ValueError(f"Table '{name}' does not hold any column with "
+                             f"a supported data type")
+
+        primary_keys = [
+            column.name for column in self._source_column_dict.values()
+            if column.is_primary_key
+        ]
+        if len(primary_keys) == 1:  # NOTE No composite keys yet.
+            if primary_key is not None and primary_key != primary_keys[0]:
+                raise ValueError(f"Found duplicate primary key "
+                                 f"definition '{primary_key}' and "
+                                 f"'{primary_keys[0]}' in table '{name}'")
+            primary_key = primary_keys[0]
+
+        unique_keys = [
+            column.name for column in self._source_column_dict.values()
+            if column.is_unique_key
+        ]
+        if primary_key is None and len(unique_keys) == 1:
+            primary_key = unique_keys[0]
+
         self._columns: Dict[str, Column] = {}
-        for column_name in columns or []:
+        for column_name in columns or list(self._source_column_dict.keys()):
             self.add_column(column_name)
 
         if primary_key is not None:
@@ -104,12 +136,12 @@ class Table(ABC):
             raise KeyError(f"Column '{name}' already exists in table "
                            f"'{self.name}'")
 
-        if not self._has_source_column(name):
+        if name not in self._source_column_dict:
             raise KeyError(f"Column '{name}' does not exist in the underlying "
                            f"source table")
 
         try:
-            dtype = self._get_source_dtype(name)
+            dtype = self._source_column_dict[name].dtype
         except Exception as e:
             raise RuntimeError(f"Could not obtain data type for column "
                                f"'{name}' in table '{self.name}'. Change "
@@ -117,7 +149,17 @@ class Table(ABC):
                                f"table or remove it from the table.") from e
 
         try:
-            stype = self._get_source_stype(name, dtype)
+            ser = self._sample_df[name]
+            if contains_id(ser, name, dtype):
+                stype = Stype.ID
+            elif contains_timestamp(ser, name, dtype):
+                stype = Stype.timestamp
+            elif contains_multicategorical(ser, name, dtype):
+                stype = Stype.multicategorical
+            elif contains_categorical(ser, name, dtype):
+                stype = Stype.categorical
+            else:
+                stype = dtype.default_stype
         except Exception as e:
             raise RuntimeError(f"Could not obtain semantic type for column "
                                f"'{name}' in table '{self.name}'. Change "
@@ -338,10 +380,16 @@ class Table(ABC):
 
     def print_metadata(self) -> None:
         r"""Prints the :meth:`~metadata` of this table."""
-        num_rows = self._num_rows()
-        num_rows_repr = ' ({num_rows:,} rows)' if num_rows is not None else ''
+        num_rows_repr = ''
+        if self._num_rows is not None:
+            num_rows_repr = ' ({self._num_rows:,} rows)'
 
-        if in_notebook():
+        if in_snowflake_notebook():
+            import streamlit as st
+            md_repr = f"### 🏷️ Metadata of Table `{self.name}`{num_rows_repr}"
+            st.markdown(md_repr)
+            st.dataframe(self.metadata, hide_index=True)
+        elif in_notebook():
             from IPython.display import Markdown, display
             md_repr = f"### 🏷️ Metadata of Table `{self.name}`{num_rows_repr}"
             display(Markdown(md_repr))
@@ -384,7 +432,11 @@ class Table(ABC):
                 column.name for column in self.columns if is_candidate(column)
             ]
 
-            if primary_key := self._infer_primary_key(candidates):
+            if primary_key := infer_primary_key(
+                    table_name=self.name,
+                    df=self._sample_df,
+                    candidates=candidates,
+            ):
                 self.primary_key = primary_key
                 logs.append(f"primary key '{primary_key}'")
 
@@ -395,7 +447,10 @@ class Table(ABC):
                 if column.stype == Stype.timestamp
                 and column.name != self._end_time_column
             ]
-            if time_column := self._infer_time_column(candidates):
+            if time_column := infer_time_column(
+                    df=self._sample_df,
+                    candidates=candidates,
+            ):
                 self.time_column = time_column
                 logs.append(f"time column '{time_column}'")
 
@@ -446,32 +501,45 @@ class Table(ABC):
                 f'  end_time_column={self._end_time_column},\n'
                 f')')
 
-    # Abstract method #########################################################
+    # Abstract Methods ########################################################
 
-    @abstractmethod
-    def _has_source_column(self, name: str) -> bool:
-        pass
+    @cached_property
+    def _source_column_dict(self) -> Dict[str, SourceColumn]:
+        return {col.name: col for col in self._get_source_columns()}
 
     @abstractmethod
-    def _get_source_dtype(self, name: str) -> Dtype:
+    def _get_source_columns(self) -> List[SourceColumn]:
         pass
 
-    @abstractmethod
-    def _get_source_stype(self, name: str, dtype: Dtype) -> Stype:
-        pass
+    @cached_property
+    def _source_foreign_key_dict(self) -> Dict[str, SourceForeignKey]:
+        fkeys = self._get_source_foreign_keys()
+        # NOTE Drop all keys that link to different primary keys in the same
+        # table since we don't support composite keys yet:
+        table_pkeys: Dict[str, Set[str]] = defaultdict(set)
+        for fkey in fkeys:
+            table_pkeys[fkey.dst_table].add(fkey.primary_key)
+        return {
+            fkey.name: fkey
+            for fkey in fkeys if len(table_pkeys[fkey.dst_table]) == 1
+        }
 
     @abstractmethod
-    def _get_source_foreign_keys(self) -> List[Tuple[str, str, str]]:
+    def _get_source_foreign_keys(self) -> List[SourceForeignKey]:
         pass
 
-    @abstractmethod
-    def _infer_primary_key(self, candidates: List[str]) -> Optional[str]:
-        pass
+    @cached_property
+    def _sample_df(self) -> pd.DataFrame:
+        return self._get_sample_df()
 
     @abstractmethod
-    def _infer_time_column(self, candidates: List[str]) -> Optional[str]:
+    def _get_sample_df(self) -> pd.DataFrame:
         pass
 
-    @abstractmethod
+    @cached_property
     def _num_rows(self) -> Optional[int]:
+        return self._get_num_rows()
+
+    @abstractmethod
+    def _get_num_rows(self) -> Optional[int]:
         pass

kumoai/experimental/rfm/graph.py

@@ -2,7 +2,8 @@ import contextlib
 import io
 import warnings
 from collections import defaultdict
-from importlib.util import find_spec
+from dataclasses import dataclass, field
+from pathlib import Path
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Sequence, Union
 
 import pandas as pd
@@ -11,12 +12,21 @@ from kumoapi.table import TableDefinition
 from kumoapi.typing import Stype
 from typing_extensions import Self
 
-from kumoai import in_notebook
+from kumoai import in_notebook, in_snowflake_notebook
 from kumoai.experimental.rfm import Table
 from kumoai.graph import Edge
+from kumoai.mixin import CastMixin
 
 if TYPE_CHECKING:
     import graphviz
+    from adbc_driver_sqlite.dbapi import AdbcSqliteConnection
+    from snowflake.connector import SnowflakeConnection
+
+
+@dataclass
+class SqliteConnectionConfig(CastMixin):
+    uri: Union[str, Path]
+    kwargs: Dict[str, Any] = field(default_factory=dict)
 
 
 class Graph:
@@ -86,14 +96,17 @@ class Graph:
             self.add_table(table)
 
         for table in tables:
-            for fkey, dst_table, pkey in table._get_source_foreign_keys():
-                if self[dst_table].primary_key is None:
-                    self[dst_table].primary_key = pkey
-                elif self[dst_table]._primary_key != pkey:
+            for fkey in table._source_foreign_key_dict.values():
+                if fkey.name not in table or fkey.dst_table not in self:
+                    continue
+                if self[fkey.dst_table].primary_key is None:
+                    self[fkey.dst_table].primary_key = fkey.primary_key
+                elif self[fkey.dst_table]._primary_key != fkey.primary_key:
                     raise ValueError(f"Found duplicate primary key definition "
-                                     f"'{self[dst_table]._primary_key}' and "
-                                     f"'{pkey}' in table '{dst_table}'.")
-                self.link(table.name, fkey, dst_table)
+                                     f"'{self[fkey.dst_table]._primary_key}' "
+                                     f"and '{fkey.primary_key}' in table "
+                                     f"'{fkey.dst_table}'.")
+                self.link(table.name, fkey.name, fkey.dst_table)
 
         for edge in (edges or []):
             _edge = Edge._cast(edge)
@@ -132,13 +145,6 @@ class Graph:
             ...     "table3": df3,
             ... })
 
-            >>> # Inspect table metadata:
-            >>> for table in graph.tables.values():
-            ...     table.print_metadata()
-
-            >>> # Visualize graph (if graphviz is installed):
-            >>> graph.visualize()
-
         Args:
             df_dict: A dictionary of data frames, where the keys are the names
                 of the tables and the values hold table data.
@@ -169,12 +175,17 @@ class Graph:
     @classmethod
     def from_sqlite(
         cls,
-        uri: Any,
+        connection: Union[
+            'AdbcSqliteConnection',
+            SqliteConnectionConfig,
+            str,
+            Path,
+            Dict[str, Any],
+        ],
         table_names: Optional[Sequence[str]] = None,
         edges: Optional[Sequence[Edge]] = None,
         infer_metadata: bool = True,
         verbose: bool = True,
-        conn_kwargs: Optional[Dict[str, Any]] = None,
     ) -> Self:
         r"""Creates a :class:`Graph` from a :class:`sqlite` database.
 
@@ -188,16 +199,10 @@ class Graph:
             >>> # Create a graph from a SQLite database:
             >>> graph = rfm.Graph.from_sqlite('data.db')
 
-            >>> # Inspect table metadata:
-            >>> for table in graph.tables.values():
-            ...     table.print_metadata()
-
-            >>> # Visualize graph (if graphviz is installed):
-            >>> graph.visualize()
-
         Args:
-            uri: The path to the database file or an open connection obtained
-                from :meth:`~kumoai.experimental.rfm.backend.sqlite.connect`.
+            connection: An open connection from
+                :meth:`~kumoai.experimental.rfm.backend.sqlite.connect` or the
+                path to the database file.
             table_names: Set of table names to include. If ``None``, will add
                 all tables present in the database.
             edges: An optional list of :class:`~kumoai.graph.Edge` objects to
@@ -206,8 +211,6 @@ class Graph:
             infer_metadata: Whether to infer metadata for all tables in the
                 graph.
             verbose: Whether to print verbose output.
-            conn_kwargs: Additional connection arguments, following the
-                :class:`adbc_driver_sqlite` protocol.
         """
         from kumoai.experimental.rfm.backend.sqlite import (
             Connection,
@@ -215,10 +218,11 @@ class Graph:
             connect,
         )
 
-        if not isinstance(uri, Connection):
-            connection = connect(uri, **(conn_kwargs or {}))
-        else:
-            connection = uri
+        if not isinstance(connection, Connection):
+            connection = SqliteConnectionConfig._cast(connection)
+            assert isinstance(connection, SqliteConnectionConfig)
+            connection = connect(connection.uri, **connection.kwargs)
+        assert isinstance(connection, Connection)
 
         if table_names is None:
             with connection.cursor() as cursor:
@@ -242,6 +246,154 @@ class Graph:
 
         return graph
 
+    @classmethod
+    def from_snowflake(
+        cls,
+        connection: Union['SnowflakeConnection', Dict[str, Any], None] = None,
+        database: Optional[str] = None,
+        schema: Optional[str] = None,
+        table_names: Optional[Sequence[str]] = None,
+        edges: Optional[Sequence[Edge]] = None,
+        infer_metadata: bool = True,
+        verbose: bool = True,
+    ) -> Self:
+        r"""Creates a :class:`Graph` from a :class:`snowflake` database and
+        schema.
+
+        Automatically infers table metadata and links by default.
+
+        .. code-block:: python
+
+            >>> # doctest: +SKIP
+            >>> import kumoai.experimental.rfm as rfm
+
+            >>> # Create a graph directly in a Snowflake notebook:
+            >>> graph = rfm.Graph.from_snowflake(schema='my_schema')
+
+        Args:
+            connection: An open connection from
+                :meth:`~kumoai.experimental.rfm.backend.snow.connect` or the
+                :class:`snowflake` connector keyword arguments to open a new
+                connection. If ``None``, will re-use an active session in case
+                it exists, or create a new connection from credentials stored
+                in environment variables.
+            database: The database.
+            schema: The schema.
+            table_names: Set of table names to include. If ``None``, will add
+                all tables present in the database.
+            edges: An optional list of :class:`~kumoai.graph.Edge` objects to
+                add to the graph. If not provided, edges will be automatically
+                inferred from the data in case ``infer_metadata=True``.
+            infer_metadata: Whether to infer metadata for all tables in the
+                graph.
+            verbose: Whether to print verbose output.
+        """
+        from kumoai.experimental.rfm.backend.snow import (
+            Connection,
+            SnowTable,
+            connect,
+        )
+
+        if not isinstance(connection, Connection):
+            connection = connect(**(connection or {}))
+        assert isinstance(connection, Connection)
+
+        if table_names is None:
+            with connection.cursor() as cursor:
+                if database is None and schema is None:
+                    cursor.execute("SELECT CURRENT_DATABASE(), "
+                                   "CURRENT_SCHEMA()")
+                    result = cursor.fetchone()
+                    database = database or result[0]
+                    schema = schema or result[1]
+                cursor.execute(f"""
+                SELECT TABLE_NAME
+                FROM {database}.INFORMATION_SCHEMA.TABLES
+                WHERE TABLE_SCHEMA = '{schema}'
+                """)
+                table_names = [row[0] for row in cursor.fetchall()]
+
+        tables = [
+            SnowTable(
+                connection,
+                name=table_name,
+                database=database,
+                schema=schema,
+            ) for table_name in table_names
+        ]
+
+        graph = cls(tables, edges=edges or [])
+
+        if infer_metadata:
+            graph.infer_metadata(False)
+
+            if edges is None:
+                graph.infer_links(False)
+
+        if verbose:
+            graph.print_metadata()
+            graph.print_links()
+
+        return graph
+
+    @classmethod
+    def from_snowflake_semantic_view(
+        cls,
+        semantic_view_name: str,
+        connection: Union['SnowflakeConnection', Dict[str, Any], None] = None,
+        verbose: bool = True,
+    ) -> Self:
+        import yaml
+
+        from kumoai.experimental.rfm.backend.snow import (
+            Connection,
+            SnowTable,
+            connect,
+        )
+
+        if not isinstance(connection, Connection):
+            connection = connect(**(connection or {}))
+        assert isinstance(connection, Connection)
+
+        with connection.cursor() as cursor:
+            cursor.execute(f"SELECT SYSTEM$READ_YAML_FROM_SEMANTIC_VIEW("
+                           f"'{semantic_view_name}')")
+            view = yaml.safe_load(cursor.fetchone()[0])
+
+        graph = cls(tables=[])
+
+        for table_desc in view['tables']:
+            primary_key: Optional[str] = None
+            if ('primary_key' in table_desc  # NOTE No composite keys yet.
+                    and len(table_desc['primary_key']['columns']) == 1):
+                primary_key = table_desc['primary_key']['columns'][0]
+
+            table = SnowTable(
+                connection,
+                name=table_desc['base_table']['table'],
+                database=table_desc['base_table']['database'],
+                schema=table_desc['base_table']['schema'],
+                primary_key=primary_key,
+            )
+            graph.add_table(table)
+
+        # TODO Find a solution to register time columns!
+
+        for relations in view['relationships']:
+            if len(relations['relationship_columns']) != 1:
+                continue  # NOTE No composite keys yet.
+            graph.link(
+                src_table=relations['left_table'],
+                fkey=relations['relationship_columns'][0]['left_column'],
+                dst_table=relations['right_table'],
+            )
+
+        if verbose:
+            graph.print_metadata()
+            graph.print_links()
+
+        return graph
+
     # Tables ##############################################################
 
     def has_table(self, name: str) -> bool:
@@ -349,9 +501,13 @@ class Graph:
 
     def print_metadata(self) -> None:
         r"""Prints the :meth:`~Graph.metadata` of the graph."""
-        if in_notebook():
+        if in_snowflake_notebook():
+            import streamlit as st
+            st.markdown("### 🗂️ Graph Metadata")
+            st.dataframe(self.metadata, hide_index=True)
+        elif in_notebook():
             from IPython.display import Markdown, display
-            display(Markdown('### 🗂️ Graph Metadata'))
+            display(Markdown("### 🗂️ Graph Metadata"))
             df = self.metadata
             try:
                 if hasattr(df.style, 'hide'):
@@ -395,26 +551,36 @@ class Graph:
                   edge.src_table, edge.fkey) for edge in self.edges]
         edges = sorted(edges)
 
-        if in_notebook():
+        if in_snowflake_notebook():
+            import streamlit as st
+            st.markdown("### 🕸️ Graph Links (FK ↔️ PK)")
+            if len(edges) > 0:
+                st.markdown('\n'.join([
+                    f"- `{edge[2]}.{edge[3]}` ↔️ `{edge[0]}.{edge[1]}`"
+                    for edge in edges
+                ]))
+            else:
+                st.markdown("*No links registered*")
+        elif in_notebook():
             from IPython.display import Markdown, display
-            display(Markdown('### 🕸️ Graph Links (FK ↔️ PK)'))
+            display(Markdown("### 🕸️ Graph Links (FK ↔️ PK)"))
             if len(edges) > 0:
                 display(
                     Markdown('\n'.join([
-                        f'- `{edge[2]}.{edge[3]}` ↔️ `{edge[0]}.{edge[1]}`'
+                        f"- `{edge[2]}.{edge[3]}` ↔️ `{edge[0]}.{edge[1]}`"
                         for edge in edges
                     ])))
             else:
-                display(Markdown('*No links registered*'))
+                display(Markdown("*No links registered*"))
         else:
             print("🕸️ Graph Links (FK ↔️ PK):")
             if len(edges) > 0:
                 print('\n'.join([
-                    f'• {edge[2]}.{edge[3]} ↔️ {edge[0]}.{edge[1]}'
+                    f"• {edge[2]}.{edge[3]} ↔️ {edge[0]}.{edge[1]}"
                     for edge in edges
                 ]))
             else:
-                print('No links registered')
+                print("No links registered")
 
     def link(
         self,
@@ -612,10 +778,9 @@ class Graph:
                         score += 1.0
 
                     # Cardinality ratio:
-                    src_num_rows = src_table._num_rows()
-                    dst_num_rows = dst_table._num_rows()
-                    if (src_num_rows is not None and dst_num_rows is not None
-                            and src_num_rows > dst_num_rows):
+                    if (src_table._num_rows is not None
+                            and dst_table._num_rows is not None
+                            and src_table._num_rows > dst_table._num_rows):
                         score += 1.0
 
                     if score < 5.0:
@@ -732,19 +897,19 @@ class Graph:
 
             return True
 
-        # Check basic dependency:
-        if not find_spec('graphviz'):
-            raise ModuleNotFoundError("The 'graphviz' package is required for "
-                                      "visualization")
-        elif not has_graphviz_executables():
+        try:  # Check basic dependency:
+            import graphviz
+        except ImportError as e:
+            raise ImportError("The 'graphviz' package is required for "
+                              "visualization") from e
+
+        if not in_snowflake_notebook() and not has_graphviz_executables():
             raise RuntimeError("Could not visualize graph as 'graphviz' "
                                "executables are not installed. These "
                                "dependencies are required in addition to the "
                                "'graphviz' Python package. Please install "
                                "them as described at "
                                "https://graphviz.org/download/.")
-        else:
-            import graphviz
 
         format: Optional[str] = None
         if isinstance(path, str):
@@ -828,6 +993,9 @@ class Graph:
             graph.render(path, cleanup=True)
         elif isinstance(path, io.BytesIO):
             path.write(graph.pipe())
+        elif in_snowflake_notebook():
+            import streamlit as st
+            st.graphviz_chart(graph)
         elif in_notebook():
             from IPython.display import display
             display(graph)

kumoai/experimental/rfm/infer/__init__.py

@@ -1,13 +1,17 @@
+from .dtype import infer_dtype
+from .pkey import infer_primary_key
+from .time_col import infer_time_column
 from .id import contains_id
 from .timestamp import contains_timestamp
 from .categorical import contains_categorical
 from .multicategorical import contains_multicategorical
-from .stype import infer_stype
 
 __all__ = [
+    'infer_dtype',
+    'infer_primary_key',
+    'infer_time_column',
     'contains_id',
     'contains_timestamp',
     'contains_categorical',
     'contains_multicategorical',
-    'infer_stype',
 ]