vastorbit.connection.delete_connection¶

vastorbit.connection.delete_connection(name: str) → bool¶

Deletes a specified connection from the connection file.

Parameters:: name (str) – Name of the connection.
Returns:: True if the connection was deleted, False otherwise.
Return type:: bool

Examples

Create a connection named ‘My_New_vast_connection’:

from vastorbit.connection import new_connection

new_connection(
    {
        "host": "10.20.110.10",
        "port": "8080",
        "catalog": "vast",
        "schema": "default",
        "user": "admin",
    },
    name = "My_New_vast_connection",
)

Display all available connections:

from vastorbit.connection import available_connections

available_connections()

['VASTDSN', 'My_New_vast_connection']

Delete the ‘My_New_vast_connection’ connection:

from vastorbit.connection import delete_connection

delete_connection("My_New_vast_connection")

Confirm that the connection no longer appears in the available connections:

available_connections()

['VASTDSN']