Name: QueryBuilder (FSharp.Core) | FSharp.Core
Rating: 4.5 (9861 reviews)

QueryBuilder Type

Namespace: FSharp.Linq
Assembly: FSharp.Core.dll
Base Type: obj

The type used to support the F# query syntax. Use 'query { ... }' to use the query syntax. See also F# Query Expressions in the F# Language Guide.

Constructors

Constructor	Description
`QueryBuilder()` Full Usage: `QueryBuilder()` Returns: `QueryBuilder`	Create an instance of this builder. Use 'query { ... }' to use the query syntax. Returns: `QueryBuilder`

Instance members

Instance member	Description
`all predicate` Full Usage: `all predicate` Parameters: predicate : `'T -> bool` Returns: `bool`	A query operator that determines whether all elements selected so far satisfies a condition. predicate : `'T -> bool` Returns: `bool`
`averageBy projection` Full Usage: `averageBy projection` Parameters: projection : `'T -> ^Value` Returns: `^Value` Modifiers: inline Type parameters: 'T, 'Q, ^Value	A query operator that selects a value for each element selected so far and returns the average of these values. projection : `'T -> ^Value` Returns: `^Value`
`averageByNullable projection` Full Usage: `averageByNullable projection` Parameters: projection : `'T -> Nullable<^Value>` Returns: `Nullable<^Value>` Modifiers: inline Type parameters: 'T, 'Q, ^Value	A query operator that selects a nullable value for each element selected so far and returns the average of these values. If any nullable does not have a value, it is ignored. projection : `'T -> Nullable<^Value>` Returns: `Nullable<^Value>`
`contains key` Full Usage: `contains key` Parameters: key : `'T` Returns: `bool`	A query operator that determines whether the selected elements contains a specified element. key : `'T` Returns: `bool`
`count` Full Usage: `count` Returns: `int`	A query operator that returns the number of selected elements. Returns: `int`
`distinct` Full Usage: `distinct` Returns: `QuerySource<'T, 'Q>`	A query operator that selects distinct elements from the elements selected so far. Returns: `QuerySource<'T, 'Q>`
`exactlyOne` Full Usage: `exactlyOne` Returns: `'T`	A query operator that selects the single, specific element selected so far Returns: `'T`
`exactlyOneOrDefault` Full Usage: `exactlyOneOrDefault` Returns: `'T`	A query operator that selects the single, specific element of those selected so far, or a default value if that element is not found. Returns: `'T`
`exists predicate` Full Usage: `exists predicate` Parameters: predicate : `'T -> bool` Returns: `bool`	A query operator that determines whether any element selected so far satisfies a condition. predicate : `'T -> bool` Returns: `bool`
`find predicate` Full Usage: `find predicate` Parameters: predicate : `'T -> bool` Returns: `'T`	A query operator that selects the first element selected so far that satisfies a specified condition. predicate : `'T -> bool` Returns: `'T`
`this.For` Full Usage: `this.For` Parameters: source : `QuerySource<'T, 'Q>` body : `'T -> QuerySource<'Result, 'Q2>` Returns: `QuerySource<'Result, 'Q>`	A method used to support the F# query syntax. Projects each element of a sequence to another sequence and combines the resulting sequences into one sequence. source : `QuerySource<'T, 'Q>` body : `'T -> QuerySource<'Result, 'Q2>` Returns: `QuerySource<'Result, 'Q>`
`groupBy keySelector` Full Usage: `groupBy keySelector` Parameters: keySelector : `'T -> 'Key` Returns: `QuerySource<IGrouping<'Key, 'T>, 'Q>`	A query operator that groups the elements selected so far according to a specified key selector. keySelector : `'T -> 'Key` Returns: `QuerySource<IGrouping<'Key, 'T>, 'Q>`
`groupJoin innerSource outerKeySelector innerKeySelector resultSelector` Full Usage: `groupJoin innerSource outerKeySelector innerKeySelector resultSelector` Parameters: innerSource : `QuerySource<'Inner, 'Q>` outerKeySelector : `'Outer -> 'Key` innerKeySelector : `'Inner -> 'Key` resultSelector : `'Outer -> 'Inner seq -> 'Result` Returns: `QuerySource<'Result, 'Q>`	A query operator that correlates two sets of selected values based on matching keys and groups the results. Normal usage is 'groupJoin y in elements2 on (key1 = key2) into group'. innerSource : `QuerySource<'Inner, 'Q>` outerKeySelector : `'Outer -> 'Key` innerKeySelector : `'Inner -> 'Key` resultSelector : `'Outer -> 'Inner seq -> 'Result` Returns: `QuerySource<'Result, 'Q>`
`groupValBy resultSelector keySelector` Full Usage: `groupValBy resultSelector keySelector` Parameters: resultSelector : `'T -> 'Value` keySelector : `'T -> 'Key` Returns: `QuerySource<IGrouping<'Key, 'Value>, 'Q>`	A query operator that selects a value for each element selected so far and groups the elements by the given key. resultSelector : `'T -> 'Value` keySelector : `'T -> 'Key` Returns: `QuerySource<IGrouping<'Key, 'Value>, 'Q>`
`head` Full Usage: `head` Returns: `'T`	A query operator that selects the first element from those selected so far. Returns: `'T`
`headOrDefault` Full Usage: `headOrDefault` Returns: `'T`	A query operator that selects the first element of those selected so far, or a default value if the sequence contains no elements. Returns: `'T`
`join innerSource outerKeySelector innerKeySelector resultSelector` Full Usage: `join innerSource outerKeySelector innerKeySelector resultSelector` Parameters: innerSource : `QuerySource<'Inner, 'Q>` outerKeySelector : `'Outer -> 'Key` innerKeySelector : `'Inner -> 'Key` resultSelector : `'Outer -> 'Inner -> 'Result` Returns: `QuerySource<'Result, 'Q>`	A query operator that correlates two sets of selected values based on matching keys. Normal usage is 'join y in elements2 on (key1 = key2)'. innerSource : `QuerySource<'Inner, 'Q>` outerKeySelector : `'Outer -> 'Key` innerKeySelector : `'Inner -> 'Key` resultSelector : `'Outer -> 'Inner -> 'Result` Returns: `QuerySource<'Result, 'Q>`
`last` Full Usage: `last` Returns: `'T`	A query operator that selects the last element of those selected so far. Returns: `'T`
`lastOrDefault` Full Usage: `lastOrDefault` Returns: `'T`	A query operator that selects the last element of those selected so far, or a default value if no element is found. Returns: `'T`
`leftOuterJoin innerSource outerKeySelector innerKeySelector resultSelector` Full Usage: `leftOuterJoin innerSource outerKeySelector innerKeySelector resultSelector` Parameters: innerSource : `QuerySource<'Inner, 'Q>` outerKeySelector : `'Outer -> 'Key` innerKeySelector : `'Inner -> 'Key` resultSelector : `'Outer -> 'Inner seq -> 'Result` Returns: `QuerySource<'Result, 'Q>`	A query operator that correlates two sets of selected values based on matching keys and groups the results. If any group is empty, a group with a single default value is used instead. Normal usage is 'leftOuterJoin y in elements2 on (key1 = key2) into group'. innerSource : `QuerySource<'Inner, 'Q>` outerKeySelector : `'Outer -> 'Key` innerKeySelector : `'Inner -> 'Key` resultSelector : `'Outer -> 'Inner seq -> 'Result` Returns: `QuerySource<'Result, 'Q>`
`maxBy valueSelector` Full Usage: `maxBy valueSelector` Parameters: valueSelector : `'T -> 'Value` Returns: `'Value`	A query operator that selects a value for each element selected so far and returns the maximum resulting value. valueSelector : `'T -> 'Value` Returns: `'Value`
`maxByNullable valueSelector` Full Usage: `maxByNullable valueSelector` Parameters: valueSelector : `'T -> Nullable<'Value>` Returns: `Nullable<'Value>`	A query operator that selects a nullable value for each element selected so far and returns the maximum of these values. If any nullable does not have a value, it is ignored. valueSelector : `'T -> Nullable<'Value>` Returns: `Nullable<'Value>`
`minBy valueSelector` Full Usage: `minBy valueSelector` Parameters: valueSelector : `'T -> 'Value` Returns: `'Value`	A query operator that selects a value for each element selected so far and returns the minimum resulting value. valueSelector : `'T -> 'Value` Returns: `'Value`
`minByNullable valueSelector` Full Usage: `minByNullable valueSelector` Parameters: valueSelector : `'T -> Nullable<'Value>` Returns: `Nullable<'Value>`	A query operator that selects a nullable value for each element selected so far and returns the minimum of these values. If any nullable does not have a value, it is ignored. valueSelector : `'T -> Nullable<'Value>` Returns: `Nullable<'Value>`
`nth index` Full Usage: `nth index` Parameters: index : `int` Returns: `'T`	A query operator that selects the element at a specified index amongst those selected so far. index : `int` Returns: `'T`
`this.Quote` Full Usage: `this.Quote` Parameters: arg0 : `Expr<'T>` Returns: `Expr<'T>`	A method used to support the F# query syntax. Indicates that the query should be passed as a quotation to the Run method. arg0 : `Expr<'T>` Returns: `Expr<'T>`
`this.Run` Full Usage: `this.Run` Parameters: arg0 : `Expr<QuerySource<'T, IQueryable>>` Returns: `IQueryable<'T>`	A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IQueryable rules. arg0 : `Expr<QuerySource<'T, IQueryable>>` Returns: `IQueryable<'T>`
`select projection` Full Usage: `select projection` Parameters: projection : `'T -> 'Result` Returns: `QuerySource<'Result, 'Q>`	A query operator that projects each of the elements selected so far. projection : `'T -> 'Result` Returns: `QuerySource<'Result, 'Q>`
`skip count` Full Usage: `skip count` Parameters: count : `int` Returns: `QuerySource<'T, 'Q>`	A query operator that bypasses a specified number of the elements selected so far and selects the remaining elements. count : `int` Returns: `QuerySource<'T, 'Q>`
`skipWhile predicate` Full Usage: `skipWhile predicate` Parameters: predicate : `'T -> bool` Returns: `QuerySource<'T, 'Q>`	A query operator that bypasses elements in a sequence as long as a specified condition is true and then selects the remaining elements. predicate : `'T -> bool` Returns: `QuerySource<'T, 'Q>`
`sortBy keySelector` Full Usage: `sortBy keySelector` Parameters: keySelector : `'T -> 'Key` Returns: `QuerySource<'T, 'Q>`	A query operator that sorts the elements selected so far in ascending order by the given sorting key. keySelector : `'T -> 'Key` Returns: `QuerySource<'T, 'Q>`
`sortByDescending keySelector` Full Usage: `sortByDescending keySelector` Parameters: keySelector : `'T -> 'Key` Returns: `QuerySource<'T, 'Q>`	A query operator that sorts the elements selected so far in descending order by the given sorting key. keySelector : `'T -> 'Key` Returns: `QuerySource<'T, 'Q>`
`sortByNullable keySelector` Full Usage: `sortByNullable keySelector` Parameters: keySelector : `'T -> Nullable<'Key>` Returns: `QuerySource<'T, 'Q>`	A query operator that sorts the elements selected so far in ascending order by the given nullable sorting key. keySelector : `'T -> Nullable<'Key>` Returns: `QuerySource<'T, 'Q>`
`sortByNullableDescending keySelector` Full Usage: `sortByNullableDescending keySelector` Parameters: keySelector : `'T -> Nullable<'Key>` Returns: `QuerySource<'T, 'Q>`	A query operator that sorts the elements selected so far in descending order by the given nullable sorting key. keySelector : `'T -> Nullable<'Key>` Returns: `QuerySource<'T, 'Q>`
`this.Source` Full Usage: `this.Source` Parameters: source : `IEnumerable<'T>` Returns: `QuerySource<'T, IEnumerable>`	A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. source : `IEnumerable<'T>` Returns: `QuerySource<'T, IEnumerable>`
`this.Source` Full Usage: `this.Source` Parameters: source : `IQueryable<'T>` Returns: `QuerySource<'T, 'Q>`	A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. source : `IQueryable<'T>` Returns: `QuerySource<'T, 'Q>`
`sumBy projection` Full Usage: `sumBy projection` Parameters: projection : `'T -> ^Value` Returns: `^Value` Modifiers: inline Type parameters: 'T, 'Q, ^Value	A query operator that selects a value for each element selected so far and returns the sum of these values. projection : `'T -> ^Value` Returns: `^Value`
`sumByNullable valueSelector` Full Usage: `sumByNullable valueSelector` Parameters: valueSelector : `'T -> Nullable<^Value>` Returns: `Nullable<^Value>` Modifiers: inline Type parameters: 'T, 'Q, ^Value	A query operator that selects a nullable value for each element selected so far and returns the sum of these values. If any nullable does not have a value, it is ignored. valueSelector : `'T -> Nullable<^Value>` Returns: `Nullable<^Value>`
`take count` Full Usage: `take count` Parameters: count : `int` Returns: `QuerySource<'T, 'Q>`	A query operator that selects a specified number of contiguous elements from those selected so far. count : `int` Returns: `QuerySource<'T, 'Q>`
`takeWhile predicate` Full Usage: `takeWhile predicate` Parameters: predicate : `'T -> bool` Returns: `QuerySource<'T, 'Q>`	A query operator that selects elements from a sequence as long as a specified condition is true, and then skips the remaining elements. predicate : `'T -> bool` Returns: `QuerySource<'T, 'Q>`
`thenBy keySelector` Full Usage: `thenBy keySelector` Parameters: keySelector : `'T -> 'Key` Returns: `QuerySource<'T, 'Q>`	A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given sorting key. This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. keySelector : `'T -> 'Key` Returns: `QuerySource<'T, 'Q>`
`thenByDescending keySelector` Full Usage: `thenByDescending keySelector` Parameters: keySelector : `'T -> 'Key` Returns: `QuerySource<'T, 'Q>`	A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given sorting key. This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. keySelector : `'T -> 'Key` Returns: `QuerySource<'T, 'Q>`
`thenByNullable keySelector` Full Usage: `thenByNullable keySelector` Parameters: keySelector : `'T -> Nullable<'Key>` Returns: `QuerySource<'T, 'Q>`	A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given nullable sorting key. This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. keySelector : `'T -> Nullable<'Key>` Returns: `QuerySource<'T, 'Q>`
`thenByNullableDescending keySelector` Full Usage: `thenByNullableDescending keySelector` Parameters: keySelector : `'T -> Nullable<'Key>` Returns: `QuerySource<'T, 'Q>`	A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given nullable sorting key. This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. keySelector : `'T -> Nullable<'Key>` Returns: `QuerySource<'T, 'Q>`
`where predicate` Full Usage: `where predicate` Parameters: predicate : `'T -> bool` Returns: `QuerySource<'T, 'Q>`	A query operator that selects those elements based on a specified predicate. predicate : `'T -> bool` Returns: `QuerySource<'T, 'Q>`
`this.Yield` Full Usage: `this.Yield` Parameters: value : `'T` Returns: `QuerySource<'T, 'Q>`	A method used to support the F# query syntax. Returns a sequence of length one that contains the specified value. value : `'T` Returns: `QuerySource<'T, 'Q>`
`this.YieldFrom` Full Usage: `this.YieldFrom` Parameters: computation : `QuerySource<'T, 'Q>` Returns: `QuerySource<'T, 'Q>`	A method used to support the F# query syntax. Returns a sequence that contains the specified values. computation : `QuerySource<'T, 'Q>` Returns: `QuerySource<'T, 'Q>`
`this.Zero` Full Usage: `this.Zero` Returns: `QuerySource<'T, 'Q>`	A method used to support the F# query syntax. Returns an empty sequence that has the specified type argument. Returns: `QuerySource<'T, 'Q>`