Gestion des projets DCM avec Snowflake CLI¶

Vous pouvez gérer un DCM project avec Snowflake CLI. Pour plus d’informations sur les projets DCM, voir Snowflake DCM Projects.

Installer Snowflake CLI avec les fonctions DCM project¶

Pour utiliser les commandes snow dcm, vous devez installer Snowflake CLI version 3.16.0 ou ultérieure. Pour plus d’informations, voir Installation de Snowflake CLI.

Vérifier que vous disposez d’une connexion valide à Snowflake¶

Snowflake CLI nécessite une connexion opérationnelle pour interagir avec Snowflake. Pour plus d’informations sur la gestion des connexions, voir Configuration de Snowflake CLI.

Activer les commandes DCM dans Snowflake CLI¶

Pour utiliser les commandes DCM, vous devez activer l’indicateur de fonctionnalité SNOWFLAKE_CLI_FEATURES_ENABLE_SNOWFLAKE_PROJECTS, en utilisant l’une des méthodes suivantes :

Définissez la variable d’environnement SNOWFLAKE_CLI_FEATURES_ENABLE_SNOWFLAKE_PROJECTS sur true avant d’exécuter la commande.
Définissez l’option de configuration enable_snowflake_projects sur true dans le fichier config.toml, comme indiqué dans l’exemple suivant :
```
[cli.features]
enable_snowflake_projects = true
```

Initialiser un DCM project à partir d’un modèle¶

Pour initialiser un DCM project à partir d’un modèle, utilisez la commande snow init :
```
snow init <project_dir_name> --template dcm_project
```
où :codenowrap :<project_dir_name> est le répertoire avec les fichiers DCM project. Ce répertoire est créé par la commande snow init et est rempli avec les fichiers de projet générés à partir du modèle spécifié.

Par exemple, la commande suivante crée les fichiers de projet dans le répertoire MY_PROJECT :
```
snow init MY_PROJECT --template dcm_project
```

commandes Snowflake CLI¶

Pour prendre en charge DCM Projects, Snowflake CLI a ajouté les commandes suivantes :

Créer et déployer des projets DCM projects¶

Cette section explique comment créer, valider et déployer des projets DCM projects avec Snowflake CLI.

Créer une DCM project¶

Utilisez la commande snow dcm create pour créer un nouveau DCM project dans Snowflake. L’identificateur du projet peut être spécifié directement sous forme d’argument ou résolu à partir du fichier manifest.yml.

Créez un projet en utilisant l’identificateur de la cible par défaut spécifiée dans le manifeste :
```
snow dcm create
```
Créez un projet en utilisant l’identificateur depuis la cible dev spécifiée dans le manifeste :
```
snow dcm create --target dev
```
Créez un projet uniquement s’il n’existe pas déjà :
```
snow dcm create --if-not-exists
```

Pour plus d’informations, voir snow dcm create.

Planifier un projet DCM project¶

Utilisez la commande snow dcm plan pour valider votre projet avant de le déployer. Cette commande montre les changements qui seraient appliqués sans réellement apporter de modifications.

Validez un projet :
```
snow dcm plan
```
Validez avec substitution de variable :
```
snow dcm plan -D "db_name=my_database" -D "schema_name=my_schema"
```
Validez en utilisant un profil cible spécifique et enregistrez la sortie :
```
snow dcm plan --target dev --save-output
```
Lorsque vous utilisez --save-output, la commande enregistre la réponse et les artefacts dans un répertoire local:file:out/.

Pour plus d’informations, voir snow dcm plan.

Déployer un DCM project¶

Utilisez la commande snow dcm deploy pour appliquer les modifications définies dans votre DCM project à Snowflake.

Déployer un projet :
```
snow dcm deploy
```
Déployer avec une substitution de variable :
```
snow dcm deploy -D "table_name='MY_DB.PUBLIC.MY_TABLE'"
```
Déployer avec un alias pour le déploiement :
```
snow dcm deploy --alias v1.0
```
Déployer à partir d’un répertoire spécifique à l’aide d’un profil cible :
```
snow dcm deploy --from /path/to/project --target prod
```

Pour plus d’informations, voir snow dcm deploy.

Prévisualiser un DCM project¶

Utilisez la commande snow dcm preview pour renvoyer des lignes à partir de n’importe quelle table, vue ou table dynamique définie dans votre projet. Cette commande est utile pour tester vos définitions avant ou après le déploiement.

Prévisualiser les données d’une table :
```
snow dcm preview --object MY_DB.PUBLIC.MY_TABLE
```
Prévisualiser avec une limite de lignes :
```
snow dcm preview --object MY_DB.PUBLIC.MY_VIEW --limit 10
```
Prévisualiser avec substitution de variable :
```
snow dcm preview --object MY_DB.PUBLIC.MY_VIEW -D "filter_date='2024-01-01'"
```

Pour plus d’informations, voir snow dcm preview.

Tester une DCM project¶

Utilisez la commande snow dcm test pour exécuter toutes les attentes (fonctions de métrique des données) définies dans votre projet. Cette commande valide les règles de qualité des données et renvoie les résultats de réussite/d’échec.

Tester un projet :
```
snow dcm test
```
Tester en utilisant un profil cible :
```
snow dcm test --target dev
```
Tester et enregistrer les résultats :
```
snow dcm test --save-output
```

La commande renvoie le code de sortie 0 si tous les tests réussissent, ou le code de sortie 1 si un test échoue.

Pour plus d’informations, voir snow dcm test.

Actualiser un DCM project¶

Utilisez la commande snow dcm refresh pour actualiser toutes les tables dynamiques définies dans votre DCM project. Cela déclenche une actualisation immédiate des données.

Actualiser les tables dynamiques d’un projet :
```
snow dcm refresh
```
Actualiser à l’aide d’un profil cible :
```
snow dcm refresh --target prod
```
Actualiser et enregistrer la sortie :
```
snow dcm refresh --save-output
```

La commande indique l’état de chaque table dynamique, y compris le nombre de lignes insérées et supprimées.

Pour plus d’informations, voir snow dcm refresh.

Détruire un DCM project¶

Utilisez la commande snow dcm drop pour détruire un DCM project. Cette commande supprime le projet et toutes ses versions. La zone de préparation associée au projet n’est pas supprimée.

Détruire un projet :
```
snow dcm drop
```
Détruire un projet uniquement s’il existe :
```
snow dcm drop --if-exists
```

Pour plus d’informations, voir snow dcm drop.

Gérer les DCM projects déployés¶

Après avoir déployé un DCM project, vous pouvez répertorier et gérer des déploiements individuels.

Répertorier les DCM projects déployés¶

Utilisez la commande snow dcm list-deployments pour répertorier tous les déploiements d’un DCM project donné.

Répertorier les déploiements d’un projet :
```
snow dcm list-deployments
```
Répertorier les déploiements à l’aide d’un profil de cible :
```
snow dcm list-deployments --target dev
```

La sortie affiche le nom de déploiement et l’alias (s’il est défini) de chaque déploiement.

Pour plus d’informations, voir snow dcm list-deployments.

Détruire les DCM projects déployés¶

Utilisez la commande snow dcm drop-deployment pour détruire un déploiement spécifique d’un DCM project.

Supprimer un déploiement par son nom :
```
snow dcm drop-deployment --deployment 'DEPLOYMENT$1'
```
Note

Pour les noms de déploiement contenant $, utilisez des guillemets simples pour empêcher l’expansion de shell.
Détruire un déploiement par alias :
```
snow dcm drop-deployment --deployment v1.0
```
Supprimer un déploiement uniquement s’il existe :
```
snow dcm drop-deployment --deployment v1.0 --if-exists
```

Pour plus d’informations, voir snow dcm drop-deployment.