aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommand.cs
blob: 99d0f1878a8af158d961b20ccf83c0977ef0aeaa (plain)
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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tango.FSE.Common.SQL
{
    /// <summary>
    /// Represents a SQL command that can be executed by a <see cref="IRemoteSqlProvider"/>.
    /// </summary>
    /// <example>
    /// <para>
    /// <i>
    /// The following example demonstrates how to set the connected machine's demo state and query for the connected machine's jobs.
    /// </i>
    /// </para>
    /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Sql/Program.cs" title="Remote SQL" region="Example" />
    /// </example>
    public class RemoteSqlCommand
    {
        /// <summary>
        /// Gets or sets the command execution mode.
        /// </summary>
        public RemoteSqlCommandMode Mode { get; set; }

        /// <summary>
        /// Gets or sets the SQL query.
        /// </summary>
        public String SQL { get; set; }

        /// <summary>
        /// Gets or sets the command timeout.
        /// </summary>
        public int Timeout { get; set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="RemoteSqlCommand"/> class.
        /// </summary>
        public RemoteSqlCommand()
        {
            Timeout = 30;
        }
    }
}