class documentation

class qaapDB(ABC):

Known subclasses: qA_Ap.db.flatfiledb.FlatFileDB

View In Hierarchy

Abstract base class for qA_Ap databases.

Method add_attribute_values Undocumented
Method attribute_exists Undocumented
Method comment_exists Undocumented
Method get_all_documents_data Undocumented
Method get_attribute_values Undocumented
Method get_catalog Undocumented
Method get_document Undocumented
Method get_document_medias Undocumented
Method get_note_medias Undocumented
Method get_notes_for_post Undocumented
Method get_vector_store Undocumented
Method post_exists Undocumented
Method write_attribute Undocumented
Method write_catalog Undocumented
Method write_comment Undocumented
Method write_post Undocumented
Method write_vector_store Undocumented
@abstractmethod
def add_attribute_values(self, attribute: str, data: list[str]) -> bool:

Undocumented

@abstractmethod
def attribute_exists(self, attribute: str) -> bool:

Undocumented

@abstractmethod
def comment_exists(self, post_title: str, note_title: str) -> bool:

Undocumented

@abstractmethod
def get_all_documents_data(self) -> list[dict[str, str]]:

Undocumented

@abstractmethod
def get_attribute_values(self, attribute: str) -> str:

Undocumented

@abstractmethod
def get_catalog(self) -> str:

Undocumented

@abstractmethod
def get_document(self, post_title: str) -> tuple[str, str]:

Undocumented

@abstractmethod
def get_document_medias(self, post_title: str, includes: list[str] = []) -> list[str]:

Undocumented

@abstractmethod
def get_note_medias(self, post_title: str, note_title: str, includes: list[str] = []) -> list[str]:

Undocumented

@abstractmethod
def get_notes_for_post(self, post_title: str, perpage: int = 0, page: int = 0) -> list[tuple[str, str, str]]:

Undocumented

@abstractmethod
def get_vector_store(self) -> bytes:

Undocumented

@abstractmethod
def post_exists(self, post_title: str) -> bool:

Undocumented

@abstractmethod
def write_attribute(self, attribute: str, data: str) -> bool:

Undocumented

@abstractmethod
def write_catalog(self, json: str) -> bool:

Undocumented

@abstractmethod
def write_comment(self, post_title: str, note_title: str, content: str, medias: list[tuple[str, str]]) -> bool:

Undocumented

@abstractmethod
def write_post(self, post_title: str, content: str, medias: list[tuple[str, str]]) -> bool:

Undocumented

@abstractmethod
def write_vector_store(self, bytes_data: bytes) -> bool:

Undocumented