Cover eth.db.* in API docs

Author: cburgdorf

docs/api/api.db.rst

@@ -7,7 +7,14 @@ DataBase
    :name: toc-eth-api-db
    :caption: Database
 
-   db/api.db.backends
    db/api.db.account
+   db/api.db.atomic
+   db/api.db.backends
+   db/api.db.batch
+   db/api.db.cache
+   db/api.db.chain
+   db/api.db.diff
+   db/api.db.header
    db/api.db.journal
-   db/api.db.chain
+   db/api.db.schema
+   db/api.db.storage

docs/api/db/api.db.atomic.rst

@@ -0,0 +1,13 @@
+Atomic
+======
+
+AtomicDB
+~~~~~~~~
+
+.. autoclass:: eth.db.atomic.AtomicDB
+  :members:
+
+
+.. autoclass:: eth.db.atomic.AtomicDBWriteBatch
+  :members:
+

docs/api/db/api.db.batch.rst

@@ -0,0 +1,8 @@
+Batch
+=====
+
+BatchDB
+~~~~~~~
+
+.. autoclass:: eth.db.batch.BatchDB
+  :members:

docs/api/db/api.db.cache.rst

@@ -0,0 +1,8 @@
+Cache
+=====
+
+CacheDB
+~~~~~~~
+
+.. autoclass:: eth.db.cache.CacheDB
+  :members:

docs/api/db/api.db.diff.rst

@@ -0,0 +1,22 @@
+DBDiff
+======
+
+DBDiff
+~~~~~~
+
+.. autoclass:: eth.db.diff.DBDiff
+  :members:
+
+DBDiffTracker
+~~~~~~~~~~~~~
+
+.. autoclass:: eth.db.diff.DBDiffTracker
+  :members:
+
+DiffMissingError
+~~~~~~~~~~~~~~~~
+
+.. autoclass:: eth.db.diff.DiffMissingError
+  :members:
+
+

docs/api/db/api.db.header.rst

@@ -0,0 +1,8 @@
+Header
+======
+
+HeaderDB
+~~~~~~~~
+
+.. autoclass:: eth.db.header.HeaderDB
+  :members:

docs/api/db/api.db.schema.rst

@@ -0,0 +1,8 @@
+Schema
+======
+
+SchemaV1
+--------
+
+.. autoclass:: eth.db.schema.SchemaV1
+  :members:

docs/api/db/api.db.storage.rst

@@ -0,0 +1,14 @@
+Storage
+=======
+
+AccountStorageDB
+----------------
+
+.. autoclass:: eth.db.storage.AccountStorageDB
+  :members:
+
+StorageLookup
+-------------
+
+.. autoclass:: eth.db.storage.StorageLookup
+  :members:

eth/abc.py

@@ -255,6 +255,28 @@ def is_genesis(self) -> bool:
         ...
 
 
+class SchemaAPI(ABC):
+    @staticmethod
+    @abstractmethod
+    def make_canonical_head_hash_lookup_key() -> bytes:
+        ...
+
+    @staticmethod
+    @abstractmethod
+    def make_block_number_to_hash_lookup_key(block_number: BlockNumber) -> bytes:
+        ...
+
+    @staticmethod
+    @abstractmethod
+    def make_block_hash_to_score_lookup_key(block_hash: Hash32) -> bytes:
+        ...
+
+    @staticmethod
+    @abstractmethod
+    def make_transaction_hash_to_block_lookup_key(transaction_hash: Hash32) -> bytes:
+        ...
+
+
 class DatabaseAPI(MutableMapping[bytes, bytes], ABC):
     @abstractmethod
     def set(self, key: bytes, value: bytes) -> None:

eth/db/schema.py

@@ -1,34 +1,12 @@
-from abc import ABC, abstractmethod
-
 from eth_typing import (
     BlockNumber,
     Hash32,
 )
 
-
-class BaseSchema(ABC):
-    @staticmethod
-    @abstractmethod
-    def make_canonical_head_hash_lookup_key() -> bytes:
-        raise NotImplementedError('Must be implemented by subclasses')
-
-    @staticmethod
-    @abstractmethod
-    def make_block_number_to_hash_lookup_key(block_number: BlockNumber) -> bytes:
-        raise NotImplementedError('Must be implemented by subclasses')
-
-    @staticmethod
-    @abstractmethod
-    def make_block_hash_to_score_lookup_key(block_hash: Hash32) -> bytes:
-        raise NotImplementedError('Must be implemented by subclasses')
-
-    @staticmethod
-    @abstractmethod
-    def make_transaction_hash_to_block_lookup_key(transaction_hash: Hash32) -> bytes:
-        raise NotImplementedError('Must be implemented by subclasses')
+from eth.abc import SchemaAPI
 
 
-class SchemaV1(BaseSchema):
+class SchemaV1(SchemaAPI):
     @staticmethod
     def make_canonical_head_hash_lookup_key() -> bytes:
         return b'v1:canonical_head_hash'