Extension Databricks pour Visual Studio Code

L'extension Databricks pour Visual Studio Code vous permet de vous connecter à vos workspaces Databricks distants depuis Visual Studio Code ou Cursor sur votre machine de développement locale. Vous pouvez ensuite :

• Définissez, déployez et exécutez des Declarative Automation Bundles pour appliquer les modèles et les meilleures pratiques CI/CD à vos Lakeflow Jobs, Lakeflow Pipelines et MLOps Stacks à l’aide de l’interface utilisateur de Visual Studio Code. Voir Que sont les Declarative Automation Bundles ? et les fonctionnalités d’extension des Declarative Automation Bundles.
• Exécutez des fichiers de code Python locaux de Visual Studio Code sur des clusters Databricks ou un compute Serverless dans vos Workspaces distants. Voir Exécuter un fichier Python sur un cluster.
• Exécutez des fichiers de code Python locaux (.py) et des Notebooks Python, R, Scala et SQL (.py, .ipynb, .r, .scala et .sql) depuis Visual Studio Code en tant que Lakeflow Jobs dans vos Workspaces distants. Voir Exécuter un fichier Python en tant que Job.
• Configurez votre environnement de debugging et Databricks Connect à l'aide d'une simple liste de contrôle qui déclenche des dialogues de sélection. Consultez Déboguer du code à l'aide de Databricks Connect pour l'extension Databricks pour Visual Studio Code.
• Déboguer les Notebooks cellule par cellule dans Visual Studio Code avec Databricks Connect. Consultez Exécuter et déboguer les cellules de Notebook avec Databricks Connect à l'aide de l'extension Databricks pour Visual Studio Code.
• Synchronisez le code local que vous développez dans Visual Studio Code avec le code dans vos Workspace distants. Consultez Synchronisez votre dossier Workspace avec Databricks

remarque

L’extension Databricks pour Visual Studio Code prend en charge l’exécution de notebooks R, Scala et SQL en tant de jobs automatisés, mais n’offre aucun support plus approfondi pour ces langages au sein de Visual Studio Code.

Get start

Pour start avec l’extension Databricks pour Visual Studio Code :

• Installer l’extension.
• Créez un nouveau projet Databricks ou convertissez un projet Visual Studio Code existant.
• Configurez facilement votre projet à l'aide de l'interface utilisateur de l'extension Databricks.
• Exécutez du code Python dans le cadre du tutoriel d'extension.
• Déboguez votre code à l'aide de l'intégration Databricks Connect.
• Testez votre code à l’aide de pytest. Voir Exécuter des tests Python à l'aide de l'extension Databricks pour Visual Studio Code.

Créer un nouveau projet Databricks

Une fois l'extension installée, vous pouvez créer un nouveau projet Databricks à l'aide de l'extension Databricks pour Visual Studio Code :

1. Lancer Visual Studio Code.
2. Cliquez sur l'icône Databricks dans la barre latérale de Visual Studio Code pour ouvrir l'extension.
3. Cliquez sur Créer un nouveau projet .
4. Dans la Palette de commandes , sélectionnez un hôte et une méthode d'authentification pour le projet. Voir Configurer l'autorisation pour l'extension Databricks pour Visual Studio Code.
5. Dans Indiquez un chemin d’accès à un dossier où vous souhaitez que votre nouveau projet se trouve , entrez le chemin d’accès à un dossier sur votre ordinateur de développement local où vous souhaitez créer le projet, ou cliquez sur Ouvrir la boîte de dialogue de sélection de dossier et sélectionnez le chemin d’accès au dossier de projet.
6. Pour Template to use dans la vue d'initialisation du projet Databricks, utilisez les flèches haut et bas pour sélectionner un Template de projet, puis appuyez sur Entrée . Pour plus d'informations sur les templates de projets de bundle, consultez les templates de projets Declarative Automation Bundles.
7. Saisissez un nom unique pour ce projet ou laissez le nom de projet par default my_project, puis appuyez sur Entrée .
8. Choisissez d'ajouter un Notebook stub (échantillon), un pipeline Delta Live Tables stub (échantillon) ou un package Python stub (échantillon) au projet, ou toute combinaison de ces stubs (échantillons).
9. Appuyez sur n’importe quelle touche pour fermer l’ Databricks Project Init editor tab.
10. Pour Sélectionnez le projet que vous souhaitez ouvrir , choisissez le projet que vous venez de créer.

Ouvrez un projet Declarative Automation Bundles existant

Un projet Declarative Automation Bundles contient un fichier databricks.yml dans le dossier racine du projet. Voir la configuration des Declarative Automation Bundles. Si vous souhaitez utiliser l'extension avec un projet Declarative Automation Bundles existant :

1. Lancez Visual Studio Code. Dans le menu principal, cliquez sur Fichier > Ouvrir le dossier et accédez au répertoire qui contient votre projet de bundle.

2. Cliquez sur l'icône Databricks dans la barre latérale de Visual Studio Code pour ouvrir et commencer à utiliser les fonctionnalités de l'extension.

   Si l'extension Databricks pour Visual Studio Code découvre plus d'un projet Declarative Automation Bundles dans le dossier actuel, elle vous permet de choisir d'ouvrir un projet ou de créer un fichier de configuration de projet dans le dossier racine.

   

   • Si vous avez choisi un projet, dans la Palette de commandes , sélectionnez votre projet Declarative Automation Bundles existant.
   • Si vous créez une configuration dans le dossier racine, ce dossier devient un projet bundle.

3. Sélectionnez un hôte et une méthode d'authentification pour le projet. Consultez Configuration de l'autorisation pour l'extension Databricks pour Visual Studio Code.

remarque

Si vous ouvrez un projet créé à l'aide de l'extension Databricks pour Visual Studio Code v1, une tentative de migration est effectuée automatiquement en utilisant l'authentification et la configuration du Workspace existantes du projet. Le bouton de migration est disponible uniquement si la migration automatique échoue.

Basculer entre les projets Databricks

L'extension Databricks pour Visual Studio Code vous permet d'avoir plusieurs projets Databricks dans votre workspace Visual Studio Code et de passer facilement de l'un à l'autre. Avec votre projet multi-bundle ouvert dans le workspace Visual Studio Code :

1. Cliquez sur l'icône Databricks dans la barre latérale de Visual Studio Code pour ouvrir l'extension.

2. Cliquez sur Dossier local pour sélectionner le projet que l'extension doit utiliser.

   

remarque

Les actions d'exécution sont uniquement disponibles pour les fichiers dans le bundle actif.

Convertir un projet en projet Databricks

Si vous avez un projet existant que vous souhaitez convertir en projet Databricks :

1. Lancez Visual Studio Code. Dans le menu principal, cliquez sur Fichier > Ouvrir le dossier et naviguez jusqu’à votre projet pour l’ouvrir.
2. Cliquez sur l'icône Databricks dans la barre latérale de Visual Studio Code pour ouvrir l'extension.
3. Cliquez sur Créer la configuration .
4. Dans la Palette de commandes , sélectionnez un hôte et une méthode d'authentification pour le projet. Voir Configurer l'autorisation pour l'extension Databricks pour Visual Studio Code.