vastorbit.connection.get_connection_file¶

vastorbit.connection.get_connection_file() → str¶

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

Returns:: the validated full path to the auto-connection file.
Return type:: string

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 vastorbit.connection import get_connection_file

get_connection_file()

'C:\Users\user\.vastorbit\connections.vastorbit'