Crate pliantdb[−][src]

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 with PliantDb.
pliantdb-local: Local, file-based database implementation.
pliantdb-server: Networked PliantDb server implementation.
pliantdb-client: Client to access a PliantDb 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: Enables local-full, server-full, and client-full.
cli: Enables the pliantdb executable.

Local databases only

[dependencies]
pliantdb = { version = "*", default-features = false, features = "local-full" }

local-full: Enables local, local-cli, local-keyvalue, and local-pubsub
local: Enables the local module, which re-exports the crate pliantdb-local.
local-cli: Enables the StructOpt structures for embedding database management commands into your own command-line interface.
local-pubsub: Enables PubSub for pliantdb-local.
local-keyvalue: Enables the key-value store for pliantdb-local.

`PliantDb` server

[dependencies]
pliantdb = { version = "*", default-features = false, features = "server-full" }

server-full: Enables server, server-websockets, server-keyvalue, and server-pubsub
server: Enables the server module, which re-exports the crate pliantdb-server.
server-websockets: Enables WebSocket support for pliantdb-server.
server-pubsub: Enables PubSub for pliantdb-server.
server-keyvalue: Enables the key-value store for pliantdb-server.

Client for accessing a `PliantDb` server.

[dependencies]
pliantdb = { version = "*", default-features = false, features = "client-full" }

client-full: Enables client, client-trusted-dns, client-websockets, client-keyvalue, and client-pubsub
client: Enables the client module, which re-exports the crate pliantdb-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: Enables WebSocket support for pliantdb-client.
client-pubsub: Enables PubSub for pliantdb-client.
client-keyvalue: Enables the key-value store for pliantdb-client.

Modules

cli	`PliantDb` command line tools.
client	Client for `pliantdb-server`.
core	Core functionality and types for `PliantDb`.
local	Local storage backend for `PliantDb`.
server	The `PliantDb` Server.

Crate pliantdb⎘[−][src]