verticapy.connection.get_connection_file#

verticapy.connection.get_connection_file() → str#

Gets (and creates, if necessary) the auto-connection file. If the environment variable VERTICAPY_CONNECTION is set, it is assumed to be the full path to the auto-connection file. Otherwise, we reference “connections.verticapy” in the hidden “.verticapy” folder in the user’s home directory.

Returns#

string: the full path to the auto-connection file.

Examples#

The connection file is used to store all connections:

Warning

Connections are stored in plain text format. In shared environments, it’s recommended to create connections manually for added security.

from verticapy.connection import get_connection_file

get_connection_file()

'C:\Users\user\.vertica\connections.verticapy'