External connections (APIs)

Using the Python SDK client, you can create external database connections, search for defined external connections, and manage external connections using the methods provided by vianops_client.api.webservices.external_connection.

Import and Initiate the client

For example,

from vianops_client import ExternalConnectionV1Api

external_connections_api = ExternalConnectionV1Api()

Payload and methods

The pydantic model V1ExternalConnectionModel has the following payload:

createdby (str | None)  
createddate (float | None)  
description (str)  
display (bool)  
hide_tables (list | None)  
index (int | None)  
name (str)  
type (str)  
url (str)

The Monitor placeholder notebook (accessible from the platform’s edahub service) shows how to access database connections using names (external_connections_api.search_by_name(name=db_name)["url"])rather than urls/database strings. You can also access by index.

TABLE OF CONTENTS