mirror of
https://github.com/claunia/marechai.git
synced 2025-12-16 19:14:25 +00:00
Add XML documentation.
This commit is contained in:
@@ -27,22 +27,51 @@
|
||||
// ----------------------------------------------------------------------------
|
||||
// Copyright © 2003-2018 Natalia Portillo
|
||||
*******************************************************************************/
|
||||
|
||||
using System.Data;
|
||||
|
||||
namespace Cicm.Database
|
||||
{
|
||||
/// <summary>Interface to database</summary>
|
||||
public interface IDbCore
|
||||
{
|
||||
/// <summary>Database operations</summary>
|
||||
Operations Operations { get; }
|
||||
|
||||
/// <summary>Last inserted row's ID</summary>
|
||||
long LastInsertRowId { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Opens an existing database
|
||||
/// </summary>
|
||||
/// <param name="server">Server</param>
|
||||
/// <param name="user">User</param>
|
||||
/// <param name="database">Database name</param>
|
||||
/// <param name="password">Password</param>
|
||||
/// <param name="port">Port</param>
|
||||
/// <returns><c>true</c> if database opened correctly, <c>false</c> otherwise</returns>
|
||||
bool OpenDb(string server, string user, string database, string password, ushort port);
|
||||
|
||||
/// <summary>
|
||||
/// Closes the database
|
||||
/// </summary>
|
||||
void CloseDb();
|
||||
|
||||
/// <summary>
|
||||
/// Creates a new database
|
||||
/// </summary>
|
||||
/// <param name="server">Server</param>
|
||||
/// <param name="user">User</param>
|
||||
/// <param name="database">Database name</param>
|
||||
/// <param name="password">Password</param>
|
||||
/// <param name="port">Port</param>
|
||||
/// <returns><c>true</c> if database is created correctly, <c>false</c> otherwise</returns>
|
||||
bool CreateDb(string database, string server, string user, string password, ushort port);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a data adapter for the opened database
|
||||
/// </summary>
|
||||
/// <returns>Data adapter</returns>
|
||||
IDbDataAdapter GetNewDataAdapter();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user