Uso de la extensión de Visual Studio Code para el desarrollo

Oracle NoSQL Database Cloud Service proporciona una extensión para Microsoft Visual Studio Code que permite conectarse a una instancia en ejecución de Oracle NoSQL Database Cloud Service.

Puede utilizar la extensión de código de Visual Studio (VS) de Oracle NoSQL Database para:
  • Visualice las tablas en una estructura de árbol bien definida con el explorador de tablas.
  • Ver información sobre columnas, índices, claves primarias y claves de partición horizontal de una tabla.
  • Vea los datos de columna en una estructura JSON con formato correcto.
  • Cree tablas mediante una entrada de esquema basada en formulario o proporcione sentencias DDL.
  • Borrar tablas.
  • Agregue nuevas columnas mediante una entrada basada en formulario o proporcione sentencias DDL.
  • Eliminar columnas.
  • Crear índices.
  • Borrar índices.
  • Ejecutar consultas SQL SELECT en una tabla y ver los resultados de las consultas en formato tabular.
  • Ejecute sentencias DML para actualizar, insertar y suprimir datos de una tabla.
  • Descargue el resultado de la consulta después de ejecutar la consulta SELECT en un archivo JSON.
  • Descargue cada fila del resultado obtenido después de ejecutar la consulta SELECT en un archivo JSON.

En este artículo se incluyen los siguientes temas:

Instalación de la extensión de Visual Studio Code de Oracle NoSQL Database

Puede instalar la extensión de código VS de Oracle NoSQL Database de dos formas. Instalar desde Visual Studio Marketplace para la instalación en línea o instalar desde el paquete VSIX mediante el archivo *.vsix para la instalación fuera de línea.

Para poder instalar la extensión de código de Visual Studio (VS) de Oracle NoSQL Database, debe instalar Visual Studio Code. Puede descargar Visual Studio Code aquí.
  1. En Visual Studio Code, haga clic en el icono de Extensiones en la navegación izquierda.


    Barra de actividades de Visual Studio Code

    También puede abrir la vista Extensiones pulsando:
    • (Windows y Linux) Control + Mayús + X
    • (macOS) Comando + Mayús + X.
  2. Busque Oracle NoSQL Database Connector en el mercado de extensiones.
  3. Haga clic en Instalar en la extensión de Oracle NoSQL Database Connector
  1. Descargue el archivo VSIX para Oracle NoSQL Database desde el sitio Oracle NoSQL Database Downloads.
  2. En Visual Studio Code, haga clic en el icono de Extensiones en la navegación izquierda.


    Barra de actividades de Visual Studio Code

    También puede abrir la vista Extensiones pulsando:
    • (Windows y Linux) Control + Mayús + X
    • (macOS) Comando + Mayús + X.
  3. En la vista Extensiones, haga clic en el menú Más acciones (...) y, a continuación, haga clic en Instalar desde VSIX....


    Instalación desde VSIX Action

  4. Busque la ubicación donde se almacena el archivo *.vsix y haga clic en Instalar.

Conexión a Oracle NoSQL Database Cloud Service desde Visual Studio Code

La extensión de Oracle NoSQL Database Visual Studio (VS) Code proporciona dos métodos para conectarse a Oracle NoSQL Database Cloud Service u Oracle NoSQL Database Cloud Simulator.

Puede proporcionar un archivo de configuración con la información de conexión o rellenar la información de conexión en los campos específicos. Si utiliza un controlador Node.js y ya tiene los detalles de conexión guardados en un archivo, utilice la opción Conectar mediante archivo de configuración para conectarse a Oracle NoSQL Database Cloud Service. De lo contrario, si está creando una nueva conexión, utilice la opción Rellenar campos individuales.
  1. En Visual Studio Code, haga clic en la vista Oracle NoSQL DB en la barra de actividad.


    Barra de actividades de Visual Studio Code

  2. Abra la página Mostrar configuración de conexión de Oracle NoSQL DB desde la paleta de comandos o la vista Oracle NoSQL DB en la barra de actividad.
    • Abrir desde la paleta de comandos
      1. Para abrir la paleta de comandos, pulse:
        • (Windows y Linux) Control + Mayús + P
        • (macOS) Comando + Mayús + P
      2. En la paleta de comandos, seleccione OracleNoSQL: Mostrar configuración de conexiones.

        Sugerencia:

        Introduzca oraclenosql en la paleta de comandos para mostrar todos los comandos de Oracle NoSQL DB que puede utilizar.


        Comando Mostrar Valores de Conexiones de Oracle NoSQL DB

    • Abrir desde la vista de Oracle NoSQL DB
      1. Expanda el panel TABLE EXPLORER en la navegación izquierda si está contraído.
      2. Haga clic en Agregar Conexión para abrir la página Mostrar Valores de Conexión de Oracle NoSQL DB.


      EXPLORADOR DE TABLAS DE Oracle NoSQL DB

  3. En la página Mostrar configuración de conexión, haga clic en Nube o CloudSim para conectarse a Oracle NoSQL Database Cloud Service o Oracle NoSQL Database Cloud Simulator.


    NoSQL Configuración de conexión de base de datos para Oracle NoSQL Database Cloud Service

  4. Introduzca la información de conexión.

    Tabla - Parámetros de conexión a la nube

    Campo Descripción Valor de ejemplo
    Región: Seleccione el identificador de región del punto final de Oracle NoSQL Database Cloud Service. us-ashburn-1
    Archivo de Configuración: Examine la ubicación donde se almacena el archivo de configuración de OCI. /home/user/security/config/oci.config
    Perfil: Nombre del perfil de configuración que se va a utilizar para conectarse a Oracle NoSQL Database Cloud Service.

    Si no especifica este valor, el campo se define por defecto en el perfil DEFAULT.

    		ADMIN_USER
    Compartimiento: Nombre u OCID del compartimento para el esquema de Oracle NoSQL Database Cloud Service.

    Si no proporciona ningún valor, el campo se define por defecto en el compartimento root.

    Cree compartimentos en Oracle Cloud Infrastructure Identity and Access Management (IAM). Consulte Configuración de arrendamiento y Gestión de compartimentos en la documentación de Oracle Cloud Infrastructure.

    • Nombre de compartimento

      mycompartment

    • Nombre de compartimento calificado con su compartimento principal

      parent.childcompartment

    • OCID de compartimento

      ocid1.tenancy.oc1...<unique_ID>
    OCID de arrendamiento: OCID de arrendamiento para Oracle NoSQL Database Cloud Service. Consulte Dónde obtener el OCID del arrendamiento y el OCID del usuario en la documentación de Oracle Cloud Infrastructure ocid1.tenancy.oc1..<unique_ID>
    OCID de usuario: OCID del usuario para su Oracle NoSQL Database Cloud Service. Consulte Dónde obtener el OCID del arrendamiento y el OCID del usuario en la documentación de Oracle Cloud Infrastructure. ocid1.user.oc1..<unique_ID>
    Fingerprint: huellas para la clave privada que se ha añadido a este usuario.

    La huella de la clave de firma se crea al generar y cargar la clave de firma de API. Consulte Cómo obtener la huella de la clave en la documentación de Oracle Cloud Infrastructure.

    		12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef
    Archivo de Claves Privadas: Vaya a la ubicación donde se almacena la clave privada. Consulte Cómo generar una clave de firma de API para generar la clave de firma con una contraseña opcional. /home/user/.oci/oci_api_key.pem
    Contraseña: Frase de contraseña especificada al crear la clave privada. La contraseña de la clave de firma se crea al generar y cargar la clave de firma de API. Consulte Cómo obtener la huella de la clave en la documentación de Oracle Cloud Infrastructure.

    Necesario, solo si la clave está cifrada.

    		 
    Compartimiento: Nombre u OCID del compartimento para el esquema de Oracle NoSQL Database Cloud Service.

    Si no proporciona ningún valor, el campo se define por defecto en el compartimento root.

    Cree compartimentos en Oracle Cloud Infrastructure Identity and Access Management (IAM). Consulte Configuración de arrendamiento y Gestión de compartimentos en la documentación de Oracle Cloud Infrastructure.

    • Nombre de compartimento

      mycompartment

    • Nombre de compartimento calificado con su compartimento principal

      parent.childcompartment

    • OCID de compartimento

      ocid1.tenancy.oc1...<unique_ID>

    Tabla - Parámetros de conexión CloudSim

    Campo Descripción Valor de ejemplo
    Punto Final: URL de punto final de servicio de la instancia de Oracle NoSQL Database Cloud Simulator. http://myinstance.cloudsim.com:8080

    Si no especifica el valor, el valor por defecto es http://localhost:8080.

    Identificador del inquilino: Identificador único para identificar al inquilino. Tenant01

    Si no especifica el valor, el valor por defecto es TestTenant.

  5. Haga clic en Conectar.
  6. Haga clic en Restablecer para borrar los detalles de conexión guardados del espacio de trabajo.
  1. Cree el archivo de configuración, por ejemplo, config.json o un archivo con el objeto JSON. El formato de archivo de configuración para conectarse a Oracle NoSQL Database Cloud Service u Oracle NoSQL Database Cloud Simulator se muestra a continuación.

    Tabla - Plantillas de configuración

    Oracle NoSQL Database Cloud Service Simulador de Oracle NoSQL Database Cloud
    Plantilla de configuración para conectarse mediante el archivo de configuración de 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>"
    }
  }
}
    Plantilla de configuración para conectarse mediante credenciales de autenticación de IAM
    {
 "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>"
}
  2. Pulse:
    • (Windows y Linux) Control + Mayús + X
    • (macOS) Comando + Mayús + X
  3. En la paleta de comandos, seleccione Oracle NoSQL: Connect via Config File.

    Sugerencia:

    Introduzca oraclenosql en la paleta de comandos para mostrar todos los comandos de Oracle NoSQL DB que puede utilizar.


    Conectar mediante archivo de configuración

  4. Busque la ubicación donde se almacena el archivo *.config y haga clic en Seleccionar.

Gestión de tablas mediante la extensión de Visual Studio Code

Una vez que se conecte al despliegue mediante la extensión de código de Visual Studio (VS) de Oracle NoSQL Database, utilice el explorador de tablas situado en la navegación izquierda para:
  • Explore las tablas, columnas, índices, claves primarias y claves de partición horizontal.
  • Crear nuevas tablas.
  • Borre las tablas existentes.
  • Crear índices.
  • Borrar índices.
  • Agregar columnas.
  • Eliminar columnas.
  • Insertar Datos en la Tabla.
  • Ejecute consultas SQL SELECT.

Explorar tablas, columnas, índices y claves

Al ampliar una conexión activa, Oracle NoSQL Database VS Code muestra las tablas de ese despliegue.
  • Haga clic en el nombre de la tabla para ver sus columnas, índices, claves primarias y claves de partición horizontal. El nombre de columna se muestra junto con su tipo de dato.
  • Puede refrescar el esquema o la tabla en cualquier momento para volver a consultar el despliegue y rellenar Oracle NoSQL Database Cloud Service con los datos más actualizados.
    • En TABLE EXPLORER, localice la conexión y haga clic en el icono Refrescar para volver a cargar el esquema. También puede hacer clic con el botón derecho en la conexión y seleccionar Refrescar Esquema.


      Esquema de refrescamiento de extensión de código VS de Oracle NoSQL DB

    • En TABLE EXPLORER, busque el nombre de la tabla y haga clic en el icono Refresh para volver a cargar la tabla. Como alternativa, puede hacer clic con el botón derecho del ratón en el nombre de la tabla y seleccionar Refrescar Tabla.


      Tabla de refrescamiento de código de Oracle NoSQL DB VS

Realizar operaciones DDL con Visual Studio Code

Puede utilizar Visual Studio Code para realizar operaciones DDL.

Algunas de las operaciones DDL que se pueden realizar desde el plugin de Visual Studio Code son:

CREATE TABLE

Puede crear la tabla de Oracle NoSQL Database en dos modos:
  • Entrada de DDL simple: puede utilizar este modo para crear la tabla de Oracle NoSQL Database de forma declarativa, es decir, sin escribir una sentencia DDL.
  • Entrada de DDL avanzada: puede utilizar este modo para crear la tabla de Oracle NoSQL Database mediante una sentencia DDL.
  1. Mueva el cursor sobre la conexión de Oracle NoSQL Database para agregar la nueva tabla.
  2. Haga clic en el icono del signo más que aparece.
  3. En la página Crear tabla, seleccione Entrada DDL simple.


    Creación de una Tabla de Oracle NoSQL Database mediante el Modo de Entrada DDL Simple

    Tabla: creación de una tabla de Oracle NoSQL Database

    Campo Descripción
    Nombre de tabla: Especifique un nombre de tabla único.
    Nombre de la Columna Especifique un nombre de columna para la clave primaria en la tabla.
    Tipo de columna Seleccione el tipo de datos para la columna de clave primaria.
    Definir como clave de partición horizontal Seleccione esta opción para definir esta columna de clave primaria como clave de partición. La clave de partición horizontal consiste en distribuir los datos en el cluster de Oracle NoSQL Database para una mayor eficacia y ubicar localmente los registros que comparten la clave de partición horizontal para facilitar la referencia y el acceso. Los registros que comparten la clave de partición horizontal se almacenan en la misma ubicación física y se puede acceder a ella de forma atómica y eficiente.
    Eliminar Haga clic en este botón para eliminar una columna existente.
    + Agregar Columna de Clave Principal Haga clic en este botón para agregar más columnas al crear una clave primaria compuesta (de varias columnas).
    Nombre de la Columna Especifique el nombre de la columna.
    Tipo de columna Seleccione el tipo de datos para la columna.
    Valor por Defecto (Opcional) Especifique un valor por defecto para la columna.

    Note:

    No se pueden especificar valores por defecto para columnas de tipo de datos JSON y binarios.
    No Nulo Seleccione esta opción para especificar que una columna siempre debe tener un valor.
    Eliminar Haga clic en este botón para eliminar una columna existente.
    + Agregar columna Haga clic en este botón para agregar más columnas.
    Unidad Seleccione la unidad (Días o Horas) que desea utilizar para el valor de TTL para las filas de la tabla.
    Valor Especifique la duración de caducidad para las filas de la tabla. Después del número de días u horas, las filas caducan automáticamente y ya no están disponibles. El valor por defecto es cero, lo que indica que no hay tiempo de caducidad.

    Note:

    La actualización del tiempo de duración de la tabla (TTL) no cambia el valor TTL de los datos existentes en la tabla. El nuevo valor TTL se aplica sólo a las filas que se agregan a la tabla después de modificar este valor y a las filas para las que no se ha proporcionado ningún valor específico de fila de sustitución.
  4. Haga clic en Mostrar DDL para ver la sentencia DDL formada según los valores introducidos en los campos en el modo Entrada DDL simple. Esta sentencia DDL se ejecuta al hacer clic en Crear.
  5. Haga clic en Create.

DROP TABLE

  1. Haga clic con el botón derecho en la tabla de destino.
  2. Haga clic en Suprimir Tabla.
  3. Haga clic en Sí para borrar la tabla.

CREATE INDEX

  • Localice Table Explorer y haga clic en Refresh Schema para volver a cargar el esquema.
  • Haga clic con el botón derecho en la tabla en la que se debe crear el índice. Seleccione Crear Índice.
  • Especifique el nombre del índice y las columnas que formarán parte del mismo.
  • Haga clic en Agregar índice.

DROP INDEX

  • Localice Table Explorer y haga clic en Refresh Schema para volver a cargar el esquema.
  • Haga clic en la tabla en la que se debe eliminar el índice. La lista de índices se muestra debajo de los nombres de columnas.
  • Haga clic con el botón derecho en el índice que desea borrar. Haga clic en Borrar Índice.
  • Aparece una ventana de confirmación, haga clic en Aceptar para confirmar la acción de borrado.

AGREGAR COLUMNA

  • Localice Table Explorer y haga clic en Refresh Schema para volver a cargar el esquema.
  • Haga clic con el botón derecho en la tabla en la que se debe agregar la columna. Haga clic en Agregar columnas.
  • Especifique el nombre de la columna y defina la columna con sus propiedades: tipo de dato, valor por defecto y si se puede anular.
  • Haga clic en Agregar nuevas columnas.

ELIMINAR COLUMNA

  • Localice Table Explorer y haga clic en Refresh Schema para volver a cargar el esquema.
  • Amplíe la tabla donde se debe eliminar la columna.
  • Haga clic con el botón derecho en la columna que desea eliminar y seleccione Borrar Columna.
  • Aparece una ventana de confirmación, haga clic en Aceptar para confirmar la acción de borrado.

Realizar operaciones DML con Visual Studio Code

Puede agregar datos, modificar datos existentes y consultar datos desde el plugin usingVisual Studio Code de las tablas.

Insertar Datos

  • Localice Table Explorer y haga clic en Refresh Schema para volver a cargar el esquema.
  • Haga clic con el botón derecho en la tabla en la que se debe insertar una fila. Seleccione Insertar fila.
  • En el panel Insertar fila, introduzca los detalles para insertar una nueva fila. Puede insertar una nueva fila en dos modos:
    • Entrada Simple: Puede utilizar este modo para insertar la nueva fila sin escribir una sentencia DML. Aquí se carga una entrada de campos de fila basada en formulario, donde puede introducir el valor de cada campo de la fila.
    • Entrada JSON avanzada: puede utilizar este modo para insertar una nueva fila en la tabla proporcionando un objeto JSON que contenga el nombre de columna y su valor correspondiente como pares clave-valor.
  • Haga clic en Insertar fila.

Modificar datos - Actualizar fila/borrar fila:

  • Localice Table Explorer y haga clic en Refresh Schema para volver a cargar el esquema.
  • Haga clic en la tabla en la que se deben modificar los datos.
  • En el cuadro de texto situado a la derecha en SQL>, introduzca la sentencia SQL para recuperar datos de la tabla. Haga clic en > para ejecutar la consulta.
  • Para ver datos de celdas individuales por separado, haga clic en la celda de la tabla.
  • Para realizar operaciones DML como Actualizar y Suprimir Fila, haga clic con el botón derecho en la fila concreta. Seleccione su opción en el menú contextual que aparece.
    • Suprimir fila: aparece una ventana de confirmación y haga clic en Aceptar para suprimir la fila.
    • Actualizar fila: se abre un panel HTML independiente debajo de las filas mostradas, que contiene los nombres de columna y su valor correspondiente en una entrada basada en formulario o proporciona la entrada como objeto de par de claves ON. Puede elegir uno de los dos métodos y proporcionar nuevos valores.

      Note:

      En cualquier fila, no se pueden actualizar las columnas PRIMARY KEY y GENERATED SIEMPRE AS IDENTITY.

Ejecución de consultas SQL para una tabla

  • Localice Table Explorer y haga clic en Refresh Schema para volver a cargar el esquema.
  • Haga clic con el botón derecho en la tabla y seleccione Examinar Tabla.
  • En el cuadro de texto situado a la derecha en SQL>, introduzca la sentencia SELECT para recuperar datos de la tabla.
  • Haga clic en > para ejecutar la consulta. Los datos correspondientes se recuperan de la tabla.
  • Haga clic con el botón derecho en cualquier fila y haga clic en Descargar fila en el archivo JSON. La única fila se descarga en un archivo JSON.
  • Haga clic en Descargar resultado de consulta para guardar el resultado completo de la sentencia SELECT como un archivo JSON.
  • Haga clic en Recuperar todos los registros para recuperar todos los datos de la tabla.

Eliminando una conexión

Oracle NoSQL Database Connector proporciona dos métodos para eliminar una conexión de Visual Studio (VS) Code.

Puede:
  • Eliminar una conexión con la paleta de comandos, o
  • Elimine una conexión de la vista de Oracle NoSQL DB en la barra de actividades.

Note:

Al eliminar una conexión de Visual Studio Code, se suprimen los detalles de conexión persistentes del espacio de trabajo actual.
  1. Expanda el panel TABLE EXPLORER en la navegación izquierda si está contraído.
  2. Haga clic con el botón derecho en la conexión que desea eliminar y, a continuación, haga clic en Suprimir conexión.


Explorador de Tablas

  1. Para abrir la paleta de comandos, pulse:
    • (Windows y Linux) Control + Mayús + P
    • (macOS) Comando + Mayús + P
  2. En la paleta de comandos, seleccione OracleNoSQL: Eliminar conexión.

    Sugerencia:

    Introduzca oraclenosql en la paleta de comandos para mostrar todos los comandos de Oracle NoSQL DB que puede utilizar.


    Eliminar Conexión