sql.join

A <code>SQL</code>-like join of two <code>dbi.table</code>s that share the
same underlying <code><a href="https://dbi.r-dbi.org/reference/DBI-package.html">DBI</a></code> connection. All columns of both
<code>dbi.table</code>s are returned.

Query database tables over a 'DBI' connection using 'data.table' syntax.
Attach database schemas to the search path. Automatically merge using foreign
key constraints.

Kjell Konis

dbi.table

Database Queries Using 'data.table' Syntax

sql.join function

<dl><dt>x, y</dt>
<dd><code>dbi.table</code>s to join. <code>x</code> and <code>y</code> must share the same
<code><a href="https://dbi.r-dbi.org/reference/DBI-package.html">DBI</a></code> connection.</dd>
<dt>type</dt>
<dd>a character string specifying the join type. Valid choices are
<code>"inner"</code>, <code>"left"</code>, <code>"right"</code>, <code>"outer"</code>, and
<code>"cross"</code>.</dd>
<dt>on</dt>
<dd>a <code>call</code> specifying the join predicate. The symbols in <code>on</code>
should be column names of <code>x</code> or column names of <code>y</code>, use
prefixes as necessary.</dd>
<dt>prefixes</dt>
<dd>a 2-element character vector of distinct values. When <code>x</code> and <code>y</code>
both have a column with the same name (e.g., <code>common_name</code>) then, when
specifing the join predicate in <code>on</code>, use 
<code>`prefixes[1]`common_name</code> to refer to the <code>common_name</code> column
in <code>x</code> and <code>`prefixes[2]`common_name</code> to refer to the
<code>common_name</code> column in <code>y</code>. <code>prefixes</code> are also used to
disambiguate the output column names.</dd></dl>

Arguments

A <code>SQL</code>-like join of two <code>dbi.table</code>s that share the
same underlying <code><a href='https://dbi.r-dbi.org/reference/DBI-package.html'>DBI</a></code> connection. All columns of both
<code>dbi.table</code>s are returned.

Join dbi.tables — sql.join

<dl>

<dt>x, y</dt>
<dd><code>dbi.table</code>s to join. <code>x</code> and <code>y</code> must share the same
<code><a href='https://dbi.r-dbi.org/reference/DBI-package.html'>DBI</a></code> connection.</dd>


<dt>type</dt>
<dd>a character string specifying the join type. Valid choices are
<code>"inner"</code>, <code>"left"</code>, <code>"right"</code>, <code>"outer"</code>, and
<code>"cross"</code>.</dd>


<dt>on</dt>
<dd>a <code>call</code> specifying the join predicate. The symbols in <code>on</code>
should be column names of <code>x</code> or column names of <code>y</code>, use
prefixes as necessary.</dd>


<dt>prefixes</dt>
<dd>a 2-element character vector of distinct values. When <code>x</code> and <code>y</code>
both have a column with the same name (e.g., <code>common_name</code>) then, when
specifing the join predicate in <code>on</code>, use 
<code>`prefixes[1]`common_name</code> to refer to the <code>common_name</code> column
in <code>x</code> and <code>`prefixes[2]`common_name</code> to refer to the
<code>common_name</code> column in <code>y</code>. <code>prefixes</code> are also used to
disambiguate the output column names.</dd>

</dl>

sql.join: Join `dbi.table`s

Description

Usage

Value

Arguments

Examples