Rename ClickhouseAPI -> ClickhouseServerAPI

README.md

@@ -42,13 +42,13 @@ Nevertheless if you depend on this package it is recommended to pin a version to
 
 ### Clickhouse server
 
-Import `ClickhouseAPI`, which accepts a `clickhouse_connect` client, configured with attributes relevant for your connection:
+Import `ClickhouseServerAPI`, which accepts a `clickhouse_connect` client, configured with attributes relevant for your connection:
 ```python
 import clickhouse_connect
 import splink.comparison_library as cl
 from splink import Linker, SettingsCreator, block_on, splink_datasets
 
-from splinkclickhouse import ClickhouseAPI
+from splinkclickhouse import ClickhouseServerAPI
 
 df = splink_datasets.fake_1000
 
@@ -68,7 +68,7 @@ client = clickhouse_connect.get_client(
     database=db_name,
 )
 
-db_api = ClickhouseAPI(client)
+db_api = ClickhouseServerAPI(client)
 
 # can have at most one tf-adjusted comparison, see caveats below
 settings = SettingsCreator(
@@ -238,8 +238,8 @@ import splink.comparison_level as cl
 first_name_comparison = cl.DamerauLevenshteinAtThresholds("NULLIF(first_name, '')")
 ```
 
-### `ClickhouseAPI` pandas registration
+### `ClickhouseServerAPI` pandas registration
 
-`ClickhouseAPI` will allow registration of pandas dataframes, by inferring the types of columns. It currently only does this for string, integer, and float columns, and will always make them `Nullable`.
+`ClickhouseServerAPI` will allow registration of pandas dataframes, by inferring the types of columns. It currently only does this for string, integer, and float columns, and will always make them `Nullable`.
 
 If you require other data types, or more fine-grained control, it is recommended to import the data into Clickhouse yourself, and then pass the table name (as a string) to the `Linker` instead.

benchmarking/benchmark.py

@@ -11,7 +11,7 @@
 )
 from utils.timer import MultiTimer, Timer
 
-from splinkclickhouse import ChDBAPI, ClickhouseAPI
+from splinkclickhouse import ChDBAPI, ClickhouseServerAPI
 
 # settings for something fake_1000-shaped
 config_fake_1000 = {
@@ -101,7 +101,7 @@ def timed_full_run(data: str, config: dict, backend_to_use: str) -> Timer:
             username="splinkognito",
             password="splink123!",
         )
-        db_api = ClickhouseAPI(client)
+        db_api = ClickhouseServerAPI(client)
     elif backend_to_use == "duckdb":
         db_api = DuckDBAPI()
     else:

dev.md

@@ -21,7 +21,7 @@ uv run python scripts/getting_started_chdb.py
 Import the relevant api:
 
 ```python
-from splinkclickhouse import ClickhouseAPI
+from splinkclickhouse import ClickhouseServerAPI
 ```
 
 You can run a local instance in docker with provided docker-compose file:

scripts/getting_started_clickhouse.py

@@ -2,7 +2,7 @@
 import splink.comparison_library as cl
 from splink import Linker, SettingsCreator, block_on, splink_datasets
 
-from splinkclickhouse import ClickhouseAPI
+from splinkclickhouse import ClickhouseServerAPI
 
 df = splink_datasets.fake_1000
 
@@ -22,7 +22,7 @@
     database=db_name,
 )
 
-db_api = ClickhouseAPI(client)
+db_api = ClickhouseServerAPI(client)
 
 settings = SettingsCreator(
     link_type="dedupe_only",

splinkclickhouse/__init__.py

@@ -1,6 +1,6 @@
 from typing import Any
 
-from .clickhouse.database_api import ClickhouseAPI
+from .clickhouse.database_api import ClickhouseServerAPI
 
 __version__ = "0.3.4"
 
@@ -22,4 +22,4 @@ def __getattr__(name: str) -> Any:
     raise ImportError(f"cannot import name '{name}' from splinkclickhouse") from None
 
 
-__all__ = ["ChDBAPI", "ClickhouseAPI"]
+__all__ = ["ChDBAPI", "ClickhouseServerAPI"]

splinkclickhouse/clickhouse/database_api.py

@@ -11,7 +11,7 @@
 logger = logging.getLogger(__name__)
 
 
-class ClickhouseAPI(DatabaseAPI[None]):
+class ClickhouseServerAPI(DatabaseAPI[None]):
     sql_dialect = ClickhouseDialect()
 
     def __init__(
@@ -41,7 +41,7 @@ def _table_registration(self, input, table_name) -> None:
             self.client.query(sql)
         else:
             raise TypeError(
-                "ClickhouseAPI currently only accepts table names (str) "
+                "ClickhouseServerAPI currently only accepts table names (str) "
                 "or pandas DataFrames as inputs for table registration. "
                 f"Received type {type(input)}"
             )

splinkclickhouse/clickhouse/dataframe.py

@@ -8,11 +8,11 @@
 
 logger = logging.getLogger(__name__)
 if TYPE_CHECKING:
-    from .database_api import ClickhouseAPI
+    from .database_api import ClickhouseServerAPI
 
 
 class ClickhouseDataFrame(SplinkDataFrame):
-    db_api: ClickhouseAPI
+    db_api: ClickhouseServerAPI
 
     def __init__(self, df_name, physical_name, db_api):
         super().__init__(df_name, physical_name, db_api)

tests/conftest.py

@@ -6,7 +6,7 @@
 from pytest import fixture, mark, param
 from splink import ColumnExpression, SettingsCreator, block_on, splink_datasets
 
-from splinkclickhouse import ChDBAPI, ClickhouseAPI
+from splinkclickhouse import ChDBAPI, ClickhouseServerAPI
 
 df = splink_datasets.fake_1000
 
@@ -73,7 +73,7 @@ def clickhouse_api_factory():
             database=db_name,
         )
 
-        yield lambda: ClickhouseAPI(client)
+        yield lambda: ClickhouseServerAPI(client)
         client.close()
         default_client.command(f"DROP DATABASE {db_name}")
         default_client.close()