# HG changeset patch
# User Richard Westhaver <ellis@rwest.io>
# Date 1723688007 14400
# Node ID ab579a19f4efde414fd4be6295a64572173e0f23
# Parent  5bd0eb9fa1fab37442d368bd8285d612722513e3
docs

diff -r 5bd0eb9fa1fa -r ab579a19f4ef lisp/ffi/rocksdb/compaction.lisp
--- a/lisp/ffi/rocksdb/compaction.lisp	Wed Aug 14 21:49:56 2024 -0400
+++ b/lisp/ffi/rocksdb/compaction.lisp	Wed Aug 14 22:13:27 2024 -0400
@@ -1,6 +1,14 @@
 ;;; rocksdb/compaction.lisp --- RocksDB Compaction
 
-;;
+;; RocksDB Lisp Compaction Filter API
+
+;;; Commentary:
+
+;; compaction filters are like custom GC rules for the database. compactions
+;; run in the background and can be configured via the column-family-options
+;; or compactionfilterfactory API.
+
+;; ref: https://github.com/facebook/rocksdb/wiki/Compaction-Filter
 
 ;;; Code:
 (in-package :rocksdb)
diff -r 5bd0eb9fa1fa -r ab579a19f4ef lisp/ffi/rocksdb/comparator.lisp
--- a/lisp/ffi/rocksdb/comparator.lisp	Wed Aug 14 21:49:56 2024 -0400
+++ b/lisp/ffi/rocksdb/comparator.lisp	Wed Aug 14 22:13:27 2024 -0400
@@ -2,6 +2,18 @@
 
 ;; RocksDB Lisp Comparator API
 
+;;; Commentary:
+
+;; ref: https://github.com/facebook/rocksdb/blob/main/include/rocksdb/comparator.h
+#|
+// Three-way comparison.  Returns value:
+//   < 0 iff "a" < "b",
+//   == 0 iff "a" == "b",
+//   > 0 iff "a" > "b"
+// Note that Compare(a, b) also compares timestamp if timestamp size is
+// non-zero. For the same user key with different timestamps, larger (newer)
+// timestamp comes first.
+|#
 ;;; Code:
 (in-package :rocksdb)