Skip to content

Commit b4e9573

Browse files
author
Bob Grabar
committed
DOCS-664 review edits
1 parent 368de65 commit b4e9573

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

source/faq/developers.txt

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -171,28 +171,27 @@ storage efficiently in such situations.
171171
previously separate field was indexed, this eliminates an extra index,
172172
too.
173173

174-
- Use small field names. This is recommended only in certain situations.
174+
- Use shorter field names. This is recommended only in certain situations.
175175

176-
Consider the following record:
176+
For example, the strings ``last_name`` and ``best_score`` in this
177+
record:
177178

178179
.. code-block:: javascript
179180

180181
{ last_name : "Smith", best_score: 3.9 }
181182

182-
The strings ``last_name`` and ``best_score`` are stored in each
183-
object's BSON. Using shorter strings would save space:
183+
could be shortened to ``lname`` and ``score``, which would save 9
184+
bytes per document:
184185

185186
.. code-block:: javascript
186187

187188
{ lname : "Smith", score : 3.9 }
188189

189-
In this case, the shorter names would save 9 bytes per document. This
190-
reduces expressiveness and is not recommended unless you have a
191-
collection where this is of significant concern.
192-
193-
Shortening field names does not reduce index size. Field names are not
194-
stored in indexes, as indexes have a predefined structure. In general
195-
it is not necessary to use short field names.
190+
Shortening field names reduces expressiveness and is not recommended
191+
unless you have a collection where document overhead is of significant
192+
concern. Also, shortening field names does not reduce index size, as
193+
indexes have a predefined structure. In general it is not necessary to
194+
use short field names.
196195

197196
- Embed documents.
198197

0 commit comments

Comments
 (0)