This repository was archived by the owner on Sep 25, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Add docs for VS Code environment variables #56
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| # How to add Environment variables to VS Code | ||
|
|
||
| ## Table of Contents | ||
| - [Overview of Environment Variables in VS Code](#overview-of-environment-variables-in-vs-code) | ||
| - [User Level Environment Variables](#user-level) | ||
| - [Environment Level Environment Variables](#environment-level) | ||
| - [Project Level Environment Variables](#project-level) | ||
| - [Creating Environment Variables](#creating-variables) | ||
| - [Deleting Environment Variables](#deleting-variables) | ||
|
|
||
| ## Overview of Environment Variables in VS Code | ||
|
|
||
| Datacoves injects several[ environment variables](/reference/vscode/datacoves-env-vars.md) on your behalf. However, you may need to add additional variables to run scripts, test code etc. This doc will walk you through adding your own environment variables at the user, environment and project level. These variables are only available in your VS Code, not Airflow. For Airflow we recommend you use Airflow Variables or [Datacoves Secrets](/reference/admin-menu/secrets.md) | ||
|
|
||
| ## User Level | ||
|
|
||
| Environment variables set at the user level will only be available to the workspace environment of the individual who created them. | ||
|
|
||
| ### Step 1: Navigate to your user settings in the top right-hand corner | ||
|
|
||
|  | ||
|
|
||
| ### Step 2: Navigate to `VS Code Environment Variables` | ||
| ### Step 3: Select `Add` | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Environment Level | ||
|
|
||
| >[!NOTE] You must have admin permissions to add variables across the project or user environments. | ||
|
|
||
| Environment level variables will be available to everyone with access to the environment ie) The Development Environment. | ||
|
|
||
| ### Step 1: Navigate to the environment menu | ||
|
|
||
|  | ||
|
|
||
| ### Step 2: Navigate to `VS Code Environment Variables` | ||
|
|
||
|  | ||
|
|
||
| ### Step 3: Select `Add` | ||
|
|
||
|  | ||
|
|
||
| ## Project Level | ||
|
|
||
| Project level variables will be available across all environments in a project. | ||
|
|
||
| ### Step 1: Navigate to the project menu | ||
|
|
||
|  | ||
|
|
||
| ### Step 2: Navigate to `VS Code Environment Variables` | ||
|
|
||
|  | ||
|
|
||
| ### Step 3: Select `Add` | ||
|
|
||
|  | ||
|
|
||
| ## Creating variables | ||
|
|
||
| Creating variables is simple. Add the key following the correct format and add the desired value. | ||
|
|
||
|  | ||
|
|
||
| ## Deleting variables | ||
|
|
||
| Deleting variables is also simple. Simply navigate to the Project or Environment settings. | ||
|
|
||
| ### Step 1: Toggle the delete option or the red trashcan | ||
|
|
||
| ### Step 2: Save Changes | ||
|
|
||
| If you do not save changes, the variable will not be deleted. | ||
|
|
||
|  | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.