PageSourceSearch

https://linkml.io/linkml/

html linkml.io collected 2026-09-25 14:13:35 UTC 55,405 bytes, 716 lines download raw bytes

1<!doctype html>
2<html class="no-js" lang="en" data-content_root="./">
3  <head><meta charset="utf-8">
4    <meta name="viewport" content="width=device-width,initial-scale=1">
5    <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
6<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="LinkML at a glance" href="intro/overview.html">
7        <link rel="prefetch" href="https://linkml.io/uploads/linkml-logo_color.png" as="image">
8
9    <link rel="shortcut icon" href="https://linkml.io/uploads/linkml-logo_color-no-words.png"><!-- Generated with Sphinx 8.2.3 and Furo 2025.12.19 -->
10        <title>linkml documentation</title>
11      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
12    <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=7bdb33bb" />
13    <link rel="stylesheet" type="text/css" href="_static/mystnb.11b39860a7a0cbfd473a3ad8a317855267ff0bd372690045ca344a6b62be495e.css" />
14    <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
15    <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
16    <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
17    <link rel="stylesheet" type="text/css" href="_static/css/common.css?v=95000900" />
18    <link rel="stylesheet" type="text/css" href="_static/css/notebooks.css?v=1ce917dd" />
19    
20    
21
22
23<style>
24  body {
25    --color-code-background: #f2f2f2;
26  --color-code-foreground: #1e1e1e;
27  
28  }
29  @media not print {
30    body[data-theme="dark"] {
31      --color-code-background: #202020;
32  --color-code-foreground: #d0d0d0;
33  
34    }
35    @media (prefers-color-scheme: dark) {
36      body:not([data-theme="light"]) {
37        --color-code-background: #202020;
38  --color-code-foreground: #d0d0d0;
39  
40      }
41    }
42  }
43</style></head>
44  <body>
45    
46    
46<script>
47      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
48    </script>
48
49    
50
51<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
52  <symbol id="svg-toc" viewBox="0 0 24 24">
53    <title>Contents</title>
54    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
55      <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
56    </svg>
57  </symbol>
58  <symbol id="svg-menu" viewBox="0 0 24 24">
59    <title>Menu</title>
60    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
61      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
62      <line x1="3" y1="12" x2="21" y2="12"></line>
63      <line x1="3" y1="6" x2="21" y2="6"></line>
64      <line x1="3" y1="18" x2="21" y2="18"></line>
65    </svg>
66  </symbol>
67  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
68    <title>Expand</title>
69    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
70      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
71      <polyline points="9 18 15 12 9 6"></polyline>
72    </svg>
73  </symbol>
74  <symbol id="svg-sun" viewBox="0 0 24 24">
75    <title>Light mode</title>
76    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
77      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
78      <circle cx="12" cy="12" r="5"></circle>
79      <line x1="12" y1="1" x2="12" y2="3"></line>
80      <line x1="12" y1="21" x2="12" y2="23"></line>
81      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
82      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
83      <line x1="1" y1="12" x2="3" y2="12"></line>
84      <line x1="21" y1="12" x2="23" y2="12"></line>
85      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
86      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
87    </svg>
88  </symbol>
89  <symbol id="svg-moon" viewBox="0 0 24 24">
90    <title>Dark mode</title>
91    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
92      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
93      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
94      <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
95    </svg>
96  </symbol>
97  <symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
98    <title>Auto light/dark, in light mode</title>
99    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
100      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
101      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
102      <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
103      <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
104      <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
105      <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
106      <line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
107      <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
108      <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
109      <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
110      <line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
111      <circle cx="14.5" cy="9.55" r="3.6"/>
112    </svg>
113  </symbol>
114  <symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
115    <title>Auto light/dark, in dark mode</title>
116    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
117      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
118      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
119      <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
120      <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
121      <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
122      <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
123      <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
124      <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
125      <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
126      <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
127      <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
128      <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
129    </svg>
130  </symbol>
131  <symbol id="svg-pencil" viewBox="0 0 24 24">
132    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
133      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
134      <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
135      <path d="M13.5 6.5l4 4" />
136      <path d="M20 21l2 -2l-2 -2" />
137      <path d="M17 17l-2 2l2 2" />
138    </svg>
139  </symbol>
140  <symbol id="svg-eye" viewBox="0 0 24 24">
141    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
142      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
143      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
144      <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
145      <path
146        d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
147      <path d="M20 21l2 -2l-2 -2" />
148      <path d="M17 17l-2 2l2 2" />
149    </svg>
150  </symbol>
151</svg>
152
153<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
154<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
155<label class="overlay sidebar-overlay" for="__navigation"></label>
156<label class="overlay toc-overlay" for="__toc"></label>
157
158<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
159
160
161
162<div class="page">
163  <header class="mobile-header">
164    <div class="header-left">
165      <label class="nav-overlay-icon" for="__navigation">
166        <span class="icon"><svg><use href="#svg-menu"></use></svg></span>
167      </label>
168    </div>
169    <div class="header-center">
170      <a href="#"><div class="brand">linkml  documentation</div></a>
171    </div>
172    <div class="header-right">
173      <div class="theme-toggle-container theme-toggle-header">
174        <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
175          <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
176          <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
177          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
178          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
179        </button>
180      </div>
181      <label class="toc-overlay-icon toc-header-icon" for="__toc">
182        <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
183      </label>
184    </div>
185  </header>
186  <aside class="sidebar-drawer">
187    <div class="sidebar-container">
188      
189      <div class="sidebar-sticky"><a class="sidebar-brand" href="#">
190  <div class="sidebar-logo-container">
191    <img class="sidebar-logo" src="https://linkml.io/uploads/linkml-logo_color.png" alt="Logo"/>
192  </div>
193  
194  <span class="sidebar-brand-text">linkml  documentation</span>
195  
196</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
197  <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
198  <input type="hidden" name="check_keywords" value="yes">
199  <input type="hidden" name="area" value="default">
200</form>
201<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
202  <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
203<ul>
204<li class="toctree-l1"><a class="reference internal" href="intro/overview.html">LinkML at a glance</a></li>
205<li class="toctree-l1"><a class="reference internal" href="intro/install.html">Quick Install Guide</a></li>
206<li class="toctree-l1 has-children"><a class="reference internal" href="intro/tutorial.html">Tutorial</a><input aria-label="Toggle navigation of Tutorial" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
207<li class="toctree-l2"><a class="reference internal" href="intro/tutorial01.html">Part 1: Creating your first LinkML schema</a></li>
208<li class="toctree-l2"><a class="reference internal" href="intro/tutorial02.html">Part 2: Adding a container object</a></li>
209<li class="toctree-l2"><a class="reference internal" href="intro/tutorial03.html">Part 3: Adding constraints and performing validation</a></li>
210<li class="toctree-l2"><a class="reference internal" href="intro/tutorial04.html">Part 4: Working with RDF</a></li>
211<li class="toctree-l2"><a class="reference internal" href="intro/tutorial05.html">Part 5: Using Python dataclasses</a></li>
212<li class="toctree-l2"><a class="reference internal" href="intro/tutorial06.html">Part 6: Enumerations</a></li>
213<li class="toctree-l2"><a class="reference internal" href="intro/tutorial07.html">Part 7: Slots and inheritance</a></li>
214<li class="toctree-l2"><a class="reference internal" href="intro/tutorial08.html">Part 8: Generating Projects</a></li>
215<li class="toctree-l2"><a class="reference internal" href="intro/tutorial09.html">Part 9: Working with SQL databases</a></li>
216</ul>
217</li>
218<li class="toctree-l1 has-children"><a class="reference internal" href="schemas/index.html">LinkML Schemas</a><input aria-label="Toggle navigation of LinkML Schemas" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
219<li class="toctree-l2"><a class="reference internal" href="schemas/models.html">Models</a></li>
220<li class="toctree-l2"><a class="reference internal" href="schemas/metadata.html">Schema Element Metadata</a></li>
221<li class="toctree-l2"><a class="reference internal" href="schemas/inheritance.html">Inheritance</a></li>
222<li class="toctree-l2"><a class="reference internal" href="schemas/slots.html">Slots</a></li>
223<li class="toctree-l2"><a class="reference internal" href="schemas/arrays.html">Arrays</a></li>
224<li class="toctree-l2"><a class="reference internal" href="schemas/uris-and-mappings.html">URIs and Mappings</a></li>
225<li class="toctree-l2"><a class="reference internal" href="schemas/enums.html">Semantic Enumerations</a></li>
226<li class="toctree-l2"><a class="reference internal" href="schemas/inlining.html">Inlining objects</a></li>
227<li class="toctree-l2"><a class="reference internal" href="schemas/constraints.html">Adding constraints and rules</a></li>
228<li class="toctree-l2"><a class="reference internal" href="schemas/type-designators.html">Type designators</a></li>
229<li class="toctree-l2"><a class="reference internal" href="schemas/subsets.html">Subsets</a></li>
230<li class="toctree-l2"><a class="reference internal" href="schemas/imports.html">Imports</a></li>
231<li class="toctree-l2"><a class="reference internal" href="schemas/advanced.html">Advanced features</a></li>
232<li class="toctree-l2"><a class="reference internal" href="schemas/generators.html">Mapping schemas to other frameworks</a></li>
233<li class="toctree-l2"><a class="reference internal" href="schemas/linter.html">Schema Linter</a></li>
234<li class="toctree-l2"><a class="reference internal" href="schemas/derived-models.html">Derived models</a></li>
235<li class="toctree-l2"><a class="reference internal" href="schemas/annotations.html">Annotations</a></li>
236<li class="toctree-l2"><a class="reference internal" href="schemas/metamodel.html">The metamodel</a></li>
237<li class="toctree-l2"><a class="reference internal" href="schemas/expression-language.html">Expression Language</a></li>
238</ul>
239</li>
240<li class="toctree-l1 has-children"><a class="reference internal" href="data/index.html">Working with Data</a><input aria-label="Toggle navigation of Working with Data" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
241<li class="toctree-l2"><a class="reference internal" href="data/conversion.html">Converting between different representations</a></li>
242<li class="toctree-l2"><a class="reference internal" href="data/validating-data.html">Data Validation</a></li>
243<li class="toctree-l2"><a class="reference internal" href="data/rdf.html">Working with RDF and LinkML</a></li>
244<li class="toctree-l2"><a class="reference internal" href="data/csvs.html">CSVs and Tabular Data</a></li>
245<li class="toctree-l2"><a class="reference internal" href="data/python.html">Python</a></li>
246<li class="toctree-l2"><a class="reference internal" href="data/sql-databases.html">Working with data in SQL Databases</a></li>
247</ul>
248</li>
249<li class="toctree-l1 has-children"><a class="reference internal" href="generators/index.html">Generators</a>
249<input aria-label="Toggle navigation of Generators" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
250<li class="toctree-l2"><a class="reference internal" href="generators/json-schema.html">JSON Schema</a></li>
251<li class="toctree-l2"><a class="reference internal" href="generators/protobuf.html">ProtoBuf</a></li>
252<li class="toctree-l2"><a class="reference internal" href="generators/graphql.html">GraphQL</a></li>
253<li class="toctree-l2"><a class="reference internal" href="generators/openapi.html">OpenAPI</a></li>
254<li class="toctree-l2"><a class="reference internal" href="generators/jsonld-context.html">JSON-LD Contexts</a></li>
255<li class="toctree-l2"><a class="reference internal" href="generators/jsonld.html">JSON-LD</a></li>
256<li class="toctree-l2"><a class="reference internal" href="generators/rdf.html">RDF</a></li>
257<li class="toctree-l2"><a class="reference internal" href="generators/sparql.html">SPARQL</a></li>
258<li class="toctree-l2"><a class="reference internal" href="generators/shex.html">ShEx</a></li>
259<li class="toctree-l2"><a class="reference internal" href="generators/shacl.html">SHACL</a></li>
260<li class="toctree-l2"><a class="reference internal" href="generators/owl.html">OWL</a></li>
261<li class="toctree-l2"><a class="reference internal" href="generators/yarrrml.html">YARRRML</a></li>
262<li class="toctree-l2"><a class="reference internal" href="generators/docgen.html">Documentation</a></li>
263<li class="toctree-l2"><a class="reference internal" href="generators/erdiagram.html">ER Diagrams</a></li>
264<li class="toctree-l2"><a class="reference internal" href="generators/plantumlgen.html">PlantUML Diagram Generator</a></li>
265<li class="toctree-l2"><a class="reference internal" href="generators/project-generator.html">Project Generator</a></li>
266<li class="toctree-l2"><a class="reference internal" href="generators/python.html">Python</a></li>
267<li class="toctree-l2"><a class="reference internal" href="generators/pydantic.html">Pydantic</a></li>
268<li class="toctree-l2"><a class="reference internal" href="generators/java.html">Java</a></li>
269<li class="toctree-l2"><a class="reference internal" href="generators/golang.html">Go</a></li>
270<li class="toctree-l2"><a class="reference internal" href="generators/typescript.html">Typescript</a></li>
271<li class="toctree-l2"><a class="reference internal" href="generators/rust.html">Rust</a></li>
272<li class="toctree-l2"><a class="reference internal" href="generators/sqltable.html">SQL DDL</a></li>
273<li class="toctree-l2"><a class="reference internal" href="generators/sqlalchemy.html">SQL Alchemy</a></li>
274<li class="toctree-l2"><a class="reference internal" href="generators/sqlvalidation.html">SQL Validation</a></li>
275<li class="toctree-l2"><a class="reference internal" href="generators/bigquery.html">BigQuery DDL</a></li>
276<li class="toctree-l2"><a class="reference internal" href="generators/typedb.html">TypeDB / TypeQL</a></li>
277<li class="toctree-l2"><a class="reference internal" href="generators/linkml.html">LinkML Generators</a></li>
278<li class="toctree-l2"><a class="reference internal" href="generators/prefixmap.html">Prefix Generator</a></li>
279<li class="toctree-l2"><a class="reference internal" href="generators/sssom.html">SSSOM</a></li>
280<li class="toctree-l2"><a class="reference internal" href="generators/terminusdb.html">TerminusDB</a></li>
281<li class="toctree-l2"><a class="reference internal" href="generators/excel.html">Excel Spreadsheet</a></li>
282<li class="toctree-l2"><a class="reference internal" href="generators/csv.html">CSV</a></li>
283<li class="toctree-l2"><a class="reference internal" href="generators/yaml.html">Yaml</a></li>
284<li class="toctree-l2"><a class="reference internal" href="generators/pandera.html">Pandera</a></li>
285<li class="toctree-l2"><a class="reference internal" href="generators/dashboard.html">Generator Feature Dashboard</a></li>
286<li class="toctree-l2 has-children"><a class="reference internal" href="generators/common/index.html">Common</a><input aria-label="Toggle navigation of Common" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
287<li class="toctree-l3"><a class="reference internal" href="generators/common/build.html">Build</a></li>
288<li class="toctree-l3"><a class="reference internal" href="generators/common/lifecycle.html">Lifecycle</a></li>
289<li class="toctree-l3"><a class="reference internal" href="generators/common/type_designators.html">Type Designators</a></li>
290</ul>
291</li>
292</ul>
293</li>
294<li class="toctree-l1 has-children"><a class="reference internal" href="howtos/index.html">How-to Guides</a>
294<input aria-label="Toggle navigation of How-to Guides" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
295<li class="toctree-l2"><a class="reference internal" href="howtos/linkml-project-copier.html">LinkML Project Copier Template</a></li>
296<li class="toctree-l2"><a class="reference internal" href="howtos/collaborative-development.html">How to run a collaborative data modeling project</a></li>
297<li class="toctree-l2"><a class="reference internal" href="howtos/recognize-structural-forms.html">How to recognize and work with different structural forms</a></li>
298<li class="toctree-l2"><a class="reference internal" href="howtos/yq-for-schemas.html">Using yq for querying and manipulating schemas</a></li>
299<li class="toctree-l2"><a class="reference internal" href="howtos/using-jsonld.html">Using JSON-LD</a></li>
300<li class="toctree-l2"><a class="reference internal" href="howtos/model-measurements.html">How to model quantities and measurements</a></li>
301<li class="toctree-l2"><a class="reference internal" href="howtos/port-linkml.html">Porting LinkML tools to other programming languages</a></li>
302<li class="toctree-l2"><a class="reference internal" href="howtos/multidimensional-arrays.html">Multidimensional Arrays</a></li>
303<li class="toctree-l2"><a class="reference internal" href="howtos/model-property-graphs.html">How to make a property graph schema</a></li>
304<li class="toctree-l2"><a class="reference internal" href="howtos/generate-ai-prompts.html">How to Generate AI prompts</a></li>
305<li class="toctree-l2"><a class="reference internal" href="howtos/deprecating-elements.html">Deprecating elements while maintaining PURLs and other URIs</a></li>
306<li class="toctree-l2"><a class="reference internal" href="howtos/ontologies-as-values.html">Using ontology terms as values in data</a></li>
307<li class="toctree-l2"><a class="reference internal" href="howtos/implements-instantiates-guide.html">Implements vs Instantiates vs Inheritance: A Best Practices Guide</a></li>
308<li class="toctree-l2"><a class="reference internal" href="howtos/skip-logic.html">How to implement skip logic in LinkML</a></li>
309</ul>
310</li>
311<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of use</a></li>
312<li class="toctree-l1"><a class="reference internal" href="ecosystem.html">The LinkML Ecosystem</a></li>
313<li class="toctree-l1"><a class="reference internal" href="specifications/linkml-spec.html">LinkML specification</a></li>
314<li class="toctree-l1 has-children"><a class="reference internal" href="get-involved/index.html">Get Involved</a><input aria-label="Toggle navigation of Get Involved" class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
315<li class="toctree-l2"><a class="reference internal" href="get-involved/Community-Meetings.html">Community Meetings</a></li>
316<li class="toctree-l2"><a class="reference internal" href="get-involved/workshops-and-presentations.html">Workshops and Presentations</a></li>
317<li class="toctree-l2"><a class="reference internal" href="get-involved/office-hours.html">Monthly LinkML Office Hours</a></li>
318<li class="toctree-l2"><a class="reference internal" href="get-involved/symposium-2026.html">Virtual LinkML Symposium 2026</a></li>
319</ul>
320</li>
321<li class="toctree-l1 has-children"><a class="reference internal" href="faq/index.html">FAQ</a><input aria-label="Toggle navigation of FAQ" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
322<li class="toctree-l2"><a class="reference internal" href="faq/general.html">FAQ: General</a></li>
323<li class="toctree-l2"><a class="reference internal" href="faq/why-linkml.html">FAQ: Why LinkML</a></li>
324<li class="toctree-l2"><a class="reference internal" href="faq/modeling.html">FAQ: Modeling</a></li>
325<li class="toctree-l2"><a class="reference internal" href="faq/tools.html">FAQ: Tools</a></li>
326<li class="toctree-l2"><a class="reference internal" href="faq/python.html">FAQ: Python</a></li>
327<li class="toctree-l2"><a class="reference internal" href="faq/getting-help.html">FAQ: Getting Help</a></li>
328<li class="toctree-l2"><a class="reference internal" href="faq/contributing.html">FAQ: Contributing</a></li>
329<li class="toctree-l2"><a class="reference internal" href="faq/tricky_choices.html">FAQ: Tricky Choices</a></li>
330</ul>
331</li>
332</ul>
333<p class="caption" role="heading"><span class="caption-text">Schema Developers Guide:</span></p>
334<ul>
335<li class="toctree-l1 has-children"><a class="reference internal" href="cli/index.html">CLI</a>
335<input aria-label="Toggle navigation of CLI" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
336<li class="toctree-l2"><a class="reference internal" href="cli/linkml.html"><code class="docutils literal notranslate"><span class="pre">linkml</span></code></a></li>
337<li class="toctree-l2"><a class="reference internal" href="cli/config.html"><code class="docutils literal notranslate"><span class="pre">linkml</span> <span class="pre">config</span></code></a></li>
338<li class="toctree-l2"><a class="reference internal" href="cli/generate.html"><code class="docutils literal notranslate"><span class="pre">linkml</span> <span class="pre">generate</span></code></a></li>
339<li class="toctree-l2"><a class="reference internal" href="cli/lint.html"><code class="docutils literal notranslate"><span class="pre">linkml</span> <span class="pre">lint</span></code></a></li>
340<li class="toctree-l2"><a class="reference internal" href="cli/validate.html"><code class="docutils literal notranslate"><span class="pre">linkml</span> <span class="pre">validate</span></code></a></li>
341<li class="toctree-l2"><a class="reference internal" href="cli/entrypoints.html">Entrypoints</a></li>
342</ul>
343</li>
344<li class="toctree-l1 has-children"><a class="reference internal" href="developers/index.html">Schema Developers Guide</a><input aria-label="Toggle navigation of Schema Developers Guide" class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
345<li class="toctree-l2"><a class="reference internal" href="developers/notebooks.html">Jupyter Notebooks</a></li>
346<li class="toctree-l2"><a class="reference internal" href="developers/manipulating-schemas.html">Manipulating Schemas</a></li>
347<li class="toctree-l2"><a class="reference internal" href="developers/manage-releases.html">How to Manage Releases of your LinkML Schema</a></li>
348<li class="toctree-l2"><a class="reference internal" href="developers/schemaview.html">SchemaView</a></li>
349<li class="toctree-l2"><a class="reference internal" href="developers/schemabuilder.html">
349SchemaBuilder</a></li>
350<li class="toctree-l2"><a class="reference internal" href="developers/loaders-and-dumpers.html">Data Conversion: Loaders and Dumpers</a></li>
351<li class="toctree-l2"><a class="reference internal" href="developers/inference.html">Inferring Missing Values</a></li>
352<li class="toctree-l2"><a class="reference internal" href="developers/using-sql-dbs.html">Using SQL Databases</a></li>
353<li class="toctree-l2"><a class="reference internal" href="developers/sqlstore.html">SQLStore</a></li>
354<li class="toctree-l2"><a class="reference internal" href="developers/tool-developer-guide.html">Tool Implementer Guide</a></li>
355</ul>
356</li>
357<li class="toctree-l1 has-children"><a class="reference internal" href="code/index.html">Code</a><input aria-label="Toggle navigation of Code" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
358<li class="toctree-l2"><a class="reference internal" href="code/metamodel.html">MetaModel</a></li>
359<li class="toctree-l2"><a class="reference internal" href="code/utils.html">Utils</a></li>
360<li class="toctree-l2"><a class="reference internal" href="code/validator.html">Validator</a></li>
361<li class="toctree-l2"><a class="reference internal" href="code/deprecation.html">Deprecation Log</a></li>
362</ul>
363</li>
364<li class="toctree-l1"><a class="reference internal" href="config/index.html">Configuration</a></li>
365</ul>
366<p class="caption" role="heading"><span class="caption-text">Maintainers Guide:</span></p>
367<ul>
368<li class="toctree-l1 has-children"><a class="reference internal" href="maintainers/index.html">Maintainers Guide</a><input aria-label="Toggle navigation of Maintainers Guide" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
369<li class="toctree-l2"><a class="reference internal" href="maintainers/contributing.html">Contribution Guidelines</a></li>
370<li class="toctree-l2"><a class="reference internal" href="maintainers/organization.html">GitHub Organization</a></li>
371<li class="toctree-l2"><a class="reference internal" href="maintainers/contributor-hierarchy.html">Contributor Hierarchy</a></li>
372<li class="toctree-l2"><a class="reference internal" href="maintainers/codeowners.html">CODEOWNERS</a></li>
373<li class="toctree-l2"><a class="reference internal" href="maintainers/deprecation.html">Deprecations</a></li>
374<li class="toctree-l2"><a class="reference internal" href="maintainers/code-of-conduct.html">Code of Conduct</a></li>
375<li class="toctree-l2"><a class="reference internal" href="maintainers/generator-governance.html">Generator and Validator Governance</a></li>
376</ul>
377</li>
378</ul>
379
380</div>
381</div>
382
383      </div>
384      
385    </div>
386  </aside>
387  <div class="main">
388    <div class="content">
389      <div class="article-container">
390        <a href="#" class="back-to-top muted-link">
391          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
392            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
393          </svg>
394          <span>Back to top</span>
395        </a>
396        <div class="content-icon-container">
397          <div class="view-this-page">
398  <a class="muted-link" href="_sources/index.rst.txt" title="View this page">
399    <svg><use href="#svg-eye"></use></svg>
400    <span class="visually-hidden">View this page</span>
401  </a>
402</div>
403<div class="theme-toggle-container theme-toggle-content">
404            <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
405              <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
406              <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
407              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
408              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
409            </button>
410          </div>
411          <label class="toc-overlay-icon toc-content-icon" for="__toc">
412            <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
413          </label>
414        </div>
415        <article role="main" id="furo-main-content">
416          <section id="linkml-documentation">
417<h1>LinkML Documentation<a class="headerlink" href="#linkml-documentation" title="Link to this heading">¶</a></h1>
418<p>Everything you need to know about <a class="reference external" href="https://linkml.io">LinkML</a>, the
419Linked Data Modeling Language.</p>
420<p>LinkML is a flexible modeling language that allows you to author
421schemas in YAML that describe the structure of your data. Additionally, it is a framework for working with and validating data in a variety
422of formats (JSON, RDF, TSV), with generators for compiling LinkML
423schemas to other frameworks.</p>
424<p>LinkML is open source (licensed under the Apache-2.0 license) and community-driven. You can find the code on <a class="reference external" href="https://github.com/linkml/">GitHub</a>.</p>
425<section id="documentation">
426<h2>Documentation<a class="headerlink" href="#documentation" title="Link to this heading">¶</a></h2>
427<div class="toctree-wrapper compound">
428<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
429<ul>
430<li class="toctree-l1"><a class="reference internal" href="intro/overview.html">LinkML at a glance</a><ul>
431<li class="toctree-l2"><a class="reference internal" href="intro/overview.html#feature-easy-to-author-schemas">Feature: Easy to author schemas</a></li>
432<li class="toctree-l2"><a class="reference internal" href="intro/overview.html#feature-rich-modeling-language">Feature: Rich modeling language</a></li>
433<li class="toctree-l2"><a class="reference internal" href="intro/overview.html#a-bridge-between-frameworks">A bridge between frameworks</a></li>
434<li class="toctree-l2"><a class="reference internal" href="intro/overview.html#feature-generation-of-documentation-and-websites">Feature: Generation of documentation and websites</a></li>
435<li class="toctree-l2"><a class="reference internal" href="intro/overview.html#a-rapidly-growing-toolchain">A rapidly growing toolchain</a></li>
436<li class="toctree-l2"><a class="reference internal" href="intro/overview.html#we-eat-our-own-dogfood">We eat our own dogfood!</a></li>
437<li class="toctree-l2"><a class="reference internal" href="intro/overview.html#more-examples">More examples</a></li>
438</ul>
439</li>
440<li class="toctree-l1"><a class="reference internal" href="intro/install.html">Quick Install Guide</a><ul>
441<li class="toctree-l2"><a class="reference internal" href="intro/install.html#local-installation-use-the-python-package">Local installation: Use the Python package</a></li>
442<li class="toctree-l2"><a class="reference internal" href="intro/install.html#alternative-use-the-official-docker-oci-image">Alternative: Use the official Docker/OCI image</a></li>
443<li class="toctree-l2"><a class="reference internal" href="intro/install.html#installation-for-contributors">Installation for contributors</a></li>
444</ul>
445</li>
446<li class="toctree-l1"><a class="reference internal" href="intro/tutorial.html">Tutorial</a><ul>
447<li class="toctree-l2"><a class="reference internal" href="intro/tutorial01.html">Part 1: Creating your first LinkML schema</a></li>
448<li class="toctree-l2"><a class="reference internal" href="intro/tutorial02.html">Part 2: Adding a container object</a></li>
449<li class="toctree-l2"><a class="reference internal" href="intro/tutorial03.html">Part 3: Adding constraints and performing validation</a></li>
450<li class="toctree-l2"><a class="reference internal" href="intro/tutorial04.html">Part 4: Working with RDF</a></li>
451<li class="toctree-l2"><a class="reference internal" href="intro/tutorial05.html">Part 5: Using Python dataclasses</a></li>
452<li class="toctree-l2"><a class="reference internal" href="intro/tutorial06.html">Part 6: Enumerations</a></li>
453<li class="toctree-l2"><a class="reference internal" href="intro/tutorial07.html">Part 7: Slots and inheritance</a></li>
454<li class="toctree-l2"><a class="reference internal" href="intro/tutorial08.html">Part 8: Generating Projects</a></li>
455<li class="toctree-l2"><a class="reference internal" href="intro/tutorial09.html">Part 9: Working with SQL databases</a></li>
456</ul>
457</li>
458<li class="toctree-l1"><a class="reference internal" href="schemas/index.html">LinkML Schemas</a><ul>
459<li class="toctree-l2"><a class="reference internal" href="schemas/models.html">Models</a></li>
460<li class="toctree-l2"><a class="reference internal" href="schemas/metadata.html">
460Schema Element Metadata</a></li>
461<li class="toctree-l2"><a class="reference internal" href="schemas/inheritance.html">Inheritance</a></li>
462<li class="toctree-l2"><a class="reference internal" href="schemas/slots.html">Slots</a></li>
463<li class="toctree-l2"><a class="reference internal" href="schemas/arrays.html">Arrays</a></li>
464<li class="toctree-l2"><a class="reference internal" href="schemas/uris-and-mappings.html">URIs and Mappings</a></li>
465<li class="toctree-l2"><a class="reference internal" href="schemas/enums.html">Semantic Enumerations</a></li>
466<li class="toctree-l2"><a class="reference internal" href="schemas/inlining.html">Inlining objects</a></li>
467<li class="toctree-l2"><a class="reference internal" href="schemas/constraints.html">Adding constraints and rules</a></li>
468<li class="toctree-l2"><a class="reference internal" href="schemas/type-designators.html">Type designators</a></li>
469<li class="toctree-l2"><a class="reference internal" href="schemas/subsets.html">Subsets</a></li>
470<li class="toctree-l2"><a class="reference internal" href="schemas/imports.html">Imports</a></li>
471<li class="toctree-l2"><a class="reference internal" href="schemas/advanced.html">Advanced features</a></li>
472<li class="toctree-l2"><a class="reference internal" href="schemas/generators.html">Mapping schemas to other frameworks</a></li>
473<li class="toctree-l2"><a class="reference internal" href="schemas/linter.html">Schema Linter</a></li>
474<li class="toctree-l2"><a class="reference internal" href="schemas/derived-models.html">Derived models</a></li>
475<li class="toctree-l2"><a class="reference internal" href="schemas/annotations.html">Annotations</a></li>
476<li class="toctree-l2"><a class="reference internal" href="schemas/metamodel.html">The metamodel</a></li>
477<li class="toctree-l2"><a class="reference internal" href="schemas/expression-language.html">Expression Language</a></li>
478</ul>
479</li>
480<li class="toctree-l1"><a class="reference internal" href="data/index.html">Working with Data</a><ul>
481<li class="toctree-l2"><a class="reference internal" href="data/conversion.html">Converting between different representations</a></li>
482<li class="toctree-l2"><a class="reference internal" href="data/validating-data.html">Data Validation</a></li>
483<li class="toctree-l2"><a class="reference internal" href="data/rdf.html">Working with RDF and LinkML</a></li>
484<li class="toctree-l2"><a class="reference internal" href="data/csvs.html">CSVs and Tabular Data</a></li>
485<li class="toctree-l2"><a class="reference internal" href="data/python.html">Python</a></li>
486<li class="toctree-l2"><a class="reference internal" href="data/sql-databases.html">Working with data in SQL Databases</a></li>
487</ul>
488</li>
489<li class="toctree-l1"><a class="reference internal" href="generators/index.html">Generators</a><ul>
490<li class="toctree-l2"><a class="reference internal" href="generators/index.html#schema-frameworks">Schema Frameworks</a></li>
491<li class="toctree-l2"><a class="reference internal" href="generators/index.html#linked-data-standards">Linked Data Standards</a></li>
492<li class="toctree-l2"><a class="reference internal" href="generators/index.html#documentation-generation">Documentation Generation</a></li>
493<li class="toctree-l2"><a class="reference internal" href="generators/index.html#language-specific">Language Specific</a></li>
494<li class="toctree-l2"><a class="reference internal" href="generators/index.html#database">Database</a></li>
495<li class="toctree-l2"><a class="reference internal" href="generators/index.html#others">Others</a></li>
496<li class="toctree-l2"><a class="reference internal" href="generators/index.html#feature-dashboard">Feature Dashboard</a></li>
497<li class="toctree-l2"><a class="reference internal" href="generators/index.html#common">Common</a></li>
498</ul>
499</li>
500<li class="toctree-l1"><a class="reference internal" href="howtos/index.html">How-to Guides</a><ul>
501<li class="toctree-l2"><a class="reference internal" href="howtos/linkml-project-copier.html">LinkML Project Copier Template</a></li>
502<li class="toctree-l2"><a class="reference internal" href="howtos/collaborative-development.html">How to run a collaborative data modeling project</a></li>
503<li class="toctree-l2"><a class="reference internal" href="howtos/recognize-structural-forms.html">How to recognize and work with different structural forms</a></li>
504<li class="toctree-l2"><a class="reference internal" href="howtos/yq-for-schemas.html">Using yq for querying and manipulating schemas</a></li>
505<li class="toctree-l2"><a class="reference internal" href="howtos/using-jsonld.html">Using JSON-LD</a></li>
506<li class="toctree-l2"><a class="reference internal" href="howtos/model-measurements.html">How to model quantities and measurements</a></li>
507<li class="toctree-l2"><a class="reference internal" href="howtos/port-linkml.html">Porting LinkML tools to other programming languages</a></li>
508<li class="toctree-l2"><a class="reference internal" href="howtos/multidimensional-arrays.html">Multidimensional Arrays</a></li>
509<li class="toctree-l2"><a class="reference internal" href="howtos/model-property-graphs.html">How to make a property graph schema</a></li>
510<li class="toctree-l2"><a class="reference internal" href="howtos/generate-ai-prompts.html">How to Generate AI prompts</a></li>
511<li class="toctree-l2"><a class="reference internal" href="howtos/deprecating-elements.html">Deprecating elements while maintaining PURLs and other URIs</a></li>
512<li class="toctree-l2"><a class="reference internal" href="howtos/ontologies-as-values.html">Using ontology terms as values in data</a></li>
513<li class="toctree-l2"><a class="reference internal" href="howtos/implements-instantiates-guide.html">Implements vs Instantiates vs Inheritance: A Best Practices Guide</
513a></li>
514<li class="toctree-l2"><a class="reference internal" href="howtos/skip-logic.html">How to implement skip logic in LinkML</a></li>
515</ul>
516</li>
517<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of use</a><ul>
518<li class="toctree-l2"><a class="reference internal" href="examples.html#introductory-example">Introductory Example</a></li>
519<li class="toctree-l2"><a class="reference internal" href="examples.html#example-models">Example Models</a></li>
520<li class="toctree-l2"><a class="reference internal" href="examples.html#include-data-coordination-center">INCLUDE Data Coordination Center</a></li>
521<li class="toctree-l2"><a class="reference internal" href="examples.html#linkml-registry">LinkML Registry</a></li>
522<li class="toctree-l2"><a class="reference internal" href="examples.html#presentations-about-linkml">Presentations about LinkML</a></li>
523</ul>
524</li>
525<li class="toctree-l1"><a class="reference internal" href="ecosystem.html">The LinkML Ecosystem</a><ul>
526<li class="toctree-l2"><a class="reference internal" href="ecosystem.html#tools-that-build-off-or-enhance-linkml">Tools that build off or enhance LinkML</a></li>
527</ul>
528</li>
529<li class="toctree-l1"><a class="reference internal" href="specifications/linkml-spec.html">LinkML specification</a></li>
530<li class="toctree-l1"><a class="reference internal" href="get-involved/index.html">Get Involved</a><ul>
531<li class="toctree-l2"><a class="reference internal" href="get-involved/Community-Meetings.html">Community Meetings</a></li>
532<li class="toctree-l2"><a class="reference internal" href="get-involved/workshops-and-presentations.html">Workshops and Presentations</a></li>
533<li class="toctree-l2"><a class="reference internal" href="get-involved/office-hours.html">Monthly LinkML Office Hours</a></li>
534<li class="toctree-l2"><a class="reference internal" href="get-involved/symposium-2026.html">Virtual LinkML Symposium 2026</a></li>
535</ul>
536</li>
537<li class="toctree-l1"><a class="reference internal" href="faq/index.html">FAQ</a><ul>
538<li class="toctree-l2"><a class="reference internal" href="faq/general.html">FAQ: General</a></li>
539<li class="toctree-l2"><a class="reference internal" href="faq/why-linkml.html">FAQ: Why LinkML</a></li>
540<li class="toctree-l2"><a class="reference internal" href="faq/modeling.html">FAQ: Modeling</a></li>
541<li class="toctree-l2"><a class="reference internal" href="faq/tools.html">FAQ: Tools</a></li>
542<li class="toctree-l2"><a class="reference internal" href="faq/python.html">FAQ: Python</a></li>
543<li class="toctree-l2"><a class="reference internal" href="faq/getting-help.html">FAQ: Getting Help</a></li>
544<li class="toctree-l2"><a class="reference internal" href="faq/contributing.html">FAQ: Contributing</a></li>
545<li class="toctree-l2"><a class="reference internal" href="faq/tricky_choices.html">FAQ: Tricky Choices</a></li>
546</ul>
547</li>
548</ul>
549</div>
550</section>
551<section id="metamodel-reference">
552<h2>Metamodel Reference<a class="headerlink" href="#metamodel-reference" title="Link to this heading">¶</a></h2>
553<p>The LinkML metamodel is itself described in LinkML. This model is
554hosted in the <a class="reference external" href="https://github.com/linkml/linkml-model">linkml-model</a>
555repository. Each element of the model has a URI of the form
556<code class="docutils literal notranslate"><span class="pre">https://w3id.org/linkml/&lt;ELEMENT&gt;</span></code>, shortened to the CURIE <code class="docutils literal notranslate"><span class="pre">linkml:&lt;ELEMENT&gt;</span></code></p>
557<p>The key schema elements are:</p>
558<ul>
559<li><p><a class="reference external" href="https://w3id.org/linkml/SchemaDefinition">linkml:SchemaDefinition</a></p>
560<blockquote>
561<div><ul class="simple">
562<li><p><a class="reference external" href="https://w3id.org/linkml/ClassDefinition">linkml:ClassDefinition</a></p></li>
563<li><p><a class="reference external" href="https://w3id.org/linkml/SlotDefinition">linkml:SlotDefinition</a></p></li>
564<li><p><a class="reference external" href="https://w3id.org/linkml/TypeDefinition">linkml:TypeDefinition</a></p></li>
565<li><p><a class="reference external" href="https://w3id.org/linkml/EnumDefinition">linkml:EnumDefinition</a></p></li>
566</ul>
567</div></blockquote>
568</li>
569</ul>
570</section>
571<section id="schema-developers">
572<h2>Schema Developers<a class="headerlink" href="#schema-developers" title="Link to this heading">¶</a></h2>
573<p>If you are a Python developer looking to use LinkML programmatically to build schemas,
574work with data, or integrate LinkML into your applications, this section is for you:</p>
575<div class="toctree-wrapper compound">
576<p class="caption" role="heading"><span class="caption-text">Schema Developers Guide:</span></p>
577<ul>
578<li class="toctree-l1"><a class="reference internal" href="cli/index.html">CLI</a><ul>
579<li class="toctree-l2"><a class="reference internal" href="cli/linkml.html"><code class="docutils literal notranslate"><span class="pre">linkml</span></code></a></li>
580<li class="toctree-l2"><a class="reference internal" href="cli/config.html"><code class="docutils literal notranslate"><span class="pre">linkml</span> <span class="pre">config</span></code></a></li>
581<li class="toctree-l2"><a class="reference internal" href="cli/generate.html"><code class="docutils literal notranslate"><span class="pre">linkml</span> <span class="pre">generate</span></code></a></li>
582<li class="toctree-l2"><a class="reference internal" href="cli/lint.html"><code class="docutils literal notranslate"><span class="pre">linkml</span> <span class="pre">lint</span></code></a></li>
583<li class="toctree-l2"><a class="reference internal" href="cli/validate.html"><code class="docutils literal notranslate"><span class="pre">linkml</span> <span class="pre">validate</span></code></a></li>
584<li class="toctree-l2"><a class="reference internal" href="cli/entrypoints.html">Entrypoints</a></li>
585</ul>
586</li>
587<li class="toctree-l1"><a class="reference internal" href="developers/index.html">
587Schema Developers Guide</a><ul>
588<li class="toctree-l2"><a class="reference internal" href="developers/notebooks.html">Jupyter Notebooks</a></li>
589<li class="toctree-l2"><a class="reference internal" href="developers/manipulating-schemas.html">Manipulating Schemas</a></li>
590<li class="toctree-l2"><a class="reference internal" href="developers/manage-releases.html">How to Manage Releases of your LinkML Schema</a></li>
591<li class="toctree-l2"><a class="reference internal" href="developers/schemaview.html">SchemaView</a></li>
592<li class="toctree-l2"><a class="reference internal" href="developers/schemabuilder.html">SchemaBuilder</a></li>
593<li class="toctree-l2"><a class="reference internal" href="developers/loaders-and-dumpers.html">Data Conversion: Loaders and Dumpers</a></li>
594<li class="toctree-l2"><a class="reference internal" href="developers/inference.html">Inferring Missing Values</a></li>
595<li class="toctree-l2"><a class="reference internal" href="developers/using-sql-dbs.html">Using SQL Databases</a></li>
596<li class="toctree-l2"><a class="reference internal" href="developers/sqlstore.html">SQLStore</a></li>
597<li class="toctree-l2"><a class="reference internal" href="developers/tool-developer-guide.html">Tool Implementer Guide</a></li>
598</ul>
599</li>
600<li class="toctree-l1"><a class="reference internal" href="code/index.html">Code</a><ul>
601<li class="toctree-l2"><a class="reference internal" href="code/metamodel.html">MetaModel</a></li>
602<li class="toctree-l2"><a class="reference internal" href="code/utils.html">Utils</a></li>
603<li class="toctree-l2"><a class="reference internal" href="code/validator.html">Validator</a></li>
604<li class="toctree-l2"><a class="reference internal" href="code/deprecation.html">Deprecation Log</a></li>
605</ul>
606</li>
607<li class="toctree-l1"><a class="reference internal" href="config/index.html">Configuration</a><ul>
608<li class="toctree-l2"><a class="reference internal" href="config/index.html#sources">Sources</a></li>
609<li class="toctree-l2"><a class="reference internal" href="config/index.html#keys">Keys</a></li>
610<li class="toctree-l2"><a class="reference internal" href="config/index.html#cli">CLI</a></li>
611<li class="toctree-l2"><a class="reference internal" href="config/index.html#examples">Examples</a></li>
612<li class="toctree-l2"><a class="reference internal" href="config/index.html#module-linkml.utils.config">API</a></li>
613</ul>
614</li>
615</ul>
616</div>
617</section>
618<section id="maintainers">
619<h2>Maintainers<a class="headerlink" href="#maintainers" title="Link to this heading">¶</a></h2>
620<p>If you want to contribute to the LinkML framework itself, including bug fixes,
621new features, or documentation improvements:</p>
622<div class="toctree-wrapper compound">
623<p class="caption" role="heading"><span class="caption-text">Maintainers Guide:</span></p>
624<ul>
625<li class="toctree-l1"><a class="reference internal" href="maintainers/index.html">Maintainers Guide</a><ul>
626<li class="toctree-l2"><a class="reference internal" href="maintainers/contributing.html">Contribution Guidelines</a></li>
627<li class="toctree-l2"><a class="reference internal" href="maintainers/organization.html">GitHub Organization</a></li>
628<li class="toctree-l2"><a class="reference internal" href="maintainers/contributor-hierarchy.html">Contributor Hierarchy</a></li>
629<li class="toctree-l2"><a class="reference internal" href="maintainers/codeowners.html">CODEOWNERS</a></li>
630<li class="toctree-l2"><a class="reference internal" href="maintainers/deprecation.html">Deprecations</a></li>
631<li class="toctree-l2"><a class="reference internal" href="maintainers/code-of-conduct.html">Code of Conduct</a></li>
632<li class="toctree-l2"><a class="reference internal" href="maintainers/generator-governance.html">Generator and Validator Governance</a></li>
633</ul>
634</li>
635</ul>
636</div>
637</section>
638<section id="indices-and-tables">
639<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h2>
640<ul class="simple">
641<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
642<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
643<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
644</ul>
645</section>
646</section>
647
648        </article>
649      </div>
650      <footer>
651        
652        <div class="related-pages">
653          <a class="next-page" href="intro/overview.html">
654              <div class="page-info">
655                <div class="context">
656                  <span>Next</span>
657                </div>
658                <div class="title">LinkML at a glance</div>
659              </div>
660              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
661            </a>
662          
663        </div>
664        <div class="bottom-of-page">
665          <div class="left-details">
666            <div class="copyright">
667                Copyright &#169; 2021-2026, LinkML Authors
668            </div>
669            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
670            
671            <a href="https://github.com/pradyunsg/furo">Furo</a>
672            
673          </div>
674          <div class="right-details">
675            
676          </div>
677        </div>
678        
679      </footer>
680    </div>
681    <aside class="toc-drawer">
682      
683      
684      <div class="toc-sticky toc-scroll">
685        <div class="toc-title-container">
686          <span class="toc-title">
687            On this page
688          </span>
689        </div>
690        <div class="toc-tree-container">
691          <div class="toc-tree">
692            <ul>
693<li><a class="reference internal" href="#">LinkML Documentation</a><ul>
694<li><a class="reference internal" href="#documentation">Documentation</a></li>
695<li><a class="reference internal" href="#metamodel-reference">Metamodel Reference</a></li>
696<li><a class="reference internal" href="#schema-developers">Schema Developers</a></li>
697<li><a class="reference internal" href="#maintainers">Maintainers</a></li>
698<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
699</ul>
700</li>
701</ul>
702
703          </div>
704        </div>
705      </div>
706      
707      
708    </aside>
709  </div>
710</div>
710<script src="_static/documentation_options.js?v=5929fcd5"></script>
710
711    
711<script src="_static/doctools.js?v=9bcbadda"></script>
711
712    
712<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
712
713    
713<script src="_static/scripts/furo.js?v=46bd48cc"></script>
713
714    
714<script src="_static/design-tabs.js?v=f930bc37"></script>
714
715    </body>
716</html>

Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.