Crate pliantdb[−][src]
Expand description
A programmable document database inspired by CouchDB
written in Rust.
This crate provides a convenient way to access all functionality of
PliantDb
. The crates that are re-exported are:
pliantdb-core
: Common types and traits used when interacting withPliantDb
.pliantdb-local
: Local, file-based database implementation.pliantdb-server
: NetworkedPliantDb
server implementation.pliantdb-client
: Client to access aPliantDb
server.
Feature Flags
No feature flags are enabled by default in the pliantdb
crate. This is
because in most Rust executables, you will only need a subset of the
functionality. If you’d prefer to enable everything, you can use the full
feature:
[dependencies]
pliantdb = { version = "*", default-features = false, features = "full" }
full
: Enableslocal-full
,server-full
, andclient-full
.cli
: Enables thepliantdb
executable.
Local databases only
[dependencies]
pliantdb = { version = "*", default-features = false, features = "local-full" }
local-full
: Enableslocal
,local-cli
,local-keyvalue
, andlocal-pubsub
local
: Enables thelocal
module, which re-exports the cratepliantdb-local
.local-cli
: Enables theStructOpt
structures for embedding database management commands into your own command-line interface.local-pubsub
: EnablesPubSub
forpliantdb-local
.local-keyvalue
: Enables the key-value store forpliantdb-local
.
PliantDb
server
[dependencies]
pliantdb = { version = "*", default-features = false, features = "server-full" }
server-full
: Enablesserver
,server-websockets
,server-keyvalue
, andserver-pubsub
server
: Enables theserver
module, which re-exports the cratepliantdb-server
.server-websockets
: EnablesWebSocket
support forpliantdb-server
.server-pubsub
: EnablesPubSub
forpliantdb-server
.server-keyvalue
: Enables the key-value store forpliantdb-server
.
Client for accessing a PliantDb
server.
[dependencies]
pliantdb = { version = "*", default-features = false, features = "client-full" }
client-full
: Enablesclient
,client-trusted-dns
,client-websockets
,client-keyvalue
, andclient-pubsub
client
: Enables theclient
module, which re-exports the cratepliantdb-client
.client-trusted-dns
: Enables using trust-dns for DNS resolution. If not enabled, all DNS resolution is done with the OS’s default name resolver.client-websockets
: EnablesWebSocket
support forpliantdb-client
.client-pubsub
: EnablesPubSub
forpliantdb-client
.client-keyvalue
: Enables the key-value store forpliantdb-client
.
Modules
cli |
|
client | Client for |
core | Core functionality and types for |
local | Local storage backend for |
server | The |