Skip to main content

EdgeData

Edge Data Object​

class:: edge.api.EdgeData

This object is available at EdgeSession.sources

Methods​

Reference​

list()​

List names of stored external connections.

Returns:

     list(str)

         A list of strings representing names of stored external connections.

get()​

EdgeData.get(connection_id)

Retrieve a stored connection object, given its name or UID.

Parameters:

  • connection_id (str) — Name or UID of the connection to retrieve.

Returns:

    IConnection

         The object corresponding to the retrieved connection.

Raises:

  • NotFound — Raised if a connection with the given name is not found.
  • BadEntry — If the connector definition or name is invalid.

add()​

EdgeData.add(connection)

Adds a connection to the database

Parameters:

  • connection (IConnection) — A connector to add to the database.

update()​

EdgeData.update(connection)

Updates a connection in the database

Parameters:

  • connection (IConnection) — A connector to update in the database.

remove()​

EdgeData.remove(connection_id)

Delete a given connection from your organization.

Parameters:

  • connection_id (str) — Name or UID of the connection to remove.