enum_pk_candidates {dm} | R Documentation |
Primary key candidate
Description
enum_pk_candidates()
checks for each column of a
table if the column contains only unique values, and is thus
a suitable candidate for a primary key of the table.
dm_enum_pk_candidates()
performs these checks
for a table in a dm object.
Usage
enum_pk_candidates(table, ...)
dm_enum_pk_candidates(dm, table, ...)
Arguments
table |
A table in the |
... |
These dots are for future extensions and must be empty. |
dm |
A |
Value
A tibble with the following columns:
columns
columns of
table
,candidate
boolean: are these columns a candidate for a primary key,
why
if not a candidate for a primary key column, explanation for this.
Life cycle
These functions are marked "experimental" because we are not yet sure about
the interface, in particular if we need both dm_enum...()
and enum...()
variants.
Changing the interface later seems harmless because these functions are
most likely used interactively.
See Also
Other primary key functions:
dm_add_pk()
,
dm_add_uk()
,
dm_get_all_pks()
,
dm_get_all_uks()
,
dm_has_pk()
,
dm_rm_pk()
,
dm_rm_uk()
Examples
nycflights13::flights %>%
enum_pk_candidates()
dm_nycflights13() %>%
dm_enum_pk_candidates(airports)