mirror of
https://github.com/element-hq/synapse
synced 2024-08-18 22:40:51 +00:00
Better type annotations for simple_upsert_txn
most of these params don't really need to be lists.
This commit is contained in:
parent
b2dba06079
commit
0f6ebf393d
1 changed files with 43 additions and 30 deletions
|
@ -49,6 +49,7 @@ from synapse.metrics.background_process_metrics import run_as_background_process
|
|||
from synapse.storage.background_updates import BackgroundUpdater
|
||||
from synapse.storage.engines import BaseDatabaseEngine, PostgresEngine, Sqlite3Engine
|
||||
from synapse.storage.types import Connection, Cursor
|
||||
from synapse.types import Collection
|
||||
from synapse.util.stringutils import exception_to_unicode
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
@ -889,20 +890,24 @@ class Database(object):
|
|||
txn.execute(sql, list(allvalues.values()))
|
||||
|
||||
def simple_upsert_many_txn(
|
||||
self, txn, table, key_names, key_values, value_names, value_values
|
||||
):
|
||||
self,
|
||||
txn: LoggingTransaction,
|
||||
table: str,
|
||||
key_names: Collection[str],
|
||||
key_values: Collection[Iterable[Any]],
|
||||
value_names: Collection[str],
|
||||
value_values: Iterable[Iterable[str]],
|
||||
) -> None:
|
||||
"""
|
||||
Upsert, many times.
|
||||
|
||||
Args:
|
||||
table (str): The table to upsert into
|
||||
key_names (list[str]): The key column names.
|
||||
key_values (list[list]): A list of each row's key column values.
|
||||
value_names (list[str]): The value column names. If empty, no
|
||||
values will be used, even if value_values is provided.
|
||||
value_values (list[list]): A list of each row's value column values.
|
||||
Returns:
|
||||
None
|
||||
table: The table to upsert into
|
||||
key_names: The key column names.
|
||||
key_values: A list of each row's key column values.
|
||||
value_names: The value column names
|
||||
value_values: A list of each row's value column values.
|
||||
Ignored if value_names is empty.
|
||||
"""
|
||||
if self.engine.can_native_upsert and table not in self._unsafe_to_upsert_tables:
|
||||
return self.simple_upsert_many_txn_native_upsert(
|
||||
|
@ -914,20 +919,24 @@ class Database(object):
|
|||
)
|
||||
|
||||
def simple_upsert_many_txn_emulated(
|
||||
self, txn, table, key_names, key_values, value_names, value_values
|
||||
):
|
||||
self,
|
||||
txn: LoggingTransaction,
|
||||
table: str,
|
||||
key_names: Iterable[str],
|
||||
key_values: Collection[Iterable[Any]],
|
||||
value_names: Collection[str],
|
||||
value_values: Iterable[Iterable[str]],
|
||||
) -> None:
|
||||
"""
|
||||
Upsert, many times, but without native UPSERT support or batching.
|
||||
|
||||
Args:
|
||||
table (str): The table to upsert into
|
||||
key_names (list[str]): The key column names.
|
||||
key_values (list[list]): A list of each row's key column values.
|
||||
value_names (list[str]): The value column names. If empty, no
|
||||
values will be used, even if value_values is provided.
|
||||
value_values (list[list]): A list of each row's value column values.
|
||||
Returns:
|
||||
None
|
||||
table: The table to upsert into
|
||||
key_names: The key column names.
|
||||
key_values: A list of each row's key column values.
|
||||
value_names: The value column names
|
||||
value_values: A list of each row's value column values.
|
||||
Ignored if value_names is empty.
|
||||
"""
|
||||
# No value columns, therefore make a blank list so that the following
|
||||
# zip() works correctly.
|
||||
|
@ -941,20 +950,24 @@ class Database(object):
|
|||
self.simple_upsert_txn_emulated(txn, table, _keys, _vals)
|
||||
|
||||
def simple_upsert_many_txn_native_upsert(
|
||||
self, txn, table, key_names, key_values, value_names, value_values
|
||||
):
|
||||
self,
|
||||
txn: LoggingTransaction,
|
||||
table: str,
|
||||
key_names: Collection[str],
|
||||
key_values: Collection[Iterable[Any]],
|
||||
value_names: Collection[str],
|
||||
value_values: Iterable[Iterable[Any]],
|
||||
) -> None:
|
||||
"""
|
||||
Upsert, many times, using batching where possible.
|
||||
|
||||
Args:
|
||||
table (str): The table to upsert into
|
||||
key_names (list[str]): The key column names.
|
||||
key_values (list[list]): A list of each row's key column values.
|
||||
value_names (list[str]): The value column names. If empty, no
|
||||
values will be used, even if value_values is provided.
|
||||
value_values (list[list]): A list of each row's value column values.
|
||||
Returns:
|
||||
None
|
||||
table: The table to upsert into
|
||||
key_names: The key column names.
|
||||
key_values: A list of each row's key column values.
|
||||
value_names: The value column names
|
||||
value_values: A list of each row's value column values.
|
||||
Ignored if value_names is empty.
|
||||
"""
|
||||
allnames = [] # type: List[str]
|
||||
allnames.extend(key_names)
|
||||
|
|
Loading…
Reference in a new issue