dm_from_src() creates a dm from some or all tables in a src (a database or an environment) or which are accessible via a DBI-Connection. For Postgres and SQL Server databases, primary and foreign keys are imported from the database.

dm_from_src(src = NULL, table_names = NULL, learn_keys = NULL, ...)

Arguments

src

A dplyr table source object or a DBI::DBIConnection object is accepted.

table_names

A character vector of the names of the tables to include.

learn_keys

Experimental lifecycle

Set to TRUE to query the definition of primary and foreign keys from the database. Currently works only for Postgres and SQL Server databases. The default attempts to query and issues an informative message.

...

Experimental lifecycle

Additional parameters for the schema learning query. Currently supports schema (default: "public") and table_type (default: "BASE TABLE") for Postgres databases.

Value

A dm object.

Examples

if (rlang::is_installed("RMariaDB") && getRversion() >= 3.5) (if (getRversion() >= "3.4") withAutoprint else force)({ # examplesIf con <- DBI::dbConnect( RMariaDB::MariaDB(), username = "guest", password = "relational", dbname = "Financial_ijs", host = "relational.fit.cvut.cz" ) dm_from_src(con) DBI::dbDisconnect(con) }) # examplesIf
#> > con <- DBI::dbConnect(RMariaDB::MariaDB(), username = "guest", password = "relational", #> + dbname = "Financial_ijs", host = "relational.fit.cvut.cz") #> > dm_from_src(con)
#> Keys could not be queried, use `learn_keys = FALSE` to mute this message.
#> ── Table source ──────────────────────────────────────────────────────────────── #> src: mysql [guest@relational.fit.cvut.cz:NA/Financial_ijs] #> ── Metadata ──────────────────────────────────────────────────────────────────── #> Tables: `accounts`, `cards`, `clients`, `disps`, `districts`, … (9 total) #> Columns: 57 #> Primary keys: 0 #> Foreign keys: 0 #> > DBI::dbDisconnect(con)