sp_fetch_dvdrental_autodoc: Fetch 'dvdrental' autodoc

In smithjd/sqlpetr: Companion Package for R-Docker-Databases Book

Description

When sp_make_dvdrental_image builds the Docker image, it installs a utility called postgresql-autodoc. After restoring the dvdrental database, it runs the utilily and creates an HTML file with the database documentation on the image at /var/lib/postgresql/dvdrental.html. This function fetches that file to a file on the Docker host.

Usage

sp_fetch_dvdrental_autodoc(container_name = "sql-pet", file_path)

Arguments

container_name	character: The container name where the dvdrental database is running. The default is "sql-pet".
file_path	character: A valid file path to receive the HTML file. It should be an absolute path so you know where to find it, and the filename should end in .html so the browser can open it. There is no default.

Value

If successful: a character value of lenght 0. If unsuccessful, the function terminates with an error message.

smithjd/sqlpetr documentation built on Feb. 29, 2020, 8:15 p.m.