Update documentation for CacheSizeMB

matthewmcneely · matthewmcneely · commit 54055fb59699 · 2025-07-14T20:34:23.000-04:00
diff --git a/client.go b/client.go
@@ -143,7 +143,10 @@ func WithMaxEdgeTraversal(max int) ClientOpt {
 	}
 }
 
-// WithCacheSizeMB sets the memory cache size in MB (only applicable for embedded databases)
+// WithCacheSizeMB sets the memory cache size in MB (only applicable for embedded databases).
+// A good starting point for a system with a moderate amount of RAM (e.g., 8-16GB) would be
+// between 256 MB and 1 GB. Dgraph itself often defaults to a 1GB cache. In order to minimize
+// resource usage sans configuration, the default is set to 64 MB.
 func WithCacheSizeMB(size int) ClientOpt {
 	return func(o *clientOptions) {
 		o.cacheSizeMB = size

Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,10 @@ func WithMaxEdgeTraversal(max int) ClientOpt {`
`143`	`143`	`}`
`144`	`144`	`}`
`145`	`145`
`146`		`-// WithCacheSizeMB sets the memory cache size in MB (only applicable for embedded databases)`
	`146`	`+// WithCacheSizeMB sets the memory cache size in MB (only applicable for embedded databases).`
	`147`	`+// A good starting point for a system with a moderate amount of RAM (e.g., 8-16GB) would be`
	`148`	`+// between 256 MB and 1 GB. Dgraph itself often defaults to a 1GB cache. In order to minimize`
	`149`	`+// resource usage sans configuration, the default is set to 64 MB.`
`147`	`150`	`func WithCacheSizeMB(size int) ClientOpt {`
`148`	`151`	`return func(o *clientOptions) {`
`149`	`152`	`o.cacheSizeMB = size`