Skip to content

Drive DB interface

Source code in reportconnectors/drive_db/__init__.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
class DriveDBClient(metaclass=ABCMeta):

    class Config:
        DEFAULT_SEARCH_KPI = "InherentAvailability"
        DEFAULT_SEARCH_COLUMN = "availability"
        DRIVES_PARTITION = "drives"
        DATE_COLUMN = "date"
        SERIAL_NUMBER_COLUMN = "serialNumber"
        KPI_NAME_COLUMN = "name"
        DETAILS_COLUMN = "details"
        RESULT_TYPE_COLUMN = "resultType"
        DEFAULT_KPI_COLUMNS = (
            SERIAL_NUMBER_COLUMN,
            DATE_COLUMN,
            KPI_NAME_COLUMN,
            DETAILS_COLUMN,
        )
        KPI_DATE_FORMAT = "%Y-%m-%d"
        KPI_DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S"
        INDEX_DATEFORMAT = "%Y%m%d"
        ITEM_ID_COLUMN = "id"

    @abstractmethod
    def list_databases(self) -> List:
        pass

    @abstractmethod
    def list_containers(self, database_link: Optional[str] = None) -> List:
        pass

    @abstractmethod
    def connect_to_container(self, name: str) -> None:
        pass

    @abstractmethod
    def connect_to_database(self, name: str) -> None:
        pass

    @abstractmethod
    def get_nameplate_details(self, serial_number: str, **kwargs) -> Union[List, Dict]:
        pass

    @abstractmethod
    def list_nameplate_details(self, serial_numbers: Optional[Sequence[str]] = None, **kwargs) -> List[Dict]:
        pass

    @abstractmethod
    def list_available_serial_numbers(self, **kwargs) -> List[str]:
        pass

    @abstractmethod
    def get_available_date_ranges(
        self, serial_number: str, data_mode: str = "all", **kwargs
    ) -> List[Tuple[datetime.datetime, datetime.datetime]]:
        pass

    @abstractmethod
    def get_kpi_values(
        self,
        serial_number: str,
        kpi_name: str,
        start_date: Optional[datetime.datetime] = None,
        end_date: Optional[datetime.datetime] = None,
        **kwargs,
    ) -> List[Dict]:
        pass

    @abstractmethod
    def get_scatter_data(
        self, serial_number: str, table_name: str, start_date: datetime.datetime, end_date: datetime.datetime, **kwargs
    ) -> List[List]:
        pass

    @abstractmethod
    def list_column_names(
        self,
        serial_number: str,
        table_name: str,
        start_date: Optional[datetime.datetime] = None,
        end_date: Optional[datetime.datetime] = None,
        **kwargs,
    ) -> List[str]:
        pass