ObjectId.createFromHexString.txt

.. _ObjectId.createFromHexString:

==============================
ObjectId.createFromHexString()
==============================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

Creates an :term:`ObjectId` from a hexadecimal value.

Compatibility
-------------

This method is available in deployments hosted in the following environments: 

.. include:: /includes/fact-environments-atlas-only.rst

.. include:: /includes/fact-environments-onprem-only.rst

Syntax
------

.. method:: ObjectId.createFromHexString( <hexadecimalString> )

The ``hexadecimalString`` field specifies a string that contains a 24
character hexadecimal value. For example,
``"64c13ab08edf48a008793cac"``.

Examples
--------

The following examples show how to add an object identifier to a
document using ``ObjectId.createFromHexString()`` and how the object
identifier appears in the output when retrieved.

Create Collection Containing Document with Object Identifier
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The following example creates a collection named
``objectIdentifierValuesFromHex``:

.. code-block:: javascript
   :emphasize-lines: 3

   db.objectIdentifierValuesFromHex.insertOne( {
      _id: 0,
      objectIdentifierValue: ObjectId.createFromHexString( "64c13ab08edf48a008793cac" )
   } )

The ``objectIdentifierValue`` field contains the object identifier
created from the hexadecimal string specified in
``ObjectId.createFromHexString()``.

Retrieve Document from Collection with Object Identifier
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The following example retrieves the document:

.. code-block:: javascript

   db.objectIdentifierValuesFromHex.findOne( { _id: 0 } )

Example output:

.. code-block:: javascript
   :copyable: false
   :emphasize-lines: 3

   {
      _id: 0,
      objectIdentifierValue: ObjectId("64c13ab08edf48a008793cac")
   }