Skip to content

Commit ab99168

Browse files
docs(firestore): re-add sub-sub-headings
1 parent 4e69e24 commit ab99168

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/guide/firestore.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ You can build paths to your data by using the ``collection()`` and ``document()`
3636
Save Data
3737
---------
3838

39+
set
40+
^^^
41+
3942
To store data in a collection named ``Marvels`` and a document inside
4043
the collection named ``Movies``, use ``set()`` method.
4144

@@ -59,6 +62,8 @@ the collection named ``Movies``, use ``set()`` method.
5962
document.
6063

6164

65+
add
66+
^^^
6267

6368
To store data in a collection named ``Marvels`` within an auto
6469
generated document ID, use ``add()`` method.
@@ -82,6 +87,12 @@ generated document ID, use ``add()`` method.
8287
Read Data
8388
---------
8489

90+
|document-get|
91+
^^^^^^^^^^^^^^
92+
93+
.. |document-get| replace::
94+
get
95+
8596
To read data from an existing document ``Movies`` of the collection
8697
``Marvels``, use ``get()`` method.
8798

@@ -103,6 +114,11 @@ It is possible to filter the data of an document to receive specific fields.
103114
..
104115
105116

117+
|collection-get|
118+
^^^^^^^^^^^^^^^^
119+
120+
.. |collection-get| replace::
121+
get
106122

107123
To fetch data regarding all existing document (document ID and the data
108124
it contains) of an collection ``Marvels``, use ``get()`` method.
@@ -112,10 +128,16 @@ it contains) of an collection ``Marvels``, use ``get()`` method.
112128
fsdb.collection('Marvels').get()
113129
..
114130
131+
.. warning::
132+
This ``get()`` method is different from the above stated one, and
133+
receives different parameters and returns different output.
115134

116135
Update Data
117136
-----------
118137

138+
update
139+
^^^^^^
140+
119141
To add more data to an existing document, use ``update()`` method.
120142

121143
.. code-block:: python
@@ -163,6 +185,12 @@ To add an item to an array field in an existing document, use
163185
Delete Data
164186
-----------
165187

188+
|delete-update|
189+
^^^^^^^^^^^^^^^
190+
191+
.. |delete-update| replace::
192+
update
193+
166194
To remove an field from an existing document, use ``update()`` method.
167195

168196
.. code-block:: python
@@ -191,6 +219,8 @@ To remove an item to an array field in an existing document, use
191219
..
192220
193221

222+
delete
223+
^^^^^^
194224

195225
To remove an existing document in a collection, use ``delete()``
196226
method.

0 commit comments

Comments
 (0)