Skip to contents

Delete Sample Location

delete_sample_location.Rd

delete_sample_location() deletes an existing sample location in the sample location lookup table

Usage

delete_sample_location(con, sample_location_id)

Arguments

con

A DBI connection object obtained from DBI::dbConnect()

sample_location_id

A numeric ID for the targeted sample location get_sample_locations

Details

Note: If an sample location has been associated with a permit record, then the database restricts deleting this sample location. You must first update those records with a new sample location before reattempting to delete the sample location. Consider using the update_sample_location_status function if you are wanting to retire an sample location while retaining its value for historic records.

See also

Other sample location functions: add_sample_location(), get_sample_locations(), update_sample_location(), update_sample_location_status()

Examples

# example database connection
cfg <- config::get()
con <- DBI::dbConnect(RPostgres::Postgres(),
                      dbname = cfg$dbname,
                      host = cfg$host,
                      port = cfg$port,
                      user = cfg$username,
                      password = cfg$password)
#> Error: connection to server at "localhost" (::1), port 5432 failed: Connection refused (0x0000274D/10061)
#> 	Is the server running on that host and accepting TCP/IP connections?
#> connection to server at "localhost" (127.0.0.1), port 5432 failed: Connection refused (0x0000274D/10061)
#> 	Is the server running on that host and accepting TCP/IP connections?

all_sample_locations <- get_sample_locations(con)
#> Error in h(simpleError(msg, call)): error in evaluating the argument 'dbObj' in selecting a method for function 'dbIsValid': object 'con' not found
View(all_sample_locations) # to view the ID of the sample location needing deletion
#> Error in eval(expr, envir, enclos): object 'all_sample_locations' not found

delete_sample_location(con, 4)
#> Error in h(simpleError(msg, call)): error in evaluating the argument 'dbObj' in selecting a method for function 'dbIsValid': object 'con' not found