Skip to content

Commit 0914f45

Browse files
author
Bennett Hardwick
committed
Clarify term explosion
1 parent ecbc609 commit 0914f45

File tree

2 files changed

+22
-4
lines changed

2 files changed

+22
-4
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,8 +250,17 @@ struct User {
250250
name: String,
251251
}
252252
```
253-
It's important to note that the more annotations that are added to a field the more index terms that will be generated. Adding too many attributes could result in a
254-
proliferation of terms and data.
253+
It's important to note that the more annotations that are added to a field the more index terms that will be generated.
254+
Adding too many attributes could result in a proliferation of terms and data.
255+
256+
The previous example for example would have the following terms generated:
257+
258+
- One term for the exact index on email
259+
- One term for the exact index on name
260+
- Up to 25 terms for the prefix index on name
261+
- Up to 25 terms for the compound index of email and name
262+
263+
This would mean a total of 53 records would be inserted.
255264

256265
## Storing and Retrieving Records
257266

src/lib.rs

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,17 @@
196196
//! name: String,
197197
//! }
198198
//! ```
199-
//! It's important to note that the more annotations that are added to a field the more index terms that will be generated. Adding too many attributes could result in a
200-
//! proliferation of terms and data.
199+
//! It's important to note that the more annotations that are added to a field the more index terms that will be generated.
200+
//! Adding too many attributes could result in a proliferation of terms and data.
201+
//!
202+
//! The previous example for example would have the following terms generated:
203+
//!
204+
//! - One term for the exact index on email
205+
//! - One term for the exact index on name
206+
//! - Up to 25 terms for the prefix index on name
207+
//! - Up to 25 terms for the compound index of email and name
208+
//!
209+
//! This would mean a total of 53 records would be inserted.
201210
//!
202211
//! ## Storing and Retrieving Records
203212
//!

0 commit comments

Comments
 (0)