forked from npgsql/npgsql
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathPostgresNotice.cs
More file actions
214 lines (185 loc) · 7.7 KB
/
PostgresNotice.cs
File metadata and controls
214 lines (185 loc) · 7.7 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
using System;
using Microsoft.Extensions.Logging;
using Npgsql.BackendMessages;
using Npgsql.Internal;
namespace Npgsql;
/// <summary>
/// PostgreSQL notices are non-critical messages generated by PostgreSQL, either as a result of a user query
/// (e.g. as a warning or informational notice), or due to outside activity (e.g. if the database administrator
/// initiates a "fast" database shutdown).
/// </summary>
/// <remarks>
/// https://www.postgresql.org/docs/current/static/protocol-flow.html#PROTOCOL-ASYNC
/// </remarks>
public sealed class PostgresNotice
{
#region Message Fields
/// <summary>
/// Severity of the error or notice.
/// Always present.
/// </summary>
public string Severity { get; set; }
/// <summary>
/// Severity of the error or notice, not localized.
/// Always present since PostgreSQL 9.6.
/// </summary>
public string InvariantSeverity { get; }
/// <summary>
/// The SQLSTATE code for the error.
/// </summary>
/// <remarks>
/// Always present.
/// See https://www.postgresql.org/docs/current/static/errcodes-appendix.html
/// </remarks>
public string SqlState { get; set; }
/// <summary>
/// The SQLSTATE code for the error.
/// </summary>
/// <remarks>
/// Always present.
/// See https://www.postgresql.org/docs/current/static/errcodes-appendix.html
/// </remarks>
[Obsolete("Use SqlState instead")]
public string Code => SqlState;
/// <summary>
/// The primary human-readable error message. This should be accurate but terse.
/// </summary>
/// <remarks>
/// Always present.
/// </remarks>
public string MessageText { get; set; }
/// <summary>
/// An optional secondary error message carrying more detail about the problem.
/// May run to multiple lines.
/// </summary>
public string? Detail { get; set; }
/// <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; set; }
/// <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; set; }
/// <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; set; }
/// <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; set; }
/// <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; set; }
/// <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; set; }
/// <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; set; }
/// <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; set; }
/// <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; set; }
/// <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; set; }
/// <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; set; }
/// <summary>
/// The line number of the source-code location where the error was reported.
/// </summary>
public string? Line { get; set; }
/// <summary>
/// The name of the source-code routine reporting the error.
/// </summary>
public string? Routine { get; set; }
#endregion
/// <summary>
/// Creates a new instance.
/// </summary>
public PostgresNotice(string severity, string invariantSeverity, string sqlState, string messageText)
: this(messageText, severity, invariantSeverity, sqlState, detail: null) {}
/// <summary>
/// Creates a new instance.
/// </summary>
public PostgresNotice(
string messageText, string severity, string invariantSeverity, string sqlState,
string? detail = null, string? hint = null, int position = 0, int internalPosition = 0,
string? internalQuery = null, string? where = null, string? schemaName = null, string? tableName = null,
string? columnName = null, string? dataTypeName = null, string? constraintName = null, string? file = null,
string? line = null, string? routine = null)
{
MessageText = messageText;
Severity = severity;
InvariantSeverity = invariantSeverity;
SqlState = sqlState;
Detail = detail;
Hint = hint;
Position = position;
InternalPosition = internalPosition;
InternalQuery = internalQuery;
Where = where;
SchemaName = schemaName;
TableName = tableName;
ColumnName = columnName;
DataTypeName = dataTypeName;
ConstraintName = constraintName;
File = file;
Line = line;
Routine = routine;
}
PostgresNotice(ErrorOrNoticeMessage msg)
: this(
msg.Message, msg.Severity, msg.InvariantSeverity, msg.SqlState,
msg.Detail, msg.Hint, msg.Position, msg.InternalPosition, msg.InternalQuery,
msg.Where, msg.SchemaName, msg.TableName, msg.ColumnName, msg.DataTypeName,
msg.ConstraintName, msg.File, msg.Line, msg.Routine) {}
internal static PostgresNotice Load(NpgsqlReadBuffer buf, bool includeDetail, ILogger exceptionLogger)
=> new(ErrorOrNoticeMessage.Load(buf, includeDetail, exceptionLogger));
}
/// <summary>
/// Provides data for a PostgreSQL notice event.
/// </summary>
public sealed class NpgsqlNoticeEventArgs : EventArgs
{
/// <summary>
/// The Notice that was sent from the database.
/// </summary>
public PostgresNotice Notice { get; }
internal NpgsqlNoticeEventArgs(PostgresNotice notice)
{
Notice = notice;
}
}