Acerca de la extensión de código de Visual Studio de Oracle NoSQL Database

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 Oracle NoSQL Database Visual Studio (VS) para:
  • Ver 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 para una tabla.
  • Vea los datos de columna en una estructura JSON con formato correcto.
  • Cree tablas mediante la entrada de esquema basado en formulario o proporcione sentencias DDL.
  • Borrar tablas.
  • Ejecutar consultas SQL SELECT en una tabla y ver los resultados de las consultas en formato tabular.
  • Ejecutar sentencias DML para actualizar, insertar y suprimir datos de una tabla.

En este artículo se incluyen los siguientes temas:

Instalación de la extensión de código de Visual Studio de Oracle NoSQL Database

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

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


    Barra de actividad de código de Visual Studio

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


    Barra de actividad de código de Visual Studio

    También puede abrir la vista Extensiones pulsando:
    • (Windows y Linux) Control + Mayús + X
    • (macOS) Comando + turno + 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 acción de VSIX

  4. Vaya a 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 código de Oracle NoSQL Database Visual Studio (VS) 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 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 en campos individuales.
  1. En Visual Studio Code, haga clic en la vista Oracle NoSQL DB en la barra de actividad.


    Barra de actividad de código de Visual Studio

  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 paleta de comandos
      1. Abra la Paleta de comandos pulsando:
        • (Windows y Linux) Control + Mayús + P
        • (macOS) Comando + Mayús + P
      2. En la paleta de comandos, seleccione OracleNoSQL: Show Connections Settings.

        Consejo:

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


        Comando Mostrar Configuración 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 configuración 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 u CloudSim para conectarse a Oracle NoSQL Database Cloud Service u 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 5-4 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: Busque la ubicación en la que se almacena el archivo de configuración de OCI. /home/user/security/config/oci.config
    Perfil: Nombre del perfil de configuración que se utilizará para conectarse a Oracle NoSQL Database Cloud Service.

    Si no especifica este valor, el valor por defecto del campo es el perfil DEFAULT.

    ADMIN_USER
    Compartimento: 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.

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

    • Nombre de compartimento

      mi compartimento

    • Nombre de compartimento calificado con su compartimento principal

      Parent.childcompartment

    • OCID de compartimento

      ocid1.tenancy.oc1...<unique_ID>

    OCID de arrendatario: 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>
    huella digital: Huella para la clave privada que se ha agregado 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 frase de 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, sólo si la clave está cifrada.

     
    Compartimento: 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.

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

    • Nombre de compartimento

      mi compartimento

    • Nombre de compartimento calificado con su compartimento principal

      Parent.childcompartment

    • OCID de compartimento

      ocid1.tenancy.oc1...<unique_ID>

    Tabla 5-5 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 es como se muestra a continuación.

    Tabla 5-6 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. Abra la paleta de comandos pulsando:
    • (Windows y Linux) Control + Mayús + X
    • (macOS) Comando + turno + X
  3. En la paleta de comandos, seleccione Oracle NoSQL: Conectar mediante archivo de configuración.

    Consejo:

    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. Vaya a 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 Oracle NoSQL Database Visual Studio (VS), utilice la TABLE EXPLORER situada en la navegación izquierda para:
  • Explore las tablas, columnas, índices, claves primarias y claves de partición horizontal.
  • Cree nuevas tablas.
  • Eliminación de tablas existentes.
  • Ejecutar consultas SQL SELECT y sentencias DML en una tabla.

EXPLORADOR DE TABLAS DE Oracle NoSQL DB

Al ampliar una conexión activa, el código VS de Oracle NoSQL Database 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, busque 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 de Oracle NoSQL DB VS

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


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

Ejecución de Consultas SQL y Sentencias DML para una Tabla

  1. Haga clic con el botón derecho en la tabla de destino y seleccione Examinar tabla.
  2. En la ventana SQL, especifique la consulta SELECT en el cuadro de texto y haga clic en
    Consulta de ejecución de código de Oracle NoSQL DB VS

    . El resultado de la consulta se muestra en formato tabular. Puede ajustar el número de filas por página. También puede ejecutar sentencias DML para actualizar, insertar y suprimir datos de una tabla.
  3. Para ver datos de celdas individuales por separado, haga clic en la celda de la tabla.

Eliminación de una Tabla

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

Creación de una tabla de Oracle NoSQL Database Cloud Service desde Visual Studio Code

Puede crear la tabla de Oracle NoSQL Database Cloud Service en dos modos:
  • Entrada de DDL simple: puede utilizar este modo para crear la tabla de Oracle NoSQL Database Cloud Service 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 Cloud Service mediante una sentencia DDL.
  1. Mueva el cursor sobre la conexión de Oracle NoSQL Database Cloud Service para agregar la nueva tabla.
  2. Haga clic en el icono Más que aparece.
  3. En la página Crear tabla, seleccione Entrada de DDL simple.


    Creación de una tabla de Oracle NoSQL Database Cloud Service mediante el modo de entrada DDL simple

    Tabla 5-7 Creación de una tabla de Oracle NoSQL Database Cloud Service

    Campo Descripción
    Capacidad de lectura (unidades de lectura) Introduzca el número de unidades de lectura. Consulte Estimación de capacidad para obtener información sobre las unidades de lectura.
    Capacidad de escritura (unidades de escritura) Introduzca el número de unidades de escritura. Consulte Estimación de capacidad para obtener información sobre las unidades de escritura.
    Almacenamiento en Disco (GB) Especifique el espacio en GB del disco que va a utilizar la tabla. Consulte Estimación de capacidad para obtener información sobre la capacidad de almacenamiento.
    Nombre de tabla: Especifique un nombre de tabla único en su arrendamiento. Los nombres de tabla deben cumplir las reglas de nomenclatura de Oracle NoSQL Database Cloud Service. Consulte Límites de servicio.
    Nombre de columna Especifique un nombre de columna para la clave primaria en la tabla. Consulte Límites de servicio para obtener más información sobre los requisitos de nombres de columna.
    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 es distribuir los datos en el cluster de Oracle NoSQL Database Cloud Service 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 suprimir una columna existente.
    + Agregar columna de clave primaria Haga clic en este botón para agregar más columnas al crear una clave primaria compuesta (de varias columnas).
    Nombre de columna Especifique el nombre de la columna. Asegúrese de cumplir los requisitos de nombres de columna descritos en Límites de servicio.
    Tipo de columna Seleccione el tipo de datos para la columna de clave primaria.
    Valor por defecto (Opcional) Especifique un valor por defecto para la columna.
    Nota

    Los valores por defecto no se pueden especificar 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 suprimir 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 se utilizará para el valor TTL de las filas de la tabla.
    Valor Especifique la duración de caducidad de 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.
    Nota

    La actualización del tiempo de duración de la tabla (TTL) no cambia el valor TTL de ningún dato existente en la tabla. El nuevo valor de TTL se aplica solo 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 en función de 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 Crear.
  1. Mueva el cursor sobre la conexión de Oracle NoSQL Database Cloud Service para agregar la nueva tabla.
  2. Haga clic en el icono Más que aparece.
  3. En la página Crear tabla, seleccione Entrada de DDL avanzada.


    Creación de una tabla de Oracle NoSQL Database Cloud Service mediante el modo de entrada de DDL avanzada

    Tabla 5-8: Creación de tabla para Oracle NoSQL Database Cloud Service

    Campo Descripción
    Capacidad de lectura (unidades de lectura) Introduzca el número de unidades de lectura. Consulte Estimación de capacidad para obtener información sobre las unidades de lectura.
    Capacidad de escritura (unidades de escritura) Introduzca el número de unidades de escritura. Consulte Estimación de capacidad para obtener información sobre las unidades de escritura.
    Almacenamiento en Disco (GB) Especifique el espacio en GB del disco que va a utilizar la tabla. Consulte Estimación de capacidad para obtener información sobre la capacidad de almacenamiento.
    Sentencia DDL Especifique la sentencia DDL de creación de tabla. Consulte Referencia de SQL para Oracle NoSQL Database.
  4. Haga clic en Crear.

Eliminando una conexión

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

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

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 Eliminar conexión.


Explorador de tablas

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

    Consejo:

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


    Eliminar Conexión