Skip to main content

Ganymede Metadata Tables

Ganymede metadata tables allow users to query and reference details about flow runs, tables, and files stored within the Ganymede platform. These tables can be utilized for various purposes, such as debugging previous runs, locating specific files or table records associated with past runs, and systematically displaying tags used to contextualize and ensure traceability of captured data.

The tables described below are found in the Ganymede database under the metadata schema, and can be referenced in Dashboards.

Flow Runs

The flow_run_metadata table captures a record for each flow execution.

Field NameDescription
start_timeStart time of the Flow run
end_timeEnd time of the Flow run
export_timeTime of the Flow run export
flow_run_idUnique identifier for the Flow run, stored as epoch time in milliseconds
flow_idFlow name
inputs_dictRun context for the Flow; corresponds to the run context described in the Ganymede Class overview
initiatorFlow run initiator; agent name + MAC address for agent-initiated Flows, user email for user-initiated flows, event name for event-triggered Flows, or Flow name if triggered from another Flow
initiator_typeType of the user who initiated the flow run (AGENT, USER, EVENT, FLOW)
flow_versionCommit hash associated with flow execution
stateFinal disposition of Flow run (Success, Failed)
table_outputJSON containing database table write info associated with Flow run; table, type of write operation (e.g. - replace, append), table columns, and row count are available in data

Application Sessions

public_application_session

Field NameData TypeDescription
applicationstringThe name of the application
endTimestringThe end time of the application session
idstringThe id of the application session
initiatorstringThe user who started the session
inputFilestextA comma delimited list of file URIs that were provided to the application session
outputFilestextA comma delimited list of file URIs that were generate by the application session
startTimestringThe start time of the application session

public_application_session_users_user

This table contains a record for each user associated with an application session. The table is joined to the public_application_sessiontable by the applicationSessionId field.

Field NameData TypeDescription
applicationSessionIdstringThe id of the application session
userIdintegerThe id of a user who accessed an application session

Files

public_file

Field NameData TypeDescription
createdAtbigintTime of the file save, stored as epoch time in milliseconds
creatorstringName of the file creator (e.g. - email address for users, Connection id for Agents)
creatorTypestringType of the file creator (e.g. - User, Agent)
hostPathstringThe path of the file on the host PC
pathstringPath within storage bucket to file
sizebigintThe size of the file in bytes
uristringFull URI to the file

public_file_tag

Field NameData TypeDescription
appliedDatetimestamp with time zoneThe time the File Tag was applied to the File
displayValuestringThe display value of the File Tag
file_uristringThe uri of the File
tagIdstringThe unique id associated with the File Tag value
tagTypeIdstringThe id of the File Tag Type
updatedDatetimestamp with time zoneThe time the File Tag was updated (if allowed)
urlstringThe URL associated with the File Tag value

public_file_tag_type

Field NameData TypeDescription
allowMultiplebooleanWhether the File Tag is allowed to have multiple Tag Values applied to one File
backgroundColorstringThe hex code of the File Tag color
descriptionstringThe description of the File Tag Type
hasUrlbooleanWhether or not the File Tag Type supports URLs
iconstringThe icon of the File Tag Type
idstringThe id of the File Tag Type
textColorstringThe hex code of the File Tag text color
typestringThe name of the File Tag Type

Flow Runs

public_flow

Field NameData TypeDescription
descriptionstringDescription of the Flow
displayNamestringThe display name of the Flow
docsMarkdownstringThe Markdown description of the Flow
idintegerThe id of the Flow
namestringThe name of the Flow
ownerstringThe email of the User that owns the Flow
schedulestringThe cron schedule of the Flow

public_flow_run

Field NameData TypeDescription
end_timetimestamp with time zoneThe time that the Flow Run ended
execution_timetimestamp with time zoneThe time that the Flow Run started running
flowIdintegerThe id of the Flow
idintegerThe id of the Flow Run
initiatorstringName of the Flow run initiator (e.g. - email address for users, Connection id for Agents)
initiator_typeUSER-DEFINEDType of the user who initiated the flow run (AGENT, USER, EVENT, FLOW)
run_idstringThe id of the Flow RUn as used by the orchestrator
start_timetimestamp with time zoneThe time that the Flow Run was requested to start
statestringFinal disposition of Flow run (Success, Failed)

Instruments

public_instrument

Field NameData TypeDescription
connectionIdstringThe Connection id that is associated with this Instrument
costPerRunstringThe user-defined cost per run
idintegerThe id of the instrument
locationstringThe user-defined location of the instrument
manufacturerstringThe user-defined location of the instrument
metadatastringThe user-configurable metadata of the instrument
modelstringThe user-defined model of the instrument
namestringThe user-defined name of the instrument
serialstringThe user-defined serial number of the instrument

Users

public_user

Field NameData TypeDescription
emailstringThe User's email address
idintegerThe internal id of the User
lastActiveAttimestamp with time zoneThe last time the User made an auditable action in the Ganymede platform
lastSeenAttimestamp with time zoneThe last time the User was seen by the Ganymede platform
rolestringThe users role within the environment