Class IDatabaseExtensions

Extensions over IDatabase.

Inheritance

System.Object

IDatabaseExtensions

Namespace: Kros.KORM

Assembly: Kros.KORM.dll

Syntax

public static class IDatabaseExtensions

Methods

AddAsync<TEntity>(IDatabase, TEntity, CancellationToken)

Adds the entity to the database.

Declaration

public static Task AddAsync<TEntity>(this IDatabase database, TEntity entity, CancellationToken cancellationToken = default(CancellationToken))

    where TEntity : class

Parameters

Type	Name	Description
IDatabase	database	IDatabase instance.
TEntity	entity	The entity to add.
System.Threading.CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
TEntity	Entity type.

AddAsync<TEntity>(IDatabase, IEnumerable<TEntity>)

Adds entities to the database.

Declaration

public static Task AddAsync<TEntity>(this IDatabase database, IEnumerable<TEntity> entities)

    where TEntity : class

Parameters

Type	Name	Description
IDatabase	database	IDatabase instance.
System.Collections.Generic.IEnumerable<TEntity>	entities	Entities to add.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
TEntity	Entities type.

BulkAddAsync<TEntity>(IDatabase, IEnumerable<TEntity>)

Adds entities to the database via bulk insert.

Declaration

public static Task BulkAddAsync<TEntity>(this IDatabase database, IEnumerable<TEntity> entities)

    where TEntity : class

Parameters

Type	Name	Description
IDatabase	database	IDatabase instance.
System.Collections.Generic.IEnumerable<TEntity>	entities	Entities to add.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
TEntity	Entities type.

BulkEditAsync<TEntity>(IDatabase, IEnumerable<TEntity>)

Edits entities in the database via bulk update.

Declaration

public static Task BulkEditAsync<TEntity>(this IDatabase database, IEnumerable<TEntity> entities)

    where TEntity : class

Parameters

Type	Name	Description
IDatabase	database	IDatabase instance.
System.Collections.Generic.IEnumerable<TEntity>	entities	Entities to edit.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
TEntity	Entities type.

DeleteAsync<TEntity>(IDatabase, TEntity, CancellationToken)

Deletes the entity from the database.

Declaration

public static Task DeleteAsync<TEntity>(this IDatabase database, TEntity entity, CancellationToken cancellationToken = default(CancellationToken))

    where TEntity : class

Parameters

Type	Name	Description
IDatabase	database	IDatabase instance.
TEntity	entity	The entity to delete.
System.Threading.CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
TEntity	Entity type.

DeleteAsync<TEntity>(IDatabase, RawSqlString, CancellationToken, Object[])

Deletes the TEntity from the database by condition.

Declaration

public static Task DeleteAsync<TEntity>(this IDatabase database, RawSqlString condition, CancellationToken cancellationToken = default(CancellationToken), params object[] parameters)

    where TEntity : class

Parameters

Type	Name	Description
IDatabase	database	IDatabase instance.
RawSqlString	condition	The delete condition.
System.Threading.CancellationToken	cancellationToken	The token to monitor for cancellation requests.
System.Object[]	parameters	Condition parameters.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
TEntity	Entity type.

DeleteAsync<TEntity>(IDatabase, IEnumerable<TEntity>)

Deletes entities from the database.

Declaration

public static Task DeleteAsync<TEntity>(this IDatabase database, IEnumerable<TEntity> entities)

    where TEntity : class

Parameters

Type	Name	Description
IDatabase	database	IDatabase instance.
System.Collections.Generic.IEnumerable<TEntity>	entities	Entities to delete.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
TEntity	Entities type.

DeleteAsync<TEntity>(IDatabase, Expression<Func<TEntity, Boolean>>, CancellationToken)

Deletes the TEntity from the database by condition.

Declaration

public static Task DeleteAsync<TEntity>(this IDatabase database, Expression<Func<TEntity, bool>> condition, CancellationToken cancellationToken = default(CancellationToken))

    where TEntity : class

Parameters

Type	Name	Description
IDatabase	database	IDatabase instance.
System.Linq.Expressions.Expression<System.Func<TEntity, System.Boolean>>	condition	The delete condition.
System.Threading.CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
TEntity	Entity type.

DeleteAsync<TEntity>(IDatabase, Object, CancellationToken)

Deletes the TEntity with id from the database.

Declaration

public static Task DeleteAsync<TEntity>(this IDatabase database, object id, CancellationToken cancellationToken = default(CancellationToken))

    where TEntity : class

Parameters

Type	Name	Description
IDatabase	database	IDatabase instance.
System.Object	id	The entity id to delete.
System.Threading.CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
TEntity	Entity type.

EditAsync<TEntity>(IDatabase, TEntity, CancellationToken)

Edits the entity in the database.

Declaration

public static Task EditAsync<TEntity>(this IDatabase database, TEntity entity, CancellationToken cancellationToken = default(CancellationToken))

    where TEntity : class

Parameters

Type	Name	Description
IDatabase	database	IDatabase instance.
TEntity	entity	The entity to edit.
System.Threading.CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
TEntity	Entity type.

EditAsync<TEntity>(IDatabase, TEntity, CancellationToken, String[])

Edits the entity in the database.

Declaration

public static Task EditAsync<TEntity>(this IDatabase database, TEntity entity, CancellationToken cancellationToken = default(CancellationToken), params string[] columns)

    where TEntity : class

Parameters

Type	Name	Description
IDatabase	database	IDatabase instance.
TEntity	entity	The entity to edit.
System.Threading.CancellationToken	cancellationToken	The token to monitor for cancellation requests.
System.String[]	columns	Columns for editing.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
TEntity	Entity type.

EditAsync<TEntity>(IDatabase, IEnumerable<TEntity>)

Edits entities in the database.

Declaration

public static Task EditAsync<TEntity>(this IDatabase database, IEnumerable<TEntity> entities)

    where TEntity : class

Parameters

Type	Name	Description
IDatabase	database	IDatabase instance.
System.Collections.Generic.IEnumerable<TEntity>	entities	Entities to edit.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
TEntity	Entities type.