start_sql_connection: Start up the desired SQL connection

In pnacht/simplysql: Simple, secure DSN-like SQL connectivity

Start up the desired SQL connection

Description

This function sets up the desired SQL connection if it has been identified in the past. If not, then the connection is defined interactively and set up accordingly.

Usage

start_sql_connection(alias)

Arguments

alias

string identifying the desired SQL connection.

Details

This must be the first simplysql function called, since it sets up the connection to be used everywhere else.

If the desired connection doesn't yet exist, it is created interactively, with the user entering a valid DBI::dbConnect() call to generate the desired connection.

This unusual interaction is meant to make debugging the connection easier. The suggested workflow when making your first connection is as follows:

• if you already have a DBI::dbConnect() call, simply copy-and-paste it at the prompt and you're done.

• if you've never connected to this database before, it'll be best to validate your connection parameters with a simple DBI::dbConnect() call first to make sure everything's right. This removes sources of uncertainty in case anything goes wrong. Once you've managed to create a valid connection, just copy that call and paste it at the prompt.

The pool::pool object responsible for handling the connection is automatically registered to disconnect when the session is terminated.

Value

On success, a pool::pool object representing the desired connection.

If the connection did not exist and the user cancels the setup, returns NULL invisibly.

See Also

Other connection management functions: create_sql_connection(), delete_sql_connection()

pnacht/simplysql documentation built on Sept. 5, 2024, 8:46 p.m.