refactor(api)!: align signatures of insert method; name is positional-only; obj is positional-or-keyword; the rest are keyword-only

Author: cpcloud

ibis/backends/bigquery/__init__.py

@@ -718,38 +718,35 @@ def compile(
 
     def insert(
         self,
-        table_name: str,
+        name: str,
+        /,
         obj: pd.DataFrame | ir.Table | list | dict,
+        *,
         database: str | None = None,
         overwrite: bool = False,
-    ):
+    ) -> None:
         """Insert data into a table.
 
         Parameters
         ----------
-        table_name
-            The name of the table to which data needs will be inserted
+        name
+            The name of the table to which data needs will be inserted.
         obj
-            The source data or expression to insert
+            The source data or expression to insert.
         database
             Name of the attached database that the table is located in.
         overwrite
-            If `True` then replace existing contents of table
-
+            If `True` then replace existing contents of table.
         """
         table_loc = self._to_sqlglot_table(database)
         catalog, db = self._to_catalog_db_tuple(table_loc)
+
         if catalog is None:
             catalog = self.current_catalog
         if db is None:
             db = self.current_database
 
-        return super().insert(
-            table_name,
-            obj,
-            database=(catalog, db),
-            overwrite=overwrite,
-        )
+        return super().insert(name, obj, database=(catalog, db), overwrite=overwrite)
 
     def _to_query(
         self,

ibis/backends/clickhouse/__init__.py

@@ -442,7 +442,9 @@ def execute(
     def insert(
         self,
         name: str,
+        /,
         obj: pd.DataFrame | ir.Table,
+        *,
         settings: Mapping[str, Any] | None = None,
         overwrite: bool = False,
         database: str | None = None,

ibis/backends/flink/__init__.py

@@ -904,8 +904,10 @@ def read_json(
 
     def insert(
         self,
-        table_name: str,
+        name: str,
+        /,
         obj: pa.Table | pd.DataFrame | ir.Table | list | dict,
+        *,
         database: str | None = None,
         catalog: str | None = None,
         overwrite: bool = False,
@@ -914,7 +916,7 @@ def insert(
 
         Parameters
         ----------
-        table_name
+        name
             The name of the table to insert data into.
         obj
             The source data or expression to insert.
@@ -942,7 +944,7 @@ def insert(
 
         if isinstance(obj, ir.Table):
             statement = InsertSelect(
-                table_name,
+                name,
                 self.compile(obj),
                 database=database,
                 catalog=catalog,
@@ -951,7 +953,7 @@ def insert(
             return self.raw_sql(statement.compile())
 
         identifier = sg.table(
-            table_name, db=database, catalog=catalog, quoted=self.compiler.quoted
+            name, db=database, catalog=catalog, quoted=self.compiler.quoted
         ).sql(self.dialect)
 
         if isinstance(obj, pa.Table):

ibis/backends/impala/__init__.py

@@ -720,8 +720,10 @@ def _wrap_new_table(self, name, database):
 
     def insert(
         self,
-        table_name,
+        name,
+        /,
         obj=None,
+        *,
         database=None,
         overwrite=False,
         partition=None,
@@ -731,7 +733,7 @@ def insert(
 
         Parameters
         ----------
-        table_name
+        name
             The table name
         obj
             Table expression or DataFrame
@@ -763,7 +765,7 @@ def insert(
         if isinstance(obj, ir.Table):
             self._run_pre_execute_hooks(obj)
 
-        table = self.table(table_name, database=database)
+        table = self.table(name, database=database)
 
         if not isinstance(obj, ir.Table):
             obj = ibis.memtable(obj)
@@ -782,14 +784,14 @@ def insert(
                 if set(insert_schema.names) != set(existing_schema.names):
                     raise com.IbisInputError("Schemas have different names")
 
-                for name in insert_schema:
-                    lt = insert_schema[name]
-                    rt = existing_schema[name]
+                for insert_name in insert_schema:
+                    lt = insert_schema[insert_name]
+                    rt = existing_schema[insert_name]
                     if not lt.castable(rt):
                         raise com.IbisInputError(f"Cannot safely cast {lt!r} to {rt!r}")
 
         if partition is not None:
-            partition_schema = self.get_partition_schema(table_name, database=database)
+            partition_schema = self.get_partition_schema(name, database=database)
             partition_schema_names = frozenset(partition_schema.names)
             obj = obj.select(
                 [
@@ -802,7 +804,7 @@ def insert(
             partition_schema = None
 
         statement = ddl.InsertSelect(
-            self._fully_qualified_name(table_name, database),
+            self._fully_qualified_name(name, database),
             self.compile(obj),
             partition=partition,
             partition_schema=partition_schema,

ibis/backends/snowflake/__init__.py

@@ -1155,8 +1155,10 @@ def read_parquet(
 
     def insert(
         self,
-        table_name: str,
+        name: str,
+        /,
         obj: pd.DataFrame | ir.Table | list | dict,
+        *,
         database: str | None = None,
         overwrite: bool = False,
     ) -> None:
@@ -1173,7 +1175,7 @@ def insert(
 
         Parameters
         ----------
-        table_name
+        name
             The name of the table to which data needs will be inserted
         obj
             The source data or expression to insert
@@ -1185,7 +1187,6 @@ def insert(
             `("catalog", "database")`.
         overwrite
             If `True` then replace existing contents of table
-
         """
         table_loc = self._to_sqlglot_table(database)
         catalog, db = self._to_catalog_db_tuple(table_loc)
@@ -1196,16 +1197,15 @@ def insert(
         self._run_pre_execute_hooks(obj)
 
         query = self._build_insert_from_table(
-            target=table_name, source=obj, db=db, catalog=catalog
-        )
-        table = sg.table(
-            table_name, db=db, catalog=catalog, quoted=self.compiler.quoted
+            target=name, source=obj, db=db, catalog=catalog
         )
+        table = sg.table(name, db=db, catalog=catalog, quoted=self.compiler.quoted)
 
+        dialect = self.dialect
         statements = []
         if overwrite:
-            statements.append(f"TRUNCATE TABLE {table.sql(self.name)}")
-        statements.append(query.sql(self.name))
+            statements.append(f"TRUNCATE TABLE {table.sql(dialect)}")
+        statements.append(query.sql(dialect))
 
         statement = ";".join(statements)
         with self._safe_raw_sql(statement):

ibis/backends/sql/__init__.py

@@ -328,8 +328,10 @@ def to_pyarrow_batches(
 
     def insert(
         self,
-        table_name: str,
+        name: str,
+        /,
         obj: pd.DataFrame | ir.Table | list | dict,
+        *,
         database: str | None = None,
         overwrite: bool = False,
     ) -> None:
@@ -348,7 +350,7 @@ def insert(
 
         Parameters
         ----------
-        table_name
+        name
             The name of the table to which data needs will be inserted
         obj
             The source data or expression to insert
@@ -360,21 +362,20 @@ def insert(
             strings like `("catalog", "database")`.
         overwrite
             If `True` then replace existing contents of table
-
         """
         table_loc = self._to_sqlglot_table(database)
         catalog, db = self._to_catalog_db_tuple(table_loc)
 
         if overwrite:
-            self.truncate_table(table_name, database=(catalog, db))
+            self.truncate_table(name, database=(catalog, db))
 
         if not isinstance(obj, ir.Table):
             obj = ibis.memtable(obj)
 
         self._run_pre_execute_hooks(obj)
 
         query = self._build_insert_from_table(
-            target=table_name, source=obj, db=db, catalog=catalog
+            target=name, source=obj, db=db, catalog=catalog
         )
 
         with self._safe_raw_sql(query):

ibis/backends/sqlite/__init__.py

@@ -572,16 +572,18 @@ def create_view(
 
     def insert(
         self,
-        table_name: str,
+        name: str,
+        /,
         obj: pd.DataFrame | ir.Table | list | dict,
+        *,
         database: str | None = None,
         overwrite: bool = False,
     ) -> None:
         """Insert data into a table.
 
         Parameters
         ----------
-        table_name
+        name
             The name of the table to which data needs will be inserted
         obj
             The source data or expression to insert
@@ -596,20 +598,18 @@ def insert(
             If inserting data from a different database
         ValueError
             If the type of `obj` isn't supported
-
         """
-        table = sg.table(table_name, catalog=database, quoted=self.compiler.quoted)
+        table = sg.table(name, catalog=database, quoted=self.compiler.quoted)
         if not isinstance(obj, ir.Expr):
             obj = ibis.memtable(obj)
 
         self._run_pre_execute_hooks(obj)
 
-        query = self._build_insert_from_table(
-            target=table_name, source=obj, catalog=database
-        )
-        insert_stmt = query.sql(self.name)
+        dialect = self.dialect
+        query = self._build_insert_from_table(target=name, source=obj, catalog=database)
+        insert_stmt = query.sql(dialect)
 
         with self.begin() as cur:
             if overwrite:
-                cur.execute(sge.Delete(this=table).sql(self.dialect))
+                cur.execute(sge.Delete(this=table).sql(dialect))
             cur.execute(insert_stmt)