aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.Synchronization/Local/ILocalDataBase.cs
blob: a435bea97f76c8c5a8d3c137d31b69d889974ab8 (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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
using System;
using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tango.Synchronization.Local
{
    /// <summary>
    /// Represents an SQL data base adapter used by <see cref="LocalDBComparer"/>.
    /// </summary>
    /// <seealso cref="System.IDisposable" />
    public interface ILocalDataBase : IDisposable
    {
        /// <summary>
        /// Gets the database source URL/File.
        /// </summary>
        String Source { get; }

        /// <summary>
        /// Gets the database tables collection.
        /// </summary>
        List<DataTable> Tables { get; }

        /// <summary>
        /// Loads the tables (Must be done before any synchronization).
        /// </summary>
        void LoadTables();

        /// <summary>
        /// Clones a table from another database into this database.
        /// </summary>
        /// <param name="otherDB">The other database.</param>
        /// <param name="otherTable">The other table.</param>
        /// <returns></returns>
        DataTable CloneTableFrom(ILocalDataBase otherDB, DataTable otherTable);

        /// <summary>
        /// Replaces the table data with the data from another table.
        /// </summary>
        /// <param name="otherTable">The other table.</param>
        void ReplaceTableData(ILocalDataBase otherDB, DataTable otherTable);

        /// <summary>
        /// Replaces the table data with the data from another table.
        /// </summary>
        /// <param name="otherTable">The other table.</param>
        String GetReplaceTableDataCommand(ILocalDataBase otherDB, DataTable otherTable);

        /// <summary>
        /// Gets the SQL command for <see cref="CloneTableFrom(ILocalDataBase, DataTable)"/>.
        /// </summary>
        /// <param name="otherDB">The other database.</param>
        /// <param name="otherTable">The other table.</param>
        /// <returns></returns>
        String GetCloneTableFromCommand(ILocalDataBase otherDB, DataTable otherTable);

        /// <summary>
        /// Adds the specified column to the specified table.
        /// </summary>
        /// <param name="table">The table.</param>
        /// <param name="column">The column.</param>
        /// <returns></returns>
        DataColumn AddColumn(DataTable table, DataColumn column);

        /// <summary>
        /// Gets the SQL command for <see cref="AddColumn(DataTable, DataColumn)"/>.
        /// </summary>
        /// <param name="table">The table.</param>
        /// <param name="column">The column.</param>
        /// <returns></returns>
        String GetAddColumnCommand(DataTable table, DataColumn column);

        /// <summary>
        /// Adds the specified row to the specified table.
        /// </summary>
        /// <param name="table">The table.</param>
        /// <param name="row">The row.</param>
        void AddRow(DataTable table, DataRow row);

        /// <summary>
        /// Gets the SQL command for <see cref="AddRow(DataTable, DataRow)"/>.
        /// </summary>
        /// <param name="table">The table.</param>
        /// <param name="row">The row.</param>
        /// <returns></returns>
        String GetAddRowCommand(DataTable table, DataRow row);

        /// <summary>
        /// Updates the matching row by the row GUID.
        /// </summary>
        /// <param name="table">The table.</param>
        /// <param name="row">The row.</param>
        void UpdateRow(DataTable table, DataRow row);

        /// <summary>
        /// Gets the SQL command for <see cref="UpdateRow(DataTable, DataRow)"/>.
        /// </summary>
        /// <param name="table">The table.</param>
        /// <param name="row">The row.</param>
        /// <returns></returns>
        String GetUpdateRowCommand(DataTable table, DataRow row);

        /// <summary>
        /// Clears the data base.
        /// </summary>
        void ClearDataBase();
    }
}