DOCSP-39983: Add an optional bool flag to the write function to skip writing null fields (#21)

* initial commit

* grammar

* removing autobuilder workflow

* feedback

* move note

* stringify

Author: mayaraman19

.github/workflows/check-autobuilder.yml

@@ -211,6 +211,64 @@ You can use the ``write()`` method to write objects of the following types to Mo
 
    NumPy arrays are specified as ``dict[str, ndarray]``.
 
+Ignore Empty Values
+~~~~~~~~~~~~~~~~~~~
+
+The ``write()`` method optionally accepts a boolean ``exclude_none`` parameter.
+If you set this parameter to ``True``, the driver doesn't write empty values to
+the database. If you set this parameter to ``False`` or leave it blank, the 
+driver writes ``None`` for each empty field.
+
+The code in the following example writes an Arrow ``Table`` to MongoDB twice. One
+of the values in the ``'b'`` field is set to ``None``. 
+
+The first call to the ``write()`` method omits the ``exclude_none`` parameter, 
+so it defaults to ``False``. All values in the ``Table``, including ``None``, 
+are written to the database. The second call to the ``write()`` method sets 
+``exclude_none`` to ``True``, so the empty value in the ``'b'`` field is ignored.
+
+.. io-code-block::
+   :copyable: true
+
+   .. input:: 
+      :language: python
+      :emphasize-lines: 12, 16
+      
+      data_a = [1, 2, 3]
+      data_b = [1, None, 3]
+
+      data = Table.from_pydict(
+         {
+            "a": data_a,
+            "b": data_b,
+         },
+      )
+
+      coll.drop()
+      write(coll, data)
+      col_data = list(coll.find({}))
+
+      coll.drop()
+      write(coll, data, exclude_none=True)
+      col_data_exclude_none = list(coll.find({}))
+
+      print(col_data)
+
+      print(col_data_exclude_none)
+
+   .. output::
+      :language: json
+      :visible: false
+      :emphasize-lines: 2, 6
+
+      {'_id': ObjectId('...'), 'a': 1, 'b': 1}
+      {'_id': ObjectId('...'), 'a': 2, 'b': None}
+      {'_id': ObjectId('...'), 'a': 3, 'b': 3}
+
+      {'_id': ObjectId('...'), 'a': 1, 'b': 1}
+      {'_id': ObjectId('...'), 'a': 2}
+      {'_id': ObjectId('...'), 'a': 3, 'b': 3}
+
 Writing to Other Formats
 ------------------------