Skip to contents

Define Source datasets primary keys

Source: R/bind_keys.R
primary_keys.Rd

Primary keys can be defined as `primary_keys` parameter of set_source method. Currently, primary keys are used only to show keys information in attrition plot (See attrition).

Usage

primary_keys(...)

Arguments

...

Data keys describing tables primary keys.

Value

List of class `primary_keys` storing data_keys objects.

Examples

primary_keys(
  data_key('books', 'book_id'),
  data_key('borrowed', c('user_id', 'books_id', 'date'))
)
#> [[1]]
#> $dataset
#> [1] "books"
#> 
#> $key
#> [1] "book_id"
#> 
#> attr(,"class")
#> [1] "data_key"
#> 
#> [[2]]
#> $dataset
#> [1] "borrowed"
#> 
#> $key
#> [1] "user_id"  "books_id" "date"    
#> 
#> attr(,"class")
#> [1] "data_key"
#> 
#> attr(,"class")
#> [1] "primary_keys"