Update gh-pages to output generated at 76e5418

Katrix · Jun 2, 2024 · 8f4a9a7 · 8f4a9a7
1 parent e14f0f9
commit 8f4a9a7
Show file tree

Hide file tree

Showing 567 changed files with 10,527 additions and 3,831 deletions.
diff --git a/01_table_definitions.html b/01_table_definitions.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html data-githubContributorsUrl="https://api.github.com/repos/Katrix/DataPrism" data-githubContributorsFilename="docs/_docs/guide/01_table_definitions.md" data-pathToRoot=""><head><meta charset="utf-8"></meta><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"></meta><title>Table definitions</title><link rel="shortcut icon" type="image/x-icon" href="favicon.ico"></link><script type="text/javascript" src="scripts/theme.js"></script><script type="text/javascript" src="scripts/searchData.js" defer="true"></script><script type="text/javascript" src="scripts/scastieConfiguration.js" defer="true"></script><link rel="stylesheet" href="styles/theme/bundle.css"></link><link rel="stylesheet" href="styles/theme/components/bundle.css"></link><link rel="stylesheet" href="styles/theme/components/button/bundle.css"></link><link rel="stylesheet" href="styles/theme/layout/bundle.css"></link><link rel="stylesheet" href="styles/nord-light.css"></link><link rel="stylesheet" href="styles/dotty-icons.css"></link><link rel="stylesheet" href="styles/filter-bar.css"></link><link rel="stylesheet" href="styles/code-snippets.css"></link><link rel="stylesheet" href="styles/searchbar.css"></link><link rel="stylesheet" href="styles/social-links.css"></link><link rel="stylesheet" href="styles/versions-dropdown.css"></link><link rel="stylesheet" href="styles/content-contributors.css"></link><link rel="stylesheet" href="styles/fontawesome.css"></link><script type="text/javascript" src="hljs/highlight.pack.js" defer="true"></script><script type="text/javascript" src="scripts/hljs-scala3.js" defer="true"></script><script type="text/javascript" src="scripts/ux.js" defer="true"></script><script type="text/javascript" src="scripts/common/component.js" defer="true"></script><script type="text/javascript" src="scripts/common/utils.js" defer="true"></script><script type="text/javascript" src="scripts/components/FilterBar.js" defer="true"></script><script type="text/javascript" src="scripts/components/DocumentableList.js" defer="true"></script><script type="text/javascript" src="scripts/components/Input.js" defer="true"></script><script type="text/javascript" src="scripts/components/FilterGroup.js" defer="true"></script><script type="text/javascript" src="scripts/components/Filter.js" defer="true"></script><script type="text/javascript" src="scripts/scaladoc-scalajs.js" defer="true"></script><script type="text/javascript" src="scripts/contributors.js" defer="true"></script><script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.min.js" defer="true"></script><script type="text/javascript" src="https://d3js.org/d3.v6.min.js" defer="true"></script><script type="text/javascript" src="https://cdn.jsdelivr.net/npm/[email protected]/dist/graphlib-dot.min.js" defer="true"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/dagre-d3/0.6.1/dagre-d3.min.js" defer="true"></script><script type="text/javascript" src="https://scastie.scala-lang.org/embedded.js" defer="true"></script><script type="text/javascript" src="scripts/data.js" defer="true"></script><link rel="stylesheet" href="styles/staticsitestyles.css"></link><script>var pathToRoot = "";</script></head><body><div id=""><div id="header" class="body-small"><div class="header-container-left"><a href="" class="logo-container"><span class="project-name h300">DataPrism</span></a><span onclick="dropdownHandler(event)" class="text-button with-arrow" id="dropdown-trigger"><a><div class="projectVersion">0.0.0+68-6eb36c9b-SNAPSHOT</div></a></span><div id="version-dropdown" class="dropdown-menu"></div></div><div class="header-container-right"><button id="search-toggle" class="icon-button"></button><span id="theme-toggle" class="icon-button"></span><span id="mobile-menu-toggle" class="icon-button hamburger"></span></div></div><div id="mobile-menu"><div class="mobile-menu-header body-small"><span class="mobile-menu-logo"><span class="project-name h300">DataPrism</span></span><button id="mobile-menu-close" class="icon-button close"></button></div><div class="mobile-menu-container body-medium"><input id="mobile-scaladoc-searchbar-input" class="scaladoc-searchbar-input" type="search" placeholder="Find anything"></input><span id="mobile-theme-toggle" class="mobile-menu-item mode"></span></div></div><span id="mobile-sidebar-toggle" class="floating-button"></span><div id="leftColumn" class="body-small"><div class="switcher-container"><a id="docs-nav-button" class="switcher h100 selected" href="index.html">Docs</a><a id="api-nav-button" class="switcher h100 " href="api/index.html">API</a></div><nav id="docs-nav" class="side-menu"><div class="ni n0 expanded"><span class="nh h100 selected de"><a href="#"><span>Table definitions</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="02_queries.html"><span>Queries</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="03_operations.html"><span>Operations (SELECT, INSERT, UPDATE, DELETE)</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="04_types.html"><span>Types</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="05_dbvalue_expressions.html"><span>DbValue and Expressions</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="06_compiled.html"><span>Compiled queries and commands</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="07_mapres_exotic_data.html"><span>MapRes and Exotic data</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="08_transactions.html"><span>Transactions</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="09_cats_effects.html"><span>Usage with Cats effects</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="10_fs2_effects.html"><span>Usage with Fs2</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="11_skunk.html"><span>Usage with Skunk</span></a></span></div></nav></div><div id="footer" class="body-small"><div class="left-container">Generated with</div><div class="right-container"><a href="https://github.com/Katrix/DataPrism"><button class="icon-button gh"></button></a><div class="text"></div></div><div class="text-mobile"></div></div><div id="scaladoc-searchBar"></div><div id="main"><div class="breadcrumbs container"><a href="index.html">DataPrism</a>/<a href="01_table_definitions.html">Table definitions</a></div><div id="content" class="body-medium"><div><section id="table-definitions-1">
+<!DOCTYPE html><html data-githubContributorsUrl="https://api.github.com/repos/Katrix/DataPrism" data-githubContributorsFilename="docs/_docs/guide/01_table_definitions.md" data-pathToRoot=""><head><meta charset="utf-8"></meta><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"></meta><title>Table definitions</title><link rel="shortcut icon" type="image/x-icon" href="favicon.ico"></link><script type="text/javascript" src="scripts/theme.js"></script><script type="text/javascript" src="scripts/searchData.js" defer="true"></script><script type="text/javascript" src="scripts/scastieConfiguration.js" defer="true"></script><link rel="stylesheet" href="styles/theme/bundle.css"></link><link rel="stylesheet" href="styles/theme/components/bundle.css"></link><link rel="stylesheet" href="styles/theme/components/button/bundle.css"></link><link rel="stylesheet" href="styles/theme/layout/bundle.css"></link><link rel="stylesheet" href="styles/nord-light.css"></link><link rel="stylesheet" href="styles/dotty-icons.css"></link><link rel="stylesheet" href="styles/filter-bar.css"></link><link rel="stylesheet" href="styles/code-snippets.css"></link><link rel="stylesheet" href="styles/searchbar.css"></link><link rel="stylesheet" href="styles/social-links.css"></link><link rel="stylesheet" href="styles/versions-dropdown.css"></link><link rel="stylesheet" href="styles/content-contributors.css"></link><link rel="stylesheet" href="styles/fontawesome.css"></link><script type="text/javascript" src="hljs/highlight.pack.js" defer="true"></script><script type="text/javascript" src="scripts/hljs-scala3.js" defer="true"></script><script type="text/javascript" src="scripts/ux.js" defer="true"></script><script type="text/javascript" src="scripts/common/component.js" defer="true"></script><script type="text/javascript" src="scripts/common/utils.js" defer="true"></script><script type="text/javascript" src="scripts/components/FilterBar.js" defer="true"></script><script type="text/javascript" src="scripts/components/DocumentableList.js" defer="true"></script><script type="text/javascript" src="scripts/components/Input.js" defer="true"></script><script type="text/javascript" src="scripts/components/FilterGroup.js" defer="true"></script><script type="text/javascript" src="scripts/components/Filter.js" defer="true"></script><script type="text/javascript" src="scripts/scaladoc-scalajs.js" defer="true"></script><script type="text/javascript" src="scripts/contributors.js" defer="true"></script><script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.min.js" defer="true"></script><script type="text/javascript" src="https://d3js.org/d3.v6.min.js" defer="true"></script><script type="text/javascript" src="https://cdn.jsdelivr.net/npm/[email protected]/dist/graphlib-dot.min.js" defer="true"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/dagre-d3/0.6.1/dagre-d3.min.js" defer="true"></script><script type="text/javascript" src="https://scastie.scala-lang.org/embedded.js" defer="true"></script><script type="text/javascript" src="scripts/data.js" defer="true"></script><link rel="stylesheet" href="styles/staticsitestyles.css"></link><script>var pathToRoot = "";</script></head><body><div id=""><div id="header" class="body-small"><div class="header-container-left"><a href="" class="logo-container"><span class="project-name h300">DataPrism</span></a><span onclick="dropdownHandler(event)" class="text-button with-arrow" id="dropdown-trigger"><a><div class="projectVersion">0.0.0+69-76e5418b-SNAPSHOT</div></a></span><div id="version-dropdown" class="dropdown-menu"></div></div><div class="header-container-right"><button id="search-toggle" class="icon-button"></button><span id="theme-toggle" class="icon-button"></span><span id="mobile-menu-toggle" class="icon-button hamburger"></span></div></div><div id="mobile-menu"><div class="mobile-menu-header body-small"><span class="mobile-menu-logo"><span class="project-name h300">DataPrism</span></span><button id="mobile-menu-close" class="icon-button close"></button></div><div class="mobile-menu-container body-medium"><input id="mobile-scaladoc-searchbar-input" class="scaladoc-searchbar-input" type="search" placeholder="Find anything"></input><span id="mobile-theme-toggle" class="mobile-menu-item mode"></span></div></div><span id="mobile-sidebar-toggle" class="floating-button"></span><div id="leftColumn" class="body-small"><div class="switcher-container"><a id="docs-nav-button" class="switcher h100 selected" href="index.html">Docs</a><a id="api-nav-button" class="switcher h100 " href="api/index.html">API</a></div><nav id="docs-nav" class="side-menu"><div class="ni n0 expanded"><span class="nh h100 selected de"><a href="#"><span>Table definitions</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="02_queries.html"><span>Queries</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="03_operations.html"><span>Operations (SELECT, INSERT, UPDATE, DELETE)</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="04_types.html"><span>Types</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="05_dbvalue_expressions.html"><span>DbValue and Expressions</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="06_compiled.html"><span>Compiled queries and commands</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="07_mapres_exotic_data.html"><span>MapRes and Exotic data</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="08_transactions.html"><span>Transactions</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="09_cats_effects.html"><span>Usage with Cats effects</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="10_fs2_effects.html"><span>Usage with Fs2</span></a></span></div><div class="ni n0 "><span class="nh de"><a href="11_skunk.html"><span>Usage with Skunk</span></a></span></div></nav></div><div id="footer" class="body-small"><div class="left-container">Generated with</div><div class="right-container"><a href="https://github.com/Katrix/DataPrism"><button class="icon-button gh"></button></a><div class="text"></div></div><div class="text-mobile"></div></div><div id="scaladoc-searchBar"></div><div id="main"><div class="breadcrumbs container"><a href="index.html">DataPrism</a>/<a href="01_table_definitions.html">Table definitions</a></div><div id="content" class="body-medium"><div><section id="table-definitions-1">
  <h1 class="h500"><a href="#table-definitions-1" class="anchor"></a>Table definitions</h1>
  <p>The first thing you need when using DataPrism is a description of the table you are querying. In the vast amount of cases, you will express this using a Higher Kinded Data (HKD) structure. HKD is a normal <code>case class</code> where the type of each field is wrapped in a higher kinded type.</p>
  <p>Here's an example of a HKD structure.</p>