Skip to main content

Environment Variables

  • There are reserved variables such as Workspace ID that can be utilized.
  • Environment variables can be set from the Canvas using SideApp, Trigger, and Function.
  • Secrets are also set up as environment variables for use.

Reserved Environment Variables

Variable NameUsable NodesPurposeFormat
EBS_NAMESPACE_IDSideApp, Function, TriggerThe ID of the Namespace where the node's container runsGenerated automatically as alphanumeric string of 16 characters like 12ad92b1c3fcbccd. It is displayed on the right side of the screen when no node is selected on Canvas.
EBS_WORKSPACE_IDSideApp, Function, TriggerThe ID of the Workspace where the node's container runsSet arbitrarily from the Canvas like ws01.
EBS_LAYERIDFunctionThe layer ID in Trigger-Pipeline connected to layered EntityCan be specified arbitrarily by attaching layerid as a parameter in the format layer={id} such as 001.
EBS_COMPONENT_IDSideApp, Function, TriggerValue connecting Workspace ID and the corresponding node ID with a hyphenCan be set arbitrarily on Canvas. For example, if the Workspace ID is ws01 and the node ID is streamlit, this environment variable's value will be ws01-streamlit.
EBS_COMPONENT_TYPESideApp, Function, TriggerType of the nodeFor SideApp it will be sideapp, for Function in Pipeline it will be pipeline, for Trigger it will be trigger.
EBS_ENVIRONMENTSideApp, Function, TriggerValue to distinguish between the exaBase Studio environment and othersAutomatically set to true in the exaBase Studio environment.
EBS_STORAGE_MOUNTPOINTSideApp, Function, TriggerThe root path where information about storage is stored. This is an internal variable and is not intended for user application.Fixed value path will be set.

Setting Environment Variables

  • Select SideApp, Function, or Trigger node and press + in the right panel of the screen to set the Key and Value.
  • Pre-registered secrets can also be set as environment variables from this interface. For more details on how to use secrets, please refer to here.

Usage

  • Can be used as OS-level environment variables.
  • For example, if using Python code, you can access it by specifying the key like this:
import os

print(os.getenv("key"))