Skip to content

schema.md

Latest commit

 

History

History
125 lines (100 loc) · 5.61 KB

schema.md

File metadata and controls

125 lines (100 loc) · 5.61 KB
Raw
stage Orbit
group Context Systems
info To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description See which GitLab data and code GitLab Orbit indexes.
title GitLab Orbit indexed data

{{< details >}}

  • Tier: Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

GitLab Orbit indexes two kinds of data into one graph:

  • Software development lifecycle (SDLC) objects from GitLab, such as groups, projects, users, merge requests, pipelines, work items, and security findings
  • Source code on the default branch of each project, such as files, directories, definitions, imports, and calls

Binary files get only a File node, with no definitions. GitLab Orbit does not index other branches. The local graph on your machine holds only code.

The graph links these objects. For example, a merge request belongs to a project, runs a pipeline, and fixes a vulnerability. A file is on a branch of the project and defines a definition.

Project hub graph. A merge request, a pipeline, a vulnerability, and a branch link to the project. A file on the branch defines a definition. {.orbit-graph-figure .orbit-graph-light}

Project hub graph. A merge request, a pipeline, a vulnerability, and a branch link to the project. A file on the branch defines a definition. {.orbit-graph-figure .orbit-graph-dark}

<style> .docs-content .orbit-graph-figure { max-width: 42.5rem; margin: 0 auto var(--gl-spacing-scale-7); } .docs-content .orbit-graph-figure img { display: block; width: 100%; height: auto; padding: 0; border: 0; border-radius: 0; } .docs-content .orbit-graph-dark { display: none; } .gl-dark .docs-content .orbit-graph-light { display: none; } .gl-dark .docs-content .orbit-graph-dark { display: block; } </style>

Get the live schema

The node types, properties, and relationships change between releases. To see the current schema, use one of these methods:

  • In GitLab, in the top bar, select Search or go to > Your work > GitLab Orbit, then select the Schema tab. On GitLab.com, go to https://gitlab.com/dashboard/orbit/schema. For more information, see GitLab Orbit dashboard.
  • In a terminal, run glab orbit schema. To show the properties and relationships of node types, add their names, for example glab orbit schema MergeRequest Project.
  • In GitLab 19.6 and later, in the GraphQL API, query Query.orbit.schema. For more information, see OrbitSchema.
  • In a query, for example in the Query editor tab of the GitLab Orbit dashboard or with glab orbit query, run CALL db.schema().

Supported languages

Each language gets files, directories, and definitions. Most languages also get imports and cross-file calls.

Language File extensions Limits
Bash/Shell .sh, .bash, .zsh Function definitions and source or . imports only. No cross-file calls.
C .c, .h None
C++ .cpp, .cc, .cxx, .hpp, .hh, .hxx None
C# .cs None
Elixir .ex, .exs None
Go .go None
HCL (Terraform) .tf, .tfvars None
Java .java None
JavaScript .js, .jsx, .mjs, .cjs, .vue, .graphql, .gql, .json None
Kotlin .kt, .kts None
Lua .lua Cross-file calls on module tables loaded with require only. No cross-file calls to global functions.
PHP .php, .phtml, .php3, .php4, .php5, .php7, .phps None
Python .py None
Ruby .rb, .rbw, .rake, .gemspec None
Rust .rs Cross-file CALLS and EXTENDS relationships. No other reference relationships.
Scala .scala, .sc None
Swift .swift No cross-file calls.
TypeScript .ts, .tsx, .mts, .cts None
YAML .yml, .yaml Anchors and aliases. Mapping keys become definitions only in GitLab CI, ArgoCD, Helm, and Docker Compose files. No cross-file references.
Zig .zig No cross-file calls.

Files in other languages still get a File node, with no definitions.

Properties resolved at query time

The graph does not store some properties. The server fetches them from the repository when your query asks for them.

Node type Property Value
File content Full source text of the file
Definition content Source text of the definition
MergeRequest diff Full unified diff of the merge request
MergeRequestDiff patch Full unified patch of the diff version
MergeRequestDiffFile diff Patch of one changed file. null when too_large is true.

Use these properties to read code without a separate call to the GitLab API.

Identifiers

  • Query responses return all entity IDs as strings, even when the stored value is an integer. String IDs prevent precision loss in JavaScript clients for values above Number.MAX_SAFE_INTEGER.
  • On the server, a Definition ID is a hash of the project, branch, file path, fully qualified name, and position of the definition. The same function in two projects has two different IDs.

Related topics