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 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
//! redis_graph provides a trait with a small number of extension functions for the //! [redis](https://docs.rs/redis/) crate to allow working with redis graph //! data types that can be installed as a [redis module](https://oss.redislabs.com/redisgraph). //!Redis graph operations are mostly using two top level Redis commands //!(one for read/write operations and one for read-only operations). In addition //!to those there are some more maintenance oriented commands for perfomance, configuration and //!clean-up which starting from v0.4.0 are also supported. //!The Graph commands are available in synchronous and asynchronous versions. //! //!The crate is called `redis-graph` and you can depend on it via cargo. You will //!also need redis in your dependencies. This version was tested against redis 0.20.0 //!but should run with versions higher than that. //! //! ```ini //! [dependencies] //! redis = "0.20.0" //! redis-graph = "0.4.1" //! ``` //! //! Or via git: //! //! ```ini //! [dependencies.redis-graph] //! git = "https://github.com/tompro/redis_graph.git" //! branch = "main" //! ``` //! //! With async feature inherited from the [redis](https://docs.rs/redis) //! crate (either: 'async-std-comp' or 'tokio-comp): //! //! ```ini //! [dependencies] //! redis = "0.20.0" //! redis-graph = { version = "0.4.1", features = ['tokio-comp'] } //! ``` //! //! # Synchronous usage //! //! To enable the redis graph commands you simply load the trait //! redis_graph::GraphCommands into scope. The redis graph //! commands will then be available on your redis connection. //! To also have access to the value extractor traits simply import //! the whole crate redis_graph::*. //! //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! use redis::Commands; //! use redis_graph::*; //! //! let client = redis::Client::open("redis://127.0.0.1/")?; //! let mut con = client.get_connection()?; //! //! let _:GraphResultSet = con.graph_query( //! "my_graph", //! "CREATE (:Rider {name:'Valentino Rossi'})-[:rides]->(:Team {name:'Yamaha'})" //! )?; //! //! let _:GraphResultSet = con.graph_ro_query( //! "my_graph", //! "MATCH (rider:Rider)-[:rides]->(:Team {name:'Yamaha'}) RETURN rider" //! )?; //! # Ok(()) } //! ``` //! //! //! # Asynchronous usage //! //! To enable the redis graph async commands you simply load the //! redis_graph::AsyncGraphCommands into the scope. To also have access //! to the value extractor traits simply import the whole crate redis_graph::*. //! //! ```rust,no_run //! # #[cfg(any(feature = "tokio-comp", feature = "async-std-comp"))] //! # async fn run() -> redis::RedisResult<()> { //! use redis::AsyncCommands; //! use redis_graph::*; //! //! let client = redis::Client::open("redis://127.0.0.1/")?; //! let mut con = client.get_async_connection().await?; //! //! let _:GraphResultSet = con.graph_query( //! "my_graph", //! "CREATE (:Rider {name:'Valentino Rossi'})-[:rides]->(:Team {name:'Yamaha'})" //! ).await?; //! //! let _:GraphResultSet = con.graph_ro_query( //! "my_graph", //! "MATCH (rider:Rider)-[:rides]->(:Team {name:'Yamaha'}) RETURN rider" //! ).await?; //! # Ok(()) } //! ``` //! //! # Commands //! //! The following examples work with the synchronous and asynchronous API. For //! simplicity all examples will use the synchronous API. To use them async simply //! run them within an async function and append the .await after the command call. //! //! ## GRAPH.QUERY and GRAPH.RO_QUERY //! The query command (and read-only alternative) is the only command required for //! all graph operations. It will produce a GraphResultSet that contains the //! results of the operation. As queries are very flexible a lot of different //! data stuctures can be contained in a GraphResultSet. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! use redis::Commands; //! use redis_graph::*; //! //! let client = redis::Client::open("redis://127.0.0.1/")?; //! let mut con = client.get_connection()?; //! //! /// A create query returns metadata as a list of strings //! let r:GraphResultSet = con.graph_query( //! "my_graph", //! "CREATE (:Rider {name:'Valentino Rossi'})-[:rides]->(:Team {name:'Yamaha'})" //! )?; //! assert!(!r.metadata.is_empty()); //! //! //! /// This read-only query will return nodes and scalars in the result //! let riders = con.graph_ro_query( //! "my_graph", //! "MATCH (rider:Rider)-[:rides]->(team:Team) //! WHERE team.name = 'Yamaha' //! RETURN rider, team.name" //! )?; //! //! //! /// Data contains a vec of GraphResult with one entry per query match. //! assert!(riders.data.len() > 0); //! //! //! /// A GraphResult is indexed with the identifiers used in the RETURN //! /// clause of the query. A result has some convenience functions to //! /// extract GraphValues (Scalar|Node|Relation) into rust types. //! let entry = riders.data.get(0).unwrap(); //! let rider:Option<&NodeValue> = entry.get_node("rider"); //! let team_name:Option<String> = entry.get_scalar("team.name"); //! //! //! /// Node and Relation values can contain properties for which there are //! /// value extractors as well. //! let rider_name:Option<String> = rider.unwrap().get_property_option("name"); //! //! # Ok(()) } //! ``` //! //! ## GRAPH.PROFILE //! Executes a query and produces an execution plan augmented with metrics //! for each operation's execution. Returns strings in a list format. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_graph::*; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let profile:Vec<String> = con.graph_profile( //! "my_graph", //! "MATCH (rider:Rider)-[:rides]->(:Team {name:'Yamaha'}) RETURN rider" //! )?; //! //! # Ok(()) } //! ``` //! //! ## GRAPH.DELETE //! Completely removes the graph and all of its entities. //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_graph::*; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let res:String = con.graph_delete("my_graph")?; //! //! # Ok(()) } //! ``` //! //! ## GRAPH.EXPLAIN //! Constructs a query execution plan but does not run it. Inspect this //! execution plan to better understand how your query will get executed. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_graph::*; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let explanation:Vec<String> = con.graph_explain( //! "my_graph", //! "MATCH (rider:Rider)-[:rides]->(:Team {name:'Yamaha'}) RETURN rider" //! )?; //! //! # Ok(()) } //! ``` //! //! ## GRAPH.SLOWLOG //! Returns a list containing up to 10 of the slowest queries issued against the //! given graph ID. Results will be read into a list of SlowLogEntry. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_graph::*; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let log:Vec<SlowLogEntry> = con.graph_slowlog("my_graph")?; //! //! # Ok(()) } //! ``` //! //! ## GRAPH.CONFIG //! Allows configuring some global behaviour of redis graph for the redis server. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_graph::*; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! /// Set a config value. Be aware that setting non config fields here will //! /// result in a redis error. //! let success:bool = con.graph_config_set("RESULTSET_SIZE", 500)?; //! //! /// Get a single config value. //! let resultSetSize:i32 = con.graph_config_get("RESULTSET_SIZE")?; //! assert_eq!(resultSetSize, 500); //! //! /// Get all config values //! let config: GraphConfig = con.graph_config_get_all()?; //! let resSize:Option<u32> = config.get_value("RESULTSET_SIZE")?; //! assert_eq!(resSize.unwrap(), 500); //! //! # Ok(()) } //! ``` #[cfg(any(feature = "tokio-comp", feature = "async-std-comp"))] pub use crate::async_commands::AsyncGraphCommands; pub use crate::commands::GraphCommands; pub use crate::types::*; #[cfg(any(feature = "tokio-comp", feature = "async-std-comp"))] mod async_commands; mod commands; mod types;