# A 'dplyr' Back End for Databases

## Documentation for package ‘dbplyr’ version 2.6.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

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

## -- A --

add_count.tbl_lazy | Count observations by group
anti_join.tbl_lazy | Join SQL tables
arrange.tbl_lazy | Arrange rows by column values

## -- B --

backend-adbc | ADBC backend
backend-jdbc | JDBC backend
base_agg | Create an SQL translator
base_no_win | Create an SQL translator
base_odbc_agg | Create an SQL translator
base_odbc_scalar | Create an SQL translator
base_odbc_win | Create an SQL translator
base_scalar | Create an SQL translator
base_win | Create an SQL translator
bind_queries | Combine multiple lazy queries

## -- C --

collapse.tbl_sql | Collapse a query into a subquery
collect.tbl_sql | Collect results into a local data frame
complete.tbl_lazy | Complete a SQL table with missing combinations of data
compute.tbl_sql | Save results into a new remote table
copy_inline | Use a local data frame in a dbplyr query
copy_to.src_sql | Copy a local data frame to a remote database
count.tbl_lazy | Count observations by group
cross_join.tbl_lazy | Join SQL tables

## -- D --

db-quote | Escape/quote a value
dbplyr_pivot_wider_spec | Pivot data from long to wide
dbplyr_uncount | "Uncount" a database table
dialect_access | MS Access backend
dialect_ansi | ANSI SQL backend
dialect_db2 | DB2 backend
dialect_hana | SAP HANA backend
dialect_hive | Hive backend
dialect_impala | Impala backend
dialect_mariadb | MySQL/MariaDB backend
dialect_mssql | SQL Server backend
dialect_mysql | MySQL/MariaDB backend
dialect_odbc | ODBC backend
dialect_oracle | Oracle backend
dialect_postgres | PostgreSQL backend
dialect_redshift | Redshift backend
dialect_snowflake | Snowflake backend
dialect_spark_sql | Databricks Spark SQL backend
dialect_sqlite | SQLite backend
dialect_teradata | Teradata backend
distinct.tbl_lazy | Subset distinct/unique rows
do.tbl_sql | Perform arbitrary computation on remote backend

## -- E --

escape | Escape/quote a value
expand.tbl_lazy | Expand SQL tables to include all possible combinations of values
explain.tbl_sql | Show generated SQL and query plan

## -- F --

fill.tbl_lazy | Fill in missing values with previous or next value
filter.tbl_lazy | Keep or drop rows that match a condition
filter_out.tbl_lazy | Keep or drop rows that match a condition
full_join.tbl_lazy | Join SQL tables

## -- G --

get_returned_rows | Extract and check the 'RETURNING' rows
group_by.tbl_lazy | Group by one or more variables

## -- H --

has_returned_rows | Extract and check the 'RETURNING' rows
head.tbl_lazy | Subset the first rows

## -- I --

inner_join.tbl_lazy | Join SQL tables
intersect.tbl_lazy | SQL set operations
is.sql | Literal SQL escaping

## -- J --

join.tbl_sql | Join SQL tables

## -- L --

last_sql | Retrieve the last SQL query generated
left_join.tbl_lazy | Join SQL tables
local_memdb_frame | A temporary in-memory database

## -- M --

memdb | A temporary in-memory database
memdb_frame | A temporary in-memory database
mutate.tbl_lazy | Create, modify, and delete columns

## -- N --

new_sql_dialect | SQL dialects

## -- P --

pivot_longer.tbl_lazy | Pivot data from wide to long
pivot_wider.tbl_lazy | Pivot data from long to wide
pull.tbl_sql | Extract a single column

## -- R --

relocate.tbl_lazy | Subset, rename, and reorder columns using their names
remote_con | Metadata about a remote table
remote_name | Metadata about a remote table
remote_query | Metadata about a remote table
remote_query_plan | Metadata about a remote table
remote_src | Metadata about a remote table
remote_table | Metadata about a remote table
rename.tbl_lazy | Subset, rename, and reorder columns using their names
rename_with.tbl_lazy | Subset, rename, and reorder columns using their names
replace_na.tbl_lazy | Replace NAs with specified values
right_join.tbl_lazy | Join SQL tables
rows_append.tbl_lazy | Edit individual rows in the underlying database table
rows_delete.tbl_lazy | Edit individual rows in the underlying database table
rows_insert.tbl_lazy | Edit individual rows in the underlying database table
rows_patch.tbl_lazy | Edit individual rows in the underlying database table
rows_update.tbl_lazy | Edit individual rows in the underlying database table
rows_upsert.tbl_lazy | Edit individual rows in the underlying database table

## -- S --

select.tbl_lazy | Subset, rename, and reorder columns using their names
semi_join.tbl_lazy | Join SQL tables
setdiff.tbl_lazy | SQL set operations
show_query | Show generated SQL and query plan
show_query.tbl_lazy | Show generated SQL and query plan
simulate_access | MS Access backend
simulate_dbi | ANSI SQL backend
simulate_hana | SAP HANA backend
simulate_hive | Hive backend
simulate_impala | Impala backend
simulate_mariadb | MySQL/MariaDB backend
simulate_mssql | SQL Server backend
simulate_mysql | MySQL/MariaDB backend
simulate_odbc | ODBC backend
simulate_oracle | Oracle backend
simulate_postgres | PostgreSQL backend
simulate_redshift | Redshift backend
simulate_snowflake | Snowflake backend
simulate_spark_sql | Databricks Spark SQL backend
simulate_sqlite | SQLite backend
simulate_teradata | Teradata backend
slice_max.tbl_lazy | Subset rows using their positions
slice_min.tbl_lazy | Subset rows using their positions
slice_sample.tbl_lazy | Subset rows using their positions
sql | Literal SQL escaping
sql_aggregate | SQL helpers for aggregate functions
sql_aggregate_2 | SQL helpers for aggregate functions
sql_aggregate_n | SQL helpers for aggregate functions
sql_cast | SQL helpers for scalar functions
sql_check_na_rm | SQL helpers for aggregate functions
sql_cot | SQL helpers for scalar functions
sql_dialect | SQL dialects
sql_escape_date | Escape/quote a value
sql_escape_datetime | Escape/quote a value
sql_escape_ident | Escape/quote a value
sql_escape_logical | Escape/quote a value
sql_escape_raw | Escape/quote a value
sql_escape_string | Escape/quote a value
sql_glue | Build SQL strings with glue syntax
sql_glue2 | Build SQL strings with glue syntax
sql_infix | SQL helpers for scalar functions
sql_log | SQL helpers for scalar functions
sql_not_supported | SQL helpers for aggregate functions
sql_options | Options for generating SQL
sql_paste | SQL helpers for string functions
sql_paste_infix | SQL helpers for string functions
sql_prefix | SQL helpers for scalar functions
sql_query_append | Generate SQL for Insert, Update, Upsert, and Delete
sql_query_delete | Generate SQL for Insert, Update, Upsert, and Delete
sql_query_insert | Generate SQL for Insert, Update, Upsert, and Delete
sql_query_update_from | Generate SQL for Insert, Update, Upsert, and Delete
sql_query_upsert | Generate SQL for Insert, Update, Upsert, and Delete
sql_runif | SQL helpers for scalar functions
sql_str_sub | SQL helpers for string functions
sql_substr | SQL helpers for string functions
sql_translation_agg | SQL helpers for aggregate functions
sql_translation_scalar | SQL helpers for scalar functions
sql_translation_string | SQL helpers for string functions
sql_translation_window | SQL helpers for window functions
sql_translator | Create an SQL translator
sql_try_cast | SQL helpers for scalar functions
sql_variant | Create an SQL translator
sql_vector | Escape/quote a value
summarise.tbl_lazy | Summarise each group to one row

## -- T --

tally.tbl_lazy | Count observations by group
tbl.src_dbi | Create a lazy query backed by a database
tbl_dbi | Create a lazy query backed by a database
translate_sql | Translate an expression to SQL
translate_sql_ | Translate an expression to SQL

## -- U --

union.tbl_lazy | SQL set operations
union_all.tbl_lazy | SQL set operations

## -- W --

window_frame | Override window order and frame
window_order | Override window order and frame
win_absent | SQL helpers for window functions
win_aggregate | SQL helpers for window functions
win_aggregate_2 | SQL helpers for window functions
win_cumulative | SQL helpers for window functions
win_current_frame | SQL helpers for window functions
win_current_group | SQL helpers for window functions
win_current_order | SQL helpers for window functions
win_over | SQL helpers for window functions
win_rank | SQL helpers for window functions
win_recycled | SQL helpers for window functions
with_dialect | Override the SQL dialect for a connection

## -- misc --

.sql | Flag SQL function usage