Skip to content

Commit 66b88cf

Browse files
committed
Update generated documentation for version 1.5.14
1 parent 6fe9924 commit 66b88cf

File tree

49 files changed

+134
-132
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+134
-132
lines changed

core/general.html

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ <h2><a name="Basic-Querying" class="anchor" href="#Basic-Querying">Basic Queryin
396396
<h2><a name="Individuals" class="anchor" href="#Individuals">Individuals</a></h2>
397397
<p>The SQL provider has the ability via intellisense to navigate the actual data
398398
held within a table or view. You can then bind that data as an entity to a value.</p>
399-
<pre class="fssnip highlighted"><code lang="fsharp"><span class="k">let</span> <span onmouseout="hideTip(event, 'fs48', 151)" onmouseover="showTip(event, 'fs48', 151)" class="id">BERGS</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs16', 152)" onmouseover="showTip(event, 'fs16', 152)" class="id">ctx</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs21', 153)" onmouseover="showTip(event, 'fs21', 153)" class="prop">Main</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs22', 154)" onmouseover="showTip(event, 'fs22', 154)" class="prop">Customers</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs49', 155)" onmouseover="showTip(event, 'fs49', 155)" class="prop">Individuals</span><span class="pn">.</span><span class="id">BERGS</span>
399+
<pre class="fssnip highlighted"><code lang="fsharp"><span class="k">let</span> <span onmouseout="hideTip(event, 'fs48', 151)" onmouseover="showTip(event, 'fs48', 151)" class="id">BERGS</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs16', 152)" onmouseover="showTip(event, 'fs16', 152)" class="id">ctx</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs21', 153)" onmouseover="showTip(event, 'fs21', 153)" class="prop">Main</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs22', 154)" onmouseover="showTip(event, 'fs22', 154)" class="prop">Customers</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs49', 155)" onmouseover="showTip(event, 'fs49', 155)" class="prop">Individuals</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs50', 156)" onmouseover="showTip(event, 'fs50', 156)" class="id">BERGS</span>
400400
</code></pre>
401401
<p>Every table and view has an <code>Individuals</code> property. When you press the dot on
402402
this property, intellisense will display a list of the data in that table,
@@ -409,7 +409,7 @@ <h2><a name="Individuals" class="anchor" href="#Individuals">Individuals</a></h2
409409
is the name of a column in the table.
410410
When you press "." on one of these properties, the data is re-projected to you
411411
using both the primary key and the text of the column you have selected.</p>
412-
<pre class="fssnip highlighted"><code lang="fsharp"><span class="k">let</span> <span onmouseout="hideTip(event, 'fs50', 156)" onmouseover="showTip(event, 'fs50', 156)" class="id">christina</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs16', 157)" onmouseover="showTip(event, 'fs16', 157)" class="id">ctx</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs21', 158)" onmouseover="showTip(event, 'fs21', 158)" class="prop">Main</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs22', 159)" onmouseover="showTip(event, 'fs22', 159)" class="prop">Customers</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs49', 160)" onmouseover="showTip(event, 'fs49', 160)" class="prop">Individuals</span><span class="pn">.</span><span class="id">``As ContactName``</span><span class="pn">.</span><span class="id">``BERGS, Christina Berglund``</span>
412+
<pre class="fssnip highlighted"><code lang="fsharp"><span class="k">let</span> <span onmouseout="hideTip(event, 'fs51', 157)" onmouseover="showTip(event, 'fs51', 157)" class="id">christina</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs16', 158)" onmouseover="showTip(event, 'fs16', 158)" class="id">ctx</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs21', 159)" onmouseover="showTip(event, 'fs21', 159)" class="prop">Main</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs22', 160)" onmouseover="showTip(event, 'fs22', 160)" class="prop">Customers</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs49', 161)" onmouseover="showTip(event, 'fs49', 161)" class="prop">Individuals</span><span class="pn">.</span><span class="prop">``As ContactName``</span><span class="pn">.</span><span class="id">``BERGS, Christina Berglund``</span>
413413
</code></pre>
414414
<h2><a name="DataContext" class="anchor" href="#DataContext">DataContext</a></h2>
415415
<p>You should create and use one data context as long as it has the parameters you need.
@@ -430,7 +430,7 @@ <h2><a name="DataContext" class="anchor" href="#DataContext">DataContext</a></h2
430430
<p>A. Once SQLProvider gets a "mental model" of your database (the schema),
431431
that is what is used for any intellisense/completion suggestions for the rest of your IDE session.</p>
432432
<pre class="fssnip highlighted"><code lang="fsharp"><span class="id">This</span> <span class="id">is</span> <span class="id">a</span> <span class="id">fantastic</span> <span class="id">feature</span> <span class="id">because</span> <span class="id">it</span> <span class="id">means</span> <span class="id">you&#39;re</span> <span class="id">not</span> <span class="id">assaulting</span> <span class="id">your</span> <span class="id">database</span> <span class="k">with</span> <span class="id">a</span>
433-
<span class="k">new</span> <span class="s">&quot;What are you like?&quot;</span> <span onmouseout="hideTip(event, 'fs30', 161)" onmouseover="showTip(event, 'fs30', 161)" class="id">query</span> <span class="id">on</span> <span class="id">EVERY</span> <span class="id">SINGLE</span> <span class="id">KEYSTROKE</span><span class="pn">.</span>
433+
<span class="k">new</span> <span class="s">&quot;What are you like?&quot;</span> <span onmouseout="hideTip(event, 'fs30', 162)" onmouseover="showTip(event, 'fs30', 162)" class="id">query</span> <span class="id">on</span> <span class="id">EVERY</span> <span class="id">SINGLE</span> <span class="id">KEYSTROKE</span><span class="pn">.</span>
434434

435435
<span class="id">But</span> <span class="id">what</span> <span class="k">if</span> <span class="id">the</span> <span class="id">database</span> <span class="id">changes</span><span class="o">?</span> <span class="id">SQLProvider</span> <span class="id">will</span> <span class="id">NOT</span> <span class="id">see</span> <span class="id">your</span> <span class="id">change</span> <span class="id">because</span> <span class="id">its</span> <span class="id">source</span> <span class="k">of</span> <span class="id">truth</span> <span class="id">is</span>
436436
<span class="id">that</span> <span class="id">locally</span> <span class="id">cached</span> <span class="id">schema</span> <span class="id">snapshot</span> <span class="id">it</span> <span class="id">took</span> <span class="id">at</span> <span class="id">right</span> <span class="k">when</span> <span class="id">it</span> <span class="id">started</span><span class="pn">,</span> <span class="k">and</span> <span class="id">that</span> <span class="id">snapshot</span> <span class="id">will</span> <span class="id">persist</span> <span class="id">until</span>
@@ -443,7 +443,7 @@ <h2><a name="DataContext" class="anchor" href="#DataContext">DataContext</a></h2
443443
<span class="n">2.</span> <span class="id">Forced</span> <span class="id">clearing</span> <span class="k">of</span> <span class="id">the</span> <span class="id">local</span> <span class="id">database</span> <span class="id">schema</span> <span class="id">cache</span><span class="pn">.</span>
444444
<span class="id">If</span> <span class="id">SQLProvider</span> <span class="id">is</span> <span class="id">currently</span> <span class="id">able</span> <span class="k">to</span> <span class="id">communicate</span> <span class="k">with</span> <span class="id">the</span> <span class="id">database</span><span class="pn">,</span>
445445
<span class="id">you</span> <span class="id">can</span> <span class="id">force</span> <span class="id">the</span> <span class="id">local</span> <span class="id">cache</span> <span class="k">to</span> <span class="id">clear</span><span class="pn">,</span> <span class="k">to</span> <span class="id">be</span> <span class="id">invalidated</span> <span class="k">and</span> <span class="id">refreshed</span> <span class="id">by</span>
446-
<span class="id">by</span> <span onmouseout="hideTip(event, 'fs51', 162)" onmouseover="showTip(event, 'fs51', 162)" class="id">using</span> <span class="id">what</span> <span class="id">are</span> <span class="id">called</span> <span class="id">`</span><span class="id">Design</span> <span class="id">Time</span> <span class="id">Commands</span><span class="id">`</span><span class="pn">,</span> <span class="id">specifically</span> <span class="id">the</span>
446+
<span class="id">by</span> <span onmouseout="hideTip(event, 'fs52', 163)" onmouseover="showTip(event, 'fs52', 163)" class="id">using</span> <span class="id">what</span> <span class="id">are</span> <span class="id">called</span> <span class="id">`</span><span class="id">Design</span> <span class="id">Time</span> <span class="id">Commands</span><span class="id">`</span><span class="pn">,</span> <span class="id">specifically</span> <span class="id">the</span>
447447
<span class="id">`</span><span class="id">ClearDatabaseSchemaCache</span><span class="id">`</span> <span class="id">method</span><span class="pn">.</span>
448448

449449
<span class="id">You&#39;re</span> <span class="id">probably</span> <span class="id">thinking</span><span class="pn">:</span> <span class="s">&quot;Ok, fine, that sounds good! How do I do that though?&quot;</span>
@@ -663,10 +663,11 @@ <h2><a name="How-fast-is-SQLProvider" class="anchor" href="#How-fast-is-SQLProvi
663663
<div class="fsdocs-tip" id="fs45">val ordersQuery: (string * System.DateTime * string) array</div>
664664
<div class="fsdocs-tip" id="fs46">property SqlDataProvider&lt;...&gt;.dataContext.main.OrdersEntity.OrderDate: System.DateTime with get, set<br /><em>&lt;summary&gt;OrderDate: datetime&lt;/summary&gt;</em></div>
665665
<div class="fsdocs-tip" id="fs47">property SqlDataProvider&lt;...&gt;.dataContext.main.OrdersEntity.ShipAddress: string with get, set<br /><em>&lt;summary&gt;ShipAddress: nvarchar(60)&lt;/summary&gt;</em></div>
666-
<div class="fsdocs-tip" id="fs48">val BERGS: obj</div>
666+
<div class="fsdocs-tip" id="fs48">val BERGS: SqlDataProvider&lt;...&gt;.dataContext.main.CustomersEntity</div>
667667
<div class="fsdocs-tip" id="fs49">property SqlDataProvider&lt;...&gt;.readDataContext.mainSchema.main.Customers.Individuals: SqlDataProvider&lt;...&gt;.dataContext.main.Customers.Individuals with get<br /><em>&lt;summary&gt;Get individual items from the table. Requires single primary key.&lt;/summary&gt;</em></div>
668-
<div class="fsdocs-tip" id="fs50">val christina: obj</div>
669-
<div class="fsdocs-tip" id="fs51">val using: resource: &#39;T -&gt; action: (&#39;T -&gt; &#39;U) -&gt; &#39;U (requires &#39;T :&gt; System.IDisposable)</div>
668+
<div class="fsdocs-tip" id="fs50">property SqlDataProvider&lt;...&gt;.dataContext.main.Customers.Individuals.BERGS: SqlDataProvider&lt;...&gt;.dataContext.main.CustomersEntity with get</div>
669+
<div class="fsdocs-tip" id="fs51">val christina: SqlDataProvider&lt;...&gt;.dataContext.main.CustomersEntity</div>
670+
<div class="fsdocs-tip" id="fs52">val using: resource: &#39;T -&gt; action: (&#39;T -&gt; &#39;U) -&gt; &#39;U (requires &#39;T :&gt; System.IDisposable)</div>
670671

671672
</div>
672673
</main>

core/individuals.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -266,13 +266,13 @@ <h1><a name="Individuals" class="anchor" href="#Individuals">Individuals</a></h1
266266
<span class="k">let</span> <span onmouseout="hideTip(event, 'fs19', 25)" onmouseover="showTip(event, 'fs19', 25)" class="id">customers</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs17', 26)" onmouseover="showTip(event, 'fs17', 26)" class="id">ctx</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs20', 27)" onmouseover="showTip(event, 'fs20', 27)" class="prop">Main</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs21', 28)" onmouseover="showTip(event, 'fs21', 28)" class="id">Customers</span>
267267
</code></pre>
268268
<p>Get individual customer row by primary key value</p>
269-
<pre class="fssnip highlighted"><code lang="fsharp"><span onmouseout="hideTip(event, 'fs19', 29)" onmouseover="showTip(event, 'fs19', 29)" class="id">customers</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs22', 30)" onmouseover="showTip(event, 'fs22', 30)" class="prop">Individuals</span><span class="pn">.</span><span class="id">COMMI</span>
269+
<pre class="fssnip highlighted"><code lang="fsharp"><span onmouseout="hideTip(event, 'fs19', 29)" onmouseover="showTip(event, 'fs19', 29)" class="id">customers</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs22', 30)" onmouseover="showTip(event, 'fs22', 30)" class="prop">Individuals</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs23', 31)" onmouseover="showTip(event, 'fs23', 31)" class="id">COMMI</span>
270270
</code></pre>
271271
<p>Get individual customer row using address</p>
272-
<pre class="fssnip highlighted"><code lang="fsharp"><span onmouseout="hideTip(event, 'fs19', 31)" onmouseover="showTip(event, 'fs19', 31)" class="id">customers</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs22', 32)" onmouseover="showTip(event, 'fs22', 32)" class="prop">Individuals</span><span class="pn">.</span><span class="id">``As ContactName``</span><span class="pn">.</span><span class="id">``COMMI, Pedro Afonso``</span>
272+
<pre class="fssnip highlighted"><code lang="fsharp"><span onmouseout="hideTip(event, 'fs19', 32)" onmouseover="showTip(event, 'fs19', 32)" class="id">customers</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs22', 33)" onmouseover="showTip(event, 'fs22', 33)" class="prop">Individuals</span><span class="pn">.</span><span class="prop">``As ContactName``</span><span class="pn">.</span><span class="id">``COMMI, Pedro Afonso``</span>
273273
</code></pre>
274274
<p>Get individual customer row using address</p>
275-
<pre class="fssnip highlighted"><code lang="fsharp"><span onmouseout="hideTip(event, 'fs19', 33)" onmouseover="showTip(event, 'fs19', 33)" class="id">customers</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs22', 34)" onmouseover="showTip(event, 'fs22', 34)" class="prop">Individuals</span><span class="pn">.</span><span class="id">``As Address``</span><span class="pn">.</span><span class="id">``CONSH, Berkeley Gardens 12 Brewery``</span>
275+
<pre class="fssnip highlighted"><code lang="fsharp"><span onmouseout="hideTip(event, 'fs19', 34)" onmouseover="showTip(event, 'fs19', 34)" class="id">customers</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs22', 35)" onmouseover="showTip(event, 'fs22', 35)" class="prop">Individuals</span><span class="pn">.</span><span class="prop">``As Address``</span><span class="pn">.</span><span class="id">``CONSH, Berkeley Gardens 12 Brewery``</span>
276276
</code></pre>
277277

278278
<div class="fsdocs-tip" id="fs1">Multiple items<br />type LiteralAttribute =
@@ -339,6 +339,7 @@ <h1><a name="Individuals" class="anchor" href="#Individuals">Individuals</a></h1
339339
<div class="fsdocs-tip" id="fs20">property SqlDataProvider&lt;...&gt;.dataContext.Main: SqlDataProvider&lt;...&gt;.readDataContext.mainSchema with get</div>
340340
<div class="fsdocs-tip" id="fs21">property SqlDataProvider&lt;...&gt;.readDataContext.mainSchema.Customers: SqlDataProvider&lt;...&gt;.readDataContext.mainSchema.main.Customers with get<br /><em>&lt;summary&gt; The table Customers belonging to schema main&lt;/summary&gt;</em></div>
341341
<div class="fsdocs-tip" id="fs22">property SqlDataProvider&lt;...&gt;.readDataContext.mainSchema.main.Customers.Individuals: SqlDataProvider&lt;...&gt;.dataContext.main.Customers.Individuals with get<br /><em>&lt;summary&gt;Get individual items from the table. Requires single primary key.&lt;/summary&gt;</em></div>
342+
<div class="fsdocs-tip" id="fs23">property SqlDataProvider&lt;...&gt;.dataContext.main.Customers.Individuals.COMMI: SqlDataProvider&lt;...&gt;.dataContext.main.CustomersEntity with get</div>
342343

343344
</div>
344345
</main>

core/netstandard.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ <h1><a name="NET-Standard-NET-Core-support" class="anchor" href="#NET-Standard-N
260260
<span class="id">Postgres</span> <span class="pn">|</span> <span class="pn">[</span><span class="id">x</span><span class="pn">]</span> <span class="pn">|</span> <span class="pn">[</span><span class="id">x</span><span class="pn">]</span> <span class="pn">|</span> <span class="pn">[</span><span class="id">x</span><span class="pn">]</span> <span class="pn">|</span> <span class="id">See</span> <span class="id">post</span><span class="o">-</span><span class="id">build</span> <span onmouseout="hideTip(event, 'fs3', 4)" onmouseover="showTip(event, 'fs3', 4)" class="id">task</span><span class="pn">.</span> <span class="pn">|</span>
261261
<span class="id">MySQL</span> <span class="o">/</span> <span class="id">MariaDB</span> <span class="pn">|</span> <span class="pn">[</span><span class="id">x</span><span class="pn">]</span> <span class="pn">|</span> <span class="pn">[</span><span class="id">x</span><span class="pn">]</span> <span class="pn">|</span> <span class="pn">[</span><span class="id">x</span><span class="pn">]</span> <span class="pn">|</span> <span class="id">See</span> <span class="id">post</span><span class="o">-</span><span class="id">build</span> <span onmouseout="hideTip(event, 'fs3', 5)" onmouseover="showTip(event, 'fs3', 5)" class="id">task</span><span class="pn">.</span> <span class="pn">|</span>
262262
<span class="id">SQLite</span> <span class="pn">|</span> <span class="pn">[</span><span class="id">x</span><span class="pn">]</span> <span class="pn">|</span> <span class="pn">|</span> <span class="pn">|</span> <span class="id">See</span> <span class="id">post</span><span class="o">-</span><span class="id">build</span> <span onmouseout="hideTip(event, 'fs3', 6)" onmouseover="showTip(event, 'fs3', 6)" class="id">task</span><span class="pn">.</span> <span class="id">Builds</span> <span class="id">on</span> <span class="id">Win</span><span class="pn">,</span> <span class="id">runs</span> <span class="id">on</span> <span class="id">all</span> <span class="pn">|</span>
263-
<span class="id">FireBird</span> <span class="pn">|</span> <span class="o">?</span> <span class="pn">|</span> <span class="o">?</span> <span class="pn">|</span> <span class="o">?</span> <span class="pn">|</span> <span class="id">Not</span> <span class="id">tested</span><span class="pn">.</span> <span class="pn">|</span>
263+
<span class="id">Firebird</span> <span class="pn">|</span> <span class="o">?</span> <span class="pn">|</span> <span class="o">?</span> <span class="pn">|</span> <span class="o">?</span> <span class="pn">|</span> <span class="id">Not</span> <span class="id">tested</span><span class="pn">.</span> <span class="pn">|</span>
264264
<span class="id">Oracle</span> <span class="pn">|</span> <span class="pn">|</span> <span class="pn">|</span> <span class="pn">|</span> <span class="id">No</span> <span class="id">ODP</span><span class="pn">.</span><span class="id">NET</span><span class="o">-</span><span class="id">driver</span> <span class="id">yet</span><span class="pn">.</span> <span class="pn">|</span>
265265
<span class="id">Odbc</span> <span class="pn">|</span> <span class="pn">|</span> <span class="pn">|</span> <span class="pn">|</span> <span class="id">Not</span> <span class="id">supported</span><span class="pn">.</span> <span class="pn">|</span>
266266
<span class="id">Access</span> <span class="pn">|</span> <span class="pn">|</span> <span class="pn">|</span> <span class="pn">|</span> <span class="id">Not</span> <span class="id">supported</span><span class="pn">.</span> <span class="pn">|</span>

0 commit comments

Comments
 (0)