config_examples {sqlhelper}

Examples of yaml configurations for database connections

Description

Provides example configurations for several databases and a range of options

Usage

config_examples(filename = NA)

Arguments

filename

A string. If supplied, examples are written to a file with this name.

Details

Irrespective of whether a filename is supplied, yaml configuration examples will be returned invisibly as a single string and printed if the session is interactive.

Value

A yaml string of database configuration examples, invisibly.

Examples

config_examples()

# write the examples to a temporary file called 'examples.yml'
config_examples(file.path(tempdir(), "examples.yml"))