StorageBackend class
#include <pinedb/storage.h>
This is an interface which represents a storage backend, this class is used to create, read and write pages to a physical storage.
Derived classes
- class DiskStorageBackend
Constructors, destructors, conversion operators
- ~StorageBackend() virtual
Public functions
-
auto create_new_page() -> page_
id_ type pure virtual -
auto read_page(page_
id_ type page_id, uint8_t* buffer) -> bool pure virtual -
auto write_page(page_
id_ type page_id, uint8_t* buffer) -> bool pure virtual -
auto delete_page(page_
id_ type page_id) -> bool pure virtual -
auto page_size() -> page_
size_ type pure virtual - auto close() -> bool pure virtual
- Closes the storage backend.
Function documentation
page_
| Returns | If successful, page_id of the created page, otherwise -1 |
|---|
This method creates a new page in the physical storage
bool pinedb::
| Parameters | |
|---|---|
| page_id | id of the page to be read |
| buffer | A buffer of size atleast equal to page_size, which is used to hold the page data |
| Returns | true if the read was successful, false otherwise |
This method reads a page from the storage and copies its contents to the passed buffer
bool pinedb::
| Parameters | |
|---|---|
| page_id | id of the page to be written |
| buffer | A buffer of size atleast equal to page_size, which is used to hold the page data |
| Returns | true if the write was successful, false otherwise |
This method writes a page to the storage and copies the contents of the buffer
bool pinedb::
| Parameters | |
|---|---|
| page_id | id of the page to be deleted |
| Returns | true if the delete was successful, false otherwise |
This method deletes a page, and frees the storage associated with the page
page_
| Returns | The page size of this storage backend |
|---|
bool pinedb::
Closes the storage backend.
| Returns | true if the backend was closed / has been closed, false otherwise |
|---|