To use the MongoDB API, you can create and configure a new Autonomous Database or modify the configuration of an existing Autonomous Database by configuring ACLs or by defining a private endpoint.

Configure a New Autonomous Database for MongoDB

Follow the steps in Provision or Clone an Autonomous Database, up to the point where you select your Network Access Type.

At this point, to use Oracle Database API for MongoDB configure secure access by selecting and configuring one of these network access types:

• Secure access from allowed IPs and VCNs only

• Private endpoint access only

  See Configure Network Access with Private Endpoints for information on configuring an Autonomous Database instance with a private endpoint.

Configure an Existing Autonomous Database for MongoDB

Open the Oracle Cloud Infrastructure Console for your Autonomous Database instance.

Note

To use Oracle Database API for MongoDB the Network must be configured and the Access type must be either: Allow secure access from specified IPs and VCNs or Virtual Cloud Network.

After you configure the network access for the Autonomous Database instance, enable the MongDB API.

1. On the Autonomous Database details page, select the Tool configuration tab.
2. Click Edit tool configuration.
3. In the MongoDB API row, select in the Enable tool column to show Enabled.
4. Click Apply.

1. On the Autonomous Database details page, select the Tool configuration tab.
2. In the MongoDB API row, under Access URL click Copy.

• Retrieve the Autonomous Database Connection String from Database Actions
  

1. Login as the test user. See Create a Test Autonomous Database User for MongoDB for more information.

   $ mongosh --tls --tlsAllowInvalidCertificates 'mongodb://TESTUSER:<PASSWORD>@<database URL>.
   <OCI region>.oraclecloudapps.com:27017/admin?authMechanism=PLAIN&authSource=$external&ssl=true&loadBalanced=false'
   Current Mongosh Log ID: 614c9e2a01e3575c8c0b2ec7
   Connecting to:         mongodb://TESTUSER:<PASSWORD>@<database URL>.<OCIregion>.oraclecloudapps.com:27017/admin?
   authMechanism=PLAIN&authSource=$external&tls=true&loadBalanced=false
   Using MongoDB:                   3.6.2
   Using Mongosh:                   1.0.7
   For mongosh info see: https://docs.mongodb.com/mongodb-shell/admin
   > show dbs
   testuser    0 B
   > 

   Note
   
   

   Use URI percent-encoding to replace any reserved characters in your connection-string URI — in particular, characters in your username and password. These are the reserved characters and their percent encodings:

   !	#	$	%	&	'	(	)	*	+
   %21	%23	%24	%25	%26	%27	%28	%29	%2A	%2B

   ,	/	:	;	=	?	@	[	]
   %2C	%2F	%3A	%3B	%3D	%3F	%40	%5B	%5D

   For example, if your username is RUTH and your password is @least1/2#? then your MongoDB connection string to server <server> might look like this:

   'mongodb://RUTH:%40least1%2F2%23%3F@<server>:27017/ruth/ ...'

   Depending on the tools or drivers you use, you might be able to provide a username and password as separate parameters, instead of as part of a URI connection string. In that case you likely won't need to encode any reserved characters they contain.

   See also:

   • Percent Encoding - Reserved Characters

   • Uniform Resource Identifier (URI): Generic Syntax

2. Create a collection and insert documents into your collection.

   testuser> show collections
   
   testuser> db.createCollection( 'fruit' )
   { ok: 1 }
   testuser> show collections
   fruit
   testuser> db.fruit.insertOne( {name:"orange", count:42} )
   {
     acknowledged: true,
     insertedId: ObjectId("614ca31fdab254f63e4c6b47")
   }
   testuser> db.fruit.insertOne( {name:"apple", count:12, color: "red"} )
   {
     acknowledged: true,
     insertedId: ObjectId("614ca340dab254f63e4c6b48")
   }
   testuser> db.fruit.insertOne( {name:"pear", count:5} )
   {
     acknowledged: true,
     insertedId: ObjectId("614ca351dab254f63e4c6b49")
   }
   testuser>

3. Query the collection using a SQL client such as Database Actions.

   SELECT
        f.json_document.name, 
        f.json_document.count, 
        f.json_document.color
   FROM fruit f;

   
   

1. Download Node.js. If you have already downloaded or installed Node.js for your environment, you can skip this step.

   $ wget https://nodejs.org/dist/latest-v14.x/node-v14.17.5-linux-x64.tar.xz

2. Extract the contents of the Node,js archive. If you have already downloaded or installed Node.js for your environment, you can skip this step.

   $ tar -xf node-v14.17.5-linux-x64.tar.xz

3. Configure the PATH environment variable. If you have already downloaded or installed Node.js for your environment, you can skip this step.

   $ export PATH="`pwd`"/node-v14.17.5-linux-x64/bin:$PATH

4. Test your connection with a Javascript example.
   1. Create a new directory.

      $ mkdir autonomous_mongodb
      $ cd autonomous_mongodb
      $ npm init –y

   2. Install mongodb dependency.

      $ npm install mongodb

   3. Create a JavaScript application named connect.js.

      const { MongoClient } = require("mongodb");
      const uri =
         "mongodb://TESTUSER:<PASSWORD>@<Database URI>.<OCI region>.oraclecloudapps.com:27017/admin?authMechanism=PLAIN&authSource=$external&ssl=true&loadBalanced=false";
      
      const client = new MongoClient(uri);
      
      async function run() {
        try {
              await client.connect();
      
              const database = client.db('admin');
              const movies = database.collection('movies');
      
              // Insert a movie
              const doc = { title: 'Back to the Future', 
                            year: 1985, genres: ['Adventure', 'Comedy', 'Sci-Fi'] }
              const result = await movies.insertOne(doc);
      
              // Query for a movie that has the title 'Back to the Future' :)
              const query = { title: 'Back to the Future' };
              const movie = await movies.findOne(query);
      
              console.log(movie);
        } finally {
           // Ensures that the client will close when you finish/error
           await client.close();
        }
      }
      run().catch(console.dir);
      

      Note
      
      

      Use URI percent-encoding to replace any reserved characters in your connection-string URI — in particular, characters in your username and password. These are the reserved characters and their percent encodings:

      !	#	$	%	&	'	(	)	*	+
      %21	%23	%24	%25	%26	%27	%28	%29	%2A	%2B

      ,	/	:	;	=	?	@	[	]
      %2C	%2F	%3A	%3B	%3D	%3F	%40	%5B	%5D

      For example, if your username is RUTH and your password is @least1/2#? then your MongoDB connection string to server <server> might look like this:

      'mongodb://RUTH:%40least1%2F2%23%3F@<server>:27017/ruth/ ...'

      Depending on the tools or drivers you use, you might be able to provide a username and password as separate parameters, instead of as part of a URI connection string. In that case you likely won't need to encode any reserved characters they contain.

      See also:

      • Percent Encoding - Reserved Characters

      • Uniform Resource Identifier (URI): Generic Syntax

   4. Run the example. The output should look similar to the following.

      $ node connect
      {
        _id: new ObjectId("611e3266005202371acf27c1"),
        title: 'Back to the Future',
        year: 1985,
        genres: [ 'Adventure', 'Comedy', 'Sci-Fi' ]
      }