lib/VNLib.Plugins.Extensions.Data/src/SQL/SqlVariable.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

/*
* Copyright (c) 2022 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Data
* File: SqlVariable.cs 
*
* SqlVariable.cs is part of VNLib.Plugins.Extensions.Data which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Extensions.Data is free software: you can redistribute it and/or modify 
* it under the terms of the GNU Affero General Public License as 
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Extensions.Data is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program.  If not, see https://www.gnu.org/licenses/.
*/

using System;
using System.Data;

namespace VNLib.Plugins.Extensions.Data.SQL
{
    /// <summary>
    /// Property attribute that specifies the property is to be used for a given command variable
    /// </summary>
    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public sealed class SqlVariableAttribute : Attribute
    {
        public string VariableName { get; }
        public DbType DataType { get; }
        public ParameterDirection Direction { get; }
        public int Size { get; }
        public bool IsNullable { get; }
        /// <summary>
        /// Specifies the property to be used as an SQL variable
        /// </summary>
        /// <param name="variableName">Sql statement variable this property will substitute</param>
        /// <param name="dataType">The sql data the property will represent</param>
        /// <param name="direction">Data direction during execution</param>
        /// <param name="size">Column size</param>
        /// <param name="isNullable">Is this property allowed to be null</param>
        public SqlVariableAttribute(string variableName, DbType dataType, ParameterDirection direction, int size, bool isNullable)
        {
            this.VariableName = variableName;
            this.DataType = dataType;
            this.Direction = direction;
            this.Size = size;
            this.IsNullable = isNullable;
        }
    }
}