Teradata Package for R Function Reference | 17.00 - 17.00 - td_remove_context - Teradata Package for R

Teradata® Package for R Function Reference

Product
Teradata Package for R
Release Number
17.00
Published
July 2021
Last Update
August 2022
Content Type
Programming Reference
Publication ID
B700-4007-090K
Language
English (United States)
Last Update
2022-08-19
Remove the current context and close the corresponding connection to Teradata Vantage

Description

Use the td_remove_context function to remove an existing context created using the td_create_context or the td_set_context or dbConnect(tdplyr::NativeDriver(), ...) function. This performs removal (garbage collection) of all non-persistent work tables created by the analytic functions. This closes the corresponding connection object.
Note: If DBI::dbDisconnect is invoked on the connection object in the current context before calling the td_remove_context function, then a warning is displayed and garbage collection is not performed.

Usage

td_remove_context()

Value

Returns NULL invisibly

See Also

td_create_context, td_set_context, td_get_context, dbConnect

Examples

# Example 1: Remove the connection that is established using td_create_context().
td_create_context(dsn = "TeradataDSN")
# The nonpersistent work tables are garbage collected and the connection is disconnected
td_remove_context()

# Example 2: Remove the connection that is established using td_set_context().
# Establish connection to Teradata Vantage using the dbConnect API
con <- DBI::dbConnect(odbc::odbc(), dsn = "TeradataDSN")

# Use td_set_context to initialize a context with a given connection object.
td_set_context(con = con)
td_remove_context()