Tutorial 1: Crie e gerencie bancos de dados, esquemas e tabelas¶

Introdução¶

Neste tutorial, você aprenderá como enviar consultas REST para criar e gerenciar bancos de dados, tabelas e esquemas.

Crie um banco de dados e liste os bancos de dados disponíveis¶

É possível usar o Postman para criar um banco de dados e listar os bancos de dados disponíveis.

• Para criar um banco de dados, envie uma solicitação POST com o seguinte corpo de solicitação ao ponto de extremidade /api/v2/databases, conforme mostrado.

  {
    "name": "demo_db",
    "kind": "PERMANENT",
    "comment": "snowflake rest api demo-db",
    "data_retention_time_in_days": "1",
    "max_data_extension_time_in_days": "1"
  }
  

  Copy

  

• Para listar os bancos de dados disponíveis, envie uma solicitação GET ao ponto de extremidade /api/v2/databases, conforme mostrado nos exemplos a seguir:

  • Para encontrar bancos de dados cujo nome contém a cadeia de caracteres demo, especifique %25demo%25 no parâmetro de consulta like.

    

  • Para retornar o primeiro banco de dados cujo nome começa com a cadeia de caracteres, DEMO_DB, especifique DEMO_DB e 1 nos parâmetros de consulta startsWith e showLimit, respectivamente.

    

Para obter mais informações, consulte a Referência da Snowflake Database API.

Crie um esquema e liste os esquemas disponíveis¶

É possível usar o Postman para criar um esquema e listar os esquemas disponíveis.

• Para criar um esquema, envie uma solicitação POST ao ponto de extremidade /api/v2/databases/{database}/schemas, da seguinte forma:

  1. Adicione o nome do banco de dados (demo_db) à variável de caminho database no cabeçalho da solicitação.

     

  2. Adicione o nome do esquema (demo_sc) ao corpo da solicitação.

     {
       "name": "demo_sc",
     }
     

     Copy

     

• Para listar os esquemas disponíveis, envie uma solicitação GET ao ponto de extremidade /api/v2/databases/{databases}/schemas. Neste exemplo, você retorna o primeiro esquema cujo nome começa com a cadeia de caracteres, DEMO_SC, especificando DEMO_SC e 1 nos parâmetros de consulta startsWith e showLimit, respectivamente.

  

Para obter mais informações, consulte a Referência da Snowflake Schema API.

Crie uma tabela e busque os detalhes da tabela¶

É possível usar o Postman para criar uma tabela e listar as tabelas disponíveis.

• Para criar uma tabela, envie uma solicitação POST ao ponto de extremidade /api/v2/databases/{database}/schemas/{schema}/tables, da seguinte forma:

  1. Adicione o nome do banco de dados (demo_db) e o nome do esquema (demo_sc) nas variáveis de caminho database e database, respectivamente, no cabeçalho da solicitação.

     

  2. Adicione o nome da tabela (demo_tbl) e as colunas da tabela ao corpo da solicitação. Neste caso, você adicionou uma coluna nomeada C1.

     {
       "name": "demo_tbl",
       "columns": [
         {
         "name": "c1",
         "datatype": "integer",
         "nullable": true,
         "comment": "An integral value column"
         }
       ],
       "comment": "Demo table for Snowflake REST API"
     }
     

     Copy

     

• Para buscar a tabela que você acabou de criar, envie uma solicitação GET ao ponto de extremidade /api/v2/databases/{database}/schemas/{schema}/tables/{name}. Neste caso, você especifica demo_db, demo_sc e demo_tbl nas variáveis de caminho database, schema e name, respectivamente.

  

Para obter mais informações, consulte a Referência da Snowflake TableAPI.

Alteração de uma tabela e busca dos detalhes da tabela¶

É possível usar o Postman para alterar uma tabela.

• Para alterar a tabela que você criou no último tutorial, envie uma solicitação PUT ao ponto de extremidade /api/v2/databases/{database}/schemas/{schema}/tables/{name}, da seguinte maneira:

  1. Especifique os nomes do banco de dados, da esquema e da tabela criada nas variáveis de​caminho correspondentes.

     

  2. No corpo da solicitação, insira a nova definição de tabela. Neste caso, você adiciona uma nova coluna à tabela.

     {
       "name": "demo_tbl",
       "columns": [
         {
         "name": "c1",
         "datatype": "integer",
         "nullable": true,
         "comment": "An integral value column"
         },
         {
         "name": "c2",
         "datatype": "string",
         "comment": "An string value column"
         }
       ],
       "comment": "Demo table for Snowflake REST API"
     }
     

     Copy

     

• Verifique a alteração buscando os detalhes da tabela enviando uma solicitação GET ao ponto de extremidade /api/v2/databases/{database}/schemas/{schema}/tables/{name}. Neste caso, você especifica demo_db, demo_sc e demo_tbl nas variáveis de caminho database, schema e name, respectivamente.

  

  Observe que a tabela agora contém uma nova coluna C2.

Para obter mais informações, consulte a Referência da Snowflake TableAPI.

Listagem de tabelas disponíveis¶

É possível usar o ponto de extremidade /api/v2/databases/{database}/schemas/{schema}/tables para retornar listas de todas as tabelas disponíveis para você.

• Para listar todas as tabelas disponíveis, envie uma solicitação GET ao ponto de extremidade /api/v2/databases/{database}/schemas/{schema}/tables sem parâmetros de consulta, da seguinte forma. Neste caso, você especifica demo_db e demo_sc, e demo_tbl nas variáveis de caminho database, schema e name, respectivamente.

  

• Para listar detalhes completos das colunas e restrições em cada tabela, adicione o parâmetro de consulta recursive e defina o valor como true, conforme mostrado. Esteja ciente de que habilitar esse parâmetro de consulta pode sobrecarregar sua conexão se você tiver várias tabelas complexas.

  

Para obter mais informações, consulte a Referência da Snowflake TableAPI.

Qual é o próximo passo?¶

Parabéns! Neste tutorial, você aprendeu os fundamentos para gerenciar recursos de banco de dados, esquema e tabela Snowflake usando o Snowflake REST APIs.