Utilisation de l'API Oracle Database pour MongoDB

Oracle Database API for MongoDB permet de se connecter à Oracle Autonomous Database à l'aide des pilotes et outils de langage MongoDB.

Oracle Database API for MongoDB tire parti des fonctionnalités de base de données convergée d'Autonomous Database pour gérer plusieurs types de données, y compris les données JSON, au sein d'une seule base de données. Par exemple, ces fonctionnalités de base de données convergée vous permettent d'utiliser SQL pour interroger ou mettre à jour des données JSON.

Remarque

MongoDB exige que vous configuriez l'accès réseau pour utiliser des listes de contrôle d'accès ou que vous définissiez une adresse privée pour l'instance Autonomous Database.

See Oracle Database API for MongoDB for more information.

Pour plus d'informations, reportez-vous à A propos d'Autonomous JSON Database.

Pour plus d'informations, reportez-vous à la section A propos des types Autonomous Database.

Sujets

Configurer l'accès pour MongoDB et activer MongoDB

L'API Oracle Database API for MongoDB vous permet d'utiliser une base de données Oracle Autonomous Database comme banque de données.

Pour utiliser l'API MongoDB, vous pouvez créer et configurer une instance Autonomous Database ou modifier la configuration d'une instance Autonomous Database existante.

Remarque

MongoDB exige que vous configuriez l'accès réseau pour utiliser des listes de contrôle d'accès ou que vous définissiez une adresse privée pour l'instance Autonomous Database. En plus de configurer l'accès réseau, vous devez activer l'API MongoDB sur l'instance Autonomous Database.

Configurer l'accès pour MongoDB

Pour utiliser l'API MongoDB, vous pouvez créer et configurer une instance Autonomous Database, ou modifier la configuration d'une instance Autonomous Database existante en configurant des listes de contrôle d'accès ou en définissant une adresse privée.

Configuration d'une nouvelle instance Autonomous Database pour MongoDB

Suivez les étapes décrites dans Provisionnement ou clonage d'une instance Autonomous Database, jusqu'au point où vous sélectionnez votre type d'accès réseau.

Description de l'image adb_network_access_acl_provision.png ci-après
Description de l'illustration adb_network_access_acl_provision.png

A ce stade, pour utiliser l'API Oracle Database API for MongoDB, configurez l'accès sécurisé en sélectionnant et en configurant l'un des types d'accès réseau suivants :

  • Accès sécurisé à partir des adresses IP et des réseaux cloud virtuels autorisés uniquement

  • Accès à l'adresse privée uniquement

    Pour plus d'informations sur la configuration d'une instance Autonomous Database avec une adresse privée, reportez-vous à Configuration de l'accès réseau avec des adresses privées.

Configuration d'une instance Autonomous Database existante pour MongoDB

Ouvrez la console Oracle Cloud Infrastructure pour votre instance Autonomous Database.



Remarque

Pour utiliser l'API Oracle Database API for MongoDB, le réseau doit être configuré et le type d'accès doit être : accès sécurisé à partir des adresses IP et des réseaux cloud virtuels autorisés uniquement ou accès à l'adresse privée uniquement.

Configuration des listes de contrôle d'accès (ACL)

Pour plus d'informations, reportez-vous à Configuration de listes de contrôle d'accès pour une instance Autonomous Database existante.

Pour configurer votre liste de contrôle d'accès pour une adresse IP, vous devez obtenir l'adresse IP publique. Il existe plusieurs façons d'afficher votre adresse IP publique :
  • Dans la zone d'accès réseau choisie, cliquez sur Ajouter mon adresse IP. Votre adresse IP est alors copiée dans le champ Valeurs.

  • Après avoir désactivé un VPN, utilisez le site Web WhatIsMyIP.
  • Après avoir désactivé un VPN, utilisez la commande curl : curl -s https://ifconfig.me.
Remarque

Les adresses IP publiques peuvent changer. Toute modification de votre adresse IP publique nécessitera une modification de l'ACL. Si vous ne parvenez pas à accéder à votre base de données, votre liste de contrôle d'accès doit être vérifiée.

Types d'ACL et cas d'utilisation

Type d'ACL Cas d'emploi Commentaires
Adresse IP Ordinateurs portables de développement local partageant la même adresse IP publique Le moyen le plus simple de commencer. Tout ordinateur portable connecté à ce réseau local aura accès à la base de données avec les informations d'identification de la base de données.
Bloc CIDR Ordinateur portable de développement local Utiliser la notation IPv4/32
Adresses IP séparées par des virgules Petit nombre d'ordinateurs portables de développement local connectés sur des réseaux locaux distincts (ayant des adresses IP publiques distinctes) Peut être fastidieux à gérer avec plus de 10 ordinateurs portables.
Bloc CIDR Ordinateurs portables de développement local connectés sur le même sous-réseau exposé à Internet (chaque ordinateur portable possède sa propre adresse IP publique) Faites confiance à la notation de bloc CIDR. Pour plus d'informations, reportez-vous à calculateur ici. Exemple : 89.84.109.0/24 donne 256 adresses IP possibles de 89.84.109.0 à 89.84.109.255
VCN avec bloc CIDR Pour le pipeline de test, de production ou d'intégration continue et de déploiement continu hébergé sur OCI avec ses propres instances VCN et Compute Affectez un compartiment OCI par type d'environnement.
Mélange de l'adresse IP et du VCN avec le bloc CIDR Ordinateur portable de développement local accédant à une instance Autonomous Database de test avec des connexions à partir de l'environnement de test ou du pipeline d'intégration continue et de déploiement continu Option de configuration commune pour les travaux de développement en cours.

Activation de l'API MongoDB sur Autonomous Database

Une fois l'accès réseau configuré pour l'instance Autonomous Database, activez l'API MongDB.

Afin d'activer l'API MongoDB pour une instance existante, procédez comme suit :

  1. Sur la page de détails d'Autonomous Database, sélectionnez l'onglet Configuration de l'outil.
  2. Cliquez sur Modifier la configuration d'outil.
  3. Dans la ligne d'API MongoDB, sélectionnez l'option Activer l'outil dans la colonne Activé.
  4. Cliquez sur Appliquer.

L'état de cycle de vie passe à la mise à jour jusqu'à ce que MongoDB soit activé.

Vous pouvez également activer l'API MongoDB lorsque vous provisionnez ou clonez une instance en sélectionnant Afficher les options avancées et en sélectionnant l'onglet Outils.

Pour plus d'informations, reportez-vous à Gestion des outils intégrés Autonomous Database.

Gestion des utilisateurs pour MongoDB

L'API Oracle Database API for MongoDB vous permet d'utiliser une base de données Oracle Autonomous Database comme banque de données. Pour utiliser une instance Autonomous Database existante à cette fin, voici le workflow.

Oracle Database API for MongoDB permet de mettre en correspondance des objets Autonomous Database avec des objets MongoDB comme suit :

Objet MongoDB Objet Oracle Autonomous Database
base de données schéma
collection tableau
document document (dans une colonne)

Par exemple, vous pouvez créer une collection à l'aide de l'API Oracle Database API for MongoDB comme suit :

  use scott;
  db.createCollection('fruit');

Une table nommée FRUIT est créée dans le schéma SCOTT.

Lorsque vous vous vous connectez à l'API Oracle Database API for MongoDB, vous authentifiez à l'aide d'un nom utilisateur et d'un mot de passe Autonomous Database. Cette connexion authentifiée accède ensuite aux collections du schéma correspondant. Cet utilisateur doit répondre aux exigences suivantes :

Remarque

Le rôle DWROLE dans Autonomous Database contient ces rôles, entre autres.

L'accès aux schémas qui ne sont pas accordés à l'utilisateur est interdit. Par exemple, l'utilisateur SCOTT ne peut accéder qu'aux collections du schéma SCOTT. Il y a une exception. Si l'utilisateur authentifié dispose des privilèges Autonomous Database CREATE USER, ALTER USER et DROP USER, il peut accéder à n'importe quel schéma compatible ORDS.

En outre, un utilisateur disposant de ces privilèges peut créer implicitement des schémas. Autrement dit, lorsque l'utilisateur crée une collection dans une base de données qui n'existe pas, le schéma est créé automatiquement. See Oracle Database API for MongoDB for more information.

Création d'un utilisateur Autonomous Database de test pour MongoDB

Les étapes qui suivent utilisent Database Actions pour créer un utilisateur test doté des rôles appropriés. Vous pouvez également utiliser Database Actions SQL ou d'autres utilitaires de ligne de commande SQL pour exécuter les instructions SQL directement. Pour plus d'informations, reportez-vous à Création d'utilisateurs sur Autonomous Database - Connexion à un outil client.
  1. Ouvrez la console Oracle Cloud Infrastructure pour votre instance Autonomous Database.
  2. Sélectionnez Database Actions.
  3. Dans la fenêtre de lancement de Database Actions, sélectionnez Administration > Utilisateurs de base de données.
  4. Sélectionnez + Créer un utilisateur sur la page Utilisateurs de base de données.
  5. Entrez un nom utilisateur et un mot de passe pour l'utilisateur de test. Sélectionnez Accès Web, puis définissez le quota sur les données de tablespace.
  6. Sélectionnez l'onglet Rôles accordés.
  7. Outre les rôles par défaut, sélectionnez et ajoutez le rôle SODA_APP pour l'utilisateur.
  8. Cliquez sur le bouton Créer un utilisateur.
Vous pouvez utiliser cet utilisateur, ou un utilisateur authentifié de la même manière, à des fins de test. Pour plus d'informations, reportez-vous à Test de la connexion à l'aide de la ligne de commande.

Connexion d'applications MongoDB à Autonomous Database

La connexion de votre application MongoDB à Autonomous Database comprend plusieurs étapes, en fonction de vos exigences.

Extraction de la chaîne de connexion MongoDB Autonomous Database

Vous pouvez extraire la chaîne de connexion d'API MongoDB à partir de la console Oracle Cloud Infrastructure.

Après avoir obtenu la chaîne de connexion à l'API MongoDB, vous pouvez utiliser le shell MongoDB, qui est un utilitaire de ligne de commande, pour vous connecter et interroger vos données.

Vous devez d'abord configurer l'accès réseau et activer l'API MongoDB. Pour plus d'informations, reportez-vous à Configuration de l'accès pour MongoDB.

Pour extraire la chaîne de connexion à l'API MongoDB, procédez comme suit :

  1. Sur la page de détails d'Autonomous Database, sélectionnez l'onglet Configuration de l'outil.
  2. Sur la ligne d'API MongoDB, sous URL d'accès, cliquez sur Copier.
Extraction de la chaîne de connexion à Autonomous Database à partir de Database Actions

Utilisez le shell MongoDB, qui est un utilitaire de ligne de commande utilisé pour connecter et interroger vos données.
  1. Vous pouvez extraire la chaîne de connexion de votre instance Autonomous Database avec Database Actions.

    Pour plus d'informations, reportez-vous à Accès à Database Actions en tant qu'administrateur.

  2. Dans la fenêtre de lancement Database Actions, sous Services associés, cliquez sur API Oracle Database API for MongoDB.
  3. Sur la page API Oracle Database API for MongoDB, cliquez sur Copier.

Tester la connexion à l'aide de la ligne de commande

  1. Connectez-vous en tant qu'utilisateur de test. Pour plus d'informations, reportez-vous à Création d'un utilisateur Autonomous Database de test pour MongoDB.
    $ 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
    > 
    Remarque

    Utilisez l'encodage de pourcentage URI pour remplacer tous les caractères réservés dans votre URI de chaîne de connexion, en particulier les caractères de votre nom d'utilisateur et de votre mot de passe. Voici les caractères réservés et leur codage en pourcentage :

    ! # $ % & ' ( ) * +
    %21 %23 %24 %25 %26 %27 %28 %29 %2A %2B
    , / : ; = ? @ [ ]
    %2C %2F %3A %3B %3D %3F %40 %5B %5D

    Par exemple, si votre nom utilisateur est RUTH et que votre mot de passe est @least1/2#?, la chaîne de connexion MongoDB au serveur <server> peut se présenter comme suit :

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

    Selon les outils ou les pilotes que vous utilisez, vous pouvez fournir un nom d'utilisateur et un mot de passe en tant que paramètres distincts, au lieu de faire partie d'une chaîne de connexion URI. Dans ce cas, vous n'aurez probablement pas besoin de coder les caractères réservés qu'ils contiennent.

    Voir aussi :

  2. Créez une collection et insérez des documents dans votre 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. Interrogez la collection à l'aide d'un client SQL tel que Database Actions.
    SELECT
         f.json_document.name, 
         f.json_document.count, 
         f.json_document.color
    FROM fruit f;
    Description de l'image database_actions_sql_for_mongodb_use.png
    Description de l'illustration database_actions_sql_for_mongodb_use.png

Test de la connexion à l'aide d'une application Node.js

  1. Téléchargez Node.js. Si vous avez déjà téléchargé ou installé Node.js pour votre environnement, vous pouvez ignorer cette étape.
    $ wget https://nodejs.org/dist/latest-v14.x/node-v14.17.5-linux-x64.tar.xz
  2. Extrayez le contenu de l'archive Node,js. Si vous avez déjà téléchargé ou installé Node.js pour votre environnement, vous pouvez ignorer cette étape.
    $ tar -xf node-v14.17.5-linux-x64.tar.xz
  3. Configuration de la variable d'environnement PATH. Si vous avez déjà téléchargé ou installé Node.js pour votre environnement, vous pouvez ignorer cette étape.
    $ export PATH="`pwd`"/node-v14.17.5-linux-x64/bin:$PATH
  4. Testez votre connexion avec un exemple de Javascript.
    1. Créer un répertoire.
      $ mkdir autonomous_mongodb
      $ cd autonomous_mongodb
      $ npm init –y
    2. Installez la dépendance mongodb.
      $ npm install mongodb
    3. Créez une application JavaScript nommée 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);
      
      Remarque

      Utilisez l'encodage de pourcentage URI pour remplacer tous les caractères réservés dans votre URI de chaîne de connexion, en particulier les caractères de votre nom d'utilisateur et de votre mot de passe. Voici les caractères réservés et leur codage en pourcentage :

      ! # $ % & ' ( ) * +
      %21 %23 %24 %25 %26 %27 %28 %29 %2A %2B
      , / : ; = ? @ [ ]
      %2C %2F %3A %3B %3D %3F %40 %5B %5D

      Par exemple, si votre nom utilisateur est RUTH et que votre mot de passe est @least1/2#?, la chaîne de connexion MongoDB au serveur <server> peut se présenter comme suit :

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

      Selon les outils ou les pilotes que vous utilisez, vous pouvez fournir un nom d'utilisateur et un mot de passe en tant que paramètres distincts, au lieu de faire partie d'une chaîne de connexion URI. Dans ce cas, vous n'aurez probablement pas besoin de coder les caractères réservés qu'ils contiennent.

      Voir aussi :

    4. Exécutez l'exemple. La sortie doit ressembler à ce qui suit.
      $ node connect
      {
        _id: new ObjectId("611e3266005202371acf27c1"),
        title: 'Back to the Future',
        year: 1985,
        genres: [ 'Adventure', 'Comedy', 'Sci-Fi' ]
      }