Add the Test-Object cmdlet

Author: cedx

ChangeLog.md

@@ -10,7 +10,7 @@
 - Added the `CommandBuilder` class.
 - Added the `ColumnInfo.GetValue()` method.
 - Added the `Delete()`, `Exists()` and `Find()` methods to the `ConnectionExtensions` class.
-- Added the `Find-Object` and `Remove-Object` cmdlets.
+- Added the `Find-Object`, `Remove-Object` and `Test-Object` cmdlets.
 - Made the `Mapper.GetTable()` method public.
 
 ## Version [2.0.0](https://github.com/cedx/sql.net/compare/v1.2.0...v2.0.0)

Sql.psd1

@@ -18,6 +18,7 @@
 		"Approve-Transaction"
 		"Close-Connection"
 		"Deny-Transaction"
+		"Find-Object"
 		"Get-First"
 		"Get-Mapper"
 		"Get-Scalar"
@@ -29,6 +30,8 @@
 		"New-Connection"
 		"New-Parameter"
 		"New-Transaction"
+		"Remove-Object"
+		"Test-Object"
 	)
 
 	RequiredAssemblies = @(

src/Sql.Cmdlets/Find-Object.cs

@@ -14,7 +14,7 @@ public class FindObjectCommand: Cmdlet {
 	private static readonly Type[] parameterTypes = [typeof(IDbConnection), typeof(object), typeof(string[]), typeof(CommandOptions)];
 
 	/// <summary>
-	/// The type of object to return.
+	/// The type of object to find.
 	/// </summary>
 	[Parameter(Mandatory = true, Position = 1)]
 	public required Type Class { get; set; }

src/Sql.Cmdlets/Test-Object.cs

@@ -0,0 +1,54 @@
+namespace Belin.Sql.Cmdlets;
+
+using System.Data;
+
+/// <summary>
+/// Checks whether an entity with the specified primary key exists.
+/// </summary>
+[Cmdlet(VerbsDiagnostic.Test, "Object"), OutputType(typeof(bool))]
+public class TestObjectCommand: Cmdlet {
+
+	/// <summary>
+	/// An array of types representing the number, order, and type of the parameters of the underlying method to invoke.
+	/// </summary>
+	private static readonly Type[] parameterTypes = [typeof(IDbConnection), typeof(object), typeof(CommandOptions)];
+
+	/// <summary>
+	/// The type of object to check.
+	/// </summary>
+	[Parameter(Mandatory = true, Position = 1)]
+	public required Type Class { get; set; }
+
+	/// <summary>
+	/// The connection to the data source.
+	/// </summary>
+	[Parameter(Mandatory = true, Position = 0)]
+	public required IDbConnection Connection { get; set; }
+
+	/// <summary>
+	/// The primary key value.
+	/// </summary>
+	[Parameter(Mandatory = true, Position = 2)]
+	public required object Id { get; set; }
+
+	/// <summary>
+	/// The wait time, in seconds, before terminating the attempt to execute the command and generating an error.
+	/// </summary>
+	[Parameter, ValidateRange(ValidateRangeKind.Positive)]
+	public int Timeout { get; set; } = 30;
+
+	/// <summary>
+	/// The transaction to use, if any.
+	/// </summary>
+	[Parameter]
+	public IDbTransaction? Transaction { get; set; }
+
+	/// <summary>
+	/// Performs execution of this command.
+	/// </summary>
+	protected override void ProcessRecord() {
+		var method = typeof(ConnectionExtensions).GetMethod(nameof(ConnectionExtensions.Exists), 1, parameterTypes)!.MakeGenericMethod(Class);
+		var arguments = new object[] { Connection, Id, new CommandOptions { Timeout = Timeout, Transaction = Transaction } };
+		WriteObject(method.Invoke(null, arguments));
+	}
+}

src/Sql/ConnectionExtensions.Async.cs

@@ -84,7 +84,7 @@ public static async Task<IDataReader> ExecuteReaderAsync(this IDbConnection conn
 	}
 
 	/// <summary>
-	/// Returns a value indicating whether an entity with the specified primary key exists.
+	/// Checks whether an entity with the specified primary key exists.
 	/// </summary>
 	/// <param name="connection">The connection to the data source.</param>
 	/// <param name="id">The primary key value.</param>

src/Sql/ConnectionExtensions.Sync.cs

@@ -79,7 +79,7 @@ public static IDataReader ExecuteReader(this IDbConnection connection, string sq
 	}
 
 	/// <summary>
-	/// Returns a value indicating whether an entity with the specified primary key exists.
+	/// Checks whether an entity with the specified primary key exists.
 	/// </summary>
 	/// <param name="connection">The connection to the data source.</param>
 	/// <param name="id">The primary key value.</param>