Skip to content

Commit 4488737

Browse files
committed
Update generated documentation for version 1.5.16
1 parent 66b88cf commit 4488737

File tree

339 files changed

+19893
-8136
lines changed

Some content is hidden

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

339 files changed

+19893
-8136
lines changed

core/async.html

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -381,28 +381,42 @@ <h3><a name="Why-Not-to-Use-Async" class="anchor" href="#Why-Not-to-Use-Async">W
381381
| MSSQLSERVER_DYNAMIC = 8
382382
| MSSQLSERVER_SSDT = 9
383383
| DUCKDB = 10
384-
| EXTERNAL = 11</div>
385-
<div class="fsdocs-tip" id="fs12">Common.DatabaseProviderTypes.SQLITE: Common.DatabaseProviderTypes = 1</div>
384+
| EXTERNAL = 11<br /><em>&lt;summary&gt;
385+
Specifies the database provider type for the SQL type provider.
386+
Each provider has its own specific implementation for SQL generation and data type mapping.
387+
&lt;/summary&gt;</em></div>
388+
<div class="fsdocs-tip" id="fs12">Common.DatabaseProviderTypes.SQLITE: Common.DatabaseProviderTypes = 1<br /><em>&lt;summary&gt;
389+
SQLite database using System.Data.SQLite or Microsoft.Data.Sqlite
390+
&lt;/summary&gt;</em></div>
386391
<div class="fsdocs-tip" id="fs13">[&lt;Struct&gt;]
387392
type NullableColumnType =
388393
| NO_OPTION = 0
389394
| OPTION = 1
390-
| VALUE_OPTION = 2</div>
395+
| VALUE_OPTION = 2<br /><em>&lt;summary&gt;
396+
Specifies how to represent nullable database columns in the generated types.
397+
&lt;/summary&gt;</em></div>
391398
<div class="fsdocs-tip" id="fs14">Common.NullableColumnType.OPTION: Common.NullableColumnType = 1<br /><em>&lt;summary&gt;
392399
Option types are Option&amp;lt;_&amp;gt;. (Old true.)
393400
&lt;/summary&gt;</em></div>
394401
<div class="fsdocs-tip" id="fs15">[&lt;Struct&gt;]
395402
type CaseSensitivityChange =
396403
| ORIGINAL = 0
397404
| TOUPPER = 1
398-
| TOLOWER = 2</div>
399-
<div class="fsdocs-tip" id="fs16">Common.CaseSensitivityChange.ORIGINAL: Common.CaseSensitivityChange = 0</div>
405+
| TOLOWER = 2<br /><em>&lt;summary&gt;
406+
Specifies how to handle case sensitivity when generating table and column names.
407+
&lt;/summary&gt;</em></div>
408+
<div class="fsdocs-tip" id="fs16">Common.CaseSensitivityChange.ORIGINAL: Common.CaseSensitivityChange = 0<br /><em>&lt;summary&gt;
409+
Keep original casing from the database
410+
&lt;/summary&gt;</em></div>
400411
<div class="fsdocs-tip" id="fs17">[&lt;Struct&gt;]
401412
type SQLiteLibrary =
402413
| SystemDataSQLite = 0
403414
| MonoDataSQLite = 1
404415
| AutoSelect = 2
405-
| MicrosoftDataSqlite = 3</div>
416+
| MicrosoftDataSqlite = 3<br /><em>&lt;summary&gt;
417+
Specifies which SQLite library to use for connections.
418+
Different libraries may have different capabilities and platform support.
419+
&lt;/summary&gt;</em></div>
406420
<div class="fsdocs-tip" id="fs18">Common.SQLiteLibrary.SystemDataSQLite: Common.SQLiteLibrary = 0<br /><em>&lt;summary&gt;
407421
.NET Framework default
408422
&lt;/summary&gt;</em></div>

core/composable.html

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -443,23 +443,35 @@ <h2><a name="Generate-composable-queries-from-quotations" class="anchor" href="#
443443
| MSSQLSERVER_DYNAMIC = 8
444444
| MSSQLSERVER_SSDT = 9
445445
| DUCKDB = 10
446-
| EXTERNAL = 11</div>
447-
<div class="fsdocs-tip" id="fs13">Common.DatabaseProviderTypes.SQLITE: Common.DatabaseProviderTypes = 1</div>
446+
| EXTERNAL = 11<br /><em>&lt;summary&gt;
447+
Specifies the database provider type for the SQL type provider.
448+
Each provider has its own specific implementation for SQL generation and data type mapping.
449+
&lt;/summary&gt;</em></div>
450+
<div class="fsdocs-tip" id="fs13">Common.DatabaseProviderTypes.SQLITE: Common.DatabaseProviderTypes = 1<br /><em>&lt;summary&gt;
451+
SQLite database using System.Data.SQLite or Microsoft.Data.Sqlite
452+
&lt;/summary&gt;</em></div>
448453
<div class="fsdocs-tip" id="fs14">[&lt;Struct&gt;]
449454
type SQLiteLibrary =
450455
| SystemDataSQLite = 0
451456
| MonoDataSQLite = 1
452457
| AutoSelect = 2
453-
| MicrosoftDataSqlite = 3</div>
458+
| MicrosoftDataSqlite = 3<br /><em>&lt;summary&gt;
459+
Specifies which SQLite library to use for connections.
460+
Different libraries may have different capabilities and platform support.
461+
&lt;/summary&gt;</em></div>
454462
<div class="fsdocs-tip" id="fs15">Common.SQLiteLibrary.SystemDataSQLite: Common.SQLiteLibrary = 0<br /><em>&lt;summary&gt;
455463
.NET Framework default
456464
&lt;/summary&gt;</em></div>
457465
<div class="fsdocs-tip" id="fs16">[&lt;Struct&gt;]
458466
type CaseSensitivityChange =
459467
| ORIGINAL = 0
460468
| TOUPPER = 1
461-
| TOLOWER = 2</div>
462-
<div class="fsdocs-tip" id="fs17">Common.CaseSensitivityChange.ORIGINAL: Common.CaseSensitivityChange = 0</div>
469+
| TOLOWER = 2<br /><em>&lt;summary&gt;
470+
Specifies how to handle case sensitivity when generating table and column names.
471+
&lt;/summary&gt;</em></div>
472+
<div class="fsdocs-tip" id="fs17">Common.CaseSensitivityChange.ORIGINAL: Common.CaseSensitivityChange = 0<br /><em>&lt;summary&gt;
473+
Keep original casing from the database
474+
&lt;/summary&gt;</em></div>
463475
<div class="fsdocs-tip" id="fs18">val ctx: SqlDataProvider&lt;...&gt;.dataContext</div>
464476
<div class="fsdocs-tip" id="fs19">SqlDataProvider&lt;...&gt;.GetDataContext() : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(selectOperations: SelectOperations) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;selectOperations&#39;&gt;Execute select-clause operations in SQL database rather than .NET-side.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(commandTimeout: int) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;commandTimeout&#39;&gt;SQL command timeout. Maximum time for single SQL-command in seconds.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(transactionOptions: Transactions.TransactionOptions) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;transactionOptions&#39;&gt;TransactionOptions for the transaction created on SubmitChanges.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(connectionString: string) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;connectionString&#39;&gt;The database runtime connection string&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(connectionString: string, selectOperations: SelectOperations) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;connectionString&#39;&gt;The database runtime connection string&lt;/param&gt;&lt;param name=&#39;selectOperations&#39;&gt;Execute select-clause operations in SQL database rather than .NET-side.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(transactionOptions: Transactions.TransactionOptions, commandTimeout: int) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;transactionOptions&#39;&gt;TransactionOptions for the transaction created on SubmitChanges.&lt;/param&gt;&lt;param name=&#39;commandTimeout&#39;&gt;SQL command timeout. Maximum time for single SQL-command in seconds.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(connectionString: string, commandTimeout: int) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;connectionString&#39;&gt;The database runtime connection string&lt;/param&gt;&lt;param name=&#39;commandTimeout&#39;&gt;SQL command timeout. Maximum time for single SQL-command in seconds.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(connectionString: string, transactionOptions: Transactions.TransactionOptions) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;connectionString&#39;&gt;The database runtime connection string&lt;/param&gt;&lt;param name=&#39;transactionOptions&#39;&gt;TransactionOptions for the transaction created on SubmitChanges.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(connectionString: string, resolutionPath: string) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;connectionString&#39;&gt;The database runtime connection string&lt;/param&gt;&lt;param name=&#39;resolutionPath&#39;&gt;The location to look for dynamically loaded assemblies containing database vendor specific connections and custom types. Types used in design-time: If no better clue, prefer .NET Standard 2.0 versions. Semicolon to separate multiple.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em></div>
465477
<div class="fsdocs-tip" id="fs20">val xs: IQueryable&lt;obj&gt;</div>

core/crud.html

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -500,23 +500,35 @@ <h3><a name="Identifying-columns-dynamically" class="anchor" href="#Identifying-
500500
| MSSQLSERVER_DYNAMIC = 8
501501
| MSSQLSERVER_SSDT = 9
502502
| DUCKDB = 10
503-
| EXTERNAL = 11</div>
504-
<div class="fsdocs-tip" id="fs11">Common.DatabaseProviderTypes.SQLITE: Common.DatabaseProviderTypes = 1</div>
503+
| EXTERNAL = 11<br /><em>&lt;summary&gt;
504+
Specifies the database provider type for the SQL type provider.
505+
Each provider has its own specific implementation for SQL generation and data type mapping.
506+
&lt;/summary&gt;</em></div>
507+
<div class="fsdocs-tip" id="fs11">Common.DatabaseProviderTypes.SQLITE: Common.DatabaseProviderTypes = 1<br /><em>&lt;summary&gt;
508+
SQLite database using System.Data.SQLite or Microsoft.Data.Sqlite
509+
&lt;/summary&gt;</em></div>
505510
<div class="fsdocs-tip" id="fs12">[&lt;Struct&gt;]
506511
type SQLiteLibrary =
507512
| SystemDataSQLite = 0
508513
| MonoDataSQLite = 1
509514
| AutoSelect = 2
510-
| MicrosoftDataSqlite = 3</div>
515+
| MicrosoftDataSqlite = 3<br /><em>&lt;summary&gt;
516+
Specifies which SQLite library to use for connections.
517+
Different libraries may have different capabilities and platform support.
518+
&lt;/summary&gt;</em></div>
511519
<div class="fsdocs-tip" id="fs13">Common.SQLiteLibrary.SystemDataSQLite: Common.SQLiteLibrary = 0<br /><em>&lt;summary&gt;
512520
.NET Framework default
513521
&lt;/summary&gt;</em></div>
514522
<div class="fsdocs-tip" id="fs14">[&lt;Struct&gt;]
515523
type CaseSensitivityChange =
516524
| ORIGINAL = 0
517525
| TOUPPER = 1
518-
| TOLOWER = 2</div>
519-
<div class="fsdocs-tip" id="fs15">Common.CaseSensitivityChange.ORIGINAL: Common.CaseSensitivityChange = 0</div>
526+
| TOLOWER = 2<br /><em>&lt;summary&gt;
527+
Specifies how to handle case sensitivity when generating table and column names.
528+
&lt;/summary&gt;</em></div>
529+
<div class="fsdocs-tip" id="fs15">Common.CaseSensitivityChange.ORIGINAL: Common.CaseSensitivityChange = 0<br /><em>&lt;summary&gt;
530+
Keep original casing from the database
531+
&lt;/summary&gt;</em></div>
520532
<div class="fsdocs-tip" id="fs16">namespace System</div>
521533
<div class="fsdocs-tip" id="fs17">val ctx: SqlDataProvider&lt;...&gt;.dataContext</div>
522534
<div class="fsdocs-tip" id="fs18">SqlDataProvider&lt;...&gt;.GetDataContext() : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(selectOperations: SelectOperations) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;selectOperations&#39;&gt;Execute select-clause operations in SQL database rather than .NET-side.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(commandTimeout: int) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;commandTimeout&#39;&gt;SQL command timeout. Maximum time for single SQL-command in seconds.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(transactionOptions: Transactions.TransactionOptions) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;transactionOptions&#39;&gt;TransactionOptions for the transaction created on SubmitChanges.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(connectionString: string) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;connectionString&#39;&gt;The database runtime connection string&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(connectionString: string, selectOperations: SelectOperations) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;connectionString&#39;&gt;The database runtime connection string&lt;/param&gt;&lt;param name=&#39;selectOperations&#39;&gt;Execute select-clause operations in SQL database rather than .NET-side.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(transactionOptions: Transactions.TransactionOptions, commandTimeout: int) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;transactionOptions&#39;&gt;TransactionOptions for the transaction created on SubmitChanges.&lt;/param&gt;&lt;param name=&#39;commandTimeout&#39;&gt;SQL command timeout. Maximum time for single SQL-command in seconds.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(connectionString: string, commandTimeout: int) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;connectionString&#39;&gt;The database runtime connection string&lt;/param&gt;&lt;param name=&#39;commandTimeout&#39;&gt;SQL command timeout. Maximum time for single SQL-command in seconds.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(connectionString: string, transactionOptions: Transactions.TransactionOptions) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;connectionString&#39;&gt;The database runtime connection string&lt;/param&gt;&lt;param name=&#39;transactionOptions&#39;&gt;TransactionOptions for the transaction created on SubmitChanges.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />SqlDataProvider&lt;...&gt;.GetDataContext(connectionString: string, resolutionPath: string) : SqlDataProvider&lt;...&gt;.dataContext<br /><em>&lt;summary&gt;Returns an instance of the SQL Provider using the static parameters&lt;/summary&gt;&lt;param name=&#39;connectionString&#39;&gt;The database runtime connection string&lt;/param&gt;&lt;param name=&#39;resolutionPath&#39;&gt;The location to look for dynamically loaded assemblies containing database vendor specific connections and custom types. Types used in design-time: If no better clue, prefer .NET Standard 2.0 versions. Semicolon to separate multiple.&lt;/param&gt;</em><br />&#160;&#160;&#160;<em>(+0 other overloads)</em></div>
@@ -655,7 +667,10 @@ <h3><a name="Identifying-columns-dynamically" class="anchor" href="#Identifying-
655667
member Equals: OnConflict * IEqualityComparer -&gt; bool
656668
member IsDoNothing: bool
657669
member IsThrow: bool
658-
member IsUpdate: bool</div>
670+
member IsUpdate: bool<br /><em>&lt;summary&gt;
671+
Specifies how to handle conflicts when inserting records with duplicate primary keys.
672+
Currently supported only on databases that have UPSERT capabilities.
673+
&lt;/summary&gt;</em></div>
659674
<div class="fsdocs-tip" id="fs94">union case Common.OnConflict.Update: Common.OnConflict<br /><em>&lt;summary&gt;
660675
If the primary key already exists, updates the existing row&#39;s columns to match the new entity.
661676
Currently supported only on PostgreSQL 9.5+
@@ -683,8 +698,12 @@ <h3><a name="Identifying-columns-dynamically" class="anchor" href="#Identifying-
683698
<div class="fsdocs-tip" id="fs104">type obj = Object</div>
684699
<div class="fsdocs-tip" id="fs105">val x: obj</div>
685700
<div class="fsdocs-tip" id="fs106">Object.ToString() : string</div>
686-
<div class="fsdocs-tip" id="fs107">union case CanonicalOp.ToUpper: CanonicalOp</div>
687-
<div class="fsdocs-tip" id="fs108">union case CanonicalOp.Replace: SqlItemOrColumn * SqlItemOrColumn -&gt; CanonicalOp</div>
701+
<div class="fsdocs-tip" id="fs107">union case CanonicalOp.ToUpper: CanonicalOp<br /><em>&lt;summary&gt;
702+
Converts string to uppercase
703+
&lt;/summary&gt;</em></div>
704+
<div class="fsdocs-tip" id="fs108">union case CanonicalOp.Replace: SqlItemOrColumn * SqlItemOrColumn -&gt; CanonicalOp<br /><em>&lt;summary&gt;
705+
Replaces occurrences of a substring with another substring
706+
&lt;/summary&gt;</em></div>
688707
<div class="fsdocs-tip" id="fs109">val box: value: &#39;T -&gt; obj</div>
689708
<div class="fsdocs-tip" id="fs110">val bdate: DateTime</div>
690709
<div class="fsdocs-tip" id="fs111">DateTime.Parse(s: string) : DateTime<br />DateTime.Parse(s: string, provider: IFormatProvider) : DateTime<br />DateTime.Parse(s: ReadOnlySpan&lt;char&gt;, provider: IFormatProvider) : DateTime<br />DateTime.Parse(s: string, provider: IFormatProvider, styles: Globalization.DateTimeStyles) : DateTime<br />DateTime.Parse(s: ReadOnlySpan&lt;char&gt;, ?provider: IFormatProvider, ?styles: Globalization.DateTimeStyles) : DateTime</div>

0 commit comments

Comments
 (0)