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 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
use super::{ChannelMode, SonicChannel, SonicStream}; use crate::commands::*; use crate::result::Result; use std::net::ToSocketAddrs; /// The Sonic Channel Ingest mode is used for altering the search index /// (push, pop and flush). Once in this mode, you cannot switch to other /// modes or gain access to commands from other modes. /// /// ### Available commands /// /// In this mode you can use `push`, `pop`, `flushc`, `flushb`, `flusho`, /// `bucket_count`, `object_count`, `word_count`, `ping` and `quit` commands. /// /// **Note:** This mode requires enabling the `ingest` feature. #[derive(Debug)] pub struct IngestChannel(SonicStream); impl SonicChannel for IngestChannel { type Channel = IngestChannel; fn stream(&self) -> &SonicStream { &self.0 } fn start<A, S>(addr: A, password: S) -> Result<Self::Channel> where A: ToSocketAddrs, S: ToString, { SonicStream::connect_with_start(ChannelMode::Ingest, addr, password).map(Self) } } impl IngestChannel { init_command!( /// Stop connection. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let channel = IngestChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// channel.quit()?; /// # Ok(()) /// # } use QuitCommand for fn quit(); ); init_command!( /// Ping server. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let channel = IngestChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// channel.ping()?; /// # Ok(()) /// # } use PingCommand for fn ping(); ); } impl IngestChannel { init_command!( /// Push search data in the index. /// /// Note: This method requires enabling the `ingest` feature and start /// connection in Ingest mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let ingest_channel = IngestChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let result = ingest_channel.push( /// "search", /// "default", /// "recipe:295", /// "Sweet Teriyaki Beef Skewers", /// )?; /// assert_eq!(result, true); /// # Ok(()) /// # } /// ``` use PushCommand for fn push<'a>( collection: &'a str, bucket: &'a str, object: &'a str, text: &'a str, ); ); init_command!( /// Push search data in the index with locale parameter in ISO 639-3 code. /// /// Note: This method requires enabling the `ingest` feature and start /// connection in Ingest mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let ingest_channel = IngestChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let result = ingest_channel.push_with_locale( /// "search", /// "default", /// "recipe:296", /// "Гренки с жареным картофелем и сыром", /// "rus", /// )?; /// assert_eq!(result, true); /// # Ok(()) /// # } /// ``` use PushCommand for fn push_with_locale<'a>( collection: &'a str, bucket: &'a str, object: &'a str, text: &'a str, locale: &'a str => Some(locale), ); ); init_command!( /// Pop search data from the index. Returns removed words count as usize type. /// /// Note: This method requires enabling the `ingest` feature and start /// connection in Ingest mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let ingest_channel = IngestChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let result = ingest_channel.pop("search", "default", "recipe:295", "beef")?; /// assert_eq!(result, 1); /// # Ok(()) /// # } /// ``` use PopCommand for fn pop<'a>( collection: &'a str, bucket: &'a str, object: &'a str, text: &'a str, ); ); init_command!( /// Flush all indexed data from collections. /// /// Note: This method requires enabling the `ingest` feature and start /// connection in Ingest mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let ingest_channel = IngestChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let flushc_count = ingest_channel.flushc("search")?; /// dbg!(flushc_count); /// # Ok(()) /// # } /// ``` use FlushCommand for fn flushc<'a>( collection: &'a str, ); ); init_command!( /// Flush all indexed data from bucket in a collection. /// /// Note: This method requires enabling the `ingest` feature and start /// connection in Ingest mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let ingest_channel = IngestChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let flushb_count = ingest_channel.flushb("search", "default")?; /// dbg!(flushb_count); /// # Ok(()) /// # } /// ``` use FlushCommand for fn flushb<'a>( collection: &'a str, bucket: &'a str => Some(bucket), ); ); init_command!( /// Flush all indexed data from an object in a bucket in collection. /// /// Note: This method requires enabling the `ingest` feature and start /// connection in Ingest mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let ingest_channel = IngestChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let flusho_count = ingest_channel.flusho("search", "default", "recipe:296")?; /// dbg!(flusho_count); /// # Ok(()) /// # } /// ``` use FlushCommand for fn flusho<'a>( collection: &'a str, bucket: &'a str => Some(bucket), object: &'a str => Some(object), ); ); init_command!( /// Bucket count in indexed search data of your collection. /// /// Note: This method requires enabling the `ingest` feature and start /// connection in Ingest mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let ingest_channel = IngestChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let bucket_count = ingest_channel.bucket_count("search")?; /// dbg!(bucket_count); /// # Ok(()) /// # } /// ``` use CountCommand for fn bucket_count<'a>( collection: &'a str, ); ); init_command!( /// Object count of bucket in indexed search data. /// /// Note: This method requires enabling the `ingest` feature and start /// connection in Ingest mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let ingest_channel = IngestChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let object_count = ingest_channel.object_count("search", "default")?; /// dbg!(object_count); /// # Ok(()) /// # } /// ``` use CountCommand for fn object_count<'a>( collection: &'a str, bucket: &'a str => Some(bucket), ); ); init_command!( /// Object word count in indexed bucket search data. /// /// Note: This method requires enabling the `ingest` feature and start /// connection in Ingest mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let ingest_channel = IngestChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let word_count = ingest_channel.word_count("search", "default", "recipe:296")?; /// dbg!(word_count); /// # Ok(()) /// # } /// ``` use CountCommand for fn word_count<'a>( collection: &'a str, bucket: &'a str => Some(bucket), object: &'a str => Some(object), ); ); }