<!DOCTYPE HTML>
<html lang="en" class="light" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title></title>
<meta name="robots" content="noindex">
<!-- Custom HTML head -->
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">
<link rel="shortcut icon" href="assets/corp/favicon.png">
<link rel="stylesheet" href="css/variables.css">
<link rel="stylesheet" href="css/general.css">
<link rel="stylesheet" href="css/chrome.css">
<link rel="stylesheet" href="css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="highlight.css">
<link rel="stylesheet" href="tomorrow-night.css">
<link rel="stylesheet" href="ayu-highlight.css">
<!-- Custom theme stylesheets -->
<!-- MathJax -->
</head>
<body class="sidebar-visible no-js">
<div id="body-container">
<!-- Provide site root to javascript -->
<script>
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
<script>
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch (e) { }
if (theme === null || theme === undefined) {
theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "dark" : "light";
}
var html = document.querySelector('html');
html.classList.remove('light', 'dark')
html.classList.add(theme);
var body = document.querySelector('body');
body.classList.remove('no-js')
body.classList.add('js');
</script>
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
<!-- Hide / unhide sidebar before it is displayed -->
<script>
var body = document.querySelector('body');
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch (e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
body.classList.remove('sidebar-visible');
body.classList.add("sidebar-" + sidebar);
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item expanded "><a href="overview.html"><strong aria-hidden="true">1.</strong> Overview</a></li><li class="chapter-item expanded "><a href="installation.html"><strong aria-hidden="true">2.</strong> Installation</a></li><li class="chapter-item expanded "><a href="getting-started.html"><strong aria-hidden="true">3.</strong> Getting started</a></li><li class="chapter-item expanded "><a href="pg.html"><strong aria-hidden="true">4.</strong> pg command</a></li><li class="chapter-item expanded "><a href="pgs.html"><strong aria-hidden="true">5.</strong> pgs command</a></li><li class="chapter-item expanded "><a href="map.html"><strong aria-hidden="true">6.</strong> map command</a></li><li class="chapter-item expanded "><a href="validate.html"><strong aria-hidden="true">7.</strong> validate command</a></li><li class="chapter-item expanded "><a href="test-suite.html"><strong aria-hidden="true">8.</strong> test-suite</a></li></ol>
</div>
<div style="display: none;" id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>
<!-- Track and set sidebar scroll position -->
<script>
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
sidebarScrollbox.addEventListener('click', function (e) {
if (e.target.tagName === 'A') {
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
}
}, { passive: true });
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
sessionStorage.removeItem('sidebar-scroll');
if (sidebarScrollTop) {
// preserve sidebar scroll position when navigating via links within sidebar
sidebarScrollbox.scrollTop = sidebarScrollTop;
} else {
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
var activeSection = document.querySelector('#sidebar .active');
if (activeSection) {
activeSection.scrollIntoView({ block: 'center' });
}
}
</script>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor"
title="Toggle Table of Contents" aria-label="Toggle Table of Contents"
aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme"
aria-label="Change theme" aria-haspopup="true" aria-expanded="false"
aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="dark">Dark</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)"
aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S"
aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<header class="menu-title">
PGSchemaPC
</header>
<div class="right-buttons">
<a class="download-button" href="https://github.com/weso/pgschemapc/releases" title="Download"
aria-label="Download Zed">
Download
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book..."
aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function (link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<main>
<div class="sidetoc">
<nav class="pagetoc">
<p class="toc-title">On this page</p>
</nav>
</div>
<h1 id="overview"><a class="header" href="#overview">Overview</a></h1>
<p><code>pgschemapc</code> is a prototype implementation of PGSchema with support for property constraints.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="installation-and-building"><a class="header" href="#installation-and-building">Installation and Building</a></h1>
<p>You can download a binary from the <a href="https://github.com/weso/pgschemapc/releases">download page</a>, where you will also find the compiled packages for the installation on your system using a package manager.</p>
<h2 id="building"><a class="header" href="#building">Building</a></h2>
<p>The project has been implemented in Rust and uses <a href="https://doc.rust-lang.org/cargo/">cargo</a> for building. Once you install <code>cargo</code>, you can run:</p>
<pre><code>cargo build
</code></pre>
<p>to compile and generate a binary which will be available in <code>target/debug/pgschemapc</code>. If you want a more performant binary, you can use the <code>--release</code> option.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="getting-started"><a class="header" href="#getting-started">Getting started</a></h1>
<p>In order to verify that the installation has been successful, you can run the following command to check that everything is working as expected.</p>
<pre><code class="language-sh">pgschemapc --version
</code></pre>
<p>Once you have <code>pgschemapc</code> <a href="./installation.html">installed</a> and verified, the next step is to start using the different subcommands that are bundled within the tool. You can run:</p>
<pre><code>pgschemapc --help
A simple prototype tool to process and validate PG-Schemas with property constraints
Usage: pgschemapc [COMMAND]
Commands:
pgs Process and validate property graph schemas
pg Process and validate property graphs
map Process and validate type map associations
validate Validate a property graph with a property graph schema and some associated type map
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
</code></pre>
<div style="break-before: page; page-break-before: always;"></div><h2 id="pg---property-graphs"><a class="header" href="#pg---property-graphs">pg - Property Graphs</a></h2>
<p>Property graphs contain a list of node or edge declarations separated by <code>;</code>.</p>
<p>An example can be:</p>
<pre><code>(n1: Person { name: "Alice", age: 23 });
(n2: Person & Student { name: "Bob" });
(n3: Course { name: "Algebra" });
[e1: (n1) -[ :knows { since: 2020 }]->(n2)];
[e2: (n2)-[:knows { start: 2024, end: 2025 }]->(n3)]
</code></pre>
<p>Notice that node declarations are declared between parenthesis <code>(</code> and <code>)</code> while edge declarations are declared between square brackets <code>[</code> and <code>]</code>.</p>
<p>The full grammar is available <a href="https://github.com/weso/pgschemapc/blob/main/src/parser/pg.rustemo">here</a>.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="pgs---property-graph-schemas"><a class="header" href="#pgs---property-graph-schemas">pgs - Property Graph Schemas</a></h1>
<p>A property graph schema contains a list of <code>CREATE</code> node/edge/graph <code>TYPE</code> statements. It follows the grammar from the <a href="https://arxiv.org/abs/2211.10962">PGSchema</a> paper with some extensions for property constraints.</p>
<p>The full grammar is available <a href="https://github.com/weso/pgschemapc/blob/main/src/parser/pgs.rustemo">here</a>.</p>
<p>An example property graph schema is:</p>
<pre><code class="language-cypher">CREATE NODE TYPE ( PersonType : Person {
name: STRING,
OPTIONAL age: INTEGER
}) ;
CREATE NODE TYPE ( StudentType : Person & Student {
name: STRING,
OPTIONAL age: INTEGER
}) ;
CREATE NODE TYPE ( CourseType: Course {
name: STRING
})
</code></pre>
<div style="break-before: page; page-break-before: always;"></div><h1 id="map---type-map-associations"><a class="header" href="#map---type-map-associations">map - Type map associations</a></h1>
<p>Type map associations are used to trigger validation. They associate nodes/edges in the property graph with type names in the property graph schema.</p>
<p>The full grammar of type maps is available <a href="https://github.com/weso/pgschemapc/blob/main/src/parser/map.rustemo">here</a></p>
<p>An example type map association is:</p>
<pre><code>n1:PersonType,
n2:StudentType,
n3:CourseType
</code></pre>
<p>Notice that type maps can also be used to specify the expected result of validation which can be positive or negative. For negative validation results, we use a <code>!</code> after the colon. These result type maps are employed in the test-suite which is available <a href="https://github.com/weso/pgschemapc/tree/main/tests">here</a>.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="validate-property-graphs"><a class="header" href="#validate-property-graphs">validate property graphs</a></h1>
<p>The <code>validate</code> command can be used to validate nodes or edges from a Property Graph to check if they conform with type node declarations in a Property Graph Schema. To trigger validation it is necessary to add a third parameter, which is a type map association file which declares which nodes/edges should be checked against which type names.</p>
<p>An example validation can be run by:</p>
<pre><code class="language-sh">pgschemapc validate --graph examples/course.pg --schema examples/course.pgs --map examples/course.map
</code></pre>
<div style="break-before: page; page-break-before: always;"></div><h1 id="test-suite"><a class="header" href="#test-suite">test-suite</a></h1>
<p>The project contains a list of tests in the folder <a href="https://github.com/weso/pgschemapc/tree/main/tests">tests</a>.</p>
<p>The test cases are defined with four files:</p>
<ul>
<li>A property graph, usually with the extension <code>.pg</code></li>
<li>A property graph schema, usually with the extension <code>.pgs</code></li>
<li>An input type map association file: <code>.map</code> which declares which nodes/edges in the property graph should validate with which type names in the property graph schema.</li>
<li>A result type map association file, which declares the expected result.</li>
</ul>
</main>
</div>
</div>
</div>
<script>
window.playground_copyable = true;
</script>
<script src="elasticlunr.min.js"></script>
<script src="mark.min.js"></script>
<script src="searcher.js"></script>
<script src="clipboard.min.js"></script>
<script src="highlight.js"></script>
<script src="book.js"></script>
<!-- Custom JS scripts -->
<script>
window.addEventListener('load', function () {
window.setTimeout(window.print, 100);
});
</script>
<script>
(function () {
var theme = localStorage.getItem('mdbook-theme');
var html = document.querySelector('html');
if (theme) {
html.setAttribute('data-theme', theme);
html.setAttribute('data-color-scheme', theme);
html.className = theme;
} else {
var systemPreference = window.matchMedia("(prefers-color-scheme: dark)").matches ? "dark" : "light";
html.setAttribute('data-theme', systemPreference);
html.setAttribute('data-color-scheme', systemPreference);
html.className = systemPreference;
}
})();
</script>
</div>
</body>
</html>
