Skip to content

Commit

Permalink
Update generated documentation for version 1.4.0-alpha3
Browse files Browse the repository at this point in the history
  • Loading branch information
Thorium committed Sep 16, 2024
1 parent 9160cd0 commit 28e3c2e
Show file tree
Hide file tree
Showing 86 changed files with 5,393 additions and 777 deletions.
40 changes: 20 additions & 20 deletions core/async.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions core/composable.html
Original file line number Diff line number Diff line change
Expand Up @@ -484,10 +484,10 @@ <h2><a name="Generate-composable-queries-from-quotations" class="anchor" href="#
inherit IEnumerable
member ElementType: Type
member Expression: Expression
member Provider: IQueryProvider<br /><em>&lt;summary&gt;Provides functionality to evaluate queries against a specific data source wherein the type of the data is not specified.&lt;/summary&gt;</em><br /><br />--------------------<br />type IQueryable&lt;&#39;T&gt; =
member Provider: IQueryProvider<br /><br />--------------------<br />type IQueryable&lt;&#39;T&gt; =
inherit IEnumerable&lt;&#39;T&gt;
inherit IEnumerable
inherit IQueryable<br /><em>&lt;summary&gt;Provides functionality to evaluate queries against a specific data source wherein the type of the data is known.&lt;/summary&gt;<br />&lt;typeparam name=&quot;T&quot;&gt;The type of the data in the data source.&lt;/typeparam&gt;</em></div>
inherit IQueryable</div>
<div class="fsdocs-tip" id="fs34">&#39;T</div>
<div class="fsdocs-tip" id="fs35">val x: obj</div>
<div class="fsdocs-tip" id="fs36">type CustomersEntity = SqlDataProvider&lt;...&gt;.dataContext.main.CustomersEntity</div>
Expand Down
18 changes: 11 additions & 7 deletions core/crud.html
Original file line number Diff line number Diff line change
Expand Up @@ -535,18 +535,18 @@ <h3><a name="What-to-do-if-your-creation-fails-systematically-every-time" class=
<div class="fsdocs-tip" id="fs29">val now: DateTime</div>
<div class="fsdocs-tip" id="fs30">Multiple items<br />[&lt;Struct&gt;]
type DateTime =
new: year: int * month: int * day: int -&gt; unit + 10 overloads
new: date: DateOnly * time: TimeOnly -&gt; unit + 16 overloads
member Add: value: TimeSpan -&gt; DateTime
member AddDays: value: float -&gt; DateTime
member AddHours: value: float -&gt; DateTime
member AddMicroseconds: value: float -&gt; DateTime
member AddMilliseconds: value: float -&gt; DateTime
member AddMinutes: value: float -&gt; DateTime
member AddMonths: months: int -&gt; DateTime
member AddSeconds: value: float -&gt; DateTime
member AddTicks: value: int64 -&gt; DateTime
member AddYears: value: int -&gt; DateTime
...<br /><em>&lt;summary&gt;Represents an instant in time, typically expressed as a date and time of day.&lt;/summary&gt;</em><br /><br />--------------------<br />DateTime ()<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em></div>
<div class="fsdocs-tip" id="fs31">property DateTime.Now: DateTime with get<br /><em>&lt;summary&gt;Gets a &lt;see cref=&quot;T:System.DateTime&quot; /&gt; object that is set to the current date and time on this computer, expressed as the local time.&lt;/summary&gt;<br />&lt;returns&gt;An object whose value is the current local date and time.&lt;/returns&gt;</em></div>
...<br /><br />--------------------<br />DateTime ()<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(date: DateOnly, time: TimeOnly) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(date: DateOnly, time: TimeOnly, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em></div>
<div class="fsdocs-tip" id="fs31">property DateTime.Now: DateTime with get</div>
<div class="fsdocs-tip" id="fs32">val row: SqlDataProvider&lt;...&gt;.dataContext.main.OrdersEntity</div>
<div class="fsdocs-tip" id="fs33">SqlDataProvider&lt;...&gt;.dataContext.mainSchema.main.Orders.Create() : SqlDataProvider&lt;...&gt;.dataContext.main.OrdersEntity<br />SqlDataProvider&lt;...&gt;.dataContext.mainSchema.main.Orders.Create(data: Collections.Generic.IEnumerable&lt;string * obj&gt;) : SqlDataProvider&lt;...&gt;.dataContext.main.OrdersEntity<br /><em>&lt;summary&gt;Item array of database columns:
&lt;/summary&gt;</em></div>
Expand Down Expand Up @@ -649,7 +649,11 @@ <h3><a name="What-to-do-if-your-creation-fails-systematically-every-time" class=
type OnConflict =
| Throw
| Update
| DoNothing</div>
| DoNothing
member Equals: OnConflict * IEqualityComparer -&gt; bool
member IsDoNothing: bool
member IsThrow: bool
member IsUpdate: bool</div>
<div class="fsdocs-tip" id="fs94">union case Common.OnConflict.Update: Common.OnConflict<br /><em>&lt;summary&gt;
If the primary key already exists, updates the existing row&#39;s columns to match the new entity.
Currently supported only on PostgreSQL 9.5+
Expand Down Expand Up @@ -679,9 +683,9 @@ <h3><a name="What-to-do-if-your-creation-fails-systematically-every-time" class=
<div class="fsdocs-tip" id="fs106">union case CanonicalOp.Replace: SqlItemOrColumn * SqlItemOrColumn -&gt; CanonicalOp</div>
<div class="fsdocs-tip" id="fs107">val box: value: &#39;T -&gt; obj</div>
<div class="fsdocs-tip" id="fs108">val bdate: DateTime</div>
<div class="fsdocs-tip" id="fs109">DateTime.Parse(s: string) : DateTime<br />DateTime.Parse(s: string, 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>
<div class="fsdocs-tip" id="fs109">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>
<div class="fsdocs-tip" id="fs110">DateTime.AddYears(value: int) : DateTime</div>
<div class="fsdocs-tip" id="fs111">property DateTime.UtcNow: DateTime with get<br /><em>&lt;summary&gt;Gets a &lt;see cref=&quot;T:System.DateTime&quot; /&gt; object that is set to the current date and time on this computer, expressed as the Coordinated Universal Time (UTC).&lt;/summary&gt;<br />&lt;returns&gt;An object whose value is the current UTC date and time.&lt;/returns&gt;</em></div>
<div class="fsdocs-tip" id="fs111">property DateTime.UtcNow: DateTime with get</div>
<div class="fsdocs-tip" id="fs112">val failwith: message: string -&gt; &#39;T</div>
<div class="fsdocs-tip" id="fs113">DateTime.ToString() : string<br />DateTime.ToString(format: string) : string<br />DateTime.ToString(provider: IFormatProvider) : string<br />DateTime.ToString(format: string, provider: IFormatProvider) : string</div>
<div class="fsdocs-tip" id="fs114">val others: string * obj</div>
Expand Down
6 changes: 3 additions & 3 deletions core/mappers.html
Original file line number Diff line number Diff line change
Expand Up @@ -370,17 +370,17 @@ <h2><a name="Adding-a-Mapper-using-dataContext-to-use-generated-types-from-db" c
<div class="fsdocs-tip" id="fs19">Multiple items<br />val string: value: &#39;T -&gt; string<br /><br />--------------------<br />type string = String</div>
<div class="fsdocs-tip" id="fs20">Multiple items<br />[&lt;Struct&gt;]
type DateTime =
new: year: int * month: int * day: int -&gt; unit + 10 overloads
new: date: DateOnly * time: TimeOnly -&gt; unit + 16 overloads
member Add: value: TimeSpan -&gt; DateTime
member AddDays: value: float -&gt; DateTime
member AddHours: value: float -&gt; DateTime
member AddMicroseconds: value: float -&gt; DateTime
member AddMilliseconds: value: float -&gt; DateTime
member AddMinutes: value: float -&gt; DateTime
member AddMonths: months: int -&gt; DateTime
member AddSeconds: value: float -&gt; DateTime
member AddTicks: value: int64 -&gt; DateTime
member AddYears: value: int -&gt; DateTime
...<br /><em>&lt;summary&gt;Represents an instant in time, typically expressed as a date and time of day.&lt;/summary&gt;</em><br /><br />--------------------<br />DateTime ()<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em></div>
...<br /><br />--------------------<br />DateTime ()<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(date: DateOnly, time: TimeOnly) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(date: DateOnly, time: TimeOnly, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em></div>
<div class="fsdocs-tip" id="fs21">val mapEmployee: dbRecord: SqlDataProvider&lt;...&gt;.dataContext.main.EmployeesEntity -&gt; Employee</div>
<div class="fsdocs-tip" id="fs22">val dbRecord: SqlDataProvider&lt;...&gt;.dataContext.main.EmployeesEntity</div>
<div class="fsdocs-tip" id="fs23">type dataContext =
Expand Down
22 changes: 11 additions & 11 deletions core/mysql.html
Original file line number Diff line number Diff line change
Expand Up @@ -450,34 +450,34 @@ <h3><a name="Example-performance-difference-from-our-unit-tests" class="anchor"
<div class="fsdocs-tip" id="fs34">val myGuid: Guid</div>
<div class="fsdocs-tip" id="fs35">Multiple items<br />[&lt;Struct&gt;]
type Guid =
new: b: byte array -&gt; unit + 5 overloads
new: b: byte array -&gt; unit + 6 overloads
member CompareTo: value: Guid -&gt; int + 1 overload
member Equals: g: Guid -&gt; bool + 1 overload
member GetHashCode: unit -&gt; int
member ToByteArray: unit -&gt; byte array
member ToByteArray: unit -&gt; byte array + 1 overload
member ToString: unit -&gt; string + 2 overloads
member TryFormat: destination: Span&lt;char&gt; * charsWritten: byref&lt;int&gt; * ?format: ReadOnlySpan&lt;char&gt; -&gt; bool
member TryWriteBytes: destination: Span&lt;byte&gt; -&gt; bool
static member (&lt;&gt;) : a: Guid * b: Guid -&gt; bool
static member (=) : a: Guid * b: Guid -&gt; bool
...<br /><em>&lt;summary&gt;Represents a globally unique identifier (GUID).&lt;/summary&gt;</em><br /><br />--------------------<br />Guid ()<br />Guid(b: byte array) : Guid<br />Guid(b: ReadOnlySpan&lt;byte&gt;) : Guid<br />Guid(g: string) : Guid<br />Guid(a: int, b: int16, c: int16, d: byte array) : Guid<br />Guid(a: int, b: int16, c: int16, d: byte, e: byte, f: byte, g: byte, h: byte, i: byte, j: byte, k: byte) : Guid<br />Guid(a: uint32, b: uint16, c: uint16, d: byte, e: byte, f: byte, g: byte, h: byte, i: byte, j: byte, k: byte) : Guid</div>
member TryFormat: utf8Destination: Span&lt;byte&gt; * bytesWritten: byref&lt;int&gt; * ?format: ReadOnlySpan&lt;char&gt; -&gt; bool + 1 overload
member TryWriteBytes: destination: Span&lt;byte&gt; -&gt; bool + 1 overload
static member (&lt;) : left: Guid * right: Guid -&gt; bool
static member (&lt;=) : left: Guid * right: Guid -&gt; bool
...<br /><br />--------------------<br />Guid ()<br />Guid(b: byte array) : Guid<br />Guid(b: ReadOnlySpan&lt;byte&gt;) : Guid<br />Guid(g: string) : Guid<br />Guid(b: ReadOnlySpan&lt;byte&gt;, bigEndian: bool) : Guid<br />Guid(a: int, b: int16, c: int16, d: byte array) : Guid<br />Guid(a: int, b: int16, c: int16, d: byte, e: byte, f: byte, g: byte, h: byte, i: byte, j: byte, k: byte) : Guid<br />Guid(a: uint32, b: uint16, c: uint16, d: byte, e: byte, f: byte, g: byte, h: byte, i: byte, j: byte, k: byte) : Guid</div>
<div class="fsdocs-tip" id="fs36">Guid.NewGuid() : Guid</div>
<div class="fsdocs-tip" id="fs37">val myGuidAsString: string</div>
<div class="fsdocs-tip" id="fs38">Guid.ToString() : string<br />Guid.ToString(format: string) : string<br />Guid.ToString(format: string, provider: IFormatProvider) : string</div>
<div class="fsdocs-tip" id="fs39">Multiple items<br />[&lt;Struct&gt;]
type DateTime =
new: year: int * month: int * day: int -&gt; unit + 10 overloads
new: date: DateOnly * time: TimeOnly -&gt; unit + 16 overloads
member Add: value: TimeSpan -&gt; DateTime
member AddDays: value: float -&gt; DateTime
member AddHours: value: float -&gt; DateTime
member AddMicroseconds: value: float -&gt; DateTime
member AddMilliseconds: value: float -&gt; DateTime
member AddMinutes: value: float -&gt; DateTime
member AddMonths: months: int -&gt; DateTime
member AddSeconds: value: float -&gt; DateTime
member AddTicks: value: int64 -&gt; DateTime
member AddYears: value: int -&gt; DateTime
...<br /><em>&lt;summary&gt;Represents an instant in time, typically expressed as a date and time of day.&lt;/summary&gt;</em><br /><br />--------------------<br />DateTime ()<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em></div>
<div class="fsdocs-tip" id="fs40">property DateTime.UtcNow: DateTime with get<br /><em>&lt;summary&gt;Gets a &lt;see cref=&quot;T:System.DateTime&quot; /&gt; object that is set to the current date and time on this computer, expressed as the Coordinated Universal Time (UTC).&lt;/summary&gt;<br />&lt;returns&gt;An object whose value is the current UTC date and time.&lt;/returns&gt;</em></div>
...<br /><br />--------------------<br />DateTime ()<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(date: DateOnly, time: TimeOnly) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(date: DateOnly, time: TimeOnly, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em></div>
<div class="fsdocs-tip" id="fs40">property DateTime.UtcNow: DateTime with get</div>
<div class="fsdocs-tip" id="fs41">DateTime.ToString() : string<br />DateTime.ToString(format: string) : string<br />DateTime.ToString(provider: IFormatProvider) : string<br />DateTime.ToString(format: string, provider: IFormatProvider) : string</div>
<div class="fsdocs-tip" id="fs42">val box: value: &#39;T -&gt; obj</div>
<div class="fsdocs-tip" id="fs43">val longAgo: obj</div>
Expand Down
1 change: 1 addition & 0 deletions core/odbc.html
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,7 @@ <h3><a name="DTC-Transactions" class="anchor" href="#DTC-Transactions">DTC Trans
Timeout: TimeSpan
IsolationLevel: IsolationLevel
}
member Equals: TransactionOptions * IEqualityComparer -&gt; bool
static member Default: TransactionOptions<br /><em>&lt;summary&gt;
Corresponds to the System.Transactions.TransactionOptions.
&lt;/summary&gt;</em></div>
Expand Down
Loading

0 comments on commit 28e3c2e

Please sign in to comment.