abacusai.database_connector
Module Contents
Classes
A connector to an external service |
- class abacusai.database_connector.DatabaseConnector(client, databaseConnectorId=None, service=None, name=None, status=None, auth=None, createdAt=None)
Bases:
abacusai.return_class.AbstractApiClass
A connector to an external service
- Parameters:
client (ApiClient) – An authenticated API Client instance
databaseConnectorId (str) – A unique string identifier for the connection.
service (str) – An enum string indicating the service this connection connects to.
name (str) – A user-friendly name for the service.
status (str) – The status of the database connector.
auth (dict) – Non-secret connection information for this connector.
createdAt (str) – The ISO-8601 string indicating when the API key was created.
- __repr__()
Return repr(self).
- to_dict()
Get a dict representation of the parameters in this class
- Returns:
The dict value representation of the class parameters
- Return type:
- list_objects()
Lists querable objects in the database connector.
- Parameters:
database_connector_id (str) – Unique string identifier for the database connector.
- get_object_schema(object_name=None)
Get the schema of an object in an database connector.
- Parameters:
object_name (str) – Unique identifier for the object in the external system.
- rename(name)
Renames a Database Connector
- Parameters:
name (str) – The new name for the Database Connector.