UUID()

On this page

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoDB server.

Definition

Generates a BSON UUID object.

UUID() has the following syntax:

UUID(<string>)

Parameter	Type	Description
`hex`	string	Optional. Specify a 36 character string to convert to a UUID BSON object. If not provided, MongoDB generates a random UUID in RFC 4122 v4 format. Changed in version 3.6: In earlier versions of `mongosh`, `UUID()` required a hexadecimal string argument. See the 3.4 manual.

Returns:	A BSON UUID object.

Create a 36 character string you wish to convert to a UUID:

var myuuid = '3b241101-e2bb-4255-8caf-4136c566a962'

The following command outputs the myuuid variable as a BSON UUID object:

UUID(myuuid)

This command generates the following output:

UUID("3b241101-e2bb-4255-8caf-4136c566a962")

You can run the UUID() method without specifying an argument to generate a random UUID:

UUID()

This command outputs a random UUID in the following form:

UUID("dee11d4e-63c6-4d90-983c-5c9f1e79e96c")

Changed in version 3.6: In earlier versions of mongosh, UUID() required a hexadecimal string argument.