Environments
Lists deployment environments configured for a repository, including environment names, statuses, and related configuration data.
Table-Specific Information
Select
The add-in uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
- Name supports the '=,IN' comparison operators.
- IsPinned supports the '=' comparison operator.
For example, the following queries are processed server-side:
SELECT * FROM [Environments]
SELECT * FROM [Environments] WHERE [Name] = 'Val1'
SELECT * FROM [Environments] WHERE [IsPinned] = true
The add-in processes other filters client-side within the add-in.
The add-in uses the GitHub API to process ORDER BY clause conditions that are built with the following column: Name
SELECT * FROM [Environments] ORDER BY [Name]
The add-in uses client-side processing when ordering by any other columns. This impacts performance.
Update
You can use the following column to update a record: IsPinned
UPDATE [Environments] SET [IsPinned] = true WHERE [Id] = 'EN_kwDOLvThzs8AAAABBc1m-g'
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True |
The unique node ID assigned to the Environment object. | |
DatabaseId | Long | True |
The primary key that uniquely identifies this environment in the database. | |
Name | String | True |
The name of the environment. | |
IsPinned | Bool | False |
Indicates whether the environment is currently pinned to the repository (true or false). | |
PinnedPosition | Int | True |
The position of the environment in the list, if it is pinned; null if the environment is not pinned. | |
LatestCompletedDeploymentId | String | True |
The Node ID of the most recent completed deployment in this environment. | |
LatestCompletedDeploymentState | String | True |
The current state of the latest completed deployment (for example, 'success', 'failed'). |