Documentação do Oracle Cloud Infrastructure

Sobre a Extensão do Oracle NoSQL Database Visual Studio Code

O Oracle NoSQL Database Cloud Service fornece uma extensão para o Microsoft Visual Studio Code que permite estabelecer conexão com uma instância em execução do Oracle NoSQL Database Cloud Service.

Você pode usar a extensão de Código do Oracle NoSQL Database Visual Studio (VS) para:
  • Visualizar as tabelas em uma estrutura de árvore bem definida com o Explorador de Tabelas.
  • Exiba informações sobre colunas, índices, chave(s) primária(s) e chave(s) de partição de uma tabela.
  • Exiba dados da coluna em uma Estrutura JSON bem formatada.
  • Crie tabelas usando entrada de esquema baseada em formulário ou forneça instruções DDL.
  • Drop tables.
  • Execute consultas SELECT SQL em uma tabela e exiba os resultados da consulta em formato tabular.
  • Executar instruções DML para atualizar, inserir e excluir dados de uma tabela.

Este artigo tem os seguintes tópicos:

Instalando a Extensão do Oracle NoSQL Database Visual Studio Code

Você pode instalar a extensão VS Code do Oracle NoSQL Database de duas maneiras. Instale a partir do Visual Studio Marketplace para instalação on-line ou instale a partir do pacote do VSIX usando o arquivo *.vsix para instalação off-line.

Para poder instalar a extensão de Código do Oracle NoSQL Database Visual Studio (VS), instale o Visual Studio Code. Você pode fazer download do Visual Studio Code aqui.
  1. No Visual Studio Code, clique no ícone Extensões na navegação esquerda.


    Barra de Atividades do Visual Studio Code

    Como alternativa, você pode abrir a exibição Extensões pressionando:
    • (Windows e Linux) Controle + Shift + X
    • (macOS) Comando + Shift + X.
  2. Pesquise o Oracle NoSQL Database Connector no marketplace de extensões.
  3. Clique em Instalar na extensão Oracle NoSQL Database Connector
  1. Faça download do arquivo VSIX do Oracle NoSQL Database no site de Downloads do Oracle NoSQL Database.
  2. No Visual Studio Code, clique no ícone Extensões na navegação esquerda.


    Barra de Atividades do Visual Studio Code

    Como alternativa, você pode abrir a exibição Extensões pressionando:
    • (Windows e Linux) Controle + Shift + X
    • (macOS) Comando + Shift + X.
  3. Na exibição Extensões, clique no menu Mais Ações (...) e clique em Instalar do VSIX....


    Instalar a partir da Ação do VSIX

  4. Navegue até o local em que o arquivo *.vsix está armazenado e clique em Instalar.

Estabelecendo conexão com o Oracle NoSQL Database Cloud Service por meio do Visual Studio Code

A extensão Oracle NoSQL Database Visual Studio (VS) Code fornece dois métodos para conexão com o Oracle NoSQL Database Cloud Service ou o Oracle NoSQL Database Cloud Simulator.

Você pode fornecer um arquivo de configuração com as informações de conexão ou preencher as informações de conexão nos campos específicos. Se você estiver usando um driver Node.js e já tiver detalhes de conexão salvos em um arquivo, use a opção Conectar via Arquivo de Configuração para estabelecer conexão com o Oracle NoSQL Database Cloud Service. Caso contrário, se você estiver criando uma nova conexão, use a opção Preencher Campos Individuais.
  1. No Visual Studio Code, clique na exibição Oracle NoSQL DB na Barra de Atividades.


    Barra de Atividades do Visual Studio Code

  2. Abra a página Mostrar Definições de Conexão do Oracle NoSQL DB na Paleta de Comandos ou na exibição Oracle NoSQL DB na Barra de Atividade.
    • Abrir da Paleta de Comandos
      1. Abra a Paleta de Comandos pressionando:
        • (Windows e Linux) Controle + Shift + P
        • (macOS) Comando + Shift + P
      2. Na Paleta de Comandos, selecione OracleNoSQL: Mostrar Definições de Conexões.

        Dica:

        Digite oraclenosql na Paleta de Comandos para exibir todos os comandos do Oracle NoSQL DB que você pode usar.


        Comando Mostrar Definições de Conexões do Oracle NoSQL DB

    • Abrir da View do Oracle NoSQL DB
      1. Expanda o painel TABLE EXPLORER na navegação esquerda se ele estiver recolhido.
      2. Clique em Adicionar Conexão para abrir a página Mostrar Definições de Conexão do Oracle NoSQL DB.


      EXPLORADOR DE TABELAS DO Oracle NoSQL DB

  3. Na página Mostrar Definições de Conexão, clique em Cloud ou CloudSim para estabelecer conexão com o Oracle NoSQL Database Cloud Service ou o Oracle NoSQL Database Cloud Simulator.


    NoSQL Definições de Conexão do BD para o Oracle NoSQL Database Cloud Service

  4. Especifique as informações da conexão.

    Tabela 5-4 Parâmetros de Conexão em Nuvem

    Campo Descrição Valor de Amostra
    Região: Selecione o identificador de Região do ponto final do Oracle NoSQL Database Cloud Service. us-ashburn-1
    Arquivo de Configuração: Navegue até o local em que o arquivo de configuração do OCI está armazenado. /home/user/security/config/oci.config
    Perfil: Nome do perfil de configuração a ser usado para estabelecer conexão com o Oracle NoSQL Database Cloud Service.

    Se você não especificar esse valor, o campo assumirá como padrão o perfil DEFAULT.

    		ADMIN_USER
    Compartimento: O nome ou o OCID do compartimento do seu esquema do Oracle NoSQL Database Cloud Service.

    Se você não fornecer nenhum valor, o campo assumirá como padrão o compartimento root.

    Você cria compartimentos no Oracle Cloud Infrastructure Identity and Access Management (IAM). Consulte Configurando sua Tenancy e Gerenciando Compartimentos na Documentação do Oracle Cloud Infrastructure.

    • Nome do compartimento

      mycompartment

    • Nome do compartimento qualificado com seu compartimento pai

      parent.compartimentofilho

    • OCID do Compartimento

      ocid1.tenancy.oc1...<unique_ID>
    OCID do Tenant: OCID da Tenancy para o seu Oracle NoSQL Database Cloud Service. Consulte Where to Get the Tenancy's OCID and User's OCID na Documentação do Oracle Cloud Infrastructure ocid1.tenancy.oc1..<unique_ID>
    OCID do Usuário: OCID do usuário para o seu Oracle NoSQL Database Cloud Service. Consulte Where to Get the Tenancy's OCID and User's OCID na Documentação do Oracle Cloud Infrastructure. ocid1.user.oc1..<unique_ID>
    Impressão Digital: Impressão digital da chave privada que foi adicionada a este usuário.

    A impressão digital da chave de assinatura é criada durante a geração e o upload da Chave de Assinatura da API. Consulte Como Obter a Impressão Digital da Chave na Documentação do Oracle Cloud Infrastructure.

    		12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef
    Arquivo de Chave Privada: Navegue até o local em que a chave privada está armazenada. Consulte Como Gerar uma Chave de Assinatura da API para gerar a chave de assinatura com uma frase-senha opcional. /home/user/.oci/oci_api_key.pem
    Senha: Frase-senha especificada ao criar a chave privada. A frase-senha da chave de assinatura é criada durante a geração e o upload da Chave de Assinatura da API. Consulte Como Obter a Impressão Digital da Chave na Documentação do Oracle Cloud Infrastructure.

    Obrigatório, somente se a chave estiver criptografada.

    		 
    Compartimento: O nome ou o OCID do compartimento do seu esquema do Oracle NoSQL Database Cloud Service.

    Se você não fornecer nenhum valor, o campo assumirá como padrão o compartimento root.

    Você cria compartimentos no Oracle Cloud Infrastructure Identity and Access Management (IAM). Consulte Configurando sua Tenancy e Gerenciando Compartimentos na Documentação do Oracle Cloud Infrastructure.

    • Nome do compartimento

      mycompartment

    • Nome do compartimento qualificado com seu compartimento pai

      parent.compartimentofilho

    • OCID do Compartimento

      ocid1.tenancy.oc1...<unique_ID>

    Tabela 5-5 Parâmetros de Conexão CloudSim

    Campo Descrição Valor de Amostra
    Ponto Final: URL do Ponto Final de Serviço da instância do Oracle NoSQL Database Cloud Simulator. http://myinstance.cloudsim.com:8080

    Se você não especificar o valor, o padrão será http://localhost:8080.

    Identificador do Tenant: Identificador exclusivo para identificar o tenant. Tenant01

    Se você não especificar o valor, o padrão será TestTenant.

  5. Clique em Conectar.
  6. Clique em Redefinir para limpar os detalhes da conexão salva do espaço de trabalho.
  1. Crie o arquivo de configuração, por exemplo, config.json ou um arquivo com o objeto JSON. O formato de arquivo de configuração para conexão com o Oracle NoSQL Database Cloud Service ou o Oracle NoSQL Database Cloud Simulator é mostrado abaixo.

    Tabela 5-6 Modelos de Configuração

    Oracle NoSQL Database Cloud Service Oracle NoSQL Database Cloud Simulator
    Modelo de configuração para conexão usando o arquivo de configuração do 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>"
    }
  }
}
    Modelo de configuração para conexão usando credenciais de autenticação do 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 a Paleta de Comandos pressionando:
    • (Windows e Linux) Controle + Shift + X
    • (macOS) Comando + Shift + X
  3. Na Paleta de Comandos, selecione Oracle NoSQL: Conectar via Arquivo de Configuração.

    Dica:

    Digite oraclenosql na Paleta de Comandos para exibir todos os comandos do Oracle NoSQL DB que você pode usar.


    Conectar via arquivo de configuração

  4. Navegue até o local em que o arquivo *.config está armazenado e clique em Selecionar.

Gerenciando Tabelas com a Extensão de Código do Visual Studio

Depois de estabelecer conexão com sua implantação usando a extensão Visual Studio (VS) Code do Oracle NoSQL Database, use o TABLE EXPLORER localizado na navegação esquerda para:
  • Explore tabelas, colunas, índices, chaves primárias e chaves de partição.
  • Crie novas tabelas.
  • Eliminar tabelas existentes.
  • Executar consultas SQL SELECT e instruções DML em uma tabela.

EXPLORADOR DE TABELAS DO Oracle NoSQL DB

Quando você expande uma conexão ativa, o Oracle NoSQL Database VS Code mostra as tabelas nessa implantação.
  • Clique no nome da tabela para exibir suas colunas, índices, chave(s) primária(s) e chave(s) de partição. O nome da coluna é exibido junto com seu tipo de dados.
  • Você pode atualizar o esquema ou a tabela a qualquer momento para consultar novamente sua implantação e preencher o Oracle NoSQL Database Cloud Service com os dados mais atualizados.
    • No TABLE EXPLORER, localize a conexão e clique no ícone Atualizar para recarregar o esquema. Como alternativa, você pode clicar com o botão direito do mouse na conexão e selecionar Atualizar Esquema.


      Esquema de Atualização da Extensão do Oracle NoSQL DB VS Code

    • No TABLE EXPLORER, localize o nome da tabela e clique no ícone Atualizar para recarregar a tabela. Se preferir, clique com o botão direito do mouse no nome da tabela e selecione Atualizar Tabela.


      Tabela de Atualização de Código VS do Oracle NoSQL DB

Execução de Consultas SQL e Instruções DML para uma Tabela

  1. Clique com o botão direito do mouse na tabela de destino e selecione Procurar Tabela.
  2. Na janela SQL, especifique a consulta SELECT na caixa de texto e clique em
    Consulta de Execução do Oracle NoSQL DB VS Code

    . O resultado da consulta é exibido em formato tabular. Você pode ajustar o número de linhas por página. Você também pode executar instruções DML para atualizar, inserir e excluir dados de uma tabela.
  3. Para exibir dados de células individuais separadamente, clique na célula da tabela.

Eliminando uma Tabela

  1. Clique com o botão direito do mouse na tabela de destino.
  2. Clique em Eliminar Tabela.
  3. Clique em Sim para eliminar a tabela.

Criando uma Tabela do Oracle NoSQL Database Cloud Service com Base no Visual Studio Code

Você pode criar a tabela do Oracle NoSQL Database Cloud Service de dois modos:
  • Entrada DDL Simples: você pode usar este modo para criar a tabela do Oracle NoSQL Database Cloud Service de forma declarativa, ou seja, sem criar uma instrução DDL.
  • Entrada DDL Avançada: você pode usar este modo para criar a tabela do Oracle NoSQL Database Cloud Service usando uma instrução DDL.
  1. Passe o mouse sobre a conexão do Oracle NoSQL Database Cloud Service para adicionar a nova tabela.
  2. Clique no ícone Mais exibido.
  3. Na página Criar Tabela, selecione Entrada DDL Simples.


    Criar uma Tabela do Oracle NoSQL Database Cloud Service Usando o Modo de Entrada DDL Simples

    Tabela 5-7 Criar uma Tabela do Oracle NoSQL Database Cloud Service

    Campo Descrição
    Capacidade de leitura (unidades de leitura) Insira o número de unidades de leitura. Consulte Estimando a Capacidade para aprender sobre unidades de leitura.
    Capacidade de gravação (Unidades de Gravação) Insira o número de unidades de gravação. Consulte Estimando a Capacidade para aprender sobre unidades de gravação.
    Armazenamento em disco (GB) Especifique o espaço em disco em gigabytes (GB) a ser usado pela tabela. Consulte Estimando a Capacidade para obter mais informações sobre capacidade de armazenamento.
    Nome da tabela: Especifique um nome de tabela que seja exclusivo na sua tenancy. Os nomes de tabela devem estar em conformidade com as convenções de nomenclatura do Oracle NoSQL Database Cloud Service. Consulte Limites do Serviço.
    Nome da coluna Especifique um nome de coluna para a chave primária na tabela. Consulte Limites de Serviço para aprender sobre os requisitos de nomeação de coluna.
    Tipo de Coluna Selecione o tipo de dados da sua coluna de chave primária.
    Definir como Chave de Shard Selecione esta opção para definir essa coluna de chave primária como chave de partição. A chave de partição é distribuir dados no cluster do Oracle NoSQL Database Cloud Service para aumentar a eficiência e posicionar os registros que compartilham a chave de partição localmente para fácil referência e acesso. Os registros que compartilham a chave de partição são armazenados no mesmo local físico e podem ser acessados de forma atômica e eficiente.
    Remover Clique neste botão para excluir uma coluna existente.
    + Adicionar Coluna de Chave Primária Clique neste botão para adicionar mais colunas ao criar uma chave primária composta (várias colunas).
    Nome da coluna Especifique o nome da coluna. Verifique se você está de acordo com os requisitos de nomeação de coluna descritos em Limites de Serviço.
    Tipo de Coluna Selecione o tipo de dados da sua coluna de chave primária.
    Valor Padrão (opcional) Especifique um valor padrão para a coluna.
    Observação

    Não é possível especificar valores padrão para colunas dos tipos de dados binário e JSON.
    Não Nulo Selecione esta opção para especificar que uma coluna sempre deverá ter um valor.
    Remover Clique neste botão para excluir uma coluna existente.
    + Adicionar Coluna Clique neste botão para adicionar mais colunas.
    Unidade Selecione a unidade (Dias ou Horas) a ser usada para o valor de TTL das linhas da tabela.
    Valor Especifique a duração de expiração das linhas na tabela. Depois do número de dias ou horas, as linhas expiram automaticamente e não estão mais disponíveis. O valor padrão é zero, indicando que não há tempo de expiração.
    Observação

    A Atualização do Tempo de Vida (TTL) da Tabela não altera o valor de TTL dos dados existentes na tabela. O novo valor de TTL aplica-se somente às linhas adicionadas à tabela depois que esse valor é modificado e às linhas para as quais nenhum valor específico de linha de substituição foi fornecido.
  4. Clique em Mostrar DDL para exibir a instrução DDL formada com base nos valores informados nos campos do modo de entrada DDL Simples. Esta instrução DDL é executada quando você clica em Criar.
  5. Clique em Criar.
  1. Passe o mouse sobre a conexão do Oracle NoSQL Database Cloud Service para adicionar a nova tabela.
  2. Clique no ícone Mais exibido.
  3. Na página Criar Tabela, selecione Entrada DDL Avançada.


    Criar uma Tabela do Oracle NoSQL Database Cloud Service Usando o Modo de Entrada DDL Avançada

    Tabela 5-8 Criar Tabela para o Oracle NoSQL Database Cloud Service

    Campo Descrição
    Capacidade de leitura (unidades de leitura) Insira o número de unidades de leitura. Consulte Estimando a Capacidade para aprender sobre unidades de leitura.
    Capacidade de gravação (Unidades de Gravação) Insira o número de unidades de gravação. Consulte Estimando a Capacidade para aprender sobre unidades de gravação.
    Armazenamento em disco (GB) Especifique o espaço em disco em gigabytes (GB) a ser usado pela tabela. Consulte Estimando a Capacidade para obter mais informações sobre capacidade de armazenamento.
    Instrução DDL Especifique a instrução DDL de criação de tabela. Consulte a Referência SQL do Oracle NoSQL Database.
  4. Clique em Criar.

Removendo uma Conexão

O Oracle NoSQL Database Connector fornece dois métodos para remover uma conexão do Visual Studio (VS) Code.

Você pode:
  • Remover uma conexão com a Paleta de Comandos ou
  • Remova uma conexão da view do Oracle NoSQL DB na Barra de Atividades.
Observação

A remoção de uma conexão do Visual Studio Code exclui os detalhes da conexão persistida do espaço de trabalho atual.
  1. Expanda o painel TABLE EXPLORER na navegação esquerda se ele estiver recolhido.
  2. Clique com o botão direito do mouse na conexão que você deseja remover e, em seguida, clique em Remover Conexão.


Explorador da Tabela

  1. Abra a Paleta de Comandos pressionando:
    • (Windows e Linux) Controle + Shift + P
    • (macOS) Comando + Shift + P
  2. Na Paleta de Comandos, selecione OracleNoSQL: Remover Conexão.

    Dica:

    Digite oraclenosql na Paleta de Comandos para exibir todos os comandos do Oracle NoSQL DB que você pode usar.


    Remover Conexão