Interface IVenflowCommandBuilder<TEntity>

Represents a generic command builder to create any CRUD command.

Namespace: Venflow.Commands

Assembly: Venflow.dll

Syntax

public interface IVenflowCommandBuilder<TEntity>
    where TEntity : class, new()

Type Parameters

Name	Description
TEntity	The type of the entity which will be used for the command.

Methods

Delete()

Creates a new delete command builder.

Declaration

IDeleteCommandBuilder<TEntity> Delete()

Returns

Type	Description
IDeleteCommandBuilder<TEntity>	A Fluent API Builder for a delete command.

Insert()

Creates a new insert command builder.

Declaration

IBaseInsertRelationBuilder<TEntity, TEntity> Insert()

Returns

Type	Description
IBaseInsertRelationBuilder<TEntity, TEntity>	A Fluent API Builder for a insert command.

QueryBatch(Expression<Func<TEntity, FormattableString>>)

Creates a new query command, which expects a set of primary rows to be returned. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>> QueryBatch(Expression<Func<TEntity, FormattableString>> sql)

Parameters

Type	Name	Description
Expression<Func<TEntity, FormattableString>>	sql	A string containing the SQL statement.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>>	A Fluent API Builder for a query command.

QueryBatch(String)

Creates a new query command builder, which expects a set of primary rows to be returned. This API does not support string interpolation! If you need to pass parameters with the query, either use QuerySingle(String, NpgsqlParameter[]) or QueryInterpolatedSingle(FormattableString).

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>> QueryBatch(string sql)

Parameters

Type	Name	Description
String	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>>	A Fluent API Builder for a query command.

QueryBatch(String, NpgsqlParameter[])

Creates a new query command builder, which expects a set of primary rows to be returned.This API does not support string interpolation! If you want to pass interpolated SQL use QueryInterpolatedSingle(FormattableString).

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>> QueryBatch(string sql, params NpgsqlParameter[] parameters)

Parameters

Type	Name	Description
String	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter.
NpgsqlParameter[]	parameters	A set of which contain parameters for the sql command.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>>	A Fluent API Builder for a query command.

QueryBatch<TOne>(Expression<Func<TEntity, TOne, FormattableString>>)

Creates a new query command, which expects a set of primary rows to be returned. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>> QueryBatch<TOne>(Expression<Func<TEntity, TOne, FormattableString>> sql)
    where TOne : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, FormattableString>>	sql	A string containing the SQL statement.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne

QueryBatch<TOne, TTwo>(Expression<Func<TEntity, TOne, TTwo, FormattableString>>)

Creates a new query command, which expects a set of primary rows to be returned. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>> QueryBatch<TOne, TTwo>(Expression<Func<TEntity, TOne, TTwo, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, FormattableString>>	sql	A string containing the SQL statement.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo

QueryBatch<TOne, TTwo, TThree>(Expression<Func<TEntity, TOne, TTwo, TThree, FormattableString>>)

Creates a new query command, which expects a set of primary rows to be returned. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>> QueryBatch<TOne, TTwo, TThree>(Expression<Func<TEntity, TOne, TTwo, TThree, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()
    where TThree : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, TThree, FormattableString>>	sql	A string containing the SQL statement.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo
TThree

QueryBatch<TOne, TTwo, TThree, TFour>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, FormattableString>>)

Creates a new query command, which expects a set of primary rows to be returned. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>> QueryBatch<TOne, TTwo, TThree, TFour>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()
    where TThree : class, new()
    where TFour : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, TThree, TFour, FormattableString>>	sql	A string containing the SQL statement.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo
TThree
TFour

QueryBatch<TOne, TTwo, TThree, TFour, TFive>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, FormattableString>>)

Creates a new query command, which expects a set of primary rows to be returned. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>> QueryBatch<TOne, TTwo, TThree, TFour, TFive>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()
    where TThree : class, new()
    where TFour : class, new()
    where TFive : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, FormattableString>>	sql	A string containing the SQL statement.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo
TThree
TFour
TFive

QueryBatch<TOne, TTwo, TThree, TFour, TFive, TSix>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, FormattableString>>)

Creates a new query command, which expects a set of primary rows to be returned. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>> QueryBatch<TOne, TTwo, TThree, TFour, TFive, TSix>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()
    where TThree : class, new()
    where TFour : class, new()
    where TFive : class, new()
    where TSix : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, FormattableString>>	sql	A string containing the SQL statement.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo
TThree
TFour
TFive
TSix

QueryBatch<TOne, TTwo, TThree, TFour, TFive, TSix, TSeven>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, FormattableString>>)

Creates a new query command, which expects a set of primary rows to be returned. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>> QueryBatch<TOne, TTwo, TThree, TFour, TFive, TSix, TSeven>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()
    where TThree : class, new()
    where TFour : class, new()
    where TFive : class, new()
    where TSix : class, new()
    where TSeven : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, FormattableString>>	sql	A string containing the SQL statement.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo
TThree
TFour
TFive
TSix
TSeven

QueryBatch<TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, TEight>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, TEight, FormattableString>>)

Creates a new query command, which expects a set of primary rows to be returned. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>> QueryBatch<TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, TEight>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, TEight, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()
    where TThree : class, new()
    where TFour : class, new()
    where TFive : class, new()
    where TSix : class, new()
    where TSeven : class, new()
    where TEight : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, TEight, FormattableString>>	sql	A string containing the SQL statement.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo
TThree
TFour
TFive
TSix
TSeven
TEight

QueryInterpolatedBatch(FormattableString)

Creates a new query command builder, which expects a set of primary rows to be returned. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>> QueryInterpolatedBatch(FormattableString sql)

Parameters

Type	Name	Description
FormattableString	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter. You should only add parameters trough string interpolation.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, List<TEntity>>	A Fluent API Builder for a query command.

QueryInterpolatedSingle(FormattableString)

Creates a new query command builder, which expects a single returned primary row. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, TEntity> QueryInterpolatedSingle(FormattableString sql)

Parameters

Type	Name	Description
FormattableString	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter. You should only add parameters trough string interpolation.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, TEntity>	A Fluent API Builder for a query command.

QuerySingle(Expression<Func<TEntity, FormattableString>>)

Creates a new query command, which expects a single returned primary row. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, TEntity> QuerySingle(Expression<Func<TEntity, FormattableString>> sql)

Parameters

Type	Name	Description
Expression<Func<TEntity, FormattableString>>	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, TEntity>	A Fluent API Builder for a query command.

QuerySingle(String)

Creates a query command with a single result. This API does not support string interpolation! If you need to pass parameters with the query, either use QuerySingle(String, NpgsqlParameter[]) or QueryInterpolatedSingle(FormattableString).

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, TEntity> QuerySingle(string sql)

Parameters

Type	Name	Description
String	sql

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, TEntity>	An object that can be used to further configure the operation.

QuerySingle(String, NpgsqlParameter[])

Creates a new query command builder, which expects a single returned primary row. This API does not support string interpolation! If you want to pass interpolated SQL use QueryInterpolatedSingle(FormattableString).

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, TEntity> QuerySingle(string sql, params NpgsqlParameter[] parameters)

Parameters

Type	Name	Description
String	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter.
NpgsqlParameter[]	parameters	A set of which contain parameters for the sql command.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, TEntity>	A Fluent API Builder for a query command.

QuerySingle<TOne>(Expression<Func<TEntity, TOne, FormattableString>>)

Creates a new query command, which expects a single returned primary row. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, TEntity> QuerySingle<TOne>(Expression<Func<TEntity, TOne, FormattableString>> sql)
    where TOne : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, FormattableString>>	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, TEntity>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne

QuerySingle<TOne, TTwo>(Expression<Func<TEntity, TOne, TTwo, FormattableString>>)

Creates a new query command, which expects a single returned primary row. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, TEntity> QuerySingle<TOne, TTwo>(Expression<Func<TEntity, TOne, TTwo, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, FormattableString>>	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, TEntity>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo

QuerySingle<TOne, TTwo, TThree>(Expression<Func<TEntity, TOne, TTwo, TThree, FormattableString>>)

Creates a new query command, which expects a single returned primary row. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, TEntity> QuerySingle<TOne, TTwo, TThree>(Expression<Func<TEntity, TOne, TTwo, TThree, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()
    where TThree : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, TThree, FormattableString>>	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, TEntity>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo
TThree

QuerySingle<TOne, TTwo, TThree, TFour>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, FormattableString>>)

Creates a new query command, which expects a single returned primary row. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, TEntity> QuerySingle<TOne, TTwo, TThree, TFour>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()
    where TThree : class, new()
    where TFour : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, TThree, TFour, FormattableString>>	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, TEntity>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo
TThree
TFour

QuerySingle<TOne, TTwo, TThree, TFour, TFive>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, FormattableString>>)

Creates a new query command, which expects a single returned primary row. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, TEntity> QuerySingle<TOne, TTwo, TThree, TFour, TFive>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()
    where TThree : class, new()
    where TFour : class, new()
    where TFive : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, FormattableString>>	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, TEntity>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo
TThree
TFour
TFive

QuerySingle<TOne, TTwo, TThree, TFour, TFive, TSix>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, FormattableString>>)

Creates a new query command, which expects a single returned primary row. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, TEntity> QuerySingle<TOne, TTwo, TThree, TFour, TFive, TSix>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()
    where TThree : class, new()
    where TFour : class, new()
    where TFive : class, new()
    where TSix : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, FormattableString>>	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, TEntity>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo
TThree
TFour
TFive
TSix

QuerySingle<TOne, TTwo, TThree, TFour, TFive, TSix, TSeven>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, FormattableString>>)

Creates a new query command, which expects a single returned primary row. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, TEntity> QuerySingle<TOne, TTwo, TThree, TFour, TFive, TSix, TSeven>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()
    where TThree : class, new()
    where TFour : class, new()
    where TFive : class, new()
    where TSix : class, new()
    where TSeven : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, FormattableString>>	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, TEntity>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo
TThree
TFour
TFive
TSix
TSeven

QuerySingle<TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, TEight>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, TEight, FormattableString>>)

Creates a new query command, which expects a single returned primary row. This API does support string interpolation!

Declaration

IBaseQueryRelationBuilder<TEntity, TEntity, TEntity> QuerySingle<TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, TEight>(Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, TEight, FormattableString>> sql)
    where TOne : class, new()
    where TTwo : class, new()
    where TThree : class, new()
    where TFour : class, new()
    where TFive : class, new()
    where TSix : class, new()
    where TSeven : class, new()
    where TEight : class, new()

Parameters

Type	Name	Description
Expression<Func<TEntity, TOne, TTwo, TThree, TFour, TFive, TSix, TSeven, TEight, FormattableString>>	sql	A string containing the SQL statement. Ensure that you do not pass any user manipulated SQL for this parameter.

Returns

Type	Description
IBaseQueryRelationBuilder<TEntity, TEntity, TEntity>	A Fluent API Builder for a query command.

Type Parameters

Name	Description
TOne
TTwo
TThree
TFour
TFive
TSix
TSeven
TEight

Update()

Creates a new update command builder.

Declaration

IUpdateCommandBuilder<TEntity> Update()

Returns

Type	Description
IUpdateCommandBuilder<TEntity>	A Fluent API Builder for a update command.