insertOne.txt

.. _golang-insert-one:

=========================
Insert a Document Example
=========================

.. default-domain:: mongodb

You can insert a document into a collection by using the ``InsertOne()``
method.

Example
-------

.. include:: /includes/usage-examples/run-example-tip.rst

This example uses the following ``Restaurant`` struct as a model for documents
in the ``restaurants`` collection:

.. literalinclude:: /includes/usage-examples/code-snippets/insertOne.go
   :start-after: start-restaurant-struct
   :end-before: end-restaurant-struct
   :language: go 
   :copyable: 
   :dedent:

The ``omitempty`` :ref:`struct tag<golang-struct-tags>` omits the corresponding 
field from the inserted document when left empty.

The following example inserts a new document to the ``restaurants`` collection:

.. include:: /includes/fundamentals/automatic-db-coll-creation.rst

.. literalinclude:: /includes/usage-examples/code-snippets/insertOne.go
   :start-after: begin insertOne
   :end-before: end insertOne
   :emphasize-lines: 4
   :language: go
   :dedent:

View a `fully runnable example <{+example+}/insertOne.go>`__

Expected Result
---------------

After you run the full example, you can find the following inserted
document in the ``restaurants`` collection:

.. code-block:: json
   :copyable: false

   {
     "_id": ObjectId("..."),
     "name": "8282",
     "cuisine": "Korean"
   }

For an example on how to find a document, see the :ref:`golang-find-one` usage 
example.

Additional Information
----------------------

To learn more about inserting documents, see 
:ref:`inserting documents <golang-insert-guide>`.

API Documentation
~~~~~~~~~~~~~~~~~

`InsertOne() <{+api+}/mongo#Collection.InsertOne>`__