Documentation forblock_on
ΒΆ
Generates blocking rules of equality conditions based on the columns or SQL expressions specified.
When multiple columns or SQL snippets are provided, the function generates a compound blocking rule, connecting individual match conditions with "AND" clauses.
Further information on equi-join conditions can be found here
Parameters:
Name | Type | Description | Default |
---|---|---|---|
col_names_or_exprs |
Union[str, ColumnExpression]
|
A list of input columns or SQL conditions you wish to create blocks on. |
()
|
salting_partitions |
(optional, int)
|
Whether to add salting to the blocking rule. More information on salting can be found within the docs. |
None
|
arrays_to_explode |
(optional, List[str])
|
List of arrays to explode before applying the blocking rule. |
None
|
Examples:
from splink import block_on
br_1 = block_on("first_name")
br_2 = block_on("substr(surname,1,2)", "surname")