aboutsummaryrefslogtreecommitdiff
path: root/weed/filer/foundationdb/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'weed/filer/foundationdb/doc.go')
-rw-r--r--weed/filer/foundationdb/doc.go13
1 files changed, 13 insertions, 0 deletions
diff --git a/weed/filer/foundationdb/doc.go b/weed/filer/foundationdb/doc.go
new file mode 100644
index 000000000..3b3a20bc4
--- /dev/null
+++ b/weed/filer/foundationdb/doc.go
@@ -0,0 +1,13 @@
+/*
+Package foundationdb provides a FoundationDB-based filer store for SeaweedFS.
+
+FoundationDB is a distributed ACID database with strong consistency guarantees
+and excellent scalability characteristics. This filer store leverages FDB's
+directory layer for organizing file metadata and its key-value interface for
+efficient storage and retrieval.
+
+The referenced "github.com/apple/foundationdb/bindings/go/src/fdb" library
+requires FoundationDB client libraries to be installed.
+So this is only compiled with "go build -tags foundationdb".
+*/
+package foundationdb