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
/*! Base requirements for indexable document mappings. Structures that can be indexed in Elasticsearch should implement `DocumentType`. The `DocumentType` is composed of typical mapping metadata, as well as the mapping for each of its properties. Documents can be mapped as indexable types, or as an object field on another type. # Examples Define your Elasticsearch types using _Plain Old Rust Structures_. ## Derive Mapping Mapping can be generated by deriving `ElasticType` on a struct: ``` # #[macro_use] # extern crate json_str; # #[macro_use] # extern crate serde_derive; # #[macro_use] # extern crate elastic_types_derive; # #[macro_use] # extern crate elastic_types; # extern crate serde; # use elastic_types::prelude::*; #[derive(Serialize, ElasticType)] pub struct MyType { pub my_date: Date<DefaultDateFormat>, pub my_string: String, pub my_num: i32 } # fn main() { # } ``` This will produce the following field mapping: ``` # #[macro_use] # extern crate json_str; # #[macro_use] # extern crate serde_derive; # #[macro_use] # extern crate elastic_types_derive; # #[macro_use] # extern crate elastic_types; # extern crate serde; # extern crate serde_json; # use elastic_types::prelude::*; # #[derive(Serialize, ElasticType)] # pub struct MyType { # pub my_date: Date<DefaultDateFormat>, # pub my_string: String, # pub my_num: i32 # } # fn main() { # let mapping = standalone_field_ser(MyTypeMapping).unwrap(); # let json = json_str!( { "type": "nested", "properties": { "my_date": { "type": "date", "format": "basic_date_time" }, "my_string": { "type": "text", "fields": { "keyword":{ "type":"keyword", "ignore_above":256 } } }, "my_num": { "type": "integer" } } } # ); # assert_eq!(json, mapping); # } ``` It's also possible to adjust the mapping using the `#[elastic]` attribute. ### Override Default Mapping Properties You can override the mapping meta properties for an object by providing your own mapping type with `#[elastic(mapping="{TypeName}")]`: ``` # #[macro_use] # extern crate json_str; # #[macro_use] # extern crate serde_derive; # #[macro_use] # extern crate elastic_types_derive; # #[macro_use] # extern crate elastic_types; # extern crate serde; # use elastic_types::prelude::*; #[derive(Serialize, ElasticType)] #[elastic(mapping="MyTypeMapping")] pub struct MyType { pub my_date: Date<DefaultDateFormat>, pub my_string: String, pub my_num: i32 } #[derive(Default)] pub struct MyTypeMapping; impl DocumentMapping for MyTypeMapping { //Give your own name to a type fn name() -> &'static str { "my_type" } fn data_type() -> &'static str { OBJECT_DATATYPE } } # fn main() { # } ``` This will produce the following field mapping: ``` # #[macro_use] # extern crate json_str; # #[macro_use] # extern crate serde_derive; # #[macro_use] # extern crate elastic_types_derive; # #[macro_use] # extern crate elastic_types; # extern crate serde; # extern crate serde_json; # use elastic_types::prelude::*; # #[derive(Default, Serialize, Deserialize, ElasticType)] # #[elastic(mapping="MyTypeMapping")] # pub struct MyType { # pub my_date: Date<DefaultDateFormat>, # pub my_string: String, # pub my_num: i32 # } # # #[derive(Default)] # pub struct MyTypeMapping; # impl DocumentMapping for MyTypeMapping { # fn name() -> &'static str { "my_type" } # fn data_type() -> &'static str { OBJECT_DATATYPE } # } # fn main() { # let mapping = standalone_field_ser(MyTypeMapping).unwrap(); # let json = json_str!( { "type": "object", "properties": { "my_date": { "type": "date", "format": "basic_date_time" }, "my_string": { "type": "text", "fields": { "keyword":{ "type":"keyword", "ignore_above":256 } } }, "my_num": { "type": "integer" } } } # ); # assert_eq!(json, mapping); # } ``` ### Ignore or Rename Fields You can then serialise type mappings with `#[serde]` attributes: ``` # #[macro_use] # extern crate json_str; # #[macro_use] # extern crate serde_derive; # #[macro_use] # extern crate elastic_types_derive; # #[macro_use] # extern crate elastic_types; # extern crate serde; # use elastic_types::prelude::*; #[derive(ElasticType, Serialize)] pub struct MyType { #[serde(rename="my_renamed_date")] pub my_date: Date<DefaultDateFormat>, #[serde(skip_serializing)] pub ignored: String, pub my_num: i32 } # fn main() { # } ``` > NOTE: Fields with a `#[serde(skip_deserializing)]` attribute will still be mapped, because they can still be indexed in Elasticsearch. ## Limitations Automatically deriving mapping has the following limitations: - Generics aren't supported by auto deriving. So you can't `#[derive(ElasticType)]` on `MyType<T>`. - Mapping types can't be shared. This is because they need to map the type fields, so are specific to that type. So you can't share `MyTypeMapping` between `MyType` and `MyOtherType`. All of the above limitations can be worked around by implementing the mapping manually. Remember that Elasticsearch will automatically update mappings based on the objects it sees though, so if your 'un-mapped' field is serialised, then an inferred mapping will be added for it. ## Manually Implement Mapping You can build object mappings by manually implementing the [`DocumentMapping`](mapping/trait.DocumentMapping.html) and [`PropertiesMapping`](mapping/trait.PropertiesMapping.html) traits: ``` # #[macro_use] # extern crate json_str; # #[macro_use] # extern crate serde_derive; # #[macro_use] # extern crate elastic_types_derive; # #[macro_use] # extern crate elastic_types; # extern crate serde; # use elastic_types::prelude::*; #[derive(Serialize)] pub struct MyType { pub my_date: Date<DefaultDateFormat>, pub my_string: String, pub my_num: i32 } //Implement DocumentType for your type. This binds it to the mapping impl DocumentType for MyType { type Mapping = MyTypeMapping; } //Define the type mapping for our type #[derive(Default)] pub struct MyTypeMapping; impl DocumentMapping for MyTypeMapping { fn name() -> &'static str { "my_type" } } impl PropertiesMapping for MyTypeMapping { fn props_len() -> usize { 3 } fn serialize_props<S>(state: &mut S) -> Result<(), S::Error> where S: serde::ser::SerializeStruct { try!(field_ser(state, "my_date", Date::<DefaultDateFormat>::mapping())); try!(field_ser(state, "my_string", String::mapping())); try!(field_ser(state, "my_num", i32::mapping())); Ok(()) } } # fn main() { # } ``` # Links - [Field Types](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html) - [Document Types](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html) */ pub mod mapping; mod impls; pub use self::impls::*; pub mod prelude { /*! Includes all types for document types. This is a convenience module to make it easy to build mappings for multiple types without too many `use` statements. */ pub use super::impls::*; pub use super::mapping::*; }