Skip to content

Commit

Permalink
deploy: f1383ba
Browse files Browse the repository at this point in the history
  • Loading branch information
RoelantVos committed Aug 27, 2023
0 parents commit be5e589
Show file tree
Hide file tree
Showing 117 changed files with 12,208 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
376 changes: 376 additions & 0 deletions api/DataWarehouseAutomation.BusinessKeyDefinition.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,376 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class BusinessKeyDefinition
| Schema for Data Warehouse Automation </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class BusinessKeyDefinition
| Schema for Data Warehouse Automation ">

<link rel="icon" href="../favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">

<meta name="docfx:rel" content="../">

<meta name="docfx:disabletocfilter" content="true">

</head>

<script type="module">
import options from './../public/main.js'
import { init } from './../public/docfx.min.js'
init(options)
</script>

<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>


<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../." alt="">

</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>

<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>

<nav id="breadcrumb"></nav>
</div>

<article data-uid="DataWarehouseAutomation.BusinessKeyDefinition">



<h1 id="DataWarehouseAutomation_BusinessKeyDefinition" data-uid="DataWarehouseAutomation.BusinessKeyDefinition" class="text-break">
Class BusinessKeyDefinition

</h1>

<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="DataWarehouseAutomation.html">DataWarehouseAutomation</a></dd></dl>
<dl><dt>Assembly</dt><dd>DataWarehouseAutomation.dll</dd></dl>
</div>

<div class="markdown summary"><p>A Business Key, which consists of one or more components (column mappings) and has its own surrogate key.
A Business Key is a special column, or combination of columns, that is defined separately outside of regular data item mappings.</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class BusinessKeyDefinition</code></pre>
</div>




<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">BusinessKeyDefinition</span></div>
</dd>
</dl>



<dl class="typelist derived">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>






<h2 class="section" id="properties">Properties
</h2>


<a id="DataWarehouseAutomation_BusinessKeyDefinition_BusinessKeyComponentMappings_" data-uid="DataWarehouseAutomation.BusinessKeyDefinition.BusinessKeyComponentMappings*"></a>

<h3 id="DataWarehouseAutomation_BusinessKeyDefinition_BusinessKeyComponentMappings" data-uid="DataWarehouseAutomation.BusinessKeyDefinition.BusinessKeyComponentMappings">
BusinessKeyComponentMappings

</h3>

<div class="markdown level1 summary"><p>Items that define the Business Key e.g. the collection of columns for a Business Key.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;businessKeyComponentMappings&quot;)]
public List&lt;DataItemMapping&gt; BusinessKeyComponentMappings { get; set; }</code></pre>
</div>





<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="DataWarehouseAutomation.DataItemMapping.html">DataItemMapping</a>&gt;</dt>
<dd></dd>
</dl>








<a id="DataWarehouseAutomation_BusinessKeyDefinition_Classifications_" data-uid="DataWarehouseAutomation.BusinessKeyDefinition.Classifications*"></a>

<h3 id="DataWarehouseAutomation_BusinessKeyDefinition_Classifications" data-uid="DataWarehouseAutomation.BusinessKeyDefinition.Classifications">
Classifications

</h3>

<div class="markdown level1 summary"><p>Free-form and optional classification for the Business Key for use in generation logic (evaluation).</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;classifications&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List&lt;DataClassification&gt;? Classifications { get; set; }</code></pre>
</div>





<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="DataWarehouseAutomation.DataClassification.html">DataClassification</a>&gt;</dt>
<dd></dd>
</dl>








<a id="DataWarehouseAutomation_BusinessKeyDefinition_Extensions_" data-uid="DataWarehouseAutomation.BusinessKeyDefinition.Extensions*"></a>

<h3 id="DataWarehouseAutomation_BusinessKeyDefinition_Extensions" data-uid="DataWarehouseAutomation.BusinessKeyDefinition.Extensions">
Extensions

</h3>

<div class="markdown level1 summary"><p>The collection of extension Key/Value pairs.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;extensions&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List&lt;Extension&gt;? Extensions { get; set; }</code></pre>
</div>





<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="DataWarehouseAutomation.Extension.html">Extension</a>&gt;</dt>
<dd></dd>
</dl>








<a id="DataWarehouseAutomation_BusinessKeyDefinition_Id_" data-uid="DataWarehouseAutomation.BusinessKeyDefinition.Id*"></a>

<h3 id="DataWarehouseAutomation_BusinessKeyDefinition_Id" data-uid="DataWarehouseAutomation.BusinessKeyDefinition.Id">
Id

</h3>

<div class="markdown level1 summary"><p>Optional identifier as a string value to allow various identifier approaches.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;id&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string Id { get; set; }</code></pre>
</div>





<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>








<a id="DataWarehouseAutomation_BusinessKeyDefinition_Notes_" data-uid="DataWarehouseAutomation.BusinessKeyDefinition.Notes*"></a>

<h3 id="DataWarehouseAutomation_BusinessKeyDefinition_Notes" data-uid="DataWarehouseAutomation.BusinessKeyDefinition.Notes">
Notes

</h3>

<div class="markdown level1 summary"><p>Free-format notes.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;notes&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Notes { get; set; }</code></pre>
</div>





<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>








<a id="DataWarehouseAutomation_BusinessKeyDefinition_SurrogateKey_" data-uid="DataWarehouseAutomation.BusinessKeyDefinition.SurrogateKey*"></a>

<h3 id="DataWarehouseAutomation_BusinessKeyDefinition_SurrogateKey" data-uid="DataWarehouseAutomation.BusinessKeyDefinition.SurrogateKey">
SurrogateKey

</h3>

<div class="markdown level1 summary"><p>An optional label for the end result e.g. the target business key attribute.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;surrogateKey&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? SurrogateKey { get; set; }</code></pre>
</div>





<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>









</article>



</div>

<div class="affix">
<nav id="affix"></nav>
</div>
</main>

<div class="container-xxl search-results" id="search-results"></div>

<footer class="border-top">
<div class="container-xxl">
<div class="flex-fill">
<span>Schema for Data Solution Automation</span>
</div>
</div>
</footer>
</body>
</html>
Loading

0 comments on commit be5e589

Please sign in to comment.