Utilisation de l'extension Visual Studio Code pour le développement

Oracle NoSQL Database Cloud Service fournit une extension pour Microsoft Visual Studio Code qui vous permet de vous connecter à une instance en cours d'exécution d'Oracle NoSQL Database Cloud Service.

Vous pouvez utiliser l'extension de code Visual Studio (VS) pour Oracle NoSQL Database pour :

Affichez les tables dans une structure arborescente bien définie avec l'explorateur de tables.
Voir les informations sur les colonnes, les index, les clés primaires et les clés de partition pour une table.
Voir les données de colonne dans une structure JSON au format correct.
Créez des tables à l'aide d'une entrée de schéma basée sur un formulaire ou fournissez des instructions LDD.
Supprimez des tables.
Ajoutez de nouvelles colonnes à l'aide d'une entrée basée sur un formulaire ou fournissez des instructions LDD.
Déposer des colonnes.
Créer des index.
Abandonner les index.
Exécutez des interrogations SQL SELECT sur une table et affichez les résultats des interrogations sous forme de tableau.
Exécutez des instructions LMD pour mettre à jour, insérer et supprimer des données d'une table.
Téléchargez le résultat de l'interrogation après l'exécution de l'interrogation SELECT dans un fichier JSON.
Téléchargez chaque rangée du résultat obtenu après avoir exécuté l'interrogation SELECT dans un fichier JSON.

Cet article contient les informations suivantes :

Installation de l'extension de Visual Studio Code d'Oracle NoSQL Database

Vous pouvez installer l'extension d'Oracle NoSQL Database par rapport au code VS de deux façons. Installez à partir de Visual Studio Marketplace pour une installation en ligne ou installez-le à partir de l'ensemble VSIX à l'aide du fichier *.vsix pour une installation hors ligne.

Avant de pouvoir installer l'extension de code Visual Studio (VS) pour Oracle NoSQL Database, vous devez installer Visual Studio Code. Vous pouvez télécharger Visual Studio Code à partir d'ici.

Installer à partir du marché des applications Visual Studio
Installer à partir d'un VSIX

Dans Visual Studio Code, cliquez sur l'icône Extensions dans la navigation de gauche.
Vous pouvez également ouvrir la vue Extensions en appuyant sur :
- (Windows et Linux) Contrôle + Maj + X
- (macOS) Commande + Maj + X.
Recherchez le connecteur Oracle NoSQL Database dans le marché des extensions.
Cliquez sur Installer dans l'extension Connecteur Oracle NoSQL Database

Téléchargez le fichier VSIX pour Oracle NoSQL Database à partir du site de téléchargements Oracle NoSQL Database.
Dans Visual Studio Code, cliquez sur l'icône Extensions dans la navigation de gauche.
Vous pouvez également ouvrir la vue Extensions en appuyant sur :
- (Windows et Linux) Contrôle + Maj + X
- (macOS) Commande + Maj + X.
Dans la vue Extensions, cliquez sur le menu Actions supplémentaires (...), puis cliquez sur Installer à partir de VSIX....
Accédez à l'emplacement où le fichier *.vsix est stocké et cliquez sur Installer.

Connexion à Oracle NoSQL Database Cloud Service à partir de Visual Studio Code

L'extension de code de Visual Studio (VS) pour Oracle NoSQL Database fournit deux méthodes pour se connecter à Oracle NoSQL Database Cloud Service ou au simulateur Oracle NoSQL Database Cloud.

Vous pouvez soit fournir un fichier de configuration avec les informations de connexion, soit remplir les informations de connexion dans les champs spécifiques. Si vous utilisez un pilote Node.js et que les détails de connexion sont déjà enregistrés dans un fichier, utilisez l'option Connexion au moyen d'un fichier de configuration pour vous connecter à Oracle NoSQL Database Cloud Service. Sinon, si vous créez une connexion, utilisez l'option Remplir champs individuels.

Remplir des champs individuels
Connexion au moyen d'un fichier de configuration

Dans Visual Studio Code, cliquez sur la vue Oracle NoSQL DB dans la barre d'activité.
Ouvrez la page Afficher les paramètres de connexion d'Oracle NoSQL DB à partir de la palette de commandes ou de la vue Oracle NoSQL DB dans la barre d'activité.
- Ouvrir à partir de la palette de commandes
  1. Ouvrez la palette de commandes en appuyant sur :
    - (Windows et Linux) Contrôle + Maj + P
    - (macOS) Commande + Maj + P
  2. Dans la palette de commandes, sélectionnez OracleNoSQL : Afficher les paramètres de connexion.
    
    Conseil :
    Entrez oraclenosql dans la palette de commandes pour afficher toutes les commandes Oracle NoSQL DB que vous pouvez utiliser.
- Ouvrir à partir de la vue Oracle NoSQL DB
  1. Développez le volet EXPLORATEUR DE TABLE dans la barre de navigation de gauche s'il est réduit.
  2. Cliquez sur Ajouter une connexion pour ouvrir la page Afficher les paramètres de connexion d'Oracle NoSQL DB.
Dans la page Afficher les paramètres de connexion, cliquez sur Nuage ou sur CloudSim pour vous connecter à Oracle NoSQL Database Cloud Service ou au simulateur Oracle NoSQL Database Cloud.

Entrer les informations de connexion.

Tableau - Paramètres de connexion au nuage

Champ	Description	Exemple de valeur
Région :	Sélectionnez l'identificateur de région du point d'extrémité Oracle NoSQL Database Cloud Service.	`us-ashburn-1`
Fichier de configuration :	Accédez à l'emplacement où le fichier de configuration OCI est stocké.	`/home/user/security/config/oci.config`
Profil :	Nom du profil de configuration à utiliser pour la connexion à Oracle NoSQL Database Cloud Service. Si vous ne spécifiez pas cette valeur, le champ affiche par défaut le profil `DEFAULT`.	`ADMIN_USER`
Compartiment :	Nom ou OCID du compartiment de votre schéma Oracle NoSQL Database Cloud Service. Si vous n'indiquez aucune valeur, le champ affiche par défaut le compartiment `root`. Vous créez des compartiments dans le service de gestion des identités et des accès pour Oracle Cloud Infrastructure (IAM). Voir Configuration de votre location et Gestion des compartiments dans la documentation Oracle Cloud Infrastructure.	Nom du compartiment `monobloc` Nom de compartiment qualifié avec son compartiment parent `parent.childcompartment` OCID du compartiment. `ocid1.tenancy.oc1...<unique_ID>`
OCID du locataire :	OCID de la location pour votre service Oracle NoSQL Database Cloud Service. Voir Emplacement où obtenir l'OCID de la location et l'OCID de l'utilisateur dans la documentation sur Oracle Cloud Infrastructure	`ocid1.tenancy.oc1..<unique_ID>`
OCID d'utilisateur :	OCID de l'utilisateur pour votre service Oracle NoSQL Database Cloud Service. Reportez-vous à la section Emplacement où obtenir l'OCID de la location et celui de l'utilisateur dans la documentation sur Oracle Cloud Infrastructure.	`ocid1.user.oc1..<unique_ID>`
Empreinte numérique :	Empreinte de la clé privée qui a été ajoutée à cet utilisateur. L'empreinte numérique de la clé de signature est créée lors de la génération et du chargement de cette dernière. Voir Comment obtenir l'empreinte numérique de la clé dans la documentation sur Oracle Cloud Infrastructure.	`12 h 34 h 56 h 78 h 90 h 12 h 34 h 56 h 78 h 90 h 12 h 34 h 78 h 90 h`
Fichier de clé privée :	Accédez à l'emplacement où la clé privée est stockée. Reportez-vous à la section Génération d'une clé de signature d'API pour plus d'informations sur la génération d'une clé de signature d'API avec une	`/home/user/.oci/oci_api_key.pem`
Passphrase (Phrase secrète) :	Phrase secrète que vous avez spécifiée lors de la création de la clé privée. La phrase secrète de la clé de signature est créée lors de la génération et du chargement de la clé de signature d'API. Voir Comment obtenir l'empreinte numérique de la clé dans la documentation sur Oracle Cloud Infrastructure. Obligatoire, uniquement si la clé est chiffrée.
Compartiment :	Nom ou OCID du compartiment de votre schéma Oracle NoSQL Database Cloud Service. Si vous n'indiquez aucune valeur, le champ affiche par défaut le compartiment `root`. Vous créez des compartiments dans le service de gestion des identités et des accès pour Oracle Cloud Infrastructure (IAM). Voir Configuration de votre location et Gestion des compartiments dans la documentation Oracle Cloud Infrastructure.	Nom du compartiment `monobloc` Nom de compartiment qualifié avec son compartiment parent `parent.childcompartment` OCID du compartiment. `ocid1.tenancy.oc1...<unique_ID>`

Tableau - Paramètres de connexion CloudSim

Champ	Description	Exemple de valeur
Point d'extrémité :	URL du point d'extrémité du service de l'instance du simulateur Oracle NoSQL Database Cloud.	`http://myinstance.cloudsim.com:8080` Si vous ne spécifiez pas la valeur, la valeur par défaut est `http://localhost:8080`.
Identificateur de locataire :	Identificateur unique du locataire.	`Tenant01` Si vous ne spécifiez pas la valeur, la valeur par défaut est `TestTenant`.

Cliquez sur Connexion.
Cliquez sur Réinitialiser pour effacer les détails de la connexion enregistrée de l'espace de travail.

Créez le fichier de configuration, par exemple config.json ou un fichier avec l'objet JSON. Le format du fichier de configuration pour la connexion à Oracle NoSQL Database Cloud Service ou au simulateur Oracle NoSQL Database Cloud est le suivant :

Table - Modèles de configuration

Service Oracle NoSQL Database Cloud Simulateur Oracle NoSQL Database Cloud

Service Oracle NoSQL Database Cloud	Simulateur Oracle NoSQL Database Cloud
Modèle de configuration pour la connexion à l'aide du fichier de configuration OCI `{ "region": "<region-id-of-nosql-cloud-service-endpoint>", "compartment": "<oci-compartment-name-or-id>", "auth": { "iam": { "configFile": "<path-to-OCI-config-file>", "profileName": "<oci-credentials-profile-name>" } } }` Configuration template to connect using IAM authentication credentials `{ "region": "<region-id-of-nosql-cloud-service-endpoint>", "compartment": "<oci-compartment-name-or-id>", "auth": { "iam": { "tenantId": "<tenancy-ocid>", "userId": "<user-ocid>", "fingerprint": "<fingerprint-for-the-signing-key>", "privateKeyFile": "<path-to-the-private-key>", "passphrase": "<passphrase-of-the-signing-key>" } } }`	`{ "endpoint": "http://myinstance.cloudsim.com:8080", "auth" : "Bearer<tenant-id>" }`

Modèle de configuration pour la connexion à l'aide du fichier de configuration OCI

{
 "region": "<region-id-of-nosql-cloud-service-endpoint>",
 "compartment": "<oci-compartment-name-or-id>",
 "auth":
  {
   "iam":
    {
     "configFile": "<path-to-OCI-config-file>", 
     "profileName": "<oci-credentials-profile-name>"
    }
  }
}

Configuration template to connect using IAM authentication credentials

{
 "region": "<region-id-of-nosql-cloud-service-endpoint>",
 "compartment": "<oci-compartment-name-or-id>",
 "auth":
  {
   "iam":
    {
     "tenantId": "<tenancy-ocid>",
     "userId": "<user-ocid>",
     "fingerprint": "<fingerprint-for-the-signing-key>",
     "privateKeyFile": "<path-to-the-private-key>",
     "passphrase": "<passphrase-of-the-signing-key>"
     }
   }
}

{
 "endpoint": "http://myinstance.cloudsim.com:8080",
 "auth" : "Bearer<tenant-id>"
}

Ouvrez la palette de commandes en cliquant sur :
- (Windows et Linux) Contrôle + Maj + X
- (macOS) Commande + Maj + X
Dans la palette de commandes, sélectionnez Oracle NoSQL : Connexion au moyen du fichier de configuration.

Conseil :
Entrez oraclenosql dans la palette de commandes pour afficher toutes les commandes Oracle NoSQL DB que vous pouvez utiliser.
Accédez à l'emplacement où le fichier *.config est stocké et cliquez sur Sélectionner.

Gestion des tables à partir de l'extension Visual Studio Code

Une fois connecté à votre déploiement à l'aide de l'extension de code Visual Studio (VS) pour Oracle NoSQL Database, utilisez TABLE EXPLORER située dans le menu de navigation de gauche pour :

Explorez vos tables, colonnes, index, clés primaires et clés de partition.
Créer de nouvelles tables.
Supprimez les tables existantes.
Créer des index.
Abandonner les index.
Ajouter des colonnes
Déposer des colonnes.
Insérer les données dans la table.
Exécutez des interrogations SQL SELECT.

Explorer les tables, les colonnes, les index et les clés

Lorsque vous développez une connexion active, Oracle NoSQL Database VS Code affiche les tables de ce déploiement.

Cliquez sur le nom de la table pour voir ses colonnes, ses index, ses clés primaires et ses clés de partition. Le nom de la colonne s'affiche avec son type de données.
Vous pouvez actualiser le schéma ou la table à tout moment pour interroger de nouveau votre déploiement et alimenter Oracle NoSQL Database Cloud Service avec les données les plus récentes.
- Dans TABLE EXPLORER, localisez la connexion et cliquez sur l'icône Actualiser pour recharger le schéma. Vous pouvez également cliquer avec le bouton droit de la souris sur la connexion et sélectionner Actualiser le schéma.
- Dans TABLE EXPLORER, localisez le nom de la table et cliquez sur l'icône Actualiser pour recharger la table. Vous pouvez également cliquer avec le bouton droit de la souris sur le nom de la table et sélectionner Refresh Table (Actualiser la table).

Effectuer des opérations LDD à l'aide de Visual Studio Code

Vous pouvez utiliser Visual Studio Code pour effectuer des opérations LDD.

Certaines des opérations LDD pouvant être effectuées à partir du plugiciel Visual Studio Code sont les suivantes :

CREATE TABLE
SUPPRIMER UNE TABLE
CRÉER UN INDEX
SUPPRIMER L'INDEX
AJOUTER UNE COLONNE
DÉPOSER LA COLONNE

CREATE TABLE

Vous pouvez créer la table Oracle NoSQL Database selon deux modes :

Entrée DDL simple : Vous pouvez utiliser ce mode pour créer une table Oracle NoSQL Database de manière déclarative, c'est-à-dire sans écrire d'énoncé DDL.
Entrée DDL avancée : Vous pouvez utiliser ce mode pour créer une table Oracle NoSQL Database à l'aide d'un énoncé DDL.

Pointez la connexion à Oracle NoSQL Database pour ajouter la nouvelle table.
Cliquez sur l'icône Plus qui s'affiche.

Dans la page Créer une table, sélectionnez Entrée LDD simple.

Créer une table Oracle NoSQL Database en mode d'entrée LDD simple

Table - Créer une table Oracle NoSQL Database

Champ	Description
Nom de la table :	Indiquez un nom de table unique.
Nom de colonne	Spécifiez un nom de colonne pour la clé primaire de votre table.
Type de colonne	Sélectionnez le type de données pour la colonne de clé primaire.
Définir en tant que clé de partition horizontale	Sélectionnez cette option pour définir cette colonne de clé primaire comme clé de partition. La clé de partition consiste à distribuer les données dans la grappe Oracle NoSQL Database pour une efficacité accrue et à positionner les enregistrements qui partagent la clé de partition localement pour faciliter les références et l'accès. Les enregistrements qui partagent la clé de partition sont stockés dans le même emplacement physique et sont accessibles individuellement et de manière efficace.
Supprimer	Cliquez sur ce bouton pour supprimer une colonne existante.
+ Ajouter une colonne de clé primaire	Cliquez sur ce bouton pour ajouter des colonnes lors de la création d'une clé primaire composite (multicolonne).
Nom de colonne	Spécifiez le nom de la colonne.
Type de colonne	Sélectionnez le type de données de la colonne.
Valeur par défaut	(facultatif) Spécifiez une valeur par défaut pour la colonne. Note : Vous ne pouvez pas définir de valeur par défaut pour les colonnes de type de données binaire et JSON.
Non nul	Sélectionnez cette option pour indiquer qu'une colonne doit toujours avoir une valeur.
Supprimer	Cliquez sur ce bouton pour supprimer une colonne existante.
+ Ajouter une colonne	Cliquez sur ce bouton pour ajouter d'autres colonnes.
Unité	Sélectionnez l'unité (Jours ou Heures) à utiliser pour la valeur de durée de vie des rangées de la table.
Valeur	Indiquez la durée d'expiration des rangées de la table. Après le nombre de jours ou d'heures, les rangées expirent automatiquement et ne sont plus disponibles. La valeur par défaut est zéro, ce qui signifie qu'il n'y a pas de délai d Note : La mise à jour de la durée de vie de la table ne modifie pas la durée de vie des données présentes dans la table. La nouvelle valeur de durée de vie s'applique uniquement aux rangées ajoutées à la table après la modification de cette valeur et aux rangées pour lesquelles aucune valeur spécifique de rangée de remplacement n'a été fournie.

Cliquez sur Afficher le LDD pour voir l'énoncé LDD formé en fonction des valeurs entrées dans les champs en mode Entrée LDD simple. Cet énoncé LDD est exécuté lorsque vous cliquez sur Créer.
Cliquez sur Créer.

SUPPRIMER UNE TABLE

Cliquez avec le bouton droit de la souris sur la table cible.
Cliquez sur Supprimer une table.
Cliquez sur Oui pour supprimer la table.

CRÉER UN INDEX

Localisez l'Explorateur de table et cliquez sur Refresh Schema pour recharger le schéma.
Cliquez avec le bouton droit de la souris sur la table dans laquelle l'index doit être créé. Sélectionnez Créer un index.
Indiquez le nom de l'index et les colonnes à inclure dans l'index.
Cliquez sur Ajouter un index.

ABANDONNER L'INDEX

Localisez l'Explorateur de table et cliquez sur Refresh Schema pour recharger le schéma.
Cliquez sur la table dans laquelle l'index doit être supprimé. La liste des index s'affiche sous les noms de colonne.
Cliquez avec le bouton droit de la souris sur l'index à supprimer. Cliquez sur Supprimer l'index.
Une fenêtre de confirmation s'affiche, cliquez sur OK pour confirmer l'action de suppression.

AJOUTER UNE COLONNE

Localisez l'Explorateur de table et cliquez sur Refresh Schema pour recharger le schéma.
Cliquez avec le bouton droit de la souris sur la table dans laquelle la colonne doit être ajoutée. Cliquez sur Ajouter des colonnes.
Spécifiez le nom de la colonne et définissez-la avec ses propriétés - type de données, valeur par défaut et si elle peut être nulle.
Cliquez sur Ajouter de nouvelles colonnes.

DÉPOSER LA COLONNE

Localisez l'Explorateur de table et cliquez sur Refresh Schema pour recharger le schéma.
Développez la table dans laquelle la colonne doit être supprimée.
Cliquez avec le bouton droit de la souris sur la colonne à supprimer et sélectionnez Supprimer la colonne.
Une fenêtre de confirmation s'affiche, cliquez sur OK pour confirmer l'action de suppression.

Effectuer des opérations LMD à l'aide de Visual Studio Code

Vous pouvez ajouter des données, modifier des données existantes et interroger des données à partir du plugiciel de code Studio des tables usingVisual.

Insérer des données

Localisez l'Explorateur de table et cliquez sur Refresh Schema pour recharger le schéma.
Cliquez avec le bouton droit de la souris sur la table dans laquelle une ligne doit être insérée. Sélectionnez Insérer une rangée.
Dans le panneau Insérer une rangée, entrez les détails de l'insertion d'une nouvelle rangée. Vous pouvez INSÉRER une nouvelle ligne dans deux modes :
- Entrée simple : Vous pouvez utiliser ce mode pour insérer la nouvelle ligne sans écrire d'instruction LMD. Ici, une entrée de champs de ligne basée sur un formulaire est chargée, où vous pouvez entrer la valeur de chaque champ de l'enregistrement.
- Entrée JSON avancée : Vous pouvez utiliser ce mode pour insérer une nouvelle rangée dans la table en fournissant un objet JSON contenant le nom de la colonne et sa valeur correspondante en tant que paires clé-valeur.
Cliquez sur Insérer une rangée.

Modifier les données - UPDATE ROW/DELETE ROW :

Localisez l'Explorateur de table et cliquez sur Refresh Schema pour recharger le schéma.
Cliquez sur la table où les données doivent être modifiées.
Dans la zone de texte à droite sous SQL>, entrez l'instruction SQL pour extraire les données de votre table. Cliquez sur > pour exécuter l'interrogation.
Pour afficher les données d'une cellule individuelle séparément, cliquez sur la cellule de la table.
Pour effectuer des opérations LMD telles que Update et Delete Row, cliquez avec le bouton droit de la souris sur la ligne concernée. Sélectionnez votre option dans le menu contextuel qui s'affiche.
- Supprimer la rangée : Une fenêtre de confirmation s'affiche, cliquez sur OK pour supprimer la rangée.
- Update Row : Un panneau HTML distinct s'ouvre sous les lignes répertoriées, contenant les noms de colonne et leur valeur correspondante dans une entrée basée sur un formulaire ou fournissant l'entrée en tant qu'objet de paire de clés ON. Vous pouvez choisir l'une des deux méthodes et fournir de nouvelles valeurs.
  
  Note :
  Dans n'importe quelle rangée, les colonnes PRIMARY KEY et GENERATED ALWAYS AS IDENTITY ne peuvent pas être mises à jour.

Exécuter des interrogations SQL pour une table

Localisez l'Explorateur de table et cliquez sur Refresh Schema pour recharger le schéma.
Cliquez avec le bouton droit sur la table et sélectionnez Parcourir la table.
Dans la zone de texte à droite sous SQL>, entrez l'instruction SELECT pour extraire les données de votre table.
Cliquez sur > pour exécuter l'interrogation. Les données correspondantes sont extraites de la table.
Cliquez avec le bouton droit sur n'importe quelle rangée et cliquez sur Télécharger la rangée dans le fichier JSON. La rangée unique est téléchargée dans un fichier JSON.
Cliquez sur Télécharger le résultat de l'interrogation pour enregistrer le résultat complet de l'énoncé SELECT en tant que fichier JSON.
Cliquez sur Extraire tous les enregistrements pour extraire toutes les données de la table.

Suppression d'une connexion

Le connecteur Oracle NoSQL Database fournit deux méthodes pour supprimer une connexion de Visual Studio (VS) Code.

Vous pouvez :

Supprimer une connexion avec la palette de commandes, ou
Supprimez une connexion de la vue Oracle NoSQL DB dans la barre d'activités.

Note :

La suppression d'une connexion de Visual Studio Code supprime les détails de connexion persistants de l'espace de travail courant.

Supprimer la connexion de la vue Oracle NoSQL DB
Supprimer la connexion avec la palette de commandes

Développez le volet EXPLORATEUR DE TABLE dans la barre de navigation de gauche s'il est réduit.
Cliquez avec le bouton droit de la souris sur la connexion à supprimer, puis cliquez sur Supprimer la connexion.

Ouvrez la palette de commandes en appuyant sur :
- (Windows et Linux) Contrôle + Maj + P
- (macOS) Commande + Maj + P
Dans la palette de commandes, sélectionnez OracleNoSQL : Supprimer la connexion.

Conseil :
Entrez oraclenosql dans la palette de commandes pour afficher toutes les commandes Oracle NoSQL DB que vous pouvez utiliser.

Titre et droits d'auteur

Utilisation de l'extension Visual Studio Code pour le développement

Oracle et/ou ses sociétés affiliées.