1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

// Copyright 2022 Datafuse Labs.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Redis support for OpenDAL
//!
//! # Note
//!
//! The storage format for this service is not **stable** yet.
//!
//! PLEASE DON'T USE THIS SERVICE FOR PERSIST DATA.
//!
//! # Configuration
//!
//! - `root`: Set the working directory of `OpenDAL`
//! - `endpoint`: Set the network address of redis server
//! - `username`: Set the username of Redis
//! - `password`: Set the password for authentication
//! - `db`: Set the DB of redis
//!
//! You can refer to [`Builder`]'s docs for more information
//!
//! # Environment
//!
//! - `OPENDAL_REDIS_ROOT` optional
//! - `OPENDAL_REDIS_ENDPOINT` optional
//! - `OPENDAL_REDIS_USERNAME` optional
//! - `OPENDAL_REDIS_PASSWORD` optional
//! - `OPENDAL_REDIS_DB` optional
//!
//! # Example
//!
//! ## Initiate via environment variables:
//!
//! Set environment correctly:
//!
//! ```shell
//! export OPENDAL_REDIS_ENDPOINT=tcp://example.com
//! export OPENDAL_REDIS_ROOT=/path/to/dir
//! export OPENDAL_REDIS_USERNAME=opendal
//! export OPENDAL_REDIS_PASSWORD=example_password
//! ```
//! ```no_run
//! use anyhow::Result;
//! use opendal::Object;
//! use opendal::Operator;
//! use opendal::Scheme;
//!
//! #[tokio::main]
//! async fn main() -> Result<()> {
//!     let op = Operator::from_env(Scheme::Redis);
//!
//!     // create an object handler to start operation on redis!
//!
//!     let _op: Object = op.object("hello_redis!");
//!
//!     Ok(())
//! }
//! ```
//!
//! ## Via Builder
//!
//! ```no_run
//! use anyhow::Result;
//! use opendal::services::redis;
//! use opendal::Object;
//! use opendal::Operator;
//!
//! #[tokio::main]
//! async fn main() -> Result<()> {
//!     let mut builder = redis::Builder::default();
//!
//!     // this will build a Operator accessing Redis which runs on tcp://localhost:6379
//!     let op: Operator = Operator::new(builder.build());
//!     let _: Object = op.object("test_file");
//!     Ok(())
//! }
//! ```

mod backend;
pub use backend::Builder;