Skip to main content

pc.delete_connection

pc.delete_connection(connection_name=None, connection_id=None)

    Delete the specified connection. Can delete either via name or id but not both.
     If both connection_id and onnection_name are specified, an error will be thrown.

Parameters:​

       connection_name: str, default None
       Name of connection to delete.

       connection_id: str, default None
       ID of connection to delete.

Returns:​

       None

Examples:​

Delete an unwanted connection by name.

    pc.delete_connection('S3 Connection')

Delete an unwanted connection by ID.

    pc.list_connections()
#    >  [Connection,
#             name: Postgres Connection,
#             id: 0,
#             connection_type: ConnectionType.POSTGRESQL,
#             properties: None,
#        Connection,
#             name: S3 Connection,
#             id: 1,
#             connection_type: ConnectionType.S3,
#             properties: None]

    pc.delete_connection(connection_id=1)