Skip to content

Commit 67f4461

Browse files
committed
update docs
Signed-off-by: liyun <[email protected]>
1 parent 2c5ca81 commit 67f4461

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

site/en/userGuide/schema/add-fields-to-an-existing-collection.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -331,9 +331,9 @@ Expected behavior:
331331

332332
## FAQ
333333

334-
### Can I enable dynamic schema functionality by adding a `#meta` field?
334+
### Can I enable dynamic schema functionality by adding a `$meta` field?
335335

336-
No, you cannot use `add_collection_field` to add a `#meta` field to enable dynamic field functionality. For example, the code below will not work:
336+
No, you cannot use `add_collection_field` to add a `$meta` field to enable dynamic field functionality. For example, the code below will not work:
337337

338338
<div class="multipleCode">
339339
<a href="#python">Python</a>
@@ -400,7 +400,7 @@ To enable dynamic schema functionality:
400400

401401
### What happens when I add a field with the same name as a dynamic field key?
402402

403-
When your collection has dynamic field enabled (`#meta` exists), you can add static fields that have the same name as existing dynamic field keys. The new static field will mask the dynamic field key, but the original dynamic data is preserved.
403+
When your collection has dynamic field enabled (`$meta` exists), you can add static fields that have the same name as existing dynamic field keys. The new static field will mask the dynamic field key, but the original dynamic data is preserved.
404404

405405
To avoid possible conflicts in field names, consider the name for the field to add by referring to existing fields and dynamic field keys before actually adding it.
406406

@@ -575,7 +575,7 @@ Expected behavior:
575575

576576
- **New entities** must use the static field's data type (`INT64`)
577577

578-
- **Original dynamic field key values** are preserved and accessible via `#meta` syntax
578+
- **Original dynamic field key values** are preserved and accessible via `$meta` syntax
579579

580580
- **The static field masks the dynamic field key** in normal queries
581581

site/en/userGuide/schema/json-field-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The table below summarizes the key differences between a JSON field and the dyna
5858
<tr>
5959
<td><p>Schema definition</p></td>
6060
<td><p>A scalar field that must be explicitly declared in the collection schema with the <code>DataType.JSON</code> type.</p></td>
61-
<td><p>A hidden JSON field (named <code>#meta</code>) that automatically stores undeclared fields.</p></td>
61+
<td><p>A hidden JSON field (named <code>$meta</code>) that automatically stores undeclared fields.</p></td>
6262
</tr>
6363
<tr>
6464
<td><p>Use case</p></td>
@@ -73,7 +73,7 @@ The table below summarizes the key differences between a JSON field and the dyna
7373
<tr>
7474
<td><p>Querying</p></td>
7575
<td><p>Query using your field name or target key inside the JSON field: <code>metadata["key"]</code>.</p></td>
76-
<td><p>Query directly using the dynamic field key: <code>"dynamic_key"</code> or via <code>#meta</code>: <code>#meta["dynamic_key"]</code></p></td>
76+
<td><p>Query directly using the dynamic field key: <code>"dynamic_key"</code> or via <code>$meta</code>: <code>$meta["dynamic_key"]</code></p></td>
7777
</tr>
7878
</table>
7979

0 commit comments

Comments
 (0)