# Relational Data Models

## Documentation for package ‘dm’ version 1.1.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Code demos. Use demo() to run them.
- Package NEWS.

## Help Pages

A C D E F G H I J L M N P R S T U Z

## -- A --

anti_join.dm_keyed_tbl | 'dplyr' join methods for zoomed dm objects
anti_join.dm_zoomed | 'dplyr' join methods for zoomed dm objects
arrange.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
arrange.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
as_dm | Data model class

## -- C --

check_cardinality_... | Check table relations
check_cardinality_0_1 | Check table relations
check_cardinality_0_n | Check table relations
check_cardinality_1_1 | Check table relations
check_cardinality_1_n | Check table relations
check_key | Check if column(s) can be used as keys
check_set_equality | Check column values for set equality
check_subset | Check column values for subset
collect.dm | Materialize
compute.dm | Materialize
compute.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
copy_dm_to | Copy data model to data source
count.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
count.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
cross_join.dm_keyed_tbl | 'dplyr' join methods for zoomed dm objects
cross_join.dm_zoomed | 'dplyr' join methods for zoomed dm objects

## -- D --

db_schema_create | Create a schema on a database
db_schema_drop | Remove a schema from a database
db_schema_exists | Check for existence of a schema on a database
db_schema_list | List schemas on a database
decompose_table | Decompose a table into two linked tables
distinct.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
distinct.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
dm | Data model class
dm_add_fk | Add foreign keys
dm_add_pk | Add a primary key
dm_add_uk | Add a unique key
dm_ddl_post | Create _DDL_ and _DML_ scripts for a 'dm' a and database connection
dm_ddl_pre | Create _DDL_ and _DML_ scripts for a 'dm' a and database connection
dm_deconstruct | Create code to deconstruct a dm object
dm_disambiguate_cols | Resolve column name ambiguities
dm_discard_zoomed | Mark table for manipulation
dm_dml_load | Create _DDL_ and _DML_ scripts for a 'dm' a and database connection
dm_draw | Draw a diagram of the data model
dm_enum_fk_candidates | Foreign key candidates
dm_enum_pk_candidates | Primary key candidate
dm_examine_cardinalities | Learn about your data model
dm_examine_constraints | Validate your data model
dm_filter | Filtering
dm_financial | Creates a dm object for the Financial data
dm_financial_sqlite | Creates a dm object for the Financial data
dm_flatten | Flatten a table in a 'dm' by joining its parent tables
dm_flatten_to_tbl | Flatten a part of a 'dm' into a wide table
dm_from_con | Load a dm from a remote data source
dm_get_all_fks | Get foreign key constraints
dm_get_all_pks | Get all primary keys of a 'dm' object
dm_get_all_uks | Get all unique keys of a 'dm' object
dm_get_available_colors | Color in database diagrams
dm_get_colors | Color in database diagrams
dm_get_con | Get connection
dm_get_tables | Get tables
dm_get_table_description | Add info about a dm's tables
dm_gui | Shiny app for defining dm objects
dm_has_pk | Check for primary key
dm_insert_zoomed | Mark table for manipulation
dm_mutate_tbl | Update tables in a 'dm'
dm_nest_tbl | Nest a table inside its dm
dm_nrow | Number of rows
dm_nycflights13 | Creates a dm object for the 'nycflights13' data
dm_pack_tbl | dm_pack_tbl()
dm_paste | Create R code for a dm object
dm_pixarfilms | Creates a dm object for the 'pixarfilms' data
dm_ptype | Prototype for a dm object
dm_rename | Rename columns
dm_rename_tbl | Select and rename tables
dm_reset_table_description | Add info about a dm's tables
dm_rm_fk | Remove foreign keys
dm_rm_pk | Remove a primary key
dm_rm_uk | Remove a unique key
dm_rows_... | Modifying rows for multiple tables
dm_rows_append | Modifying rows for multiple tables
dm_rows_delete | Modifying rows for multiple tables
dm_rows_insert | Modifying rows for multiple tables
dm_rows_patch | Modifying rows for multiple tables
dm_rows_update | Modifying rows for multiple tables
dm_rows_upsert | Modifying rows for multiple tables
dm_select | Select columns
dm_select_tbl | Select and rename tables
dm_set_colors | Color in database diagrams
dm_set_table_description | Add info about a dm's tables
dm_sql | Create _DDL_ and _DML_ scripts for a 'dm' a and database connection
dm_unnest_tbl | Unnest columns from a wrapped table
dm_unpack_tbl | Unpack columns from a wrapped table
dm_unwrap_tbl | Unwrap a single table dm
dm_update_zoomed | Mark table for manipulation
dm_validate | Validator
dm_wrap_tbl | Wrap dm into a single tibble dm
dm_zoomed_df | Mark table for manipulation
dm_zoom_to | Mark table for manipulation
dplyr_join | 'dplyr' join methods for zoomed dm objects
dplyr_table_manipulation | 'dplyr' table manipulation methods for zoomed dm objects

## -- E --

enum_fk_candidates | Foreign key candidates
enum_pk_candidates | Primary key candidate
examine_cardinality | Check table relations

## -- F --

filter.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
filter.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
filter_out.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
filter_out.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
full_join.dm_keyed_tbl | 'dplyr' join methods for zoomed dm objects
full_join.dm_zoomed | 'dplyr' join methods for zoomed dm objects

## -- G --

glimpse.dm | Get a glimpse of your 'dm' object
glimpse.dm_zoomed | Get a glimpse of your 'dm' object
group_by.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
group_by.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects

## -- H --

head.dm_zoomed | 'utils' table manipulation methods for 'dm_zoomed' objects

## -- I --

inner_join.dm_keyed_tbl | 'dplyr' join methods for zoomed dm objects
inner_join.dm_zoomed | 'dplyr' join methods for zoomed dm objects
is_dm | Data model class

## -- J --

json_nest | JSON nest
json_nest_join | JSON nest join
json_pack | JSON pack
json_pack_join | JSON pack join
json_unnest | Unnest a JSON column
json_unpack | Unpack a JSON column

## -- L --

left_join.dm_keyed_tbl | 'dplyr' join methods for zoomed dm objects
left_join.dm_zoomed | 'dplyr' join methods for zoomed dm objects

## -- M --

materialize | Materialize
mutate.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
mutate.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects

## -- N --

nest_join.dm_zoomed | 'dplyr' join methods for zoomed dm objects
new_dm | Data model class

## -- P --

pack_join | Pack Join
pack_join.dm_zoomed | Pack Join
pull.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
pull_tbl | Retrieve a table

## -- R --

reframe.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
reframe.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
relocate.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
relocate.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
rename.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
rename.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
reunite_parent_child | Merge two tables that are linked by a foreign key relation
reunite_parent_child_from_list | Merge two tables that are linked by a foreign key relation
right_join.dm_keyed_tbl | 'dplyr' join methods for zoomed dm objects
right_join.dm_zoomed | 'dplyr' join methods for zoomed dm objects
rows-dm | Modifying rows for multiple tables

## -- S --

select.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
select.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
semi_join.dm_keyed_tbl | 'dplyr' join methods for zoomed dm objects
semi_join.dm_zoomed | 'dplyr' join methods for zoomed dm objects
separate.dm_keyed_tbl | 'tidyr' table manipulation methods for zoomed dm objects
separate.dm_zoomed | 'tidyr' table manipulation methods for zoomed dm objects
slice.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
slice.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
summarise.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
summarise.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects

## -- T --

tail.dm_zoomed | 'utils' table manipulation methods for 'dm_zoomed' objects
tally.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
tally.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
tidyr_table_manipulation | 'tidyr' table manipulation methods for zoomed dm objects
transmute.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
transmute.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects

## -- U --

ungroup.dm_keyed_tbl | 'dplyr' table manipulation methods for zoomed dm objects
ungroup.dm_zoomed | 'dplyr' table manipulation methods for zoomed dm objects
unite.dm_keyed_tbl | 'tidyr' table manipulation methods for zoomed dm objects
unite.dm_zoomed | 'tidyr' table manipulation methods for zoomed dm objects

## -- Z --

zoomed_df | Mark table for manipulation