Class DataStatement

Namespace

Cuemon.Data

Assembly

Cuemon.Data.dll

Represents a Transact-SQL statement or stored procedure to execute against a SQL Server database.

public class DataStatement

Inheritance

object

DataStatement

Examples

DataStatement represents a database command with support for text queries, stored procedures, and parameterized commands. This example creates three different statements: a text query via implicit conversion from "SELECT * FROM Product", a stored procedure "dbo.GetOrdersByDate" with a 120-second timeout configured through an options delegate, and a parameterized UPDATE command with two IDataParameter inputs (@qty and @id). Console output shows each statement's text, CommandType, timeout, parameter count, and parameter names.

using System;
using System.Data;
using System.Linq;
using Cuemon.Data;

namespace MyApp.DataAccess
{
    public sealed class DataStatementExample
    {
        public void Demonstrate()
        {
            DataStatement textStatement = "SELECT * FROM Product";
            Console.WriteLine(textStatement.Text);
            Console.WriteLine(textStatement.Type);

            var storedProcedure = new DataStatement("dbo.GetOrdersByDate", options =>
            {
                options.Type = CommandType.StoredProcedure;
                options.Timeout = TimeSpan.FromSeconds(120);
            });
            Console.WriteLine($"{storedProcedure.Text} ({storedProcedure.Type})");

            var parameterized = new DataStatement("UPDATE Inventory SET Quantity = Quantity - @qty WHERE ProductId = @id", options =>
            {
                options.Parameters = new IDataParameter[]
                {
                    new DemoParameter("@qty", 5),
                    new DemoParameter("@id", 1001)
                };
            });

            Console.WriteLine($"Parameter count: {parameterized.Parameters.Length}");
            Console.WriteLine(string.Join(", ", parameterized.Parameters.Select(parameter => parameter.ParameterName)));
        }

        private sealed class DemoParameter : IDataParameter
        {
            public DemoParameter(string name, object value)
            {
                ParameterName = name;
                Value = value;
            }

            public DbType DbType { get; set; }

            public ParameterDirection Direction { get; set; } = ParameterDirection.Input;

            public bool IsNullable => true;

            public string ParameterName { get; set; }

            public string SourceColumn { get; set; } = string.Empty;

            public DataRowVersion SourceVersion { get; set; } = DataRowVersion.Current;

            public object Value { get; set; }
        }
    }
}

Constructors

DataStatement(string, Action<DataStatementOptions>)

Initializes a new instance of the DataStatement class.

public DataStatement(string text, Action<DataStatementOptions> setup = null)

Parameters

text string

The command text to execute.

setup Action<DataStatementOptions>

The DataStatementOptions which may be configured.

Properties

Parameters

Gets the parameters associated with this data statement.

public IDataParameter[] Parameters { get; }

Property Value

IDataParameter[]

The parameters associated with this data statement.

Text

Gets the command text to execute.

public string Text { get; }

Property Value

string

The command text to execute.

Timeout

Gets the wait time before terminating the attempt to execute a command and generating an error.

public TimeSpan Timeout { get; }

Property Value

TimeSpan

The timespan to wait for the command to execute. Default value is 1 minute and 30 seconds.

Type

Gets the command type value to execute.

public CommandType Type { get; }

Property Value

CommandType

The command type value to execute. Default type value is Text.

Operators

implicit operator DataStatement(string)

Performs an implicit conversion from the specified text to DataStatement.

public static implicit operator DataStatement(string text)

Parameters

text string

The SQL statement or stored procedure to convert.

Returns

DataStatement

A DataStatement that is equivalent to text.