2009-07-11 Michael Barker <mike@middlesoft.co.uk>
[mono.git] / mcs / class / System.Data.Linq / src / DbLinq / Vendor / ISchemaLoader.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 using System.Collections.Generic;\r
27 using System.Data;\r
28 using System.IO;\r
29 using DbLinq.Schema;\r
30 using DbLinq.Schema.Dbml;\r
31 \r
32 namespace DbLinq.Vendor\r
33 {\r
34 #if !MONO_STRICT\r
35     public\r
36 #endif\r
37     interface ISchemaLoader\r
38     {\r
39         /// <summary>\r
40         /// Underlying vendor\r
41         /// </summary>\r
42         IVendor Vendor { get; }\r
43         /// <summary>\r
44         /// Vendor typed DataContext type\r
45         /// </summary>\r
46         System.Type DataContextType { get; }\r
47         /// <summary>\r
48         /// Connection used to read schema\r
49         /// </summary>\r
50         IDbConnection Connection { get; set; }\r
51 \r
52         /// <summary>\r
53         /// Log output\r
54         /// </summary>\r
55         TextWriter Log { get; set; }\r
56 \r
57         /// <summary>\r
58         /// Loads database schema\r
59         /// </summary>\r
60         /// <param name="databaseName"></param>\r
61         /// <param name="nameAliases"></param>\r
62         /// <param name="nameFormat"></param>\r
63         /// <param name="loadStoredProcedures"></param>\r
64         /// <param name="contextNamespace"></param>\r
65         /// <param name="entityNamespace"></param>\r
66         /// <returns></returns>\r
67         Database Load(string databaseName, INameAliases nameAliases, NameFormat nameFormat,\r
68             bool loadStoredProcedures, string contextNamespace, string entityNamespace);\r
69 \r
70         /// <summary>\r
71         /// Checks all names in DBML schema, \r
72         /// and enquotes the ones where a casing problem could occur\r
73         /// </summary>\r
74         /// <param name="schema"></param>\r
75         void CheckNamesSafety(Database schema);\r
76     }\r
77 }\r