mtsql 1.12.27__py3-none-any.whl → 1.12.29__py3-none-any.whl

mt/sql/base.py

@@ -29,6 +29,7 @@ __all__ = [
     "temp_table_find_new_id",
     "temp_table_drop",
     "to_temp_table",
+    "find_common_ids",
 ]
 
 
@@ -97,7 +98,7 @@ def run_func(
             raise
 
 
-def conn_ctx(engine):
+def conn_ctx(engine: sa.engine.Engine):
     if isinstance(engine, sa.engine.Engine):
         return engine.begin()
     return ctx.nullcontext(engine)
@@ -456,10 +457,10 @@ def temp_table_drop(
 
     Parameters
     ----------
-    id : int or str
-        table id or table name. An id can be generated by invoking :func:`temp_table_find_new_id`.
     engine : sqlalchemy.engine.Engine
         connection engine to the server
+    id : int or str
+        table id or table name. An id can be generated by invoking :func:`temp_table_find_new_id`.
     logger : mt.logg.IndentedLoggerAdapter, optional
         logger for debugging
     """
@@ -494,3 +495,52 @@ def to_temp_table(df: pd.DataFrame, engine: sa.engine.Engine, **kwds):
         yield name
     finally:
         temp_table_drop(engine, tid)
+
+
+def find_common_ids(
+    l_ids: tp.List[int],
+    frame_name: str,
+    engine: sa.engine.Engine,
+    schema: tp.Optional[str] = None,
+    id_col: str = "id",
+    logger: tp.Optional[logg.IndentedLoggerAdapter] = None,
+) -> tp.List[int]:
+    """Finds common ids between a list of ids and the ids in a given frame.
+
+    Parameters
+    ----------
+    l_ids : list of int
+        list of ids to be checked
+    frame_name : str
+        name of the frame to be checked against
+    engine : sqlalchemy.engine.Engine
+        connection engine to the server
+    schema : str, optional
+        schema of the frame. If None, the default schema is used.
+    id_col : str
+        name of the id column in the frame
+    logger : mt.logg.IndentedLoggerAdapter, optional
+        logger for debugging
+
+    Returns
+    -------
+    list of int
+        list of common ids
+    """
+
+    with conn_ctx(engine) as conn:
+        temp_table = create_temp_id_table(l_ids, conn, logger=logger)
+
+        full_frame_name = frame_sql(frame_name, schema=schema)
+
+        sql = f"""
+        SELECT t.id FROM {temp_table} AS t
+        INNER JOIN {full_frame_name} AS f
+        ON t.id = f.{id_col};
+        """
+
+        df_common = read_sql(sql, conn, index_col=None, logger=logger)
+
+        l_commonIds = df_common["id"].tolist()
+
+    return l_commonIds

mt/sql/psql.py

@@ -36,6 +36,7 @@ __all__ = [
     "refresh_matview",
     "drop_matview",
     "frame_exists",
+    "count_estimate",
     "drop_frame",
     "list_columns_ext",
     "list_columns",
@@ -969,6 +970,39 @@ def frame_exists(
     )
 
 
+def count_estimate(
+    frame_name,
+    engine,
+    schema: tp.Optional[str] = None,
+    nb_trials: int = 3,
+    logger: tp.Optional[logg.IndentedLoggerAdapter] = None,
+):
+    """Gives an estimate of the number of rows of a frame.
+
+    Parameters
+    ----------
+    frame_name: str
+        name of table or view
+    engine: sqlalchemy.engine.Engine
+        an sqlalchemy connection engine created by function `create_engine()`
+    schema: str or None
+        a valid schema name returned from `list_schemas()`
+    nb_trials: int
+        number of query trials
+    logger: mt.logg.IndentedLoggerAdapter, optional
+        logger for debugging
+
+    Returns
+    -------
+    retval: int
+        the estimated number of rows
+    """
+    frame_sql_str = frame_sql(frame_name, schema=schema)
+    query_str = f"SELECT reltuples::bigint FROM pg_class WHERE oid = '{frame_sql_str}'::regclass;"
+    df = read_sql(query_str, engine, nb_trials=nb_trials, logger=logger)
+    return df.iloc[0]["reltuples"]
+
+
 def drop_frame(
     frame_name,
     engine,

mt/sql/version.py

@@ -1,5 +1,5 @@
 MAJOR_VERSION = 1
 MINOR_VERSION = 12
-PATCH_VERSION = 27
+PATCH_VERSION = 29
 version = '{}.{}.{}'.format(MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION)
 __all__  = ['MAJOR_VERSION', 'MINOR_VERSION', 'PATCH_VERSION', 'version']

{mtsql-1.12.27.dist-info → mtsql-1.12.29.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mtsql
-Version: 1.12.27
+Version: 1.12.29
 Summary: Extra Python modules to deal with the interaction between pandas dataframes and remote SQL servers, for Minh-Tri Pham
 Home-page: https://github.com/inteplus/mtsql
 Author: ['Minh-Tri Pham']

{mtsql-1.12.27.dist-info → mtsql-1.12.29.dist-info}/RECORD

@@ -1,17 +1,17 @@
 mt/sql/__init__.py,sha256=b7zO50apZxt9Hg2eOkJhRLrXgACR8eS5b-Rphdn5qNQ,44
-mt/sql/base.py,sha256=S44nryyeguGNnzdf5ETmKXb9ewbAveiGYhEXVoS7lC8,13732
+mt/sql/base.py,sha256=YM7BnNf1e3WizzH5Amg5xK-L5s0w9Cnl9-90htUqJlg,15096
 mt/sql/mysql.py,sha256=n2ENDctdUqZuSaDAcrqZYtPtawq3Wx4dOPCRsCB5Q4w,4894
-mt/sql/psql.py,sha256=8gWsF6ZobwkAxHsfecF95Em_cAlMitHHdQzinZLCi6s,67110
+mt/sql/psql.py,sha256=U8XEyg4rQYr5gm8KohRWrpCNJKl5WC1yxJMBkkm1k_A,68125
 mt/sql/sqlite.py,sha256=T2ak_hhNi_zRfpg_gp8JhNHn7D2kl4i-Ey6-9ANMtz0,8678
-mt/sql/version.py,sha256=ptD5KFc_hmlAgpcycy390fxiNgeYGr3X1VE_tWMpADM,208
+mt/sql/version.py,sha256=I7DJlgmw1b2vkxA_AWJYjd0FWS4W3BxvUIL3cHr587E,208
 mt/sql/redshift/__init__.py,sha256=S-eRxJWcrvncF7LZXuulCdPV-UERu9eiw6uyDb5aGsM,443
 mt/sql/redshift/commands.py,sha256=xhGUBf3bL66EYdZI5HCUtOx-XqPCnXT_P-LnhPgtzrY,40193
 mt/sql/redshift/ddl.py,sha256=eUcZj9oIajiE1wKKBAP-V64gYJ7cVnSAt8dLFfluOJA,9777
 mt/sql/redshift/dialect.py,sha256=-0JjJubZZHRw0abhl6H6rKWaUE9pKtGwAuX-62T0e_c,53399
 mt/sql/redshift/main.py,sha256=H8_5sjtJ7dzWoCMXzPNjYhrMQ18eLUQ9xg-aYl5QeTc,17104
 mt/sql/redshift/redshift-ca-bundle.crt,sha256=532qYkOpQOstFE0mdXE1GVtL3v00XDKgZNTr6gK5-KE,8621
-mtsql-1.12.27.dist-info/licenses/LICENSE,sha256=PojkRlQzTT5Eg6Nj03XoIVEefN3u8iiIFf1p4rqe_t4,1070
-mtsql-1.12.27.dist-info/METADATA,sha256=wYa5NZjKZh5uYQvItCnEUqNQKXwfNpIK61C9BJ_2TEQ,740
-mtsql-1.12.27.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mtsql-1.12.27.dist-info/top_level.txt,sha256=WcqGFu9cV7iMZg09iam8eNxUvGpLSKKF2Iubf6SJVOo,3
-mtsql-1.12.27.dist-info/RECORD,,
+mtsql-1.12.29.dist-info/licenses/LICENSE,sha256=PojkRlQzTT5Eg6Nj03XoIVEefN3u8iiIFf1p4rqe_t4,1070
+mtsql-1.12.29.dist-info/METADATA,sha256=dsOJv6kpa6gxLeky_Hsw939aE8bK3F8EMel1g4S1Xyo,740
+mtsql-1.12.29.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mtsql-1.12.29.dist-info/top_level.txt,sha256=WcqGFu9cV7iMZg09iam8eNxUvGpLSKKF2Iubf6SJVOo,3
+mtsql-1.12.29.dist-info/RECORD,,