Skip to content

Class swarmauri_core.dataconnectors.IDataConnector.IDataConnector

swarmauri_core.dataconnectors.IDataConnector.IDataConnector

Bases: ABC

Abstract base class for data connectors. Defines the interface for all concrete data connector implementations.

authenticate abstractmethod 

authenticate(**kwargs)

Authenticate with the data source. This method should handle any required authentication process.

:param kwargs: Authentication parameters such as API keys, tokens, etc.

Source code in swarmauri_core/dataconnectors/IDataConnector.py 
10
11
12
13
14
15
16
17
18
@abstractmethod
def authenticate(self, **kwargs):
    """
    Authenticate with the data source.
    This method should handle any required authentication process.

    :param kwargs: Authentication parameters such as API keys, tokens, etc.
    """
    pass

fetch_data abstractmethod 

fetch_data(query, **kwargs)

Fetch data from the data source based on a query.

:param query: Query string or parameters to fetch specific data. :param kwargs: Additional parameters for fetching data. :return: Data fetched from the source.

Source code in swarmauri_core/dataconnectors/IDataConnector.py 
20
21
22
23
24
25
26
27
28
29
@abstractmethod
def fetch_data(self, query: str, **kwargs):
    """
    Fetch data from the data source based on a query.

    :param query: Query string or parameters to fetch specific data.
    :param kwargs: Additional parameters for fetching data.
    :return: Data fetched from the source.
    """
    pass

insert_data abstractmethod 

insert_data(data, **kwargs)

Insert data into the data source.

:param data: Data to be inserted. :param kwargs: Additional parameters for inserting data.

Source code in swarmauri_core/dataconnectors/IDataConnector.py 
31
32
33
34
35
36
37
38
39
@abstractmethod
def insert_data(self, data, **kwargs):
    """
    Insert data into the data source.

    :param data: Data to be inserted.
    :param kwargs: Additional parameters for inserting data.
    """
    pass

update_data abstractmethod 

update_data(identifier, data, **kwargs)

Update existing data in the data source.

:param identifier: Unique identifier of the data to update. :param data: Updated data. :param kwargs: Additional parameters for updating data.

Source code in swarmauri_core/dataconnectors/IDataConnector.py 
41
42
43
44
45
46
47
48
49
50
@abstractmethod
def update_data(self, identifier, data, **kwargs):
    """
    Update existing data in the data source.

    :param identifier: Unique identifier of the data to update.
    :param data: Updated data.
    :param kwargs: Additional parameters for updating data.
    """
    pass

delete_data abstractmethod 

delete_data(identifier, **kwargs)

Delete data from the data source.

:param identifier: Unique identifier of the data to delete. :param kwargs: Additional parameters for deleting data.

Source code in swarmauri_core/dataconnectors/IDataConnector.py 
52
53
54
55
56
57
58
59
60
@abstractmethod
def delete_data(self, identifier, **kwargs):
    """
    Delete data from the data source.

    :param identifier: Unique identifier of the data to delete.
    :param kwargs: Additional parameters for deleting data.
    """
    pass

test_connection abstractmethod 

test_connection(**kwargs)

Test the connection to the data source.

:param kwargs: Connection parameters. :return: Boolean indicating whether the connection is successful.

Source code in swarmauri_core/dataconnectors/IDataConnector.py 
62
63
64
65
66
67
68
69
70
@abstractmethod
def test_connection(self, **kwargs):
    """
    Test the connection to the data source.

    :param kwargs: Connection parameters.
    :return: Boolean indicating whether the connection is successful.
    """
    pass