dm_examine_cardinalities {dm} | R Documentation |
Learn about your data model
Description
This function returns a tibble with information about
the cardinality of the FK constraints.
The printing for this object is special, use as_tibble()
to print as a regular tibble.
Usage
dm_examine_cardinalities(
.dm,
...,
.progress = NA,
dm = deprecated(),
progress = deprecated()
)
Arguments
.dm |
A |
... |
These dots are for future extensions and must be empty. |
.progress |
Whether to display a progress bar, if |
dm , progress |
Details
Uses examine_cardinality()
on each foreign key that is defined in the dm
.
Value
A tibble with the following columns:
child_table
child table,
child_fk_cols
foreign key column(s) in child table as list of character vectors,
parent_table
parent table,
parent_key_cols
key column(s) in parent table as list of character vectors,
cardinality
the nature of cardinality along the foreign key.
See Also
Other cardinality functions:
examine_cardinality()
Examples
dm_nycflights13() %>%
dm_examine_cardinalities()