Skip to content

Commit c176140

Browse files
committed
Add details about filtering by mapped property name
1 parent 914b2f3 commit c176140

File tree

3 files changed

+138
-0
lines changed

3 files changed

+138
-0
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
In the following example, the ``Frog`` object has a property named ``species``
2+
in the code that is remapped to ``latin_name`` in the database:
3+
4+
.. literalinclude:: /examples/generated/kotlin/Schema.snippet.define-persisted-name.kt
5+
:language: kotlin
6+
7+
In the database, we can filter by either property name and return the same
8+
results.
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
.. tabs-drivers::
2+
3+
tabs:
4+
- id: cpp-sdk
5+
content: |
6+
7+
.. literalinclude:: /examples/MissingPlaceholders/example.cpp
8+
:language: cpp
9+
:copyable: false
10+
11+
- id: csharp
12+
content: |
13+
14+
.. literalinclude:: /examples/MissingPlaceholders/example.cs
15+
:language: csharp
16+
:copyable: false
17+
18+
- id: dart
19+
content: |
20+
21+
.. literalinclude:: /examples/MissingPlaceholders/example.dart
22+
:language: dart
23+
:copyable: false
24+
25+
- id: java
26+
content: |
27+
28+
.. literalinclude:: /examples/MissingPlaceholders/example.java
29+
:language: java
30+
:copyable: false
31+
32+
- id: java-kotlin
33+
content: |
34+
35+
.. literalinclude:: /examples/MissingPlaceholders/example-java-kotlin.kt
36+
:language: kotlin
37+
:copyable: false
38+
39+
- id: javascript
40+
content: |
41+
42+
.. literalinclude:: /examples/MissingPlaceholders/example.js
43+
:language: javascript
44+
:copyable: false
45+
46+
- id: kotlin
47+
content: |
48+
49+
.. literalinclude:: /examples/generated/kotlin/ReadTest.snippet.query-remapped-property.kt
50+
:language: kotlin
51+
52+
- id: objectivec
53+
content: |
54+
55+
.. literalinclude:: /examples/MissingPlaceholders/example.m
56+
:language: objectivec
57+
:copyable: false
58+
59+
- id: swift
60+
content: |
61+
62+
.. literalinclude:: /examples/MissingPlaceholders/example.swift
63+
:language: swift
64+
:copyable: false
65+
66+
- id: typescript
67+
content: |
68+
69+
.. literalinclude:: /examples/MissingPlaceholders/example.ts
70+
:language: typescript
71+
:copyable: false

source/sdk/crud/read.txt

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1666,6 +1666,65 @@ method.
16661666
Filter by Remapped Property Name
16671667
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16681668

1669+
If your data model includes stored property names that you have
1670+
:ref:`mapped to different names <sdks-map-db-name>`, you can filter by
1671+
both the mapped property name used in your code and the stored property
1672+
name that's persisted in the database.
1673+
1674+
.. tabs-drivers::
1675+
1676+
.. tab::
1677+
:tabid: cpp-sdk
1678+
1679+
1680+
1681+
.. tab::
1682+
:tabid: csharp
1683+
1684+
1685+
1686+
.. tab::
1687+
:tabid: dart
1688+
1689+
1690+
1691+
.. tab::
1692+
:tabid: java
1693+
1694+
1695+
1696+
.. tab::
1697+
:tabid: java-kotlin
1698+
1699+
1700+
1701+
.. tab::
1702+
:tabid: javascript
1703+
1704+
1705+
1706+
.. tab::
1707+
:tabid: kotlin
1708+
1709+
.. include:: /includes/api-details/kotlin/crud/read-filter-by-remapped-property-name-description.rst
1710+
1711+
.. tab::
1712+
:tabid: objectivec
1713+
1714+
1715+
1716+
.. tab::
1717+
:tabid: swift
1718+
1719+
1720+
1721+
.. tab::
1722+
:tabid: typescript
1723+
1724+
1725+
1726+
.. include:: /includes/sdk-examples/crud/read-filter-by-remapped-property-name.rst
1727+
16691728
.. _sdks-read-filter-by-fts:
16701729

16711730
Filter by Full-Text Search Property

0 commit comments

Comments
 (0)