mcs/class/System.Data.Linq/src/DbLinq/Data/Linq/Database/IDatabaseContext.cs

   1 #region MIT license\r
   2 // \r
   3 // MIT license\r
   4 //\r
   5 // Copyright (c) 2007-2008 Jiri Moudry, Pascal Craponne\r
   6 // \r
   7 // Permission is hereby granted, free of charge, to any person obtaining a copy\r
   8 // of this software and associated documentation files (the "Software"), to deal\r
   9 // in the Software without restriction, including without limitation the rights\r
  10 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
  11 // copies of the Software, and to permit persons to whom the Software is\r
  12 // furnished to do so, subject to the following conditions:\r
  13 // \r
  14 // The above copyright notice and this permission notice shall be included in\r
  15 // all copies or substantial portions of the Software.\r
  16 // \r
  17 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  18 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  19 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  20 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  21 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
  22 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
  23 // THE SOFTWARE.\r
  24 // \r
  25 #endregion\r
  26 \r
  27 using System;\r
  28 using System.Data;\r
  29 \r
  30 namespace DbLinq.Data.Linq.Database\r
  31 {\r
  32     /// <summary>\r
  33     /// IDatabaseContext contains all database related information:\r
  34     /// - connection\r
  35     /// - creates or manage a transaction\r
  36     /// </summary>\r
  37 #if !MONO_STRICT\r
  38     public\r
  39 #endif\r
  40     interface IDatabaseContext : IDisposable\r
  41     {\r
  42         // there are two ways to specify a connection:\r
  43         // 1. use a provided IDbConnection\r
  44         /// <summary>\r
  45         /// Gets or sets the connection.\r
  46         /// </summary>\r
  47         /// <value>The connection.</value>\r
  48         IDbConnection Connection { set; get; }\r
  49         // 2. create our own\r
  50         /// <summary>\r
  51         /// Connects with the specified connection string.\r
  52         /// Alters Connection property\r
  53         /// </summary>\r
  54         /// <param name="connectionString">The connection string.</param>\r
  55         void Connect(string connectionString);\r
  56         /// <summary>\r
  57         /// Disconnects this instance.\r
  58         /// </summary>\r
  59         void Disconnect();\r
  60 \r
  61         // connection and transactions\r
  62         /// <summary>\r
  63         /// Creates a transaction.\r
  64         /// </summary>\r
  65         /// <returns></returns>\r
  66         IDbTransaction CreateTransaction();\r
  67 \r
  68         IDbTransaction CurrentTransaction { get; set; }\r
  69 \r
  70         /// <summary>\r
  71         /// Opens a connection.\r
  72         /// </summary>\r
  73         /// <returns></returns>\r
  74         IDisposable OpenConnection();\r
  75 \r
  76         // factory\r
  77         /// <summary>\r
  78         /// Creates a command.\r
  79         /// </summary>\r
  80         /// <returns></returns>\r
  81         IDbCommand CreateCommand();\r
  82         /// <summary>\r
  83         /// Creates a DataAdapter.\r
  84         /// </summary>\r
  85         /// <returns></returns>\r
  86         IDbDataAdapter CreateDataAdapter();\r
  87     }\r
  88 }\r