forked from npgsql/npgsql
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNpgsqlException.cs
More file actions
231 lines (204 loc) · 9.26 KB
/
NpgsqlException.cs
File metadata and controls
231 lines (204 loc) · 9.26 KB
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
#region License
// The PostgreSQL License
//
// Copyright (C) 2015 The Npgsql Development Team
//
// Permission to use, copy, modify, and distribute this software and its
// documentation for any purpose, without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph and the following two paragraphs appear in all copies.
//
// IN NO EVENT SHALL THE NPGSQL DEVELOPMENT TEAM BE LIABLE TO ANY PARTY
// FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
// INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
// DOCUMENTATION, EVEN IF THE NPGSQL DEVELOPMENT TEAM HAS BEEN ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
// THE NPGSQL DEVELOPMENT TEAM SPECIFICALLY DISCLAIMS ANY WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
// ON AN "AS IS" BASIS, AND THE NPGSQL DEVELOPMENT TEAM HAS NO OBLIGATIONS
// TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#endregion
using System;
using System.Collections;
using System.Collections.Generic;
using System.Data.Common;
using System.Diagnostics.Contracts;
using System.Linq;
using System.Reflection;
using Npgsql.BackendMessages;
#if !DNXCORE50
using System.Runtime.Serialization;
#endif
namespace Npgsql
{
/// <summary>
/// The exception that is thrown when the PostgreSQL backend reports errors.
/// Note that other errors (network issues, Npgsql client-side problems) are reported as regular
/// .NET exceptions.
/// </summary>
/// <remarks>
/// See http://www.postgresql.org/docs/current/static/errcodes-appendix.html,
/// http://www.postgresql.org/docs/current/static/protocol-error-fields.html
/// </remarks>
#if !DNXCORE50
[Serializable]
#endif
public sealed class NpgsqlException : DbException
{
readonly ErrorOrNoticeMessage _msg;
Dictionary<string, object> _data;
#region Message Fields
/// <summary>
/// Severity of the error or notice.
/// Always present.
/// </summary>
public string Severity { get { return _msg.Severity; } }
/// <summary>
/// The SQLSTATE code for the error.
/// </summary>
/// <remarks>
/// Always present.
/// See http://www.postgresql.org/docs/current/static/errcodes-appendix.html
/// </remarks>
public string Code { get { return _msg.Code; } }
/// <summary>
/// The primary human-readable error message. This should be accurate but terse.
/// </summary>
/// <remarks>
/// Always present.
/// </remarks>
public string MessageText { get { return _msg.Message; } }
/// <summary>
/// An optional secondary error message carrying more detail about the problem.
/// May run to multiple lines.
/// </summary>
public string Detail { get { return _msg.Detail; } }
/// <summary>
/// An optional suggestion what to do about the problem.
/// This is intended to differ from Detail in that it offers advice (potentially inappropriate) rather than hard facts.
/// May run to multiple lines.
/// </summary>
public string Hint { get { return _msg.Hint; } }
/// <summary>
/// The field value is a decimal ASCII integer, indicating an error cursor position as an index into the original query string.
/// The first character has index 1, and positions are measured in characters not bytes.
/// 0 means not provided.
/// </summary>
public int Position { get { return _msg.Position; } }
/// <summary>
/// This is defined the same as the <see cref="Position"/> field, but it is used when the cursor position refers to an internally generated command rather than the one submitted by the client.
/// The <see cref="InternalQuery" /> field will always appear when this field appears.
/// 0 means not provided.
/// </summary>
public int InternalPosition { get { return _msg.InternalPosition; } }
/// <summary>
/// The text of a failed internally-generated command.
/// This could be, for example, a SQL query issued by a PL/pgSQL function.
/// </summary>
public string InternalQuery { get { return _msg.InternalQuery; } }
/// <summary>
/// An indication of the context in which the error occurred.
/// Presently this includes a call stack traceback of active PL functions.
/// The trace is one entry per line, most recent first.
/// </summary>
public string Where { get { return _msg.Where; } }
/// <summary>
/// If the error was associated with a specific database object, the name of the schema containing that object, if any.
/// </summary>
/// <remarks>PostgreSQL 9.3 and up.</remarks>
public string SchemaName { get { return _msg.SchemaName; } }
/// <summary>
/// Table name: if the error was associated with a specific table, the name of the table.
/// (Refer to the schema name field for the name of the table's schema.)
/// </summary>
/// <remarks>PostgreSQL 9.3 and up.</remarks>
public string TableName { get { return _msg.TableName; } }
/// <summary>
/// If the error was associated with a specific table column, the name of the column.
/// (Refer to the schema and table name fields to identify the table.)
/// </summary>
/// <remarks>PostgreSQL 9.3 and up.</remarks>
public string ColumnName { get { return _msg.ColumnName; } }
/// <summary>
/// If the error was associated with a specific data type, the name of the data type.
/// (Refer to the schema name field for the name of the data type's schema.)
/// </summary>
/// <remarks>PostgreSQL 9.3 and up.</remarks>
public string DataTypeName { get { return _msg.DataTypeName; } }
/// <summary>
/// If the error was associated with a specific constraint, the name of the constraint.
/// Refer to fields listed above for the associated table or domain.
/// (For this purpose, indexes are treated as constraints, even if they weren't created with constraint syntax.)
/// </summary>
/// <remarks>PostgreSQL 9.3 and up.</remarks>
public string ConstraintName { get { return _msg.ConstraintName; } }
/// <summary>
/// The file name of the source-code location where the error was reported.
/// </summary>
/// <remarks>PostgreSQL 9.3 and up.</remarks>
public string File { get { return _msg.File; } }
/// <summary>
/// The line number of the source-code location where the error was reported.
/// </summary>
public string Line { get { return _msg.Line; } }
/// <summary>
/// The name of the source-code routine reporting the error.
/// </summary>
public string Routine { get { return _msg.Routine; } }
/// <summary>
/// Same as <see cref="MessageText"/>, for backwards-compatibility with Npgsql 2.x
/// </summary>
[Obsolete("Use MessageText instead")]
public string BaseMessage { get { return _msg.Message; } }
#endregion
internal NpgsqlException(NpgsqlBuffer buf)
{
_msg = new ErrorOrNoticeMessage(buf);
}
/// <summary>
/// Gets a the PostgreSQL error message and code.
/// </summary>
public override string Message
{
get { return Code + ": " + MessageText; }
}
/// <summary>
/// Gets a collection of key/value pairs that provide additional PostgreSQL fields about the exception.
/// </summary>
public override IDictionary Data
{
get
{
return _data ?? (_data = (
from p in typeof (ErrorOrNoticeMessage).GetProperties(BindingFlags.DeclaredOnly | BindingFlags.NonPublic | BindingFlags.Instance)
let k = p.Name
let v = p.GetValue(_msg)
where p.GetValue(_msg) != null
where (k != "Position" && k != "InternalPosition") || ((int)v) != 0
select new {Key = k, Value = v}
).ToDictionary(kv => kv.Key, kv => kv.Value)
);
}
}
#region Serialization
#if !DNXCORE50
NpgsqlException(SerializationInfo info, StreamingContext context) : base(info, context)
{
_msg = (ErrorOrNoticeMessage)info.GetValue("msg", typeof(ErrorOrNoticeMessage));
}
/// <summary>
/// Populates a <see cref="SerializationInfo"/> with the data needed to serialize the target object.
/// </summary>
/// <param name="info">The <see cref="SerializationInfo"/> to populate with data.</param>
/// <param name="context">The destination (see <see cref="StreamingContext"/>) for this serialization.</param>
public override void GetObjectData(SerializationInfo info, StreamingContext context)
{
base.GetObjectData(info, context);
info.AddValue("msg", _msg);
}
#endif
#endregion
}
}