ShelfDB provides a protocol server through the shelfdb CLI.
Default server¶
shelfdb server
Defaults:
- database path:
db - server URL:
tcp://127.0.0.1:31337
Custom TCP address¶
shelfdb server --url "tcp://0.0.0.0:17001" --db-path ./db
Unix socket¶
Absolute path:
shelfdb server --url "unix:///tmp/shelfdb.sock" --db-path ./db
Relative path from the current working directory:
shelfdb server --url "unix://tmp/shelfdb.sock" --db-path ./db
URL formats¶
- TCP:
tcp://host:port - Unix socket:
unix:///absolute/path.sock - Unix socket relative to the current working directory:
unix://relative/path.sock