Tutoriel 1 : Créer et gérer des bases de données, des schémas et des tables.¶

Introduction¶

Dans ce tutoriel, vous apprendrez à soumettre des requêtes REST pour créer et gérer des bases de données, des tables et des schémas.

Créer une base de données et répertorier les bases de données disponibles¶

Vous pouvez utiliser Postman pour créer une base de données et répertorier les bases de données disponibles.

• Pour créer une base de données, envoyez une requête POST avec le corps de requête suivant au point de terminaison /api/v2/databases, comme indiqué.

  {
    "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

  

• Pour lister les bases de données disponibles, envoyez un point de terminaison GET request to the /api/v2/databases, comme indiqué dans les exemples suivants :

  • Pour rechercher les bases de données dont le nom contient la chaîne, demo, précisez %25demo%25 dans le paramètre de requête like.

    

  • Pour renvoyer la première base de données dont le nom commence par la chaîne, DEMO_DB, précisez DEMO_DB et 1 dans les paramètres de requête startsWith et showLimit, respectivement.

    

Pour plus d’informations, voir la référence d’API Snowflake Database.

Créer un schéma et lister les schémas disponibles¶

Vous pouvez utiliser Postman pour créer un schéma et répertorier les schémas disponibles.

• Pour créer un schéma, envoyez une requête POST au point de terminaison /api/v2/databases/{database}/schemas, comme suit :

  1. Ajoutez le nom de la base de données (demo_db) à la variable de chemin database dans l’en-tête de la requête.

     

  2. Ajoutez le nom du schéma (demo_sc) au corps de la requête.

     {
       "name": "demo_sc",
     }
     

     Copy

     

• Pour répertorier les schémas disponibles, envoyez un point de terminaison GET request to the /api/v2/databases/{database}/schemas. Dans cet exemple, vous renvoyez le premier schéma dont le nom commence par la chaîne, DEMO_SC, en spécifiant DEMO_SC et 1 dans les paramètres de requête startsWith et showLimit, respectivement.

  

Pour plus d’informations, voir la référence d’API Snowflake Schema.

Créer une table et récupérer les détails de la table¶

Vous pouvez utiliser Postman pour créer une table et répertorier les tables disponibles.

• Pour créer une table, envoyez une requête POST au point de terminaison /api/v2/databases/{database}/schemas/{schema}/tables, comme suit :

  1. Ajoutez le nom de la base de données (demo_db) et le nom du schéma (demo_sc) dans le variables de chemin database et database, respectivement, dans l’en-tête de la requête.

     

  2. Ajoutez le nom de la table (demo_tbl) et les colonnes de la table dans le corps de la requête. Dans ce cas, vous avez ajouté une colonne nommée C1.

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

     Copy

     

• Pour récupérer la table que vous venez de créer, envoyez une requête GET au point de terminaison /api/v2/databases/{database}/schemas/{schema}/tables/{name}. Dans ce cas, vous spécifiez demo_db, demo_sc, et demo_tbl dans les variables de chemin database, schema et name, respectivement.

  

Pour plus d’informations, voir la référence d’API Snowflake Table.

Modifier une table et récupérer les détails de la table¶

Vous pouvez utiliser Postman pour modifier une table.

• Pour modifier la table que vous avez créée dans le dernier tutoriel, envoyez une requête PUT au point de terminaison /api/v2/databases/{database}/schemas/{schema}/tables/{name}, comme suit :

  1. Spécifiez les noms de la base de données, du schéma et de la table que vous avez créés dans les variables de chemin correspondantes.

     

  2. Dans le corps de la requête, entrez la nouvelle définition de table. Dans ce cas, vous ajoutez une nouvelle colonne à la table.

     {
       "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

     

• Vérifiez le changement en récupérant les détails de la table en envoyant un point de terminaison GET request to the /api/v2/databases/{database}/schemas/{schema}/tables/{name}. Dans ce cas, vous spécifiez demo_db, demo_sc, et demo_tbl dans les variables de chemin database, schema et name, respectivement.

  

  Notez que la table contient désormais une nouvelle colonne C2.

Pour plus d’informations, voir la référence d’API Snowflake Table.

Répertorier les tables disponibles¶

Vous pouvez utiliser le point de terminaison /api/v2/databases/{database}/schemas/{schema}/tables pour renvoyer des listes de toutes les tables disponibles.

• Pour lister toutes les tables disponibles, envoyez une requête GET au point de terminaison /api/v2/databases/{database}/schemas/{schema}/tables sans paramètres de requête, comme suit. Dans ce cas, vous spécifiez demo_db et demo_sc, et demo_tbl dans les variables de chemin database, schema et name, respectivement.

  

• Pour répertorier tous les détails des colonnes et des contraintes dans chaque table, ajoutez le paramètre de requête recursive et définissez la valeur sur true, comme indiqué. Sachez que l’activation de ce paramètre de requête peut surcharger votre connexion si vous avez plusieurs tables complexes.

  

Pour plus d’informations, voir la référence d’API Snowflake Table.

Quelle est la prochaine étape ?¶

Félicitations ! Dans ce tutoriel, vous avez appris les principes fondamentaux de la gestion des ressources de base de données, de schéma et de table Snowflake à l’aide de Snowflake REST APIs.