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
/*! Indexable documents and type mapping. This module contains tools for defining Elasticsearch-compatible document types. Document mapping is defined using Rust traits, which are added to fields as generic parameters. This has the following benefits: - Your `struct` is the one source of truth for serialisation and mapping. There's no extra mapping function to maintain. - Mapping is immutable and zero-cost. You don't pay anything at runtime for having mapping metadata available. # Document and data types Types in Elasticsearch are a combination of _source_ and _mapping_. The source is the data (like `42` or `"my string"`) and the mapping is metadata about how to interpret and use the data (like the format of a date string). The approach `elastic` takes to types is to bundle the mapping up as a _Zero Sized Type_, which is then bound to a field type as a generic parameter. For example: ```ignore some_field: Boolean<MyMapping> ``` The source type is `boolean` and the mapping is `MyMapping`. Most datatypes also implement a default mapping for a common Rust type if you don't need to customise how a field is mapped: ```ignore some_field: bool ``` See the table below for a complete list of supported datatypes and their default implementations. ## Supported datatypes The following table illustrates the types provided by `elastic`: Elasticsearch Type | Rust Type (Default Mapping) | Crate | Rust Type (Custom Mapping) | Format Type ------------------- | --------------------------- | --------- | -------------------------------------------------------- | ----------------- `object` | - | - | type implementing [`DocumentType<M>`][document-mod] | - `integer` | `i32` | `std` | [`Integer<M>`][number-mod] | - `long` | `i64` | `std` | [`Long<M>`][number-mod] | - `short` | `i16` | `std` | [`Short<M>`][number-mod] | - `byte` | `i8` | `std` | [`Byte<M>`][number-mod] | - `float` | `f32` | `std` | [`Float<M>`][number-mod] | - `double` | `f64` | `std` | [`Double<M>`][number-mod] | - `keyword` | - | - | [`Keyword<M>`][string-mod] | - `text` | `String` | `std` | [`Text<M>`][string-mod] | - `boolean` | `bool` | `std` | [`Boolean<M>`][boolean-mod] | - `ip` | `Ipv4Addr` | `std` | [`Ip<M>`][ip-mod] | - `date` | `DateTime<UTC>` | `chrono` | [`Date<M>`][date-mod] | `DateFormat` `geo_point` | `Point` | `geo` | [`GeoPoint<M>`][geopoint-mod] | `GeoPointFormat` `geo_shape` | - | `geojson` | [`GeoShape<M>`][geoshape-mod] | - ## Mapping Having the mapping available at compile-time captures the fact that a mapping is static and tied to the data type. Where there's a `std` type that's equivalent to an Elasticsearch type (like `i32` for `integer`), a default mapping is implemented for that type. That means you can use primitives in your structs and have them mapped to the correct type in Elasticsearch. If you want to provide your own mapping for a `std` type, there's also a struct provided by `elastic_types` that wraps the `std` type but also takes an explicit mapping (like `Integer` which implements `Deref<Target = i32>`). Where there isn't a `std` type available (like `date`), an external crate is used and an implementation of that type is provided (like `Date`, which implements `Deref<Target = chrono::DateTime<UTC>>`). ## Formats For some types (like `Date`), it's helpful to have an extra generic parameter that describes the way the data can be interpreted. For most types the format isn't exposed, because there aren't any alternative formats available. This is a particularly helpful feature for serialisation. # Examples ## Derive document mapping Document types must derive `serde`'s [serialisation traits][serde]. Use simple generic types to annotate your Rust structures with Elasticsearch document field mappings: ``` # extern crate elastic; # #[macro_use] # extern crate elastic_derive; # extern crate serde; # #[macro_use] # extern crate serde_derive; # use elastic::prelude::*; # fn main() { #[derive(Serialize, Deserialize, ElasticType)] struct MyType { // Mapped as an `integer` field id: i32, // Mapped as a `text` field with a `keyword` subfield title: String, // Mapped as a `date` field with an `epoch_millis` format timestamp: Date<DefaultDateMapping<EpochMillis>> } # } ``` You can use the `IndexDocumentMapping` type wrapper to serialise the mapping for your document types: ``` # extern crate elastic; # #[macro_use] # extern crate elastic_derive; # extern crate serde; # extern crate serde_json; # #[macro_use] # extern crate serde_derive; # use elastic::prelude::*; # fn main() { run().unwrap() } # fn run() -> Result<(), Box<::std::error::Error>> { # #[derive(Serialize, Deserialize, ElasticType)] # struct MyType {} let doc = MyType::index_mapping(); let mapping = serde_json::to_string(&doc)?; # Ok(()) # } ``` This will produce the following JSON: ``` # extern crate elastic; # #[macro_use] extern crate elastic_derive; # extern crate serde; # #[macro_use] extern crate json_str; # extern crate serde_json; # #[macro_use] extern crate serde_derive; # use elastic::prelude::*; # fn main() { run().unwrap() } # fn run() -> Result<(), Box<::std::error::Error>> { # #[derive(Serialize, Deserialize, ElasticType)] # struct MyType { # id: i32, # title: String, # timestamp: Date<DefaultDateMapping<EpochMillis>> # } # let mapping = serde_json::to_string(&MyType::index_mapping())?; # let expected = json_str!( { "properties": { "id": { "type": "integer" }, "title": { "type": "text", "fields": { "keyword": { "type": "keyword", "ignore_above": 256 } } }, "timestamp": { "type": "date", "format": "epoch_millis" } } } # ); # assert_eq!(expected, mapping); # Ok(()) # } ``` See the table above for a list of all supported datatypes and how to work with them. ## Define custom field data types Use traits to define your own field types and have them mapped as one of the core datatypes. In the below example, variants of `MyEnum` will be serialised as a string, which we map as a non-analysed `keyword` in Elasticsearch: ``` # extern crate elastic; # #[macro_use] # extern crate elastic_derive; # extern crate serde; # #[macro_use] # extern crate serde_derive; # use elastic::prelude::*; # fn main() { # #[derive(Serialize, Deserialize)] enum MyEnum { OptionA, OptionB, OptionC } // Map `MyEnum` as a `keyword` in Elasticsearch, but treat it as an enum in Rust impl KeywordFieldType<DefaultKeywordMapping> for MyEnum {} # } ``` You can then use `MyEnum` on any document type: ``` # extern crate elastic; # #[macro_use] # extern crate elastic_derive; # extern crate serde; # #[macro_use] # extern crate serde_derive; # use elastic::prelude::*; # fn main() { # #[derive(Serialize, Deserialize)] # enum MyEnum {} # impl KeywordFieldType<DefaultKeywordMapping> for MyEnum {} #[derive(Serialize, Deserialize, ElasticType)] struct MyType { value: MyEnum } # } ``` Serialising `MyType`s mapping will produce the following json: ``` # extern crate elastic; # #[macro_use] extern crate elastic_derive; # extern crate serde; # #[macro_use] extern crate serde_derive; # #[macro_use] extern crate json_str; # extern crate serde_json; # use elastic::prelude::*; # #[derive(Serialize, Deserialize)] # enum MyEnum {} # impl KeywordFieldType<DefaultKeywordMapping> for MyEnum {} # #[derive(Serialize, Deserialize, ElasticType)] # struct MyType { # value: MyEnum # } # fn main() { run().unwrap() } # fn run() -> Result<(), Box<::std::error::Error>> { # let mapping = serde_json::to_string(&MyType::index_mapping())?; # let expected = json_str!( { "properties": { "value": { "type": "keyword" } } } # ); # assert_eq!(expected, mapping); # Ok(()) # } ``` [serde]: https://serde.rs [document-mod]: document/index.html [number-mod]: number/index.html [string-mod]: string/index.html [boolean-mod]: boolean/index.html [ip-mod]: ip/index.html [date-mod]: date/index.html [geopoint-mod]: geo/point/index.html [geoshape-mod]: geo/shape/index.html */ pub use elastic_types::{boolean, date, document, geo, ip, number, prelude, string}; #[doc(hidden)] pub use elastic_types::derive;