Go to most recent revision | Details | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
2464 | - | 1 | <?xml version="1.0"?> |
2 | <doc> |
||
3 | <assembly> |
||
4 | <name>System.Data.SQLite</name> |
||
5 | </assembly> |
||
6 | <members> |
||
7 | <member name="T:System.Data.SQLite.SQLiteLogCallback"> |
||
8 | <summary> |
||
9 | This is the method signature for the SQLite core library logging callback |
||
10 | function for use with sqlite3_log() and the SQLITE_CONFIG_LOG. |
||
11 | |||
12 | WARNING: This delegate is used more-or-less directly by native code, do |
||
13 | not modify its type signature. |
||
14 | </summary> |
||
15 | <param name="pUserData"> |
||
16 | The extra data associated with this message, if any. |
||
17 | </param> |
||
18 | <param name="errorCode"> |
||
19 | The error code associated with this message. |
||
20 | </param> |
||
21 | <param name="pMessage"> |
||
22 | The message string to be logged. |
||
23 | </param> |
||
24 | </member> |
||
25 | <member name="T:System.Data.SQLite.SQLite3"> |
||
26 | <summary> |
||
27 | This class implements SQLiteBase completely, and is the guts of the code that interop's SQLite with .NET |
||
28 | </summary> |
||
29 | </member> |
||
30 | <member name="T:System.Data.SQLite.SQLiteBase"> |
||
31 | <summary> |
||
32 | This internal class provides the foundation of SQLite support. It defines all the abstract members needed to implement |
||
33 | a SQLite data provider, and inherits from SQLiteConvert which allows for simple translations of string to and from SQLite. |
||
34 | </summary> |
||
35 | </member> |
||
36 | <member name="T:System.Data.SQLite.SQLiteConvert"> |
||
37 | <summary> |
||
38 | This base class provides datatype conversion services for the SQLite provider. |
||
39 | </summary> |
||
40 | </member> |
||
41 | <member name="F:System.Data.SQLite.SQLiteConvert.FullFormat"> |
||
42 | <summary> |
||
43 | The format string for DateTime values when using the InvariantCulture or CurrentCulture formats. |
||
44 | </summary> |
||
45 | </member> |
||
46 | <member name="F:System.Data.SQLite.SQLiteConvert.UnixEpoch"> |
||
47 | <summary> |
||
48 | The value for the Unix epoch (e.g. January 1, 1970 at midnight, in UTC). |
||
49 | </summary> |
||
50 | </member> |
||
51 | <member name="F:System.Data.SQLite.SQLiteConvert.OleAutomationEpochAsJulianDay"> |
||
52 | <summary> |
||
53 | The value of the OLE Automation epoch represented as a Julian day. |
||
54 | </summary> |
||
55 | </member> |
||
56 | <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormats"> |
||
57 | <summary> |
||
58 | An array of ISO8601 datetime formats we support conversion from |
||
59 | </summary> |
||
60 | </member> |
||
61 | <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormatUtc"> |
||
62 | <summary> |
||
63 | The internal default format for UTC DateTime values when converting |
||
64 | to a string. |
||
65 | </summary> |
||
66 | </member> |
||
67 | <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormatLocal"> |
||
68 | <summary> |
||
69 | The internal default format for local DateTime values when converting |
||
70 | to a string. |
||
71 | </summary> |
||
72 | </member> |
||
73 | <member name="F:System.Data.SQLite.SQLiteConvert._utf8"> |
||
74 | <summary> |
||
75 | An UTF-8 Encoding instance, so we can convert strings to and from UTF-8 |
||
76 | </summary> |
||
77 | </member> |
||
78 | <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormat"> |
||
79 | <summary> |
||
80 | The default DateTime format for this instance |
||
81 | </summary> |
||
82 | </member> |
||
83 | <member name="F:System.Data.SQLite.SQLiteConvert._datetimeKind"> |
||
84 | <summary> |
||
85 | The default DateTimeKind for this instance. |
||
86 | </summary> |
||
87 | </member> |
||
88 | <member name="M:System.Data.SQLite.SQLiteConvert.#ctor(System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind)"> |
||
89 | <summary> |
||
90 | Initializes the conversion class |
||
91 | </summary> |
||
92 | <param name="fmt">The default date/time format to use for this instance</param> |
||
93 | <param name="kind">The DateTimeKind to use.</param> |
||
94 | </member> |
||
95 | <member name="M:System.Data.SQLite.SQLiteConvert.ToUTF8(System.String)"> |
||
96 | <summary> |
||
97 | Converts a string to a UTF-8 encoded byte array sized to include a null-terminating character. |
||
98 | </summary> |
||
99 | <param name="sourceText">The string to convert to UTF-8</param> |
||
100 | <returns>A byte array containing the converted string plus an extra 0 terminating byte at the end of the array.</returns> |
||
101 | </member> |
||
102 | <member name="M:System.Data.SQLite.SQLiteConvert.ToUTF8(System.DateTime)"> |
||
103 | <summary> |
||
104 | Convert a DateTime to a UTF-8 encoded, zero-terminated byte array. |
||
105 | </summary> |
||
106 | <remarks> |
||
107 | This function is a convenience function, which first calls ToString() on the DateTime, and then calls ToUTF8() with the |
||
108 | string result. |
||
109 | </remarks> |
||
110 | <param name="dateTimeValue">The DateTime to convert.</param> |
||
111 | <returns>The UTF-8 encoded string, including a 0 terminating byte at the end of the array.</returns> |
||
112 | </member> |
||
113 | <member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.IntPtr,System.Int32)"> |
||
114 | <summary> |
||
115 | Converts a UTF-8 encoded IntPtr of the specified length into a .NET string |
||
116 | </summary> |
||
117 | <param name="nativestring">The pointer to the memory where the UTF-8 string is encoded</param> |
||
118 | <param name="nativestringlen">The number of bytes to decode</param> |
||
119 | <returns>A string containing the translated character(s)</returns> |
||
120 | </member> |
||
121 | <member name="M:System.Data.SQLite.SQLiteConvert.UTF8ToString(System.IntPtr,System.Int32)"> |
||
122 | <summary> |
||
123 | Converts a UTF-8 encoded IntPtr of the specified length into a .NET string |
||
124 | </summary> |
||
125 | <param name="nativestring">The pointer to the memory where the UTF-8 string is encoded</param> |
||
126 | <param name="nativestringlen">The number of bytes to decode</param> |
||
127 | <returns>A string containing the translated character(s)</returns> |
||
128 | </member> |
||
129 | <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.String)"> |
||
130 | <summary> |
||
131 | Converts a string into a DateTime, using the current DateTimeFormat specified for the connection when it was opened. |
||
132 | </summary> |
||
133 | <remarks> |
||
134 | Acceptable ISO8601 DateTime formats are: |
||
135 | <list type="bullet"> |
||
136 | <item><description>THHmmssK</description></item> |
||
137 | <item><description>THHmmK</description></item> |
||
138 | <item><description>HH:mm:ss.FFFFFFFK</description></item> |
||
139 | <item><description>HH:mm:ssK</description></item> |
||
140 | <item><description>HH:mmK</description></item> |
||
141 | <item><description>yyyy-MM-dd HH:mm:ss.FFFFFFFK</description></item> |
||
142 | <item><description>yyyy-MM-dd HH:mm:ssK</description></item> |
||
143 | <item><description>yyyy-MM-dd HH:mmK</description></item> |
||
144 | <item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFFK</description></item> |
||
145 | <item><description>yyyy-MM-ddTHH:mmK</description></item> |
||
146 | <item><description>yyyy-MM-ddTHH:mm:ssK</description></item> |
||
147 | <item><description>yyyyMMddHHmmssK</description></item> |
||
148 | <item><description>yyyyMMddHHmmK</description></item> |
||
149 | <item><description>yyyyMMddTHHmmssFFFFFFFK</description></item> |
||
150 | <item><description>THHmmss</description></item> |
||
151 | <item><description>THHmm</description></item> |
||
152 | <item><description>HH:mm:ss.FFFFFFF</description></item> |
||
153 | <item><description>HH:mm:ss</description></item> |
||
154 | <item><description>HH:mm</description></item> |
||
155 | <item><description>yyyy-MM-dd HH:mm:ss.FFFFFFF</description></item> |
||
156 | <item><description>yyyy-MM-dd HH:mm:ss</description></item> |
||
157 | <item><description>yyyy-MM-dd HH:mm</description></item> |
||
158 | <item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFF</description></item> |
||
159 | <item><description>yyyy-MM-ddTHH:mm</description></item> |
||
160 | <item><description>yyyy-MM-ddTHH:mm:ss</description></item> |
||
161 | <item><description>yyyyMMddHHmmss</description></item> |
||
162 | <item><description>yyyyMMddHHmm</description></item> |
||
163 | <item><description>yyyyMMddTHHmmssFFFFFFF</description></item> |
||
164 | <item><description>yyyy-MM-dd</description></item> |
||
165 | <item><description>yyyyMMdd</description></item> |
||
166 | <item><description>yy-MM-dd</description></item> |
||
167 | </list> |
||
168 | If the string cannot be matched to one of the above formats, an exception will be thrown. |
||
169 | </remarks> |
||
170 | <param name="dateText">The string containing either a long integer number of 100-nanosecond units since |
||
171 | System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a |
||
172 | culture-independent formatted date and time string, a formatted date and time string in the current |
||
173 | culture, or an ISO8601-format string.</param> |
||
174 | <returns>A DateTime value</returns> |
||
175 | </member> |
||
176 | <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.String,System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind)"> |
||
177 | <summary> |
||
178 | Converts a string into a DateTime, using the specified DateTimeFormat and DateTimeKind. |
||
179 | </summary> |
||
180 | <remarks> |
||
181 | Acceptable ISO8601 DateTime formats are: |
||
182 | <list type="bullet"> |
||
183 | <item><description>THHmmssK</description></item> |
||
184 | <item><description>THHmmK</description></item> |
||
185 | <item><description>HH:mm:ss.FFFFFFFK</description></item> |
||
186 | <item><description>HH:mm:ssK</description></item> |
||
187 | <item><description>HH:mmK</description></item> |
||
188 | <item><description>yyyy-MM-dd HH:mm:ss.FFFFFFFK</description></item> |
||
189 | <item><description>yyyy-MM-dd HH:mm:ssK</description></item> |
||
190 | <item><description>yyyy-MM-dd HH:mmK</description></item> |
||
191 | <item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFFK</description></item> |
||
192 | <item><description>yyyy-MM-ddTHH:mmK</description></item> |
||
193 | <item><description>yyyy-MM-ddTHH:mm:ssK</description></item> |
||
194 | <item><description>yyyyMMddHHmmssK</description></item> |
||
195 | <item><description>yyyyMMddHHmmK</description></item> |
||
196 | <item><description>yyyyMMddTHHmmssFFFFFFFK</description></item> |
||
197 | <item><description>THHmmss</description></item> |
||
198 | <item><description>THHmm</description></item> |
||
199 | <item><description>HH:mm:ss.FFFFFFF</description></item> |
||
200 | <item><description>HH:mm:ss</description></item> |
||
201 | <item><description>HH:mm</description></item> |
||
202 | <item><description>yyyy-MM-dd HH:mm:ss.FFFFFFF</description></item> |
||
203 | <item><description>yyyy-MM-dd HH:mm:ss</description></item> |
||
204 | <item><description>yyyy-MM-dd HH:mm</description></item> |
||
205 | <item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFF</description></item> |
||
206 | <item><description>yyyy-MM-ddTHH:mm</description></item> |
||
207 | <item><description>yyyy-MM-ddTHH:mm:ss</description></item> |
||
208 | <item><description>yyyyMMddHHmmss</description></item> |
||
209 | <item><description>yyyyMMddHHmm</description></item> |
||
210 | <item><description>yyyyMMddTHHmmssFFFFFFF</description></item> |
||
211 | <item><description>yyyy-MM-dd</description></item> |
||
212 | <item><description>yyyyMMdd</description></item> |
||
213 | <item><description>yy-MM-dd</description></item> |
||
214 | </list> |
||
215 | If the string cannot be matched to one of the above formats, an exception will be thrown. |
||
216 | </remarks> |
||
217 | <param name="dateText">The string containing either a long integer number of 100-nanosecond units since |
||
218 | System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a |
||
219 | culture-independent formatted date and time string, a formatted date and time string in the current |
||
220 | culture, or an ISO8601-format string.</param> |
||
221 | <param name="format">The SQLiteDateFormats to use.</param> |
||
222 | <param name="kind">The DateTimeKind to use.</param> |
||
223 | <returns>A DateTime value</returns> |
||
224 | </member> |
||
225 | <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.Double)"> |
||
226 | <summary> |
||
227 | Converts a julianday value into a DateTime |
||
228 | </summary> |
||
229 | <param name="julianDay">The value to convert</param> |
||
230 | <returns>A .NET DateTime</returns> |
||
231 | </member> |
||
232 | <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.Double,System.DateTimeKind)"> |
||
233 | <summary> |
||
234 | Converts a julianday value into a DateTime |
||
235 | </summary> |
||
236 | <param name="julianDay">The value to convert</param> |
||
237 | <param name="kind">The DateTimeKind to use.</param> |
||
238 | <returns>A .NET DateTime</returns> |
||
239 | </member> |
||
240 | <member name="M:System.Data.SQLite.SQLiteConvert.ToJulianDay(System.DateTime)"> |
||
241 | <summary> |
||
242 | Converts a DateTime struct to a JulianDay double |
||
243 | </summary> |
||
244 | <param name="value">The DateTime to convert</param> |
||
245 | <returns>The JulianDay value the Datetime represents</returns> |
||
246 | </member> |
||
247 | <member name="M:System.Data.SQLite.SQLiteConvert.ToUnixEpoch(System.DateTime)"> |
||
248 | <summary> |
||
249 | Converts a DateTime struct to the whole number of seconds since the |
||
250 | Unix epoch. |
||
251 | </summary> |
||
252 | <param name="value">The DateTime to convert</param> |
||
253 | <returns>The whole number of seconds since the Unix epoch</returns> |
||
254 | </member> |
||
255 | <member name="M:System.Data.SQLite.SQLiteConvert.GetDateTimeKindFormat(System.DateTimeKind)"> |
||
256 | <summary> |
||
257 | Returns the default DateTime format string to use for the specified |
||
258 | DateTimeKind. |
||
259 | </summary> |
||
260 | <param name="kind">The DateTimeKind to use.</param> |
||
261 | <returns> |
||
262 | The default DateTime format string to use for the specified DateTimeKind. |
||
263 | </returns> |
||
264 | </member> |
||
265 | <member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.DateTime)"> |
||
266 | <summary> |
||
267 | Converts a DateTime to a string value, using the current DateTimeFormat specified for the connection when it was opened. |
||
268 | </summary> |
||
269 | <param name="dateValue">The DateTime value to convert</param> |
||
270 | <returns>Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a |
||
271 | Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time |
||
272 | string, a formatted date and time string in the current culture, or an ISO8601-format date/time string.</returns> |
||
273 | </member> |
||
274 | <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.IntPtr,System.Int32)"> |
||
275 | <summary> |
||
276 | Internal function to convert a UTF-8 encoded IntPtr of the specified length to a DateTime. |
||
277 | </summary> |
||
278 | <remarks> |
||
279 | This is a convenience function, which first calls ToString() on the IntPtr to convert it to a string, then calls |
||
280 | ToDateTime() on the string to return a DateTime. |
||
281 | </remarks> |
||
282 | <param name="ptr">A pointer to the UTF-8 encoded string</param> |
||
283 | <param name="len">The length in bytes of the string</param> |
||
284 | <returns>The parsed DateTime value</returns> |
||
285 | </member> |
||
286 | <member name="M:System.Data.SQLite.SQLiteConvert.Split(System.String,System.Char)"> |
||
287 | <summary> |
||
288 | Smart method of splitting a string. Skips quoted elements, removes the quotes. |
||
289 | </summary> |
||
290 | <remarks> |
||
291 | This split function works somewhat like the String.Split() function in that it breaks apart a string into |
||
292 | pieces and returns the pieces as an array. The primary differences are: |
||
293 | <list type="bullet"> |
||
294 | <item><description>Only one character can be provided as a separator character</description></item> |
||
295 | <item><description>Quoted text inside the string is skipped over when searching for the separator, and the quotes are removed.</description></item> |
||
296 | </list> |
||
297 | Thus, if splitting the following string looking for a comma:<br/> |
||
298 | One,Two, "Three, Four", Five<br/> |
||
299 | <br/> |
||
300 | The resulting array would contain<br/> |
||
301 | [0] One<br/> |
||
302 | [1] Two<br/> |
||
303 | [2] Three, Four<br/> |
||
304 | [3] Five<br/> |
||
305 | <br/> |
||
306 | Note that the leading and trailing spaces were removed from each item during the split. |
||
307 | </remarks> |
||
308 | <param name="source">Source string to split apart</param> |
||
309 | <param name="separator">Separator character</param> |
||
310 | <returns>A string array of the split up elements</returns> |
||
311 | </member> |
||
312 | <member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.Object)"> |
||
313 | <summary> |
||
314 | Convert a value to true or false. |
||
315 | </summary> |
||
316 | <param name="source">A string or number representing true or false</param> |
||
317 | <returns></returns> |
||
318 | </member> |
||
319 | <member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.String)"> |
||
320 | <summary> |
||
321 | Convert a string to true or false. |
||
322 | </summary> |
||
323 | <param name="source">A string representing true or false</param> |
||
324 | <returns></returns> |
||
325 | <remarks> |
||
326 | "yes", "no", "y", "n", "0", "1", "on", "off" as well as Boolean.FalseString and Boolean.TrueString will all be |
||
327 | converted to a proper boolean value. |
||
328 | </remarks> |
||
329 | </member> |
||
330 | <member name="M:System.Data.SQLite.SQLiteConvert.ColumnToType(System.Data.SQLite.SQLiteStatement,System.Int32,System.Data.SQLite.SQLiteType)"> |
||
331 | <summary> |
||
332 | Determines the data type of a column in a statement |
||
333 | </summary> |
||
334 | <param name="stmt">The statement to retrieve information for</param> |
||
335 | <param name="i">The column to retrieve type information on</param> |
||
336 | <param name="typ">The SQLiteType to receive the affinity for the given column</param> |
||
337 | </member> |
||
338 | <member name="M:System.Data.SQLite.SQLiteConvert.SQLiteTypeToType(System.Data.SQLite.SQLiteType)"> |
||
339 | <summary> |
||
340 | Converts a SQLiteType to a .NET Type object |
||
341 | </summary> |
||
342 | <param name="t">The SQLiteType to convert</param> |
||
343 | <returns>Returns a .NET Type object</returns> |
||
344 | </member> |
||
345 | <member name="M:System.Data.SQLite.SQLiteConvert.TypeToDbType(System.Type)"> |
||
346 | <summary> |
||
347 | For a given intrinsic type, return a DbType |
||
348 | </summary> |
||
349 | <param name="typ">The native type to convert</param> |
||
350 | <returns>The corresponding (closest match) DbType</returns> |
||
351 | </member> |
||
352 | <member name="M:System.Data.SQLite.SQLiteConvert.DbTypeToColumnSize(System.Data.DbType)"> |
||
353 | <summary> |
||
354 | Returns the ColumnSize for the given DbType |
||
355 | </summary> |
||
356 | <param name="typ">The DbType to get the size of</param> |
||
357 | <returns></returns> |
||
358 | </member> |
||
359 | <member name="M:System.Data.SQLite.SQLiteConvert.DbTypeToType(System.Data.DbType)"> |
||
360 | <summary> |
||
361 | Convert a DbType to a Type |
||
362 | </summary> |
||
363 | <param name="typ">The DbType to convert from</param> |
||
364 | <returns>The closest-match .NET type</returns> |
||
365 | </member> |
||
366 | <member name="M:System.Data.SQLite.SQLiteConvert.TypeToAffinity(System.Type)"> |
||
367 | <summary> |
||
368 | For a given type, return the closest-match SQLite TypeAffinity, which only understands a very limited subset of types. |
||
369 | </summary> |
||
370 | <param name="typ">The type to evaluate</param> |
||
371 | <returns>The SQLite type affinity for that type.</returns> |
||
372 | </member> |
||
373 | <member name="M:System.Data.SQLite.SQLiteConvert.TypeNameToDbType(System.String)"> |
||
374 | <summary> |
||
375 | For a given type name, return a closest-match .NET type |
||
376 | </summary> |
||
377 | <param name="Name">The name of the type to match</param> |
||
378 | <returns>The .NET DBType the text evaluates to.</returns> |
||
379 | </member> |
||
380 | <member name="M:System.Data.SQLite.SQLiteBase.SetMemoryStatus(System.Boolean)"> |
||
381 | <summary> |
||
382 | Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled. |
||
383 | If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is |
||
384 | global to the process. |
||
385 | </summary> |
||
386 | <param name="value">Non-zero to enable memory usage tracking, zero otherwise.</param> |
||
387 | <returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns> |
||
388 | </member> |
||
389 | <member name="M:System.Data.SQLite.SQLiteBase.Shutdown"> |
||
390 | <summary> |
||
391 | Shutdown the SQLite engine so that it can be restarted with different config options. |
||
392 | We depend on auto initialization to recover. |
||
393 | </summary> |
||
394 | </member> |
||
395 | <member name="M:System.Data.SQLite.SQLiteBase.IsOpen"> |
||
396 | <summary> |
||
397 | Returns non-zero if a database connection is open. |
||
398 | </summary> |
||
399 | <returns></returns> |
||
400 | </member> |
||
401 | <member name="M:System.Data.SQLite.SQLiteBase.Open(System.String,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteOpenFlagsEnum,System.Int32,System.Boolean)"> |
||
402 | <summary> |
||
403 | Opens a database. |
||
404 | </summary> |
||
405 | <remarks> |
||
406 | Implementers should call SQLiteFunction.BindFunctions() and save the array after opening a connection |
||
407 | to bind all attributed user-defined functions and collating sequences to the new connection. |
||
408 | </remarks> |
||
409 | <param name="strFilename">The filename of the database to open. SQLite automatically creates it if it doesn't exist.</param> |
||
410 | <param name="connectionFlags">The flags associated with the parent connection object</param> |
||
411 | <param name="openFlags">The open flags to use when creating the connection</param> |
||
412 | <param name="maxPoolSize">The maximum size of the pool for the given filename</param> |
||
413 | <param name="usePool">If true, the connection can be pulled from the connection pool</param> |
||
414 | </member> |
||
415 | <member name="M:System.Data.SQLite.SQLiteBase.Close(System.Boolean)"> |
||
416 | <summary> |
||
417 | Closes the currently-open database. |
||
418 | </summary> |
||
419 | <remarks> |
||
420 | After the database has been closed implemeters should call SQLiteFunction.UnbindFunctions() to deallocate all interop allocated |
||
421 | memory associated with the user-defined functions and collating sequences tied to the closed connection. |
||
422 | </remarks> |
||
423 | <param name="canThrow">Non-zero if the operation is allowed to throw exceptions, zero otherwise.</param> |
||
424 | </member> |
||
425 | <member name="M:System.Data.SQLite.SQLiteBase.SetTimeout(System.Int32)"> |
||
426 | <summary> |
||
427 | Sets the busy timeout on the connection. SQLiteCommand will call this before executing any command. |
||
428 | </summary> |
||
429 | <param name="nTimeoutMS">The number of milliseconds to wait before returning SQLITE_BUSY</param> |
||
430 | </member> |
||
431 | <member name="M:System.Data.SQLite.SQLiteBase.GetLastError"> |
||
432 | <summary> |
||
433 | Returns the text of the last error issued by SQLite |
||
434 | </summary> |
||
435 | <returns></returns> |
||
436 | </member> |
||
437 | <member name="M:System.Data.SQLite.SQLiteBase.ClearPool"> |
||
438 | <summary> |
||
439 | When pooling is enabled, force this connection to be disposed rather than returned to the pool |
||
440 | </summary> |
||
441 | </member> |
||
442 | <member name="M:System.Data.SQLite.SQLiteBase.CountPool"> |
||
443 | <summary> |
||
444 | When pooling is enabled, returns the number of pool entries matching the current file name. |
||
445 | </summary> |
||
446 | <returns>The number of pool entries matching the current file name.</returns> |
||
447 | </member> |
||
448 | <member name="M:System.Data.SQLite.SQLiteBase.Prepare(System.Data.SQLite.SQLiteConnection,System.String,System.Data.SQLite.SQLiteStatement,System.UInt32,System.String@)"> |
||
449 | <summary> |
||
450 | Prepares a SQL statement for execution. |
||
451 | </summary> |
||
452 | <param name="cnn">The source connection preparing the command. Can be null for any caller except LINQ</param> |
||
453 | <param name="strSql">The SQL command text to prepare</param> |
||
454 | <param name="previous">The previous statement in a multi-statement command, or null if no previous statement exists</param> |
||
455 | <param name="timeoutMS">The timeout to wait before aborting the prepare</param> |
||
456 | <param name="strRemain">The remainder of the statement that was not processed. Each call to prepare parses the |
||
457 | SQL up to to either the end of the text or to the first semi-colon delimiter. The remaining text is returned |
||
458 | here for a subsequent call to Prepare() until all the text has been processed.</param> |
||
459 | <returns>Returns an initialized SQLiteStatement.</returns> |
||
460 | </member> |
||
461 | <member name="M:System.Data.SQLite.SQLiteBase.Step(System.Data.SQLite.SQLiteStatement)"> |
||
462 | <summary> |
||
463 | Steps through a prepared statement. |
||
464 | </summary> |
||
465 | <param name="stmt">The SQLiteStatement to step through</param> |
||
466 | <returns>True if a row was returned, False if not.</returns> |
||
467 | </member> |
||
468 | <member name="M:System.Data.SQLite.SQLiteBase.Reset(System.Data.SQLite.SQLiteStatement)"> |
||
469 | <summary> |
||
470 | Resets a prepared statement so it can be executed again. If the error returned is SQLITE_SCHEMA, |
||
471 | transparently attempt to rebuild the SQL statement and throw an error if that was not possible. |
||
472 | </summary> |
||
473 | <param name="stmt">The statement to reset</param> |
||
474 | <returns>Returns -1 if the schema changed while resetting, 0 if the reset was sucessful or 6 (SQLITE_LOCKED) if the reset failed due to a lock</returns> |
||
475 | </member> |
||
476 | <member name="M:System.Data.SQLite.SQLiteBase.SetLoadExtension(System.Boolean)"> |
||
477 | <summary> |
||
478 | Enables or disabled extension loading by SQLite. |
||
479 | </summary> |
||
480 | <param name="bOnOff"> |
||
481 | True to enable loading of extensions, false to disable. |
||
482 | </param> |
||
483 | </member> |
||
484 | <member name="M:System.Data.SQLite.SQLiteBase.LoadExtension(System.String,System.String)"> |
||
485 | <summary> |
||
486 | Loads a SQLite extension library from the named file. |
||
487 | </summary> |
||
488 | <param name="fileName"> |
||
489 | The name of the dynamic link library file containing the extension. |
||
490 | </param> |
||
491 | <param name="procName"> |
||
492 | The name of the exported function used to initialize the extension. |
||
493 | If null, the default "sqlite3_extension_init" will be used. |
||
494 | </param> |
||
495 | </member> |
||
496 | <member name="M:System.Data.SQLite.SQLiteBase.SetExtendedResultCodes(System.Boolean)"> |
||
497 | <summary> |
||
498 | Enables or disabled extened result codes returned by SQLite |
||
499 | </summary> |
||
500 | <param name="bOnOff">true to enable extended result codes, false to disable.</param> |
||
501 | <returns></returns> |
||
502 | </member> |
||
503 | <member name="M:System.Data.SQLite.SQLiteBase.ResultCode"> |
||
504 | <summary> |
||
505 | Returns the numeric result code for the most recent failed SQLite API call |
||
506 | associated with the database connection. |
||
507 | </summary> |
||
508 | <returns>Result code</returns> |
||
509 | </member> |
||
510 | <member name="M:System.Data.SQLite.SQLiteBase.ExtendedResultCode"> |
||
511 | <summary> |
||
512 | Returns the extended numeric result code for the most recent failed SQLite API call |
||
513 | associated with the database connection. |
||
514 | </summary> |
||
515 | <returns>Extended result code</returns> |
||
516 | </member> |
||
517 | <member name="M:System.Data.SQLite.SQLiteBase.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)"> |
||
518 | <summary> |
||
519 | Add a log message via the SQLite sqlite3_log interface. |
||
520 | </summary> |
||
521 | <param name="iErrCode">Error code to be logged with the message.</param> |
||
522 | <param name="zMessage">String to be logged. Unlike the SQLite sqlite3_log() |
||
523 | interface, this should be pre-formatted. Consider using the |
||
524 | String.Format() function.</param> |
||
525 | <returns></returns> |
||
526 | </member> |
||
527 | <member name="M:System.Data.SQLite.SQLiteBase.IsInitialized"> |
||
528 | <summary> |
||
529 | Checks if the SQLite core library has been initialized in the current process. |
||
530 | </summary> |
||
531 | <returns> |
||
532 | Non-zero if the SQLite core library has been initialized in the current process, |
||
533 | zero otherwise. |
||
534 | </returns> |
||
535 | </member> |
||
536 | <member name="M:System.Data.SQLite.SQLiteBase.InitializeBackup(System.Data.SQLite.SQLiteConnection,System.String,System.String)"> |
||
537 | <summary> |
||
538 | Creates a new SQLite backup object based on the provided destination |
||
539 | database connection. The source database connection is the one |
||
540 | associated with this object. The source and destination database |
||
541 | connections cannot be the same. |
||
542 | </summary> |
||
543 | <param name="destCnn">The destination database connection.</param> |
||
544 | <param name="destName">The destination database name.</param> |
||
545 | <param name="sourceName">The source database name.</param> |
||
546 | <returns>The newly created backup object.</returns> |
||
547 | </member> |
||
548 | <member name="M:System.Data.SQLite.SQLiteBase.StepBackup(System.Data.SQLite.SQLiteBackup,System.Int32,System.Boolean@)"> |
||
549 | <summary> |
||
550 | Copies up to N pages from the source database to the destination |
||
551 | database associated with the specified backup object. |
||
552 | </summary> |
||
553 | <param name="backup">The backup object to use.</param> |
||
554 | <param name="nPage"> |
||
555 | The number of pages to copy or negative to copy all remaining pages. |
||
556 | </param> |
||
557 | <param name="retry"> |
||
558 | Set to true if the operation needs to be retried due to database |
||
559 | locking issues. |
||
560 | </param> |
||
561 | <returns> |
||
562 | True if there are more pages to be copied, false otherwise. |
||
563 | </returns> |
||
564 | </member> |
||
565 | <member name="M:System.Data.SQLite.SQLiteBase.RemainingBackup(System.Data.SQLite.SQLiteBackup)"> |
||
566 | <summary> |
||
567 | Returns the number of pages remaining to be copied from the source |
||
568 | database to the destination database associated with the specified |
||
569 | backup object. |
||
570 | </summary> |
||
571 | <param name="backup">The backup object to check.</param> |
||
572 | <returns>The number of pages remaining to be copied.</returns> |
||
573 | </member> |
||
574 | <member name="M:System.Data.SQLite.SQLiteBase.PageCountBackup(System.Data.SQLite.SQLiteBackup)"> |
||
575 | <summary> |
||
576 | Returns the total number of pages in the source database associated |
||
577 | with the specified backup object. |
||
578 | </summary> |
||
579 | <param name="backup">The backup object to check.</param> |
||
580 | <returns>The total number of pages in the source database.</returns> |
||
581 | </member> |
||
582 | <member name="M:System.Data.SQLite.SQLiteBase.FinishBackup(System.Data.SQLite.SQLiteBackup)"> |
||
583 | <summary> |
||
584 | Destroys the backup object, rolling back any backup that may be in |
||
585 | progess. |
||
586 | </summary> |
||
587 | <param name="backup">The backup object to destroy.</param> |
||
588 | </member> |
||
589 | <member name="M:System.Data.SQLite.SQLiteBase.FallbackGetErrorString(System.Data.SQLite.SQLiteErrorCode)"> |
||
590 | <summary> |
||
591 | Returns the error message for the specified SQLite return code using |
||
592 | the internal static lookup table. |
||
593 | </summary> |
||
594 | <param name="rc">The SQLite return code.</param> |
||
595 | <returns>The error message or null if it cannot be found.</returns> |
||
596 | </member> |
||
597 | <member name="M:System.Data.SQLite.SQLiteBase.GetErrorString(System.Data.SQLite.SQLiteErrorCode)"> |
||
598 | <summary> |
||
599 | Returns the error message for the specified SQLite return code using |
||
600 | the sqlite3_errstr() function, falling back to the internal lookup |
||
601 | table if necessary. |
||
602 | </summary> |
||
603 | <param name="rc">The SQLite return code.</param> |
||
604 | <returns>The error message or null if it cannot be found.</returns> |
||
605 | </member> |
||
606 | <member name="P:System.Data.SQLite.SQLiteBase.Version"> |
||
607 | <summary> |
||
608 | Returns a string representing the active version of SQLite |
||
609 | </summary> |
||
610 | </member> |
||
611 | <member name="P:System.Data.SQLite.SQLiteBase.VersionNumber"> |
||
612 | <summary> |
||
613 | Returns an integer representing the active version of SQLite |
||
614 | </summary> |
||
615 | </member> |
||
616 | <member name="P:System.Data.SQLite.SQLiteBase.LastInsertRowId"> |
||
617 | <summary> |
||
618 | Returns the rowid of the most recent successful INSERT into the database from this connection. |
||
619 | </summary> |
||
620 | </member> |
||
621 | <member name="P:System.Data.SQLite.SQLiteBase.Changes"> |
||
622 | <summary> |
||
623 | Returns the number of changes the last executing insert/update caused. |
||
624 | </summary> |
||
625 | </member> |
||
626 | <member name="P:System.Data.SQLite.SQLiteBase.MemoryUsed"> |
||
627 | <summary> |
||
628 | Returns the amount of memory (in bytes) currently in use by the SQLite core library. This is not really a per-connection |
||
629 | value, it is global to the process. |
||
630 | </summary> |
||
631 | </member> |
||
632 | <member name="P:System.Data.SQLite.SQLiteBase.MemoryHighwater"> |
||
633 | <summary> |
||
634 | Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset. |
||
635 | This is not really a per-connection value, it is global to the process. |
||
636 | </summary> |
||
637 | </member> |
||
638 | <member name="F:System.Data.SQLite.SQLite3._sql"> |
||
639 | <summary> |
||
640 | The opaque pointer returned to us by the sqlite provider |
||
641 | </summary> |
||
642 | </member> |
||
643 | <member name="F:System.Data.SQLite.SQLite3._functionsArray"> |
||
644 | <summary> |
||
645 | The user-defined functions registered on this connection |
||
646 | </summary> |
||
647 | </member> |
||
648 | <member name="M:System.Data.SQLite.SQLite3.Shutdown"> |
||
649 | <summary> |
||
650 | Shutdown the SQLite engine so that it can be restarted with different config options. |
||
651 | We depend on auto initialization to recover. |
||
652 | </summary> |
||
653 | <returns>Returns a result code</returns> |
||
654 | </member> |
||
655 | <member name="M:System.Data.SQLite.SQLite3.SetLoadExtension(System.Boolean)"> |
||
656 | <summary> |
||
657 | Enables or disabled extension loading by SQLite. |
||
658 | </summary> |
||
659 | <param name="bOnOff"> |
||
660 | True to enable loading of extensions, false to disable. |
||
661 | </param> |
||
662 | </member> |
||
663 | <member name="M:System.Data.SQLite.SQLite3.LoadExtension(System.String,System.String)"> |
||
664 | <summary> |
||
665 | Loads a SQLite extension library from the named file. |
||
666 | </summary> |
||
667 | <param name="fileName"> |
||
668 | The name of the dynamic link library file containing the extension. |
||
669 | </param> |
||
670 | <param name="procName"> |
||
671 | The name of the exported function used to initialize the extension. |
||
672 | If null, the default "sqlite3_extension_init" will be used. |
||
673 | </param> |
||
674 | </member> |
||
675 | <member name="M:System.Data.SQLite.SQLite3.SetExtendedResultCodes(System.Boolean)"> |
||
676 | Enables or disabled extended result codes returned by SQLite |
||
677 | </member> |
||
678 | <member name="M:System.Data.SQLite.SQLite3.ResultCode"> |
||
679 | Gets the last SQLite error code |
||
680 | </member> |
||
681 | <member name="M:System.Data.SQLite.SQLite3.ExtendedResultCode"> |
||
682 | Gets the last SQLite extended error code |
||
683 | </member> |
||
684 | <member name="M:System.Data.SQLite.SQLite3.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)"> |
||
685 | Add a log message via the SQLite sqlite3_log interface. |
||
686 | </member> |
||
687 | <member name="M:System.Data.SQLite.SQLite3.SetLogCallback(System.Data.SQLite.SQLiteLogCallback)"> |
||
688 | <summary> |
||
689 | Allows the setting of a logging callback invoked by SQLite when a |
||
690 | log event occurs. Only one callback may be set. If NULL is passed, |
||
691 | the logging callback is unregistered. |
||
692 | </summary> |
||
693 | <param name="func">The callback function to invoke.</param> |
||
694 | <returns>Returns a result code</returns> |
||
695 | </member> |
||
696 | <member name="M:System.Data.SQLite.SQLite3.InitializeBackup(System.Data.SQLite.SQLiteConnection,System.String,System.String)"> |
||
697 | <summary> |
||
698 | Creates a new SQLite backup object based on the provided destination |
||
699 | database connection. The source database connection is the one |
||
700 | associated with this object. The source and destination database |
||
701 | connections cannot be the same. |
||
702 | </summary> |
||
703 | <param name="destCnn">The destination database connection.</param> |
||
704 | <param name="destName">The destination database name.</param> |
||
705 | <param name="sourceName">The source database name.</param> |
||
706 | <returns>The newly created backup object.</returns> |
||
707 | </member> |
||
708 | <member name="M:System.Data.SQLite.SQLite3.StepBackup(System.Data.SQLite.SQLiteBackup,System.Int32,System.Boolean@)"> |
||
709 | <summary> |
||
710 | Copies up to N pages from the source database to the destination |
||
711 | database associated with the specified backup object. |
||
712 | </summary> |
||
713 | <param name="backup">The backup object to use.</param> |
||
714 | <param name="nPage"> |
||
715 | The number of pages to copy, negative to copy all remaining pages. |
||
716 | </param> |
||
717 | <param name="retry"> |
||
718 | Set to true if the operation needs to be retried due to database |
||
719 | locking issues; otherwise, set to false. |
||
720 | </param> |
||
721 | <returns> |
||
722 | True if there are more pages to be copied, false otherwise. |
||
723 | </returns> |
||
724 | </member> |
||
725 | <member name="M:System.Data.SQLite.SQLite3.RemainingBackup(System.Data.SQLite.SQLiteBackup)"> |
||
726 | <summary> |
||
727 | Returns the number of pages remaining to be copied from the source |
||
728 | database to the destination database associated with the specified |
||
729 | backup object. |
||
730 | </summary> |
||
731 | <param name="backup">The backup object to check.</param> |
||
732 | <returns>The number of pages remaining to be copied.</returns> |
||
733 | </member> |
||
734 | <member name="M:System.Data.SQLite.SQLite3.PageCountBackup(System.Data.SQLite.SQLiteBackup)"> |
||
735 | <summary> |
||
736 | Returns the total number of pages in the source database associated |
||
737 | with the specified backup object. |
||
738 | </summary> |
||
739 | <param name="backup">The backup object to check.</param> |
||
740 | <returns>The total number of pages in the source database.</returns> |
||
741 | </member> |
||
742 | <member name="M:System.Data.SQLite.SQLite3.FinishBackup(System.Data.SQLite.SQLiteBackup)"> |
||
743 | <summary> |
||
744 | Destroys the backup object, rolling back any backup that may be in |
||
745 | progess. |
||
746 | </summary> |
||
747 | <param name="backup">The backup object to destroy.</param> |
||
748 | </member> |
||
749 | <member name="M:System.Data.SQLite.SQLite3.IsInitialized"> |
||
750 | <summary> |
||
751 | Determines if the SQLite core library has been initialized for the |
||
752 | current process. |
||
753 | </summary> |
||
754 | <returns> |
||
755 | A boolean indicating whether or not the SQLite core library has been |
||
756 | initialized for the current process. |
||
757 | </returns> |
||
758 | </member> |
||
759 | <member name="M:System.Data.SQLite.SQLite3.StaticIsInitialized"> |
||
760 | <summary> |
||
761 | Determines if the SQLite core library has been initialized for the |
||
762 | current process. |
||
763 | </summary> |
||
764 | <returns> |
||
765 | A boolean indicating whether or not the SQLite core library has been |
||
766 | initialized for the current process. |
||
767 | </returns> |
||
768 | </member> |
||
769 | <member name="M:System.Data.SQLite.SQLite3.GetValue(System.Data.SQLite.SQLiteStatement,System.Int32,System.Data.SQLite.SQLiteType)"> |
||
770 | <summary> |
||
771 | Helper function to retrieve a column of data from an active statement. |
||
772 | </summary> |
||
773 | <param name="stmt">The statement being step()'d through</param> |
||
774 | <param name="index">The column index to retrieve</param> |
||
775 | <param name="typ">The type of data contained in the column. If Uninitialized, this function will retrieve the datatype information.</param> |
||
776 | <returns>Returns the data in the column</returns> |
||
777 | </member> |
||
778 | <member name="T:System.Data.SQLite.SQLite3_UTF16"> |
||
779 | <summary> |
||
780 | Alternate SQLite3 object, overriding many text behaviors to support UTF-16 (Unicode) |
||
781 | </summary> |
||
782 | </member> |
||
783 | <member name="M:System.Data.SQLite.SQLite3_UTF16.ToString(System.IntPtr,System.Int32)"> |
||
784 | <summary> |
||
785 | Overrides SQLiteConvert.ToString() to marshal UTF-16 strings instead of UTF-8 |
||
786 | </summary> |
||
787 | <param name="b">A pointer to a UTF-16 string</param> |
||
788 | <param name="nbytelen">The length (IN BYTES) of the string</param> |
||
789 | <returns>A .NET string</returns> |
||
790 | </member> |
||
791 | <member name="T:System.Data.SQLite.SQLiteBackup"> |
||
792 | <summary> |
||
793 | Represents a single SQL backup in SQLite. |
||
794 | </summary> |
||
795 | </member> |
||
796 | <member name="F:System.Data.SQLite.SQLiteBackup._sql"> |
||
797 | <summary> |
||
798 | The underlying SQLite object this backup is bound to. |
||
799 | </summary> |
||
800 | </member> |
||
801 | <member name="F:System.Data.SQLite.SQLiteBackup._sqlite_backup"> |
||
802 | <summary> |
||
803 | The actual backup handle. |
||
804 | </summary> |
||
805 | </member> |
||
806 | <member name="F:System.Data.SQLite.SQLiteBackup._destDb"> |
||
807 | <summary> |
||
808 | The destination database for the backup. |
||
809 | </summary> |
||
810 | </member> |
||
811 | <member name="F:System.Data.SQLite.SQLiteBackup._zDestName"> |
||
812 | <summary> |
||
813 | The destination database name for the backup. |
||
814 | </summary> |
||
815 | </member> |
||
816 | <member name="F:System.Data.SQLite.SQLiteBackup._sourceDb"> |
||
817 | <summary> |
||
818 | The source database for the backup. |
||
819 | </summary> |
||
820 | </member> |
||
821 | <member name="F:System.Data.SQLite.SQLiteBackup._zSourceName"> |
||
822 | <summary> |
||
823 | The source database name for the backup. |
||
824 | </summary> |
||
825 | </member> |
||
826 | <member name="F:System.Data.SQLite.SQLiteBackup._stepResult"> |
||
827 | <summary> |
||
828 | The last result from the StepBackup method of the SQLite3 class. |
||
829 | This is used to determine if the call to the FinishBackup method of |
||
830 | the SQLite3 class should throw an exception when it receives a non-Ok |
||
831 | return code from the core SQLite library. |
||
832 | </summary> |
||
833 | </member> |
||
834 | <member name="M:System.Data.SQLite.SQLiteBackup.#ctor(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteBackupHandle,System.IntPtr,System.Byte[],System.IntPtr,System.Byte[])"> |
||
835 | <summary> |
||
836 | Initializes the backup. |
||
837 | </summary> |
||
838 | <param name="sqlbase">The base SQLite object.</param> |
||
839 | <param name="backup">The backup handle.</param> |
||
840 | <param name="destDb">The destination database for the backup.</param> |
||
841 | <param name="zDestName">The destination database name for the backup.</param> |
||
842 | <param name="sourceDb">The source database for the backup.</param> |
||
843 | <param name="zSourceName">The source database name for the backup.</param> |
||
844 | </member> |
||
845 | <member name="M:System.Data.SQLite.SQLiteBackup.Dispose"> |
||
846 | <summary> |
||
847 | Disposes and finalizes the backup. |
||
848 | </summary> |
||
849 | </member> |
||
850 | <member name="T:System.Data.SQLite.SQLiteConnectionFlags"> |
||
851 | <summary> |
||
852 | The extra behavioral flags that can be applied to a connection. |
||
853 | </summary> |
||
854 | </member> |
||
855 | <member name="F:System.Data.SQLite.SQLiteConnectionFlags.None"> |
||
856 | <summary> |
||
857 | No extra flags. |
||
858 | </summary> |
||
859 | </member> |
||
860 | <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogPrepare"> |
||
861 | <summary> |
||
862 | Enable logging of all SQL statements to be prepared. |
||
863 | </summary> |
||
864 | </member> |
||
865 | <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogPreBind"> |
||
866 | <summary> |
||
867 | Enable logging of all bound parameter types and raw values. |
||
868 | </summary> |
||
869 | </member> |
||
870 | <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogBind"> |
||
871 | <summary> |
||
872 | Enable logging of all bound parameter strongly typed values. |
||
873 | </summary> |
||
874 | </member> |
||
875 | <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogCallbackException"> |
||
876 | <summary> |
||
877 | Enable logging of all exceptions caught from user-provided |
||
878 | managed code called from native code via delegates. |
||
879 | </summary> |
||
880 | </member> |
||
881 | <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogBackup"> |
||
882 | <summary> |
||
883 | Enable logging of backup API errors. |
||
884 | </summary> |
||
885 | </member> |
||
886 | <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoExtensionFunctions"> |
||
887 | <summary> |
||
888 | Skip adding the extension functions provided by the native |
||
889 | interop assembly. |
||
890 | </summary> |
||
891 | </member> |
||
892 | <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogAll"> |
||
893 | <summary> |
||
894 | Enable all logging. |
||
895 | </summary> |
||
896 | </member> |
||
897 | <member name="F:System.Data.SQLite.SQLiteConnectionFlags.Default"> |
||
898 | <summary> |
||
899 | The default extra flags for new connections. |
||
900 | </summary> |
||
901 | </member> |
||
902 | <member name="T:System.Data.SQLite.SQLiteCommand"> |
||
903 | <summary> |
||
904 | SQLite implementation of DbCommand. |
||
905 | </summary> |
||
906 | </member> |
||
907 | <member name="F:System.Data.SQLite.SQLiteCommand._commandText"> |
||
908 | <summary> |
||
909 | The command text this command is based on |
||
910 | </summary> |
||
911 | </member> |
||
912 | <member name="F:System.Data.SQLite.SQLiteCommand._cnn"> |
||
913 | <summary> |
||
914 | The connection the command is associated with |
||
915 | </summary> |
||
916 | </member> |
||
917 | <member name="F:System.Data.SQLite.SQLiteCommand._version"> |
||
918 | <summary> |
||
919 | The version of the connection the command is associated with |
||
920 | </summary> |
||
921 | </member> |
||
922 | <member name="F:System.Data.SQLite.SQLiteCommand._activeReader"> |
||
923 | <summary> |
||
924 | Indicates whether or not a DataReader is active on the command. |
||
925 | </summary> |
||
926 | </member> |
||
927 | <member name="F:System.Data.SQLite.SQLiteCommand._commandTimeout"> |
||
928 | <summary> |
||
929 | The timeout for the command, kludged because SQLite doesn't support per-command timeout values |
||
930 | </summary> |
||
931 | </member> |
||
932 | <member name="F:System.Data.SQLite.SQLiteCommand._designTimeVisible"> |
||
933 | <summary> |
||
934 | Designer support |
||
935 | </summary> |
||
936 | </member> |
||
937 | <member name="F:System.Data.SQLite.SQLiteCommand._updateRowSource"> |
||
938 | <summary> |
||
939 | Used by DbDataAdapter to determine updating behavior |
||
940 | </summary> |
||
941 | </member> |
||
942 | <member name="F:System.Data.SQLite.SQLiteCommand._parameterCollection"> |
||
943 | <summary> |
||
944 | The collection of parameters for the command |
||
945 | </summary> |
||
946 | </member> |
||
947 | <member name="F:System.Data.SQLite.SQLiteCommand._statementList"> |
||
948 | <summary> |
||
949 | The SQL command text, broken into individual SQL statements as they are executed |
||
950 | </summary> |
||
951 | </member> |
||
952 | <member name="F:System.Data.SQLite.SQLiteCommand._remainingText"> |
||
953 | <summary> |
||
954 | Unprocessed SQL text that has not been executed |
||
955 | </summary> |
||
956 | </member> |
||
957 | <member name="F:System.Data.SQLite.SQLiteCommand._transaction"> |
||
958 | <summary> |
||
959 | Transaction associated with this command |
||
960 | </summary> |
||
961 | </member> |
||
962 | <member name="M:System.Data.SQLite.SQLiteCommand.#ctor"> |
||
963 | <overloads> |
||
964 | Constructs a new SQLiteCommand |
||
965 | </overloads> |
||
966 | <summary> |
||
967 | Default constructor |
||
968 | </summary> |
||
969 | </member> |
||
970 | <member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String)"> |
||
971 | <summary> |
||
972 | Initializes the command with the given command text |
||
973 | </summary> |
||
974 | <param name="commandText">The SQL command text</param> |
||
975 | </member> |
||
976 | <member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String,System.Data.SQLite.SQLiteConnection)"> |
||
977 | <summary> |
||
978 | Initializes the command with the given SQL command text and attach the command to the specified |
||
979 | connection. |
||
980 | </summary> |
||
981 | <param name="commandText">The SQL command text</param> |
||
982 | <param name="connection">The connection to associate with the command</param> |
||
983 | </member> |
||
984 | <member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.Data.SQLite.SQLiteConnection)"> |
||
985 | <summary> |
||
986 | Initializes the command and associates it with the specified connection. |
||
987 | </summary> |
||
988 | <param name="connection">The connection to associate with the command</param> |
||
989 | </member> |
||
990 | <member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String,System.Data.SQLite.SQLiteConnection,System.Data.SQLite.SQLiteTransaction)"> |
||
991 | <summary> |
||
992 | Initializes a command with the given SQL, connection and transaction |
||
993 | </summary> |
||
994 | <param name="commandText">The SQL command text</param> |
||
995 | <param name="connection">The connection to associate with the command</param> |
||
996 | <param name="transaction">The transaction the command should be associated with</param> |
||
997 | </member> |
||
998 | <member name="M:System.Data.SQLite.SQLiteCommand.Dispose(System.Boolean)"> |
||
999 | <summary> |
||
1000 | Disposes of the command and clears all member variables |
||
1001 | </summary> |
||
1002 | <param name="disposing">Whether or not the class is being explicitly or implicitly disposed</param> |
||
1003 | </member> |
||
1004 | <member name="M:System.Data.SQLite.SQLiteCommand.ClearCommands"> |
||
1005 | <summary> |
||
1006 | Clears and destroys all statements currently prepared |
||
1007 | </summary> |
||
1008 | </member> |
||
1009 | <member name="M:System.Data.SQLite.SQLiteCommand.BuildNextCommand"> |
||
1010 | <summary> |
||
1011 | Builds an array of prepared statements for each complete SQL statement in the command text |
||
1012 | </summary> |
||
1013 | </member> |
||
1014 | <member name="M:System.Data.SQLite.SQLiteCommand.Cancel"> |
||
1015 | <summary> |
||
1016 | Not implemented |
||
1017 | </summary> |
||
1018 | </member> |
||
1019 | <member name="M:System.Data.SQLite.SQLiteCommand.CreateDbParameter"> |
||
1020 | <summary> |
||
1021 | Forwards to the local CreateParameter() function |
||
1022 | </summary> |
||
1023 | <returns></returns> |
||
1024 | </member> |
||
1025 | <member name="M:System.Data.SQLite.SQLiteCommand.CreateParameter"> |
||
1026 | <summary> |
||
1027 | Create a new parameter |
||
1028 | </summary> |
||
1029 | <returns></returns> |
||
1030 | </member> |
||
1031 | <member name="M:System.Data.SQLite.SQLiteCommand.InitializeForReader"> |
||
1032 | <summary> |
||
1033 | This function ensures there are no active readers, that we have a valid connection, |
||
1034 | that the connection is open, that all statements are prepared and all parameters are assigned |
||
1035 | in preparation for allocating a data reader. |
||
1036 | </summary> |
||
1037 | </member> |
||
1038 | <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteDbDataReader(System.Data.CommandBehavior)"> |
||
1039 | <summary> |
||
1040 | Creates a new SQLiteDataReader to execute/iterate the array of SQLite prepared statements |
||
1041 | </summary> |
||
1042 | <param name="behavior">The behavior the data reader should adopt</param> |
||
1043 | <returns>Returns a SQLiteDataReader object</returns> |
||
1044 | </member> |
||
1045 | <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteReader(System.Data.CommandBehavior)"> |
||
1046 | <summary> |
||
1047 | Overrides the default behavior to return a SQLiteDataReader specialization class |
||
1048 | </summary> |
||
1049 | <param name="behavior">The flags to be associated with the reader</param> |
||
1050 | <returns>A SQLiteDataReader</returns> |
||
1051 | </member> |
||
1052 | <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteReader"> |
||
1053 | <summary> |
||
1054 | Overrides the default behavior of DbDataReader to return a specialized SQLiteDataReader class |
||
1055 | </summary> |
||
1056 | <returns>A SQLiteDataReader</returns> |
||
1057 | </member> |
||
1058 | <member name="M:System.Data.SQLite.SQLiteCommand.ClearDataReader"> |
||
1059 | <summary> |
||
1060 | Called by the SQLiteDataReader when the data reader is closed. |
||
1061 | </summary> |
||
1062 | </member> |
||
1063 | <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteNonQuery"> |
||
1064 | <summary> |
||
1065 | Execute the command and return the number of rows inserted/updated affected by it. |
||
1066 | </summary> |
||
1067 | <returns></returns> |
||
1068 | </member> |
||
1069 | <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteScalar"> |
||
1070 | <summary> |
||
1071 | Execute the command and return the first column of the first row of the resultset |
||
1072 | (if present), or null if no resultset was returned. |
||
1073 | </summary> |
||
1074 | <returns>The first column of the first row of the first resultset from the query</returns> |
||
1075 | </member> |
||
1076 | <member name="M:System.Data.SQLite.SQLiteCommand.Prepare"> |
||
1077 | <summary> |
||
1078 | Does nothing. Commands are prepared as they are executed the first time, and kept in prepared state afterwards. |
||
1079 | </summary> |
||
1080 | </member> |
||
1081 | <member name="M:System.Data.SQLite.SQLiteCommand.Clone"> |
||
1082 | <summary> |
||
1083 | Clones a command, including all its parameters |
||
1084 | </summary> |
||
1085 | <returns>A new SQLiteCommand with the same commandtext, connection and parameters</returns> |
||
1086 | </member> |
||
1087 | <member name="P:System.Data.SQLite.SQLiteCommand.CommandText"> |
||
1088 | <summary> |
||
1089 | The SQL command text associated with the command |
||
1090 | </summary> |
||
1091 | </member> |
||
1092 | <member name="P:System.Data.SQLite.SQLiteCommand.CommandTimeout"> |
||
1093 | <summary> |
||
1094 | The amount of time to wait for the connection to become available before erroring out |
||
1095 | </summary> |
||
1096 | </member> |
||
1097 | <member name="P:System.Data.SQLite.SQLiteCommand.CommandType"> |
||
1098 | <summary> |
||
1099 | The type of the command. SQLite only supports CommandType.Text |
||
1100 | </summary> |
||
1101 | </member> |
||
1102 | <member name="P:System.Data.SQLite.SQLiteCommand.Connection"> |
||
1103 | <summary> |
||
1104 | The connection associated with this command |
||
1105 | </summary> |
||
1106 | </member> |
||
1107 | <member name="P:System.Data.SQLite.SQLiteCommand.DbConnection"> |
||
1108 | <summary> |
||
1109 | Forwards to the local Connection property |
||
1110 | </summary> |
||
1111 | </member> |
||
1112 | <member name="P:System.Data.SQLite.SQLiteCommand.Parameters"> |
||
1113 | <summary> |
||
1114 | Returns the SQLiteParameterCollection for the given command |
||
1115 | </summary> |
||
1116 | </member> |
||
1117 | <member name="P:System.Data.SQLite.SQLiteCommand.DbParameterCollection"> |
||
1118 | <summary> |
||
1119 | Forwards to the local Parameters property |
||
1120 | </summary> |
||
1121 | </member> |
||
1122 | <member name="P:System.Data.SQLite.SQLiteCommand.Transaction"> |
||
1123 | <summary> |
||
1124 | The transaction associated with this command. SQLite only supports one transaction per connection, so this property forwards to the |
||
1125 | command's underlying connection. |
||
1126 | </summary> |
||
1127 | </member> |
||
1128 | <member name="P:System.Data.SQLite.SQLiteCommand.DbTransaction"> |
||
1129 | <summary> |
||
1130 | Forwards to the local Transaction property |
||
1131 | </summary> |
||
1132 | </member> |
||
1133 | <member name="P:System.Data.SQLite.SQLiteCommand.UpdatedRowSource"> |
||
1134 | <summary> |
||
1135 | Sets the method the SQLiteCommandBuilder uses to determine how to update inserted or updated rows in a DataTable. |
||
1136 | </summary> |
||
1137 | </member> |
||
1138 | <member name="P:System.Data.SQLite.SQLiteCommand.DesignTimeVisible"> |
||
1139 | <summary> |
||
1140 | Determines if the command is visible at design time. Defaults to True. |
||
1141 | </summary> |
||
1142 | </member> |
||
1143 | <member name="T:System.Data.SQLite.SQLiteCommandBuilder"> |
||
1144 | <summary> |
||
1145 | SQLite implementation of DbCommandBuilder. |
||
1146 | </summary> |
||
1147 | </member> |
||
1148 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.#ctor"> |
||
1149 | <summary> |
||
1150 | Default constructor |
||
1151 | </summary> |
||
1152 | </member> |
||
1153 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.#ctor(System.Data.SQLite.SQLiteDataAdapter)"> |
||
1154 | <summary> |
||
1155 | Initializes the command builder and associates it with the specified data adapter. |
||
1156 | </summary> |
||
1157 | <param name="adp"></param> |
||
1158 | </member> |
||
1159 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.ApplyParameterInfo(System.Data.Common.DbParameter,System.Data.DataRow,System.Data.StatementType,System.Boolean)"> |
||
1160 | <summary> |
||
1161 | Minimal amount of parameter processing. Primarily sets the DbType for the parameter equal to the provider type in the schema |
||
1162 | </summary> |
||
1163 | <param name="parameter">The parameter to use in applying custom behaviors to a row</param> |
||
1164 | <param name="row">The row to apply the parameter to</param> |
||
1165 | <param name="statementType">The type of statement</param> |
||
1166 | <param name="whereClause">Whether the application of the parameter is part of a WHERE clause</param> |
||
1167 | </member> |
||
1168 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterName(System.String)"> |
||
1169 | <summary> |
||
1170 | Returns a valid named parameter |
||
1171 | </summary> |
||
1172 | <param name="parameterName">The name of the parameter</param> |
||
1173 | <returns>Error</returns> |
||
1174 | </member> |
||
1175 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterName(System.Int32)"> |
||
1176 | <summary> |
||
1177 | Returns a named parameter for the given ordinal |
||
1178 | </summary> |
||
1179 | <param name="parameterOrdinal">The i of the parameter</param> |
||
1180 | <returns>Error</returns> |
||
1181 | </member> |
||
1182 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterPlaceholder(System.Int32)"> |
||
1183 | <summary> |
||
1184 | Returns a placeholder character for the specified parameter i. |
||
1185 | </summary> |
||
1186 | <param name="parameterOrdinal">The index of the parameter to provide a placeholder for</param> |
||
1187 | <returns>Returns a named parameter</returns> |
||
1188 | </member> |
||
1189 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.SetRowUpdatingHandler(System.Data.Common.DbDataAdapter)"> |
||
1190 | <summary> |
||
1191 | Sets the handler for receiving row updating events. Used by the DbCommandBuilder to autogenerate SQL |
||
1192 | statements that may not have previously been generated. |
||
1193 | </summary> |
||
1194 | <param name="adapter">A data adapter to receive events on.</param> |
||
1195 | </member> |
||
1196 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetDeleteCommand"> |
||
1197 | <summary> |
||
1198 | Returns the automatically-generated SQLite command to delete rows from the database |
||
1199 | </summary> |
||
1200 | <returns></returns> |
||
1201 | </member> |
||
1202 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetDeleteCommand(System.Boolean)"> |
||
1203 | <summary> |
||
1204 | Returns the automatically-generated SQLite command to delete rows from the database |
||
1205 | </summary> |
||
1206 | <param name="useColumnsForParameterNames"></param> |
||
1207 | <returns></returns> |
||
1208 | </member> |
||
1209 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetUpdateCommand"> |
||
1210 | <summary> |
||
1211 | Returns the automatically-generated SQLite command to update rows in the database |
||
1212 | </summary> |
||
1213 | <returns></returns> |
||
1214 | </member> |
||
1215 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetUpdateCommand(System.Boolean)"> |
||
1216 | <summary> |
||
1217 | Returns the automatically-generated SQLite command to update rows in the database |
||
1218 | </summary> |
||
1219 | <param name="useColumnsForParameterNames"></param> |
||
1220 | <returns></returns> |
||
1221 | </member> |
||
1222 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetInsertCommand"> |
||
1223 | <summary> |
||
1224 | Returns the automatically-generated SQLite command to insert rows into the database |
||
1225 | </summary> |
||
1226 | <returns></returns> |
||
1227 | </member> |
||
1228 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetInsertCommand(System.Boolean)"> |
||
1229 | <summary> |
||
1230 | Returns the automatically-generated SQLite command to insert rows into the database |
||
1231 | </summary> |
||
1232 | <param name="useColumnsForParameterNames"></param> |
||
1233 | <returns></returns> |
||
1234 | </member> |
||
1235 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.QuoteIdentifier(System.String)"> |
||
1236 | <summary> |
||
1237 | Places brackets around an identifier |
||
1238 | </summary> |
||
1239 | <param name="unquotedIdentifier">The identifier to quote</param> |
||
1240 | <returns>The bracketed identifier</returns> |
||
1241 | </member> |
||
1242 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.UnquoteIdentifier(System.String)"> |
||
1243 | <summary> |
||
1244 | Removes brackets around an identifier |
||
1245 | </summary> |
||
1246 | <param name="quotedIdentifier">The quoted (bracketed) identifier</param> |
||
1247 | <returns>The undecorated identifier</returns> |
||
1248 | </member> |
||
1249 | <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetSchemaTable(System.Data.Common.DbCommand)"> |
||
1250 | <summary> |
||
1251 | Override helper, which can help the base command builder choose the right keys for the given query |
||
1252 | </summary> |
||
1253 | <param name="sourceCommand"></param> |
||
1254 | <returns></returns> |
||
1255 | </member> |
||
1256 | <member name="P:System.Data.SQLite.SQLiteCommandBuilder.DataAdapter"> |
||
1257 | <summary> |
||
1258 | Gets/sets the DataAdapter for this CommandBuilder |
||
1259 | </summary> |
||
1260 | </member> |
||
1261 | <member name="P:System.Data.SQLite.SQLiteCommandBuilder.CatalogLocation"> |
||
1262 | <summary> |
||
1263 | Overridden to hide its property from the designer |
||
1264 | </summary> |
||
1265 | </member> |
||
1266 | <member name="P:System.Data.SQLite.SQLiteCommandBuilder.CatalogSeparator"> |
||
1267 | <summary> |
||
1268 | Overridden to hide its property from the designer |
||
1269 | </summary> |
||
1270 | </member> |
||
1271 | <member name="P:System.Data.SQLite.SQLiteCommandBuilder.QuotePrefix"> |
||
1272 | <summary> |
||
1273 | Overridden to hide its property from the designer |
||
1274 | </summary> |
||
1275 | </member> |
||
1276 | <member name="P:System.Data.SQLite.SQLiteCommandBuilder.QuoteSuffix"> |
||
1277 | <summary> |
||
1278 | Overridden to hide its property from the designer |
||
1279 | </summary> |
||
1280 | </member> |
||
1281 | <member name="P:System.Data.SQLite.SQLiteCommandBuilder.SchemaSeparator"> |
||
1282 | <summary> |
||
1283 | Overridden to hide its property from the designer |
||
1284 | </summary> |
||
1285 | </member> |
||
1286 | <member name="T:System.Data.SQLite.ConnectionEventArgs"> |
||
1287 | <summary> |
||
1288 | Event data for connection event handlers. |
||
1289 | </summary> |
||
1290 | </member> |
||
1291 | <member name="F:System.Data.SQLite.ConnectionEventArgs.EventType"> |
||
1292 | <summary> |
||
1293 | The type of event being raised. |
||
1294 | </summary> |
||
1295 | </member> |
||
1296 | <member name="F:System.Data.SQLite.ConnectionEventArgs.EventArgs"> |
||
1297 | <summary> |
||
1298 | The <see cref="T:System.Data.StateChangeEventArgs"/> associated with this event, if any. |
||
1299 | </summary> |
||
1300 | </member> |
||
1301 | <member name="F:System.Data.SQLite.ConnectionEventArgs.Transaction"> |
||
1302 | <summary> |
||
1303 | The transaction associated with this event, if any. |
||
1304 | </summary> |
||
1305 | </member> |
||
1306 | <member name="F:System.Data.SQLite.ConnectionEventArgs.Command"> |
||
1307 | <summary> |
||
1308 | The command associated with this event, if any. |
||
1309 | </summary> |
||
1310 | </member> |
||
1311 | <member name="F:System.Data.SQLite.ConnectionEventArgs.Text"> |
||
1312 | <summary> |
||
1313 | Command or message text associated with this event, if any. |
||
1314 | </summary> |
||
1315 | </member> |
||
1316 | <member name="F:System.Data.SQLite.ConnectionEventArgs.Data"> |
||
1317 | <summary> |
||
1318 | Extra data associated with this event, if any. |
||
1319 | </summary> |
||
1320 | </member> |
||
1321 | <member name="M:System.Data.SQLite.ConnectionEventArgs.#ctor(System.Data.SQLite.SQLiteConnectionEventType,System.Data.StateChangeEventArgs,System.Data.IDbTransaction,System.Data.IDbCommand,System.String,System.Object)"> |
||
1322 | <summary> |
||
1323 | Constructs the object. |
||
1324 | </summary> |
||
1325 | <param name="eventType">The type of event being raised.</param> |
||
1326 | <param name="eventArgs">The base <see cref="F:System.Data.SQLite.ConnectionEventArgs.EventArgs"/> associated |
||
1327 | with this event, if any.</param> |
||
1328 | <param name="transaction">The transaction associated with this event, if any.</param> |
||
1329 | <param name="command">The command associated with this event, if any.</param> |
||
1330 | <param name="text">The command or message text, if any.</param> |
||
1331 | <param name="data">The extra data, if any.</param> |
||
1332 | </member> |
||
1333 | <member name="T:System.Data.SQLite.SQLiteConnectionEventHandler"> |
||
1334 | <summary> |
||
1335 | Raised when an event pertaining to a connection occurs. |
||
1336 | </summary> |
||
1337 | <param name="sender">The connection involved.</param> |
||
1338 | <param name="e">Extra information about the event.</param> |
||
1339 | </member> |
||
1340 | <member name="T:System.Data.SQLite.SQLiteConnection"> |
||
1341 | <summary> |
||
1342 | SQLite implentation of DbConnection. |
||
1343 | </summary> |
||
1344 | <remarks> |
||
1345 | The <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString"/> property can contain the following parameter(s), delimited with a semi-colon: |
||
1346 | <list type="table"> |
||
1347 | <listheader> |
||
1348 | <term>Parameter</term> |
||
1349 | <term>Values</term> |
||
1350 | <term>Required</term> |
||
1351 | <term>Default</term> |
||
1352 | </listheader> |
||
1353 | <item> |
||
1354 | <description>Data Source</description> |
||
1355 | <description>This may be a file name, the string ":memory:", or any supported URI (starting with SQLite 3.7.7).</description> |
||
1356 | <description>Y</description> |
||
1357 | <description></description> |
||
1358 | </item> |
||
1359 | <item> |
||
1360 | <description>Version</description> |
||
1361 | <description>3</description> |
||
1362 | <description>N</description> |
||
1363 | <description>3</description> |
||
1364 | </item> |
||
1365 | <item> |
||
1366 | <description>UseUTF16Encoding</description> |
||
1367 | <description><b>True</b><br/><b>False</b></description> |
||
1368 | <description>N</description> |
||
1369 | <description>False</description> |
||
1370 | </item> |
||
1371 | <item> |
||
1372 | <description>DateTimeFormat</description> |
||
1373 | <description> |
||
1374 | <b>Ticks</b> - Use the value of DateTime.Ticks.<br/> |
||
1375 | <b>ISO8601</b> - Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC |
||
1376 | DateTime values and "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values).<br/> |
||
1377 | <b>JulianDay</b> - The interval of time in days and fractions of a day since January 1, 4713 BC.<br/> |
||
1378 | <b>UnixEpoch</b> - The whole number of seconds since the Unix epoch (January 1, 1970).<br/> |
||
1379 | <b>InvariantCulture</b> - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime.<br/> |
||
1380 | <b>CurrentCulture</b> - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture.</description> |
||
1381 | <description>N</description> |
||
1382 | <description>ISO8601</description> |
||
1383 | </item> |
||
1384 | <item> |
||
1385 | <description>DateTimeKind</description> |
||
1386 | <description><b>Unspecified</b> - Not specified as either UTC or local time.<br/><b>Utc</b> - The time represented is UTC.<br/><b>Local</b> - The time represented is local time.</description> |
||
1387 | <description>N</description> |
||
1388 | <description>Unspecified</description> |
||
1389 | </item> |
||
1390 | <item> |
||
1391 | <description>BaseSchemaName</description> |
||
1392 | <description>Some base data classes in the framework (e.g. those that build SQL queries dynamically) |
||
1393 | assume that an ADO.NET provider cannot support an alternate catalog (i.e. database) without supporting |
||
1394 | alternate schemas as well; however, SQLite does not fit into this model. Therefore, this value is used |
||
1395 | as a placeholder and removed prior to preparing any SQL statements that may contain it.</description> |
||
1396 | <description>N</description> |
||
1397 | <description>sqlite_default_schema</description> |
||
1398 | </item> |
||
1399 | <item> |
||
1400 | <description>BinaryGUID</description> |
||
1401 | <description><b>True</b> - Store GUID columns in binary form<br/><b>False</b> - Store GUID columns as text</description> |
||
1402 | <description>N</description> |
||
1403 | <description>True</description> |
||
1404 | </item> |
||
1405 | <item> |
||
1406 | <description>Cache Size</description> |
||
1407 | <description>{size in bytes}</description> |
||
1408 | <description>N</description> |
||
1409 | <description>2000</description> |
||
1410 | </item> |
||
1411 | <item> |
||
1412 | <description>Synchronous</description> |
||
1413 | <description><b>Normal</b> - Normal file flushing behavior<br/><b>Full</b> - Full flushing after all writes<br/><b>Off</b> - Underlying OS flushes I/O's</description> |
||
1414 | <description>N</description> |
||
1415 | <description>Full</description> |
||
1416 | </item> |
||
1417 | <item> |
||
1418 | <description>Page Size</description> |
||
1419 | <description>{size in bytes}</description> |
||
1420 | <description>N</description> |
||
1421 | <description>1024</description> |
||
1422 | </item> |
||
1423 | <item> |
||
1424 | <description>Password</description> |
||
1425 | <description>{password} - Using this parameter requires that the CryptoAPI based codec be enabled at compile-time for both the native interop assembly and the core managed assemblies; otherwise, using this parameter may result in an exception being thrown when attempting to open the connection.</description> |
||
1426 | <description>N</description> |
||
1427 | <description></description> |
||
1428 | </item> |
||
1429 | <item> |
||
1430 | <description>Enlist</description> |
||
1431 | <description><b>Y</b> - Automatically enlist in distributed transactions<br/><b>N</b> - No automatic enlistment</description> |
||
1432 | <description>N</description> |
||
1433 | <description>Y</description> |
||
1434 | </item> |
||
1435 | <item> |
||
1436 | <description>Pooling</description> |
||
1437 | <description><b>True</b> - Use connection pooling<br/><b>False</b> - Do not use connection pooling</description> |
||
1438 | <description>N</description> |
||
1439 | <description>False</description> |
||
1440 | </item> |
||
1441 | <item> |
||
1442 | <description>FailIfMissing</description> |
||
1443 | <description><b>True</b> - Don't create the database if it does not exist, throw an error instead<br/><b>False</b> - Automatically create the database if it does not exist</description> |
||
1444 | <description>N</description> |
||
1445 | <description>False</description> |
||
1446 | </item> |
||
1447 | <item> |
||
1448 | <description>Max Page Count</description> |
||
1449 | <description>{size in pages} - Limits the maximum number of pages (limits the size) of the database</description> |
||
1450 | <description>N</description> |
||
1451 | <description>0</description> |
||
1452 | </item> |
||
1453 | <item> |
||
1454 | <description>Legacy Format</description> |
||
1455 | <description><b>True</b> - Use the more compatible legacy 3.x database format<br/><b>False</b> - Use the newer 3.3x database format which compresses numbers more effectively</description> |
||
1456 | <description>N</description> |
||
1457 | <description>False</description> |
||
1458 | </item> |
||
1459 | <item> |
||
1460 | <description>Default Timeout</description> |
||
1461 | <description>{time in seconds}<br/>The default command timeout</description> |
||
1462 | <description>N</description> |
||
1463 | <description>30</description> |
||
1464 | </item> |
||
1465 | <item> |
||
1466 | <description>Journal Mode</description> |
||
1467 | <description><b>Delete</b> - Delete the journal file after a commit<br/><b>Persist</b> - Zero out and leave the journal file on disk after a commit<br/><b>Off</b> - Disable the rollback journal entirely</description> |
||
1468 | <description>N</description> |
||
1469 | <description>Delete</description> |
||
1470 | </item> |
||
1471 | <item> |
||
1472 | <description>Read Only</description> |
||
1473 | <description><b>True</b> - Open the database for read only access<br/><b>False</b> - Open the database for normal read/write access</description> |
||
1474 | <description>N</description> |
||
1475 | <description>False</description> |
||
1476 | </item> |
||
1477 | <item> |
||
1478 | <description>Max Pool Size</description> |
||
1479 | <description>The maximum number of connections for the given connection string that can be in the connection pool</description> |
||
1480 | <description>N</description> |
||
1481 | <description>100</description> |
||
1482 | </item> |
||
1483 | <item> |
||
1484 | <description>Default IsolationLevel</description> |
||
1485 | <description>The default transaciton isolation level</description> |
||
1486 | <description>N</description> |
||
1487 | <description>Serializable</description> |
||
1488 | </item> |
||
1489 | <item> |
||
1490 | <description>Foreign Keys</description> |
||
1491 | <description>Enable foreign key constraints</description> |
||
1492 | <description>N</description> |
||
1493 | <description>False</description> |
||
1494 | </item> |
||
1495 | <item> |
||
1496 | <description>Flags</description> |
||
1497 | <description>Extra behavioral flags for the connection. See the <see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> enumeration for possible values.</description> |
||
1498 | <description>N</description> |
||
1499 | <description>Default</description> |
||
1500 | </item> |
||
1501 | <item> |
||
1502 | <description>SetDefaults</description> |
||
1503 | <description> |
||
1504 | <b>True</b> - Apply the default connection settings to the opened database.<br/> |
||
1505 | <b>False</b> - Skip applying the default connection settings to the opened database. |
||
1506 | </description> |
||
1507 | <description>N</description> |
||
1508 | <description>True</description> |
||
1509 | </item> |
||
1510 | <item> |
||
1511 | <description>ToFullPath</description> |
||
1512 | <description> |
||
1513 | <b>True</b> - Attempt to expand the data source file name to a fully qualified path before opening.<br/> |
||
1514 | <b>False</b> - Skip attempting to expand the data source file name to a fully qualified path before opening. |
||
1515 | </description> |
||
1516 | <description>N</description> |
||
1517 | <description>True</description> |
||
1518 | </item> |
||
1519 | </list> |
||
1520 | </remarks> |
||
1521 | </member> |
||
1522 | <member name="F:System.Data.SQLite.SQLiteConnection.DefaultBaseSchemaName"> |
||
1523 | <summary> |
||
1524 | The default "stub" (i.e. placeholder) base schema name to use when |
||
1525 | returning column schema information. Used as the initial value of |
||
1526 | the BaseSchemaName property. This should start with "sqlite_*" |
||
1527 | because those names are reserved for use by SQLite (i.e. they cannot |
||
1528 | be confused with the names of user objects). |
||
1529 | </summary> |
||
1530 | </member> |
||
1531 | <member name="F:System.Data.SQLite.SQLiteConnection._syncRoot"> |
||
1532 | <summary> |
||
1533 | Object used to synchronize access to the static instance data |
||
1534 | for this class. |
||
1535 | </summary> |
||
1536 | </member> |
||
1537 | <member name="F:System.Data.SQLite.SQLiteConnection._connectionState"> |
||
1538 | <summary> |
||
1539 | State of the current connection |
||
1540 | </summary> |
||
1541 | </member> |
||
1542 | <member name="F:System.Data.SQLite.SQLiteConnection._connectionString"> |
||
1543 | <summary> |
||
1544 | The connection string |
||
1545 | </summary> |
||
1546 | </member> |
||
1547 | <member name="F:System.Data.SQLite.SQLiteConnection._transactionLevel"> |
||
1548 | <summary> |
||
1549 | Nesting level of the transactions open on the connection |
||
1550 | </summary> |
||
1551 | </member> |
||
1552 | <member name="F:System.Data.SQLite.SQLiteConnection._disposing"> |
||
1553 | <summary> |
||
1554 | If set, then the connection is currently being disposed. |
||
1555 | </summary> |
||
1556 | </member> |
||
1557 | <member name="F:System.Data.SQLite.SQLiteConnection._defaultIsolation"> |
||
1558 | <summary> |
||
1559 | The default isolation level for new transactions |
||
1560 | </summary> |
||
1561 | </member> |
||
1562 | <member name="F:System.Data.SQLite.SQLiteConnection._sql"> |
||
1563 | <summary> |
||
1564 | The base SQLite object to interop with |
||
1565 | </summary> |
||
1566 | </member> |
||
1567 | <member name="F:System.Data.SQLite.SQLiteConnection._dataSource"> |
||
1568 | <summary> |
||
1569 | The database filename minus path and extension |
||
1570 | </summary> |
||
1571 | </member> |
||
1572 | <member name="F:System.Data.SQLite.SQLiteConnection._password"> |
||
1573 | <summary> |
||
1574 | Temporary password storage, emptied after the database has been opened |
||
1575 | </summary> |
||
1576 | </member> |
||
1577 | <member name="F:System.Data.SQLite.SQLiteConnection._baseSchemaName"> |
||
1578 | <summary> |
||
1579 | The "stub" (i.e. placeholder) base schema name to use when returning |
||
1580 | column schema information. |
||
1581 | </summary> |
||
1582 | </member> |
||
1583 | <member name="F:System.Data.SQLite.SQLiteConnection._flags"> |
||
1584 | <summary> |
||
1585 | The extra behavioral flags for this connection, if any. See the |
||
1586 | <see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> enumeration for a list of |
||
1587 | possible values. |
||
1588 | </summary> |
||
1589 | </member> |
||
1590 | <member name="F:System.Data.SQLite.SQLiteConnection._defaultTimeout"> |
||
1591 | <summary> |
||
1592 | Default command timeout |
||
1593 | </summary> |
||
1594 | </member> |
||
1595 | <member name="F:System.Data.SQLite.SQLiteConnection._parseViaFramework"> |
||
1596 | <summary> |
||
1597 | Non-zero if the built-in (i.e. framework provided) connection string |
||
1598 | parser should be used when opening the connection. |
||
1599 | </summary> |
||
1600 | </member> |
||
1601 | <member name="M:System.Data.SQLite.SQLiteConnection.#ctor"> |
||
1602 | <overloads> |
||
1603 | Constructs a new SQLiteConnection object |
||
1604 | </overloads> |
||
1605 | <summary> |
||
1606 | Default constructor |
||
1607 | </summary> |
||
1608 | </member> |
||
1609 | <member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.String)"> |
||
1610 | <summary> |
||
1611 | Initializes the connection with the specified connection string. |
||
1612 | </summary> |
||
1613 | <param name="connectionString">The connection string to use.</param> |
||
1614 | </member> |
||
1615 | <member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.String,System.Boolean)"> |
||
1616 | <summary> |
||
1617 | Initializes the connection with the specified connection string. |
||
1618 | </summary> |
||
1619 | <param name="connectionString"> |
||
1620 | The connection string to use on. |
||
1621 | </param> |
||
1622 | <param name="parseViaFramework"> |
||
1623 | Non-zero to parse the connection string using the built-in (i.e. |
||
1624 | framework provided) parser when opening the connection. |
||
1625 | </param> |
||
1626 | </member> |
||
1627 | <member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.Data.SQLite.SQLiteConnection)"> |
||
1628 | <summary> |
||
1629 | Clones the settings and connection string from an existing connection. If the existing connection is already open, this |
||
1630 | function will open its own connection, enumerate any attached databases of the original connection, and automatically |
||
1631 | attach to them. |
||
1632 | </summary> |
||
1633 | <param name="connection">The connection to copy the settings from.</param> |
||
1634 | </member> |
||
1635 | <member name="M:System.Data.SQLite.SQLiteConnection.OnChanged(System.Data.SQLite.SQLiteConnection,System.Data.SQLite.ConnectionEventArgs)"> |
||
1636 | <summary> |
||
1637 | Raises the <see cref="E:System.Data.SQLite.SQLiteConnection.Changed"/> event. |
||
1638 | </summary> |
||
1639 | <param name="connection"> |
||
1640 | The connection associated with this event. |
||
1641 | </param> |
||
1642 | <param name="e"> |
||
1643 | A <see cref="T:System.Data.SQLite.ConnectionEventArgs"/> that contains the event data. |
||
1644 | </param> |
||
1645 | </member> |
||
1646 | <member name="M:System.Data.SQLite.SQLiteConnection.BackupDatabase(System.Data.SQLite.SQLiteConnection,System.String,System.String,System.Int32,System.Data.SQLite.SQLiteBackupCallback,System.Int32)"> |
||
1647 | <summary> |
||
1648 | Backs up the database, using the specified database connection as the |
||
1649 | destination. |
||
1650 | </summary> |
||
1651 | <param name="destination">The destination database connection.</param> |
||
1652 | <param name="destinationName">The destination database name.</param> |
||
1653 | <param name="sourceName">The source database name.</param> |
||
1654 | <param name="pages"> |
||
1655 | The number of pages to copy or negative to copy all remaining pages. |
||
1656 | </param> |
||
1657 | <param name="callback"> |
||
1658 | The method to invoke between each step of the backup process. This |
||
1659 | parameter may be null (i.e. no callbacks will be performed). |
||
1660 | </param> |
||
1661 | <param name="retryMilliseconds"> |
||
1662 | The number of milliseconds to sleep after encountering a locking error |
||
1663 | during the backup process. A value less than zero means that no sleep |
||
1664 | should be performed. |
||
1665 | </param> |
||
1666 | </member> |
||
1667 | <member name="M:System.Data.SQLite.SQLiteConnection.Clone"> |
||
1668 | <summary> |
||
1669 | Creates a clone of the connection. All attached databases and user-defined functions are cloned. If the existing connection is open, the cloned connection |
||
1670 | will also be opened. |
||
1671 | </summary> |
||
1672 | <returns></returns> |
||
1673 | </member> |
||
1674 | <member name="M:System.Data.SQLite.SQLiteConnection.CreateFile(System.String)"> |
||
1675 | <summary> |
||
1676 | Creates a database file. This just creates a zero-byte file which SQLite |
||
1677 | will turn into a database when the file is opened properly. |
||
1678 | </summary> |
||
1679 | <param name="databaseFileName">The file to create</param> |
||
1680 | </member> |
||
1681 | <member name="M:System.Data.SQLite.SQLiteConnection.OnStateChange(System.Data.ConnectionState,System.Data.StateChangeEventArgs@)"> |
||
1682 | <summary> |
||
1683 | Raises the state change event when the state of the connection changes |
||
1684 | </summary> |
||
1685 | <param name="newState">The new connection state. If this is different |
||
1686 | from the previous state, the <see cref="E:System.Data.SQLite.SQLiteConnection.StateChange"/> event is |
||
1687 | raised.</param> |
||
1688 | <param name="eventArgs">The event data created for the raised event, if |
||
1689 | it was actually raised.</param> |
||
1690 | </member> |
||
1691 | <member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel,System.Boolean)"> |
||
1692 | <summary> |
||
1693 | OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection. |
||
1694 | </summary> |
||
1695 | <param name="isolationLevel">This parameter is ignored.</param> |
||
1696 | <param name="deferredLock">When TRUE, SQLite defers obtaining a write lock until a write operation is requested. |
||
1697 | When FALSE, a writelock is obtained immediately. The default is TRUE, but in a multi-threaded multi-writer |
||
1698 | environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock.</param> |
||
1699 | <returns>Returns a SQLiteTransaction object.</returns> |
||
1700 | </member> |
||
1701 | <member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Boolean)"> |
||
1702 | <summary> |
||
1703 | OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection. |
||
1704 | </summary> |
||
1705 | <param name="deferredLock">When TRUE, SQLite defers obtaining a write lock until a write operation is requested. |
||
1706 | When FALSE, a writelock is obtained immediately. The default is false, but in a multi-threaded multi-writer |
||
1707 | environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock.</param> |
||
1708 | <returns>Returns a SQLiteTransaction object.</returns> |
||
1709 | </member> |
||
1710 | <member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel)"> |
||
1711 | <summary> |
||
1712 | Creates a new <see cref="T:System.Data.SQLite.SQLiteTransaction"/> if one isn't already active on the connection. |
||
1713 | </summary> |
||
1714 | <param name="isolationLevel">Supported isolation levels are Serializable, ReadCommitted and Unspecified.</param> |
||
1715 | <remarks> |
||
1716 | Unspecified will use the default isolation level specified in the connection string. If no isolation level is specified in the |
||
1717 | connection string, Serializable is used. |
||
1718 | Serializable transactions are the default. In this mode, the engine gets an immediate lock on the database, and no other threads |
||
1719 | may begin a transaction. Other threads may read from the database, but not write. |
||
1720 | With a ReadCommitted isolation level, locks are deferred and elevated as needed. It is possible for multiple threads to start |
||
1721 | a transaction in ReadCommitted mode, but if a thread attempts to commit a transaction while another thread |
||
1722 | has a ReadCommitted lock, it may timeout or cause a deadlock on both threads until both threads' CommandTimeout's are reached. |
||
1723 | </remarks> |
||
1724 | <returns>Returns a SQLiteTransaction object.</returns> |
||
1725 | </member> |
||
1726 | <member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction"> |
||
1727 | <summary> |
||
1728 | Creates a new <see cref="T:System.Data.SQLite.SQLiteTransaction"/> if one isn't already |
||
1729 | active on the connection. |
||
1730 | </summary> |
||
1731 | <returns>Returns the new transaction object.</returns> |
||
1732 | </member> |
||
1733 | <member name="M:System.Data.SQLite.SQLiteConnection.BeginDbTransaction(System.Data.IsolationLevel)"> |
||
1734 | <summary> |
||
1735 | Forwards to the local <see cref="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel)"/> function |
||
1736 | </summary> |
||
1737 | <param name="isolationLevel">Supported isolation levels are Unspecified, Serializable, and ReadCommitted</param> |
||
1738 | <returns></returns> |
||
1739 | </member> |
||
1740 | <member name="M:System.Data.SQLite.SQLiteConnection.ChangeDatabase(System.String)"> |
||
1741 | <summary> |
||
1742 | This method is not implemented; however, the <see cref="E:System.Data.SQLite.SQLiteConnection.Changed"/> |
||
1743 | event will still be raised. |
||
1744 | </summary> |
||
1745 | <param name="databaseName"></param> |
||
1746 | </member> |
||
1747 | <member name="M:System.Data.SQLite.SQLiteConnection.Close"> |
||
1748 | <summary> |
||
1749 | When the database connection is closed, all commands linked to this connection are automatically reset. |
||
1750 | </summary> |
||
1751 | </member> |
||
1752 | <member name="M:System.Data.SQLite.SQLiteConnection.ClearPool(System.Data.SQLite.SQLiteConnection)"> |
||
1753 | <summary> |
||
1754 | Clears the connection pool associated with the connection. Any other active connections using the same database file |
||
1755 | will be discarded instead of returned to the pool when they are closed. |
||
1756 | </summary> |
||
1757 | <param name="connection"></param> |
||
1758 | </member> |
||
1759 | <member name="M:System.Data.SQLite.SQLiteConnection.ClearAllPools"> |
||
1760 | <summary> |
||
1761 | Clears all connection pools. Any active connections will be discarded instead of sent to the pool when they are closed. |
||
1762 | </summary> |
||
1763 | </member> |
||
1764 | <member name="M:System.Data.SQLite.SQLiteConnection.CreateCommand"> |
||
1765 | <summary> |
||
1766 | Create a new <see cref="T:System.Data.SQLite.SQLiteCommand"/> and associate it with this connection. |
||
1767 | </summary> |
||
1768 | <returns>Returns a new command object already assigned to this connection.</returns> |
||
1769 | </member> |
||
1770 | <member name="M:System.Data.SQLite.SQLiteConnection.CreateDbCommand"> |
||
1771 | <summary> |
||
1772 | Forwards to the local <see cref="M:System.Data.SQLite.SQLiteConnection.CreateCommand"/> function. |
||
1773 | </summary> |
||
1774 | <returns></returns> |
||
1775 | </member> |
||
1776 | <member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionString(System.String)"> |
||
1777 | <summary> |
||
1778 | Parses the connection string into component parts using the custom |
||
1779 | connection string parser. |
||
1780 | </summary> |
||
1781 | <param name="connectionString">The connection string to parse</param> |
||
1782 | <returns>An array of key-value pairs representing each parameter of the connection string</returns> |
||
1783 | </member> |
||
1784 | <member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionStringViaFramework(System.String,System.Boolean)"> |
||
1785 | <summary> |
||
1786 | Parses a connection string using the built-in (i.e. framework provided) |
||
1787 | connection string parser class and returns the key/value pairs. An |
||
1788 | exception may be thrown if the connection string is invalid or cannot be |
||
1789 | parsed. When compiled for the .NET Compact Framework, the custom |
||
1790 | connection string parser is always used instead because the framework |
||
1791 | provided one is unavailable there. |
||
1792 | </summary> |
||
1793 | <param name="connectionString"> |
||
1794 | The connection string to parse. |
||
1795 | </param> |
||
1796 | <param name="strict"> |
||
1797 | Non-zero to throw an exception if any connection string values are not of |
||
1798 | the <see cref="T:System.String"/> type. |
||
1799 | </param> |
||
1800 | <returns>The list of key/value pairs.</returns> |
||
1801 | </member> |
||
1802 | <member name="M:System.Data.SQLite.SQLiteConnection.FindKey(System.Collections.Generic.SortedList{System.String,System.String},System.String,System.String)"> |
||
1803 | <summary> |
||
1804 | Looks for a key in the array of key/values of the parameter string. If not found, return the specified default value |
||
1805 | </summary> |
||
1806 | <param name="items">The list to look in</param> |
||
1807 | <param name="key">The key to find</param> |
||
1808 | <param name="defValue">The default value to return if the key is not found</param> |
||
1809 | <returns>The value corresponding to the specified key, or the default value if not found.</returns> |
||
1810 | </member> |
||
1811 | <member name="M:System.Data.SQLite.SQLiteConnection.TryParseEnum(System.Type,System.String,System.Boolean)"> |
||
1812 | <summary> |
||
1813 | Attempts to convert the string value to an enumerated value of the specified type. |
||
1814 | </summary> |
||
1815 | <param name="type">The enumerated type to convert the string value to.</param> |
||
1816 | <param name="value">The string value to be converted.</param> |
||
1817 | <param name="ignoreCase">Non-zero to make the conversion case-insensitive.</param> |
||
1818 | <returns>The enumerated value upon success or null upon error.</returns> |
||
1819 | </member> |
||
1820 | <member name="M:System.Data.SQLite.SQLiteConnection.EnableExtensions(System.Boolean)"> |
||
1821 | <summary> |
||
1822 | Enables or disabled extension loading. |
||
1823 | </summary> |
||
1824 | <param name="enable"> |
||
1825 | True to enable loading of extensions, false to disable. |
||
1826 | </param> |
||
1827 | </member> |
||
1828 | <member name="M:System.Data.SQLite.SQLiteConnection.LoadExtension(System.String)"> |
||
1829 | <summary> |
||
1830 | Loads a SQLite extension library from the named dynamic link library file. |
||
1831 | </summary> |
||
1832 | <param name="fileName"> |
||
1833 | The name of the dynamic link library file containing the extension. |
||
1834 | </param> |
||
1835 | </member> |
||
1836 | <member name="M:System.Data.SQLite.SQLiteConnection.LoadExtension(System.String,System.String)"> |
||
1837 | <summary> |
||
1838 | Loads a SQLite extension library from the named dynamic link library file. |
||
1839 | </summary> |
||
1840 | <param name="fileName"> |
||
1841 | The name of the dynamic link library file containing the extension. |
||
1842 | </param> |
||
1843 | <param name="procName"> |
||
1844 | The name of the exported function used to initialize the extension. |
||
1845 | If null, the default "sqlite3_extension_init" will be used. |
||
1846 | </param> |
||
1847 | </member> |
||
1848 | <member name="M:System.Data.SQLite.SQLiteConnection.Open"> |
||
1849 | <summary> |
||
1850 | Opens the connection using the parameters found in the <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString"/>. |
||
1851 | </summary> |
||
1852 | </member> |
||
1853 | <member name="M:System.Data.SQLite.SQLiteConnection.OpenAndReturn"> |
||
1854 | <summary> |
||
1855 | Opens the connection using the parameters found in the <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString"/> and then returns it. |
||
1856 | </summary> |
||
1857 | <returns>The current connection object.</returns> |
||
1858 | </member> |
||
1859 | <member name="M:System.Data.SQLite.SQLiteConnection.Cancel"> |
||
1860 | <summary> |
||
1861 | This method causes any pending database operation to abort and return at |
||
1862 | its earliest opportunity. This routine is typically called in response |
||
1863 | to a user action such as pressing "Cancel" or Ctrl-C where the user wants |
||
1864 | a long query operation to halt immediately. It is safe to call this |
||
1865 | routine from any thread. However, it is not safe to call this routine |
||
1866 | with a database connection that is closed or might close before this method |
||
1867 | returns. |
||
1868 | </summary> |
||
1869 | </member> |
||
1870 | <member name="M:System.Data.SQLite.SQLiteConnection.SetMemoryStatus(System.Boolean)"> |
||
1871 | <summary> |
||
1872 | Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled. |
||
1873 | If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is |
||
1874 | global to the process. |
||
1875 | </summary> |
||
1876 | <param name="value">Non-zero to enable memory usage tracking, zero otherwise.</param> |
||
1877 | <returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns> |
||
1878 | </member> |
||
1879 | <member name="M:System.Data.SQLite.SQLiteConnection.Shutdown"> |
||
1880 | Passes a shutdown request off to SQLite. |
||
1881 | </member> |
||
1882 | <member name="M:System.Data.SQLite.SQLiteConnection.SetExtendedResultCodes(System.Boolean)"> |
||
1883 | Enables or disabled extended result codes returned by SQLite |
||
1884 | </member> |
||
1885 | <member name="M:System.Data.SQLite.SQLiteConnection.ResultCode"> |
||
1886 | Enables or disabled extended result codes returned by SQLite |
||
1887 | </member> |
||
1888 | <member name="M:System.Data.SQLite.SQLiteConnection.ExtendedResultCode"> |
||
1889 | Enables or disabled extended result codes returned by SQLite |
||
1890 | </member> |
||
1891 | <member name="M:System.Data.SQLite.SQLiteConnection.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)"> |
||
1892 | Add a log message via the SQLite sqlite3_log interface. |
||
1893 | </member> |
||
1894 | <member name="M:System.Data.SQLite.SQLiteConnection.LogMessage(System.Int32,System.String)"> |
||
1895 | Add a log message via the SQLite sqlite3_log interface. |
||
1896 | </member> |
||
1897 | <member name="M:System.Data.SQLite.SQLiteConnection.ChangePassword(System.String)"> |
||
1898 | <summary> |
||
1899 | Change the password (or assign a password) to an open database. |
||
1900 | </summary> |
||
1901 | <remarks> |
||
1902 | No readers or writers may be active for this process. The database must already be open |
||
1903 | and if it already was password protected, the existing password must already have been supplied. |
||
1904 | </remarks> |
||
1905 | <param name="newPassword">The new password to assign to the database</param> |
||
1906 | </member> |
||
1907 | <member name="M:System.Data.SQLite.SQLiteConnection.ChangePassword(System.Byte[])"> |
||
1908 | <summary> |
||
1909 | Change the password (or assign a password) to an open database. |
||
1910 | </summary> |
||
1911 | <remarks> |
||
1912 | No readers or writers may be active for this process. The database must already be open |
||
1913 | and if it already was password protected, the existing password must already have been supplied. |
||
1914 | </remarks> |
||
1915 | <param name="newPassword">The new password to assign to the database</param> |
||
1916 | </member> |
||
1917 | <member name="M:System.Data.SQLite.SQLiteConnection.SetPassword(System.String)"> |
||
1918 | <summary> |
||
1919 | Sets the password for a password-protected database. A password-protected database is |
||
1920 | unusable for any operation until the password has been set. |
||
1921 | </summary> |
||
1922 | <param name="databasePassword">The password for the database</param> |
||
1923 | </member> |
||
1924 | <member name="M:System.Data.SQLite.SQLiteConnection.SetPassword(System.Byte[])"> |
||
1925 | <summary> |
||
1926 | Sets the password for a password-protected database. A password-protected database is |
||
1927 | unusable for any operation until the password has been set. |
||
1928 | </summary> |
||
1929 | <param name="databasePassword">The password for the database</param> |
||
1930 | </member> |
||
1931 | <member name="M:System.Data.SQLite.SQLiteConnection.SetAvRetry(System.Int32@,System.Int32@)"> |
||
1932 | <summary> |
||
1933 | Queries or modifies the number of retries or the retry interval (in milliseconds) for |
||
1934 | certain I/O operations that may fail due to anti-virus software. |
||
1935 | </summary> |
||
1936 | <param name="count">The number of times to retry the I/O operation. A negative value |
||
1937 | will cause the current count to be queried and replace that negative value.</param> |
||
1938 | <param name="interval">The number of milliseconds to wait before retrying the I/O |
||
1939 | operation. This number is multiplied by the number of retry attempts so far to come |
||
1940 | up with the final number of milliseconds to wait. A negative value will cause the |
||
1941 | current interval to be queried and replace that negative value.</param> |
||
1942 | <returns>Zero for success, non-zero for error.</returns> |
||
1943 | </member> |
||
1944 | <member name="M:System.Data.SQLite.SQLiteConnection.UnwrapString(System.String)"> |
||
1945 | <summary> |
||
1946 | Removes one set of surrounding single -OR- double quotes from the string |
||
1947 | value and returns the resulting string value. If the string is null, empty, |
||
1948 | or contains quotes that are not balanced, nothing is done and the original |
||
1949 | string value will be returned. |
||
1950 | </summary> |
||
1951 | <param name="value">The string value to process.</param> |
||
1952 | <returns> |
||
1953 | The string value, modified to remove one set of surrounding single -OR- |
||
1954 | double quotes, if applicable. |
||
1955 | </returns> |
||
1956 | </member> |
||
1957 | <member name="M:System.Data.SQLite.SQLiteConnection.ExpandFileName(System.String,System.Boolean)"> |
||
1958 | <summary> |
||
1959 | Expand the filename of the data source, resolving the |DataDirectory| |
||
1960 | macro as appropriate. |
||
1961 | </summary> |
||
1962 | <param name="sourceFile">The database filename to expand</param> |
||
1963 | <param name="toFullPath"> |
||
1964 | Non-zero if the returned file name should be converted to a full path |
||
1965 | (except when using the .NET Compact Framework). |
||
1966 | </param> |
||
1967 | <returns>The expanded path and filename of the filename</returns> |
||
1968 | </member> |
||
1969 | <member name="M:System.Data.SQLite.SQLiteConnection.GetSchema"> |
||
1970 | <overloads> |
||
1971 | The following commands are used to extract schema information out of the database. Valid schema types are: |
||
1972 | <list type="bullet"> |
||
1973 | <item> |
||
1974 | <description>MetaDataCollections</description> |
||
1975 | </item> |
||
1976 | <item> |
||
1977 | <description>DataSourceInformation</description> |
||
1978 | </item> |
||
1979 | <item> |
||
1980 | <description>Catalogs</description> |
||
1981 | </item> |
||
1982 | <item> |
||
1983 | <description>Columns</description> |
||
1984 | </item> |
||
1985 | <item> |
||
1986 | <description>ForeignKeys</description> |
||
1987 | </item> |
||
1988 | <item> |
||
1989 | <description>Indexes</description> |
||
1990 | </item> |
||
1991 | <item> |
||
1992 | <description>IndexColumns</description> |
||
1993 | </item> |
||
1994 | <item> |
||
1995 | <description>Tables</description> |
||
1996 | </item> |
||
1997 | <item> |
||
1998 | <description>Views</description> |
||
1999 | </item> |
||
2000 | <item> |
||
2001 | <description>ViewColumns</description> |
||
2002 | </item> |
||
2003 | </list> |
||
2004 | </overloads> |
||
2005 | <summary> |
||
2006 | Returns the MetaDataCollections schema |
||
2007 | </summary> |
||
2008 | <returns>A DataTable of the MetaDataCollections schema</returns> |
||
2009 | </member> |
||
2010 | <member name="M:System.Data.SQLite.SQLiteConnection.GetSchema(System.String)"> |
||
2011 | <summary> |
||
2012 | Returns schema information of the specified collection |
||
2013 | </summary> |
||
2014 | <param name="collectionName">The schema collection to retrieve</param> |
||
2015 | <returns>A DataTable of the specified collection</returns> |
||
2016 | </member> |
||
2017 | <member name="M:System.Data.SQLite.SQLiteConnection.GetSchema(System.String,System.String[])"> |
||
2018 | <summary> |
||
2019 | Retrieves schema information using the specified constraint(s) for the specified collection |
||
2020 | </summary> |
||
2021 | <param name="collectionName">The collection to retrieve</param> |
||
2022 | <param name="restrictionValues">The restrictions to impose</param> |
||
2023 | <returns>A DataTable of the specified collection</returns> |
||
2024 | </member> |
||
2025 | <member name="M:System.Data.SQLite.SQLiteConnection.Schema_MetaDataCollections"> |
||
2026 | <summary> |
||
2027 | Builds a MetaDataCollections schema datatable |
||
2028 | </summary> |
||
2029 | <returns>DataTable</returns> |
||
2030 | </member> |
||
2031 | <member name="M:System.Data.SQLite.SQLiteConnection.Schema_DataSourceInformation"> |
||
2032 | <summary> |
||
2033 | Builds a DataSourceInformation datatable |
||
2034 | </summary> |
||
2035 | <returns>DataTable</returns> |
||
2036 | </member> |
||
2037 | <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Columns(System.String,System.String,System.String)"> |
||
2038 | <summary> |
||
2039 | Build a Columns schema |
||
2040 | </summary> |
||
2041 | <param name="strCatalog">The catalog (attached database) to query, can be null</param> |
||
2042 | <param name="strTable">The table to retrieve schema information for, must not be null</param> |
||
2043 | <param name="strColumn">The column to retrieve schema information for, can be null</param> |
||
2044 | <returns>DataTable</returns> |
||
2045 | </member> |
||
2046 | <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Indexes(System.String,System.String,System.String)"> |
||
2047 | <summary> |
||
2048 | Returns index information for the given database and catalog |
||
2049 | </summary> |
||
2050 | <param name="strCatalog">The catalog (attached database) to query, can be null</param> |
||
2051 | <param name="strIndex">The name of the index to retrieve information for, can be null</param> |
||
2052 | <param name="strTable">The table to retrieve index information for, can be null</param> |
||
2053 | <returns>DataTable</returns> |
||
2054 | </member> |
||
2055 | <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Tables(System.String,System.String,System.String)"> |
||
2056 | <summary> |
||
2057 | Retrieves table schema information for the database and catalog |
||
2058 | </summary> |
||
2059 | <param name="strCatalog">The catalog (attached database) to retrieve tables on</param> |
||
2060 | <param name="strTable">The table to retrieve, can be null</param> |
||
2061 | <param name="strType">The table type, can be null</param> |
||
2062 | <returns>DataTable</returns> |
||
2063 | </member> |
||
2064 | <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Views(System.String,System.String)"> |
||
2065 | <summary> |
||
2066 | Retrieves view schema information for the database |
||
2067 | </summary> |
||
2068 | <param name="strCatalog">The catalog (attached database) to retrieve views on</param> |
||
2069 | <param name="strView">The view name, can be null</param> |
||
2070 | <returns>DataTable</returns> |
||
2071 | </member> |
||
2072 | <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Catalogs(System.String)"> |
||
2073 | <summary> |
||
2074 | Retrieves catalog (attached databases) schema information for the database |
||
2075 | </summary> |
||
2076 | <param name="strCatalog">The catalog to retrieve, can be null</param> |
||
2077 | <returns>DataTable</returns> |
||
2078 | </member> |
||
2079 | <member name="M:System.Data.SQLite.SQLiteConnection.Schema_IndexColumns(System.String,System.String,System.String,System.String)"> |
||
2080 | <summary> |
||
2081 | Returns the base column information for indexes in a database |
||
2082 | </summary> |
||
2083 | <param name="strCatalog">The catalog to retrieve indexes for (can be null)</param> |
||
2084 | <param name="strTable">The table to restrict index information by (can be null)</param> |
||
2085 | <param name="strIndex">The index to restrict index information by (can be null)</param> |
||
2086 | <param name="strColumn">The source column to restrict index information by (can be null)</param> |
||
2087 | <returns>A DataTable containing the results</returns> |
||
2088 | </member> |
||
2089 | <member name="M:System.Data.SQLite.SQLiteConnection.Schema_ViewColumns(System.String,System.String,System.String)"> |
||
2090 | <summary> |
||
2091 | Returns detailed column information for a specified view |
||
2092 | </summary> |
||
2093 | <param name="strCatalog">The catalog to retrieve columns for (can be null)</param> |
||
2094 | <param name="strView">The view to restrict column information by (can be null)</param> |
||
2095 | <param name="strColumn">The source column to restrict column information by (can be null)</param> |
||
2096 | <returns>A DataTable containing the results</returns> |
||
2097 | </member> |
||
2098 | <member name="M:System.Data.SQLite.SQLiteConnection.Schema_ForeignKeys(System.String,System.String,System.String)"> |
||
2099 | <summary> |
||
2100 | Retrieves foreign key information from the specified set of filters |
||
2101 | </summary> |
||
2102 | <param name="strCatalog">An optional catalog to restrict results on</param> |
||
2103 | <param name="strTable">An optional table to restrict results on</param> |
||
2104 | <param name="strKeyName">An optional foreign key name to restrict results on</param> |
||
2105 | <returns>A DataTable with the results of the query</returns> |
||
2106 | </member> |
||
2107 | <member name="E:System.Data.SQLite.SQLiteConnection._handlers"> |
||
2108 | <summary> |
||
2109 | Static variable to store the connection event handlers to call. |
||
2110 | </summary> |
||
2111 | </member> |
||
2112 | <member name="E:System.Data.SQLite.SQLiteConnection.StateChange"> |
||
2113 | <summary> |
||
2114 | This event is raised whenever the database is opened or closed. |
||
2115 | </summary> |
||
2116 | </member> |
||
2117 | <member name="E:System.Data.SQLite.SQLiteConnection.Changed"> |
||
2118 | <summary> |
||
2119 | This event is raised when events related to the lifecycle of a |
||
2120 | SQLiteConnection object occur. |
||
2121 | </summary> |
||
2122 | </member> |
||
2123 | <member name="P:System.Data.SQLite.SQLiteConnection.ConnectionTimeout"> |
||
2124 | <summary> |
||
2125 | Obsolete |
||
2126 | </summary> |
||
2127 | </member> |
||
2128 | <member name="P:System.Data.SQLite.SQLiteConnection.PoolCount"> |
||
2129 | <summary> |
||
2130 | Returns the number of pool entries for the file name associated with this connection. |
||
2131 | </summary> |
||
2132 | </member> |
||
2133 | <member name="P:System.Data.SQLite.SQLiteConnection.ConnectionString"> |
||
2134 | <summary> |
||
2135 | The connection string containing the parameters for the connection |
||
2136 | </summary> |
||
2137 | <remarks> |
||
2138 | <list type="table"> |
||
2139 | <listheader> |
||
2140 | <term>Parameter</term> |
||
2141 | <term>Values</term> |
||
2142 | <term>Required</term> |
||
2143 | <term>Default</term> |
||
2144 | </listheader> |
||
2145 | <item> |
||
2146 | <description>Data Source</description> |
||
2147 | <description>This may be a file name, the string ":memory:", or any supported URI (starting with SQLite 3.7.7).</description> |
||
2148 | <description>Y</description> |
||
2149 | <description></description> |
||
2150 | </item> |
||
2151 | <item> |
||
2152 | <description>Version</description> |
||
2153 | <description>3</description> |
||
2154 | <description>N</description> |
||
2155 | <description>3</description> |
||
2156 | </item> |
||
2157 | <item> |
||
2158 | <description>UseUTF16Encoding</description> |
||
2159 | <description><b>True</b><br/><b>False</b></description> |
||
2160 | <description>N</description> |
||
2161 | <description>False</description> |
||
2162 | </item> |
||
2163 | <item> |
||
2164 | <description>DateTimeFormat</description> |
||
2165 | <description> |
||
2166 | <b>Ticks</b> - Use the value of DateTime.Ticks.<br/> |
||
2167 | <b>ISO8601</b> - Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC |
||
2168 | DateTime values and "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values).<br/> |
||
2169 | <b>JulianDay</b> - The interval of time in days and fractions of a day since January 1, 4713 BC.<br/> |
||
2170 | <b>UnixEpoch</b> - The whole number of seconds since the Unix epoch (January 1, 1970).<br/> |
||
2171 | <b>InvariantCulture</b> - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime.<br/> |
||
2172 | <b>CurrentCulture</b> - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture.</description> |
||
2173 | <description>N</description> |
||
2174 | <description>ISO8601</description> |
||
2175 | </item> |
||
2176 | <item> |
||
2177 | <description>DateTimeKind</description> |
||
2178 | <description><b>Unspecified</b> - Not specified as either UTC or local time.<br/><b>Utc</b> - The time represented is UTC.<br/><b>Local</b> - The time represented is local time.</description> |
||
2179 | <description>N</description> |
||
2180 | <description>Unspecified</description> |
||
2181 | </item> |
||
2182 | <item> |
||
2183 | <description>BaseSchemaName</description> |
||
2184 | <description>Some base data classes in the framework (e.g. those that build SQL queries dynamically) |
||
2185 | assume that an ADO.NET provider cannot support an alternate catalog (i.e. database) without supporting |
||
2186 | alternate schemas as well; however, SQLite does not fit into this model. Therefore, this value is used |
||
2187 | as a placeholder and removed prior to preparing any SQL statements that may contain it.</description> |
||
2188 | <description>N</description> |
||
2189 | <description>sqlite_default_schema</description> |
||
2190 | </item> |
||
2191 | <item> |
||
2192 | <description>BinaryGUID</description> |
||
2193 | <description><b>True</b> - Store GUID columns in binary form<br/><b>False</b> - Store GUID columns as text</description> |
||
2194 | <description>N</description> |
||
2195 | <description>True</description> |
||
2196 | </item> |
||
2197 | <item> |
||
2198 | <description>Cache Size</description> |
||
2199 | <description>{size in bytes}</description> |
||
2200 | <description>N</description> |
||
2201 | <description>2000</description> |
||
2202 | </item> |
||
2203 | <item> |
||
2204 | <description>Synchronous</description> |
||
2205 | <description><b>Normal</b> - Normal file flushing behavior<br/><b>Full</b> - Full flushing after all writes<br/><b>Off</b> - Underlying OS flushes I/O's</description> |
||
2206 | <description>N</description> |
||
2207 | <description>Full</description> |
||
2208 | </item> |
||
2209 | <item> |
||
2210 | <description>Page Size</description> |
||
2211 | <description>{size in bytes}</description> |
||
2212 | <description>N</description> |
||
2213 | <description>1024</description> |
||
2214 | </item> |
||
2215 | <item> |
||
2216 | <description>Password</description> |
||
2217 | <description>{password} - Using this parameter requires that the CryptoAPI based codec be enabled at compile-time for both the native interop assembly and the core managed assemblies; otherwise, using this parameter may result in an exception being thrown when attempting to open the connection.</description> |
||
2218 | <description>N</description> |
||
2219 | <description></description> |
||
2220 | </item> |
||
2221 | <item> |
||
2222 | <description>Enlist</description> |
||
2223 | <description><b>Y</b> - Automatically enlist in distributed transactions<br/><b>N</b> - No automatic enlistment</description> |
||
2224 | <description>N</description> |
||
2225 | <description>Y</description> |
||
2226 | </item> |
||
2227 | <item> |
||
2228 | <description>Pooling</description> |
||
2229 | <description><b>True</b> - Use connection pooling<br/><b>False</b> - Do not use connection pooling</description> |
||
2230 | <description>N</description> |
||
2231 | <description>False</description> |
||
2232 | </item> |
||
2233 | <item> |
||
2234 | <description>FailIfMissing</description> |
||
2235 | <description><b>True</b> - Don't create the database if it does not exist, throw an error instead<br/><b>False</b> - Automatically create the database if it does not exist</description> |
||
2236 | <description>N</description> |
||
2237 | <description>False</description> |
||
2238 | </item> |
||
2239 | <item> |
||
2240 | <description>Max Page Count</description> |
||
2241 | <description>{size in pages} - Limits the maximum number of pages (limits the size) of the database</description> |
||
2242 | <description>N</description> |
||
2243 | <description>0</description> |
||
2244 | </item> |
||
2245 | <item> |
||
2246 | <description>Legacy Format</description> |
||
2247 | <description><b>True</b> - Use the more compatible legacy 3.x database format<br/><b>False</b> - Use the newer 3.3x database format which compresses numbers more effectively</description> |
||
2248 | <description>N</description> |
||
2249 | <description>False</description> |
||
2250 | </item> |
||
2251 | <item> |
||
2252 | <description>Default Timeout</description> |
||
2253 | <description>{time in seconds}<br/>The default command timeout</description> |
||
2254 | <description>N</description> |
||
2255 | <description>30</description> |
||
2256 | </item> |
||
2257 | <item> |
||
2258 | <description>Journal Mode</description> |
||
2259 | <description><b>Delete</b> - Delete the journal file after a commit<br/><b>Persist</b> - Zero out and leave the journal file on disk after a commit<br/><b>Off</b> - Disable the rollback journal entirely</description> |
||
2260 | <description>N</description> |
||
2261 | <description>Delete</description> |
||
2262 | </item> |
||
2263 | <item> |
||
2264 | <description>Read Only</description> |
||
2265 | <description><b>True</b> - Open the database for read only access<br/><b>False</b> - Open the database for normal read/write access</description> |
||
2266 | <description>N</description> |
||
2267 | <description>False</description> |
||
2268 | </item> |
||
2269 | <item> |
||
2270 | <description>Max Pool Size</description> |
||
2271 | <description>The maximum number of connections for the given connection string that can be in the connection pool</description> |
||
2272 | <description>N</description> |
||
2273 | <description>100</description> |
||
2274 | </item> |
||
2275 | <item> |
||
2276 | <description>Default IsolationLevel</description> |
||
2277 | <description>The default transaciton isolation level</description> |
||
2278 | <description>N</description> |
||
2279 | <description>Serializable</description> |
||
2280 | </item> |
||
2281 | <item> |
||
2282 | <description>Foreign Keys</description> |
||
2283 | <description>Enable foreign key constraints</description> |
||
2284 | <description>N</description> |
||
2285 | <description>False</description> |
||
2286 | </item> |
||
2287 | <item> |
||
2288 | <description>Flags</description> |
||
2289 | <description>Extra behavioral flags for the connection. See the <see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> enumeration for possible values.</description> |
||
2290 | <description>N</description> |
||
2291 | <description>Default</description> |
||
2292 | </item> |
||
2293 | <item> |
||
2294 | <description>SetDefaults</description> |
||
2295 | <description> |
||
2296 | <b>True</b> - Apply the default connection settings to the opened database.<br/> |
||
2297 | <b>False</b> - Skip applying the default connection settings to the opened database. |
||
2298 | </description> |
||
2299 | <description>N</description> |
||
2300 | <description>True</description> |
||
2301 | </item> |
||
2302 | <item> |
||
2303 | <description>ToFullPath</description> |
||
2304 | <description> |
||
2305 | <b>True</b> - Attempt to expand the data source file name to a fully qualified path before opening.<br/> |
||
2306 | <b>False</b> - Skip attempting to expand the data source file name to a fully qualified path before opening. |
||
2307 | </description> |
||
2308 | <description>N</description> |
||
2309 | <description>True</description> |
||
2310 | </item> |
||
2311 | </list> |
||
2312 | </remarks> |
||
2313 | </member> |
||
2314 | <member name="P:System.Data.SQLite.SQLiteConnection.DataSource"> |
||
2315 | <summary> |
||
2316 | Returns the data source file name without extension or path. |
||
2317 | </summary> |
||
2318 | </member> |
||
2319 | <member name="P:System.Data.SQLite.SQLiteConnection.Database"> |
||
2320 | <summary> |
||
2321 | Returns the string "main". |
||
2322 | </summary> |
||
2323 | </member> |
||
2324 | <member name="P:System.Data.SQLite.SQLiteConnection.DefaultTimeout"> |
||
2325 | <summary> |
||
2326 | Gets/sets the default command timeout for newly-created commands. This is especially useful for |
||
2327 | commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible. |
||
2328 | This can also be set in the ConnectionString with "Default Timeout" |
||
2329 | </summary> |
||
2330 | </member> |
||
2331 | <member name="P:System.Data.SQLite.SQLiteConnection.ParseViaFramework"> |
||
2332 | <summary> |
||
2333 | Non-zero if the built-in (i.e. framework provided) connection string |
||
2334 | parser should be used when opening the connection. |
||
2335 | </summary> |
||
2336 | </member> |
||
2337 | <member name="P:System.Data.SQLite.SQLiteConnection.Flags"> |
||
2338 | <summary> |
||
2339 | Gets/sets the extra behavioral flags for this connection. See the |
||
2340 | <see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> enumeration for a list of |
||
2341 | possible values. |
||
2342 | </summary> |
||
2343 | </member> |
||
2344 | <member name="P:System.Data.SQLite.SQLiteConnection.ServerVersion"> |
||
2345 | <summary> |
||
2346 | Returns the version of the underlying SQLite database engine |
||
2347 | </summary> |
||
2348 | </member> |
||
2349 | <member name="P:System.Data.SQLite.SQLiteConnection.LastInsertRowId"> |
||
2350 | <summary> |
||
2351 | Returns the rowid of the most recent successful INSERT into the database from this connection. |
||
2352 | </summary> |
||
2353 | </member> |
||
2354 | <member name="P:System.Data.SQLite.SQLiteConnection.Changes"> |
||
2355 | <summary> |
||
2356 | Returns the number of rows changed by the last INSERT, UPDATE, or DELETE statement executed on |
||
2357 | this connection. |
||
2358 | </summary> |
||
2359 | </member> |
||
2360 | <member name="P:System.Data.SQLite.SQLiteConnection.MemoryUsed"> |
||
2361 | <summary> |
||
2362 | Returns the amount of memory (in bytes) currently in use by the SQLite core library. |
||
2363 | </summary> |
||
2364 | </member> |
||
2365 | <member name="P:System.Data.SQLite.SQLiteConnection.MemoryHighwater"> |
||
2366 | <summary> |
||
2367 | Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset. |
||
2368 | </summary> |
||
2369 | </member> |
||
2370 | <member name="P:System.Data.SQLite.SQLiteConnection.DefineConstants"> |
||
2371 | <summary> |
||
2372 | Returns a string containing the define constants (i.e. compile-time |
||
2373 | options) used to compile the core managed assembly, delimited with |
||
2374 | spaces. |
||
2375 | </summary> |
||
2376 | </member> |
||
2377 | <member name="P:System.Data.SQLite.SQLiteConnection.SQLiteVersion"> |
||
2378 | <summary> |
||
2379 | Returns the version of the underlying SQLite database engine |
||
2380 | </summary> |
||
2381 | </member> |
||
2382 | <member name="P:System.Data.SQLite.SQLiteConnection.SQLiteSourceId"> |
||
2383 | <summary> |
||
2384 | This method returns the string whose value is the same as the |
||
2385 | SQLITE_SOURCE_ID C preprocessor macro used when compiling the |
||
2386 | SQLite core library. |
||
2387 | </summary> |
||
2388 | </member> |
||
2389 | <member name="P:System.Data.SQLite.SQLiteConnection.State"> |
||
2390 | <summary> |
||
2391 | Returns the state of the connection. |
||
2392 | </summary> |
||
2393 | </member> |
||
2394 | <member name="E:System.Data.SQLite.SQLiteConnection.Update"> |
||
2395 | <summary> |
||
2396 | This event is raised whenever SQLite makes an update/delete/insert into the database on |
||
2397 | this connection. It only applies to the given connection. |
||
2398 | </summary> |
||
2399 | </member> |
||
2400 | <member name="E:System.Data.SQLite.SQLiteConnection.Commit"> |
||
2401 | <summary> |
||
2402 | This event is raised whenever SQLite is committing a transaction. |
||
2403 | Return non-zero to trigger a rollback. |
||
2404 | </summary> |
||
2405 | </member> |
||
2406 | <member name="E:System.Data.SQLite.SQLiteConnection.Trace"> |
||
2407 | <summary> |
||
2408 | This event is raised whenever SQLite statement first begins executing on |
||
2409 | this connection. It only applies to the given connection. |
||
2410 | </summary> |
||
2411 | </member> |
||
2412 | <member name="E:System.Data.SQLite.SQLiteConnection.RollBack"> |
||
2413 | <summary> |
||
2414 | This event is raised whenever SQLite is rolling back a transaction. |
||
2415 | </summary> |
||
2416 | </member> |
||
2417 | <member name="T:System.Data.SQLite.SynchronizationModes"> |
||
2418 | <summary> |
||
2419 | The I/O file cache flushing behavior for the connection |
||
2420 | </summary> |
||
2421 | </member> |
||
2422 | <member name="F:System.Data.SQLite.SynchronizationModes.Normal"> |
||
2423 | <summary> |
||
2424 | Normal file flushing at critical sections of the code |
||
2425 | </summary> |
||
2426 | </member> |
||
2427 | <member name="F:System.Data.SQLite.SynchronizationModes.Full"> |
||
2428 | <summary> |
||
2429 | Full file flushing after every write operation |
||
2430 | </summary> |
||
2431 | </member> |
||
2432 | <member name="F:System.Data.SQLite.SynchronizationModes.Off"> |
||
2433 | <summary> |
||
2434 | Use the default operating system's file flushing, SQLite does not explicitly flush the file buffers after writing |
||
2435 | </summary> |
||
2436 | </member> |
||
2437 | <member name="T:System.Data.SQLite.SQLiteCommitHandler"> |
||
2438 | <summary> |
||
2439 | Raised when a transaction is about to be committed. To roll back a transaction, set the |
||
2440 | rollbackTrans boolean value to true. |
||
2441 | </summary> |
||
2442 | <param name="sender">The connection committing the transaction</param> |
||
2443 | <param name="e">Event arguments on the transaction</param> |
||
2444 | </member> |
||
2445 | <member name="T:System.Data.SQLite.SQLiteUpdateEventHandler"> |
||
2446 | <summary> |
||
2447 | Raised when data is inserted, updated and deleted on a given connection |
||
2448 | </summary> |
||
2449 | <param name="sender">The connection committing the transaction</param> |
||
2450 | <param name="e">The event parameters which triggered the event</param> |
||
2451 | </member> |
||
2452 | <member name="T:System.Data.SQLite.SQLiteTraceEventHandler"> |
||
2453 | <summary> |
||
2454 | Raised when a statement first begins executing on a given connection |
||
2455 | </summary> |
||
2456 | <param name="sender">The connection executing the statement</param> |
||
2457 | <param name="e">Event arguments of the trace</param> |
||
2458 | </member> |
||
2459 | <member name="T:System.Data.SQLite.SQLiteBackupCallback"> |
||
2460 | <summary> |
||
2461 | Raised between each backup step. |
||
2462 | </summary> |
||
2463 | <param name="source"> |
||
2464 | The source database connection. |
||
2465 | </param> |
||
2466 | <param name="sourceName"> |
||
2467 | The source database name. |
||
2468 | </param> |
||
2469 | <param name="destination"> |
||
2470 | The destination database connection. |
||
2471 | </param> |
||
2472 | <param name="destinationName"> |
||
2473 | The destination database name. |
||
2474 | </param> |
||
2475 | <param name="pages"> |
||
2476 | The number of pages copied with each step. |
||
2477 | </param> |
||
2478 | <param name="remainingPages"> |
||
2479 | The number of pages remaining to be copied. |
||
2480 | </param> |
||
2481 | <param name="totalPages"> |
||
2482 | The total number of pages in the source database. |
||
2483 | </param> |
||
2484 | <param name="retry"> |
||
2485 | Set to true if the operation needs to be retried due to database |
||
2486 | locking issues; otherwise, set to false. |
||
2487 | </param> |
||
2488 | <returns> |
||
2489 | True to continue with the backup process or false to halt the backup |
||
2490 | process, rolling back any changes that have been made so far. |
||
2491 | </returns> |
||
2492 | </member> |
||
2493 | <member name="T:System.Data.SQLite.UpdateEventType"> |
||
2494 | <summary> |
||
2495 | Whenever an update event is triggered on a connection, this enum will indicate |
||
2496 | exactly what type of operation is being performed. |
||
2497 | </summary> |
||
2498 | </member> |
||
2499 | <member name="F:System.Data.SQLite.UpdateEventType.Delete"> |
||
2500 | <summary> |
||
2501 | A row is being deleted from the given database and table |
||
2502 | </summary> |
||
2503 | </member> |
||
2504 | <member name="F:System.Data.SQLite.UpdateEventType.Insert"> |
||
2505 | <summary> |
||
2506 | A row is being inserted into the table. |
||
2507 | </summary> |
||
2508 | </member> |
||
2509 | <member name="F:System.Data.SQLite.UpdateEventType.Update"> |
||
2510 | <summary> |
||
2511 | A row is being updated in the table. |
||
2512 | </summary> |
||
2513 | </member> |
||
2514 | <member name="T:System.Data.SQLite.UpdateEventArgs"> |
||
2515 | <summary> |
||
2516 | Passed during an Update callback, these event arguments detail the type of update operation being performed |
||
2517 | on the given connection. |
||
2518 | </summary> |
||
2519 | </member> |
||
2520 | <member name="F:System.Data.SQLite.UpdateEventArgs.Database"> |
||
2521 | <summary> |
||
2522 | The name of the database being updated (usually "main" but can be any attached or temporary database) |
||
2523 | </summary> |
||
2524 | </member> |
||
2525 | <member name="F:System.Data.SQLite.UpdateEventArgs.Table"> |
||
2526 | <summary> |
||
2527 | The name of the table being updated |
||
2528 | </summary> |
||
2529 | </member> |
||
2530 | <member name="F:System.Data.SQLite.UpdateEventArgs.Event"> |
||
2531 | <summary> |
||
2532 | The type of update being performed (insert/update/delete) |
||
2533 | </summary> |
||
2534 | </member> |
||
2535 | <member name="F:System.Data.SQLite.UpdateEventArgs.RowId"> |
||
2536 | <summary> |
||
2537 | The RowId affected by this update. |
||
2538 | </summary> |
||
2539 | </member> |
||
2540 | <member name="T:System.Data.SQLite.CommitEventArgs"> |
||
2541 | <summary> |
||
2542 | Event arguments raised when a transaction is being committed |
||
2543 | </summary> |
||
2544 | </member> |
||
2545 | <member name="F:System.Data.SQLite.CommitEventArgs.AbortTransaction"> |
||
2546 | <summary> |
||
2547 | Set to true to abort the transaction and trigger a rollback |
||
2548 | </summary> |
||
2549 | </member> |
||
2550 | <member name="T:System.Data.SQLite.TraceEventArgs"> |
||
2551 | <summary> |
||
2552 | Passed during an Trace callback, these event arguments contain the UTF-8 rendering of the SQL statement text |
||
2553 | </summary> |
||
2554 | </member> |
||
2555 | <member name="F:System.Data.SQLite.TraceEventArgs.Statement"> |
||
2556 | <summary> |
||
2557 | SQL statement text as the statement first begins executing |
||
2558 | </summary> |
||
2559 | </member> |
||
2560 | <member name="F:System.Data.SQLite.SQLiteConnectionPool._connections"> |
||
2561 | <summary> |
||
2562 | The connection pool object |
||
2563 | </summary> |
||
2564 | </member> |
||
2565 | <member name="F:System.Data.SQLite.SQLiteConnectionPool._poolVersion"> |
||
2566 | <summary> |
||
2567 | The default version number new pools will get |
||
2568 | </summary> |
||
2569 | </member> |
||
2570 | <member name="F:System.Data.SQLite.SQLiteConnectionPool._poolOpened"> |
||
2571 | <summary> |
||
2572 | The number of connections successfully opened from any pool. |
||
2573 | This value is incremented by the Remove method. |
||
2574 | </summary> |
||
2575 | </member> |
||
2576 | <member name="F:System.Data.SQLite.SQLiteConnectionPool._poolClosed"> |
||
2577 | <summary> |
||
2578 | The number of connections successfully closed from any pool. |
||
2579 | This value is incremented by the Add method. |
||
2580 | </summary> |
||
2581 | </member> |
||
2582 | <member name="M:System.Data.SQLite.SQLiteConnectionPool.GetCounts(System.String,System.Collections.Generic.Dictionary{System.String,System.Int32}@,System.Int32@,System.Int32@,System.Int32@)"> |
||
2583 | <summary> |
||
2584 | Counts the number of pool entries matching the specified file name. |
||
2585 | </summary> |
||
2586 | <param name="fileName">The file name to match or null to match all files.</param> |
||
2587 | <param name="counts">The pool entry counts for each matching file.</param> |
||
2588 | <param name="openCount">The total number of connections successfully opened from any pool.</param> |
||
2589 | <param name="closeCount">The total number of connections successfully closed from any pool.</param> |
||
2590 | <param name="totalCount">The total number of pool entries for all matching files.</param> |
||
2591 | </member> |
||
2592 | <member name="M:System.Data.SQLite.SQLiteConnectionPool.Remove(System.String,System.Int32,System.Int32@)"> |
||
2593 | <summary> |
||
2594 | Attempt to pull a pooled connection out of the queue for active duty |
||
2595 | </summary> |
||
2596 | <param name="fileName">The filename for a desired connection</param> |
||
2597 | <param name="maxPoolSize">The maximum size the connection pool for the filename can be</param> |
||
2598 | <param name="version">The pool version the returned connection will belong to</param> |
||
2599 | <returns>Returns NULL if no connections were available. Even if none are, the poolversion will still be a valid pool version</returns> |
||
2600 | </member> |
||
2601 | <member name="M:System.Data.SQLite.SQLiteConnectionPool.ClearAllPools"> |
||
2602 | <summary> |
||
2603 | Clears out all pooled connections and rev's up the default pool version to force all old active objects |
||
2604 | not in the pool to get discarded rather than returned to their pools. |
||
2605 | </summary> |
||
2606 | </member> |
||
2607 | <member name="M:System.Data.SQLite.SQLiteConnectionPool.ClearPool(System.String)"> |
||
2608 | <summary> |
||
2609 | Clear a given pool for a given filename. Discards anything in the pool for the given file, and revs the pool |
||
2610 | version so current active objects on the old version of the pool will get discarded rather than be returned to the pool. |
||
2611 | </summary> |
||
2612 | <param name="fileName">The filename of the pool to clear</param> |
||
2613 | </member> |
||
2614 | <member name="M:System.Data.SQLite.SQLiteConnectionPool.Add(System.String,System.Data.SQLite.SQLiteConnectionHandle,System.Int32)"> |
||
2615 | <summary> |
||
2616 | Return a connection to the pool for someone else to use. |
||
2617 | </summary> |
||
2618 | <param name="fileName">The filename of the pool to use</param> |
||
2619 | <param name="hdl">The connection handle to pool</param> |
||
2620 | <param name="version">The pool version the handle was created under</param> |
||
2621 | <remarks> |
||
2622 | If the version numbers don't match between the connection and the pool, then the handle is discarded. |
||
2623 | </remarks> |
||
2624 | </member> |
||
2625 | <member name="M:System.Data.SQLite.SQLiteConnectionPool.ResizePool(System.Data.SQLite.SQLiteConnectionPool.Pool,System.Boolean)"> |
||
2626 | <summary> |
||
2627 | We don't have to thread-lock anything in this function, because it's only called by other functions above |
||
2628 | which already have a thread-safe lock. |
||
2629 | </summary> |
||
2630 | <param name="queue">The queue to resize</param> |
||
2631 | <param name="forAdding">If a function intends to add to the pool, this is true, which forces the resize |
||
2632 | to take one more than it needs from the pool</param> |
||
2633 | </member> |
||
2634 | <member name="T:System.Data.SQLite.SQLiteConnectionPool.Pool"> |
||
2635 | <summary> |
||
2636 | Keeps track of connections made on a specified file. The PoolVersion dictates whether old objects get |
||
2637 | returned to the pool or discarded when no longer in use. |
||
2638 | </summary> |
||
2639 | </member> |
||
2640 | <member name="T:System.Data.SQLite.TypeAffinity"> |
||
2641 | <summary> |
||
2642 | SQLite has very limited types, and is inherently text-based. The first 5 types below represent the sum of all types SQLite |
||
2643 | understands. The DateTime extension to the spec is for internal use only. |
||
2644 | </summary> |
||
2645 | </member> |
||
2646 | <member name="F:System.Data.SQLite.TypeAffinity.Uninitialized"> |
||
2647 | <summary> |
||
2648 | Not used |
||
2649 | </summary> |
||
2650 | </member> |
||
2651 | <member name="F:System.Data.SQLite.TypeAffinity.Int64"> |
||
2652 | <summary> |
||
2653 | All integers in SQLite default to Int64 |
||
2654 | </summary> |
||
2655 | </member> |
||
2656 | <member name="F:System.Data.SQLite.TypeAffinity.Double"> |
||
2657 | <summary> |
||
2658 | All floating point numbers in SQLite default to double |
||
2659 | </summary> |
||
2660 | </member> |
||
2661 | <member name="F:System.Data.SQLite.TypeAffinity.Text"> |
||
2662 | <summary> |
||
2663 | The default data type of SQLite is text |
||
2664 | </summary> |
||
2665 | </member> |
||
2666 | <member name="F:System.Data.SQLite.TypeAffinity.Blob"> |
||
2667 | <summary> |
||
2668 | Typically blob types are only seen when returned from a function |
||
2669 | </summary> |
||
2670 | </member> |
||
2671 | <member name="F:System.Data.SQLite.TypeAffinity.Null"> |
||
2672 | <summary> |
||
2673 | Null types can be returned from functions |
||
2674 | </summary> |
||
2675 | </member> |
||
2676 | <member name="F:System.Data.SQLite.TypeAffinity.DateTime"> |
||
2677 | <summary> |
||
2678 | Used internally by this provider |
||
2679 | </summary> |
||
2680 | </member> |
||
2681 | <member name="F:System.Data.SQLite.TypeAffinity.None"> |
||
2682 | <summary> |
||
2683 | Used internally |
||
2684 | </summary> |
||
2685 | </member> |
||
2686 | <member name="T:System.Data.SQLite.SQLiteConnectionEventType"> |
||
2687 | <summary> |
||
2688 | These are the event types associated with the |
||
2689 | <see cref="T:System.Data.SQLite.SQLiteConnectionEventHandler"/> |
||
2690 | delegate (and its corresponding event) and the |
||
2691 | <see cref="T:System.Data.SQLite.ConnectionEventArgs"/> class. |
||
2692 | </summary> |
||
2693 | </member> |
||
2694 | <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Invalid"> |
||
2695 | <summary> |
||
2696 | Not used. |
||
2697 | </summary> |
||
2698 | </member> |
||
2699 | <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Unknown"> |
||
2700 | <summary> |
||
2701 | Not used. |
||
2702 | </summary> |
||
2703 | </member> |
||
2704 | <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Opening"> |
||
2705 | <summary> |
||
2706 | The connection is being opened. |
||
2707 | </summary> |
||
2708 | </member> |
||
2709 | <member name="F:System.Data.SQLite.SQLiteConnectionEventType.ConnectionString"> |
||
2710 | <summary> |
||
2711 | The connection string has been parsed. |
||
2712 | </summary> |
||
2713 | </member> |
||
2714 | <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Opened"> |
||
2715 | <summary> |
||
2716 | The connection was opened. |
||
2717 | </summary> |
||
2718 | </member> |
||
2719 | <member name="F:System.Data.SQLite.SQLiteConnectionEventType.ChangeDatabase"> |
||
2720 | <summary> |
||
2721 | The <see cref="F:System.Data.SQLite.SQLiteConnectionEventType.ChangeDatabase"/> method was called on the |
||
2722 | connection. |
||
2723 | </summary> |
||
2724 | </member> |
||
2725 | <member name="F:System.Data.SQLite.SQLiteConnectionEventType.NewTransaction"> |
||
2726 | <summary> |
||
2727 | A transaction was created using the connection. |
||
2728 | </summary> |
||
2729 | </member> |
||
2730 | <member name="F:System.Data.SQLite.SQLiteConnectionEventType.EnlistTransaction"> |
||
2731 | <summary> |
||
2732 | The connection was enlisted into a transaction. |
||
2733 | </summary> |
||
2734 | </member> |
||
2735 | <member name="F:System.Data.SQLite.SQLiteConnectionEventType.NewCommand"> |
||
2736 | <summary> |
||
2737 | A command was created using the connection. |
||
2738 | </summary> |
||
2739 | </member> |
||
2740 | <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Closing"> |
||
2741 | <summary> |
||
2742 | The connection is being closed. |
||
2743 | </summary> |
||
2744 | </member> |
||
2745 | <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Closed"> |
||
2746 | <summary> |
||
2747 | The connection was closed. |
||
2748 | </summary> |
||
2749 | </member> |
||
2750 | <member name="T:System.Data.SQLite.SQLiteDateFormats"> |
||
2751 | <summary> |
||
2752 | This implementation of SQLite for ADO.NET can process date/time fields in databases in only one of three formats. Ticks, ISO8601 |
||
2753 | and JulianDay. |
||
2754 | </summary> |
||
2755 | <remarks> |
||
2756 | ISO8601 is more compatible, readable, fully-processable, but less accurate as it doesn't provide time down to fractions of a second. |
||
2757 | JulianDay is the numeric format the SQLite uses internally and is arguably the most compatible with 3rd party tools. It is |
||
2758 | not readable as text without post-processing. |
||
2759 | Ticks less compatible with 3rd party tools that query the database, and renders the DateTime field unreadable as text without post-processing. |
||
2760 | |||
2761 | The preferred order of choosing a datetime format is JulianDay, ISO8601, and then Ticks. Ticks is mainly present for legacy |
||
2762 | code support. |
||
2763 | </remarks> |
||
2764 | </member> |
||
2765 | <member name="F:System.Data.SQLite.SQLiteDateFormats.Ticks"> |
||
2766 | <summary> |
||
2767 | Use the value of DateTime.Ticks. This value is not recommended and is not well supported with LINQ. |
||
2768 | </summary> |
||
2769 | </member> |
||
2770 | <member name="F:System.Data.SQLite.SQLiteDateFormats.ISO8601"> |
||
2771 | <summary> |
||
2772 | Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC DateTime values and |
||
2773 | "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values). |
||
2774 | </summary> |
||
2775 | </member> |
||
2776 | <member name="F:System.Data.SQLite.SQLiteDateFormats.JulianDay"> |
||
2777 | <summary> |
||
2778 | The interval of time in days and fractions of a day since January 1, 4713 BC. |
||
2779 | </summary> |
||
2780 | </member> |
||
2781 | <member name="F:System.Data.SQLite.SQLiteDateFormats.UnixEpoch"> |
||
2782 | <summary> |
||
2783 | The whole number of seconds since the Unix epoch (January 1, 1970). |
||
2784 | </summary> |
||
2785 | </member> |
||
2786 | <member name="F:System.Data.SQLite.SQLiteDateFormats.InvariantCulture"> |
||
2787 | <summary> |
||
2788 | Any culture-independent string value that the .NET Framework can interpret as a valid DateTime. |
||
2789 | </summary> |
||
2790 | </member> |
||
2791 | <member name="F:System.Data.SQLite.SQLiteDateFormats.CurrentCulture"> |
||
2792 | <summary> |
||
2793 | Any string value that the .NET Framework can interpret as a valid DateTime using the current culture. |
||
2794 | </summary> |
||
2795 | </member> |
||
2796 | <member name="F:System.Data.SQLite.SQLiteDateFormats.Default"> |
||
2797 | <summary> |
||
2798 | The default format for this provider. |
||
2799 | </summary> |
||
2800 | </member> |
||
2801 | <member name="T:System.Data.SQLite.SQLiteJournalModeEnum"> |
||
2802 | <summary> |
||
2803 | This enum determines how SQLite treats its journal file. |
||
2804 | </summary> |
||
2805 | <remarks> |
||
2806 | By default SQLite will create and delete the journal file when needed during a transaction. |
||
2807 | However, for some computers running certain filesystem monitoring tools, the rapid |
||
2808 | creation and deletion of the journal file can cause those programs to fail, or to interfere with SQLite. |
||
2809 | |||
2810 | If a program or virus scanner is interfering with SQLite's journal file, you may receive errors like "unable to open database file" |
||
2811 | when starting a transaction. If this is happening, you may want to change the default journal mode to Persist. |
||
2812 | </remarks> |
||
2813 | </member> |
||
2814 | <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Default"> |
||
2815 | <summary> |
||
2816 | The default mode, this causes SQLite to use the existing journaling mode for the database. |
||
2817 | </summary> |
||
2818 | </member> |
||
2819 | <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Delete"> |
||
2820 | <summary> |
||
2821 | SQLite will create and destroy the journal file as-needed. |
||
2822 | </summary> |
||
2823 | </member> |
||
2824 | <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Persist"> |
||
2825 | <summary> |
||
2826 | When this is set, SQLite will keep the journal file even after a transaction has completed. It's contents will be erased, |
||
2827 | and the journal re-used as often as needed. If it is deleted, it will be recreated the next time it is needed. |
||
2828 | </summary> |
||
2829 | </member> |
||
2830 | <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Off"> |
||
2831 | <summary> |
||
2832 | This option disables the rollback journal entirely. Interrupted transactions or a program crash can cause database |
||
2833 | corruption in this mode! |
||
2834 | </summary> |
||
2835 | </member> |
||
2836 | <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Truncate"> |
||
2837 | <summary> |
||
2838 | SQLite will truncate the journal file to zero-length instead of deleting it. |
||
2839 | </summary> |
||
2840 | </member> |
||
2841 | <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Memory"> |
||
2842 | <summary> |
||
2843 | SQLite will store the journal in volatile RAM. This saves disk I/O but at the expense of database safety and integrity. |
||
2844 | If the application using SQLite crashes in the middle of a transaction when the MEMORY journaling mode is set, then the |
||
2845 | database file will very likely go corrupt. |
||
2846 | </summary> |
||
2847 | </member> |
||
2848 | <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Wal"> |
||
2849 | <summary> |
||
2850 | SQLite uses a write-ahead log instead of a rollback journal to implement transactions. The WAL journaling mode is persistent; |
||
2851 | after being set it stays in effect across multiple database connections and after closing and reopening the database. A database |
||
2852 | in WAL journaling mode can only be accessed by SQLite version 3.7.0 or later. |
||
2853 | </summary> |
||
2854 | </member> |
||
2855 | <member name="T:System.Data.SQLite.SQLiteSynchronousEnum"> |
||
2856 | <summary> |
||
2857 | Possible values for the "synchronous" database setting. This setting determines |
||
2858 | how often the database engine calls the xSync method of the VFS. |
||
2859 | </summary> |
||
2860 | </member> |
||
2861 | <member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Default"> |
||
2862 | <summary> |
||
2863 | Use the default "synchronous" database setting. Currently, this should be |
||
2864 | the same as using the FULL mode. |
||
2865 | </summary> |
||
2866 | </member> |
||
2867 | <member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Off"> |
||
2868 | <summary> |
||
2869 | The database engine continues without syncing as soon as it has handed |
||
2870 | data off to the operating system. If the application running SQLite |
||
2871 | crashes, the data will be safe, but the database might become corrupted |
||
2872 | if the operating system crashes or the computer loses power before that |
||
2873 | data has been written to the disk surface. |
||
2874 | </summary> |
||
2875 | </member> |
||
2876 | <member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Normal"> |
||
2877 | <summary> |
||
2878 | The database engine will still sync at the most critical moments, but |
||
2879 | less often than in FULL mode. There is a very small (though non-zero) |
||
2880 | chance that a power failure at just the wrong time could corrupt the |
||
2881 | database in NORMAL mode. |
||
2882 | </summary> |
||
2883 | </member> |
||
2884 | <member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Full"> |
||
2885 | <summary> |
||
2886 | The database engine will use the xSync method of the VFS to ensure that |
||
2887 | all content is safely written to the disk surface prior to continuing. |
||
2888 | This ensures that an operating system crash or power failure will not |
||
2889 | corrupt the database. FULL synchronous is very safe, but it is also |
||
2890 | slower. |
||
2891 | </summary> |
||
2892 | </member> |
||
2893 | <member name="T:System.Data.SQLite.SQLiteType"> |
||
2894 | <summary> |
||
2895 | Struct used internally to determine the datatype of a column in a resultset |
||
2896 | </summary> |
||
2897 | </member> |
||
2898 | <member name="F:System.Data.SQLite.SQLiteType.Type"> |
||
2899 | <summary> |
||
2900 | The DbType of the column, or DbType.Object if it cannot be determined |
||
2901 | </summary> |
||
2902 | </member> |
||
2903 | <member name="F:System.Data.SQLite.SQLiteType.Affinity"> |
||
2904 | <summary> |
||
2905 | The affinity of a column, used for expressions or when Type is DbType.Object |
||
2906 | </summary> |
||
2907 | </member> |
||
2908 | <member name="T:System.Data.SQLite.SQLiteDataAdapter"> |
||
2909 | <summary> |
||
2910 | SQLite implementation of DbDataAdapter. |
||
2911 | </summary> |
||
2912 | </member> |
||
2913 | <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor"> |
||
2914 | <overloads> |
||
2915 | This class is just a shell around the DbDataAdapter. Nothing from DbDataAdapter is overridden here, just a few constructors are defined. |
||
2916 | </overloads> |
||
2917 | <summary> |
||
2918 | Default constructor. |
||
2919 | </summary> |
||
2920 | </member> |
||
2921 | <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.Data.SQLite.SQLiteCommand)"> |
||
2922 | <summary> |
||
2923 | Constructs a data adapter using the specified select command. |
||
2924 | </summary> |
||
2925 | <param name="cmd">The select command to associate with the adapter.</param> |
||
2926 | </member> |
||
2927 | <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.String,System.Data.SQLite.SQLiteConnection)"> |
||
2928 | <summary> |
||
2929 | Constructs a data adapter with the supplied select command text and associated with the specified connection. |
||
2930 | </summary> |
||
2931 | <param name="commandText">The select command text to associate with the data adapter.</param> |
||
2932 | <param name="connection">The connection to associate with the select command.</param> |
||
2933 | </member> |
||
2934 | <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.String,System.String)"> |
||
2935 | <summary> |
||
2936 | Constructs a data adapter with the specified select command text, and using the specified database connection string. |
||
2937 | </summary> |
||
2938 | <param name="commandText">The select command text to use to construct a select command.</param> |
||
2939 | <param name="connectionString">A connection string suitable for passing to a new SQLiteConnection, which is associated with the select command.</param> |
||
2940 | </member> |
||
2941 | <member name="M:System.Data.SQLite.SQLiteDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)"> |
||
2942 | <summary> |
||
2943 | Raised by the underlying DbDataAdapter when a row is being updated |
||
2944 | </summary> |
||
2945 | <param name="value">The event's specifics</param> |
||
2946 | </member> |
||
2947 | <member name="M:System.Data.SQLite.SQLiteDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)"> |
||
2948 | <summary> |
||
2949 | Raised by DbDataAdapter after a row is updated |
||
2950 | </summary> |
||
2951 | <param name="value">The event's specifics</param> |
||
2952 | </member> |
||
2953 | <member name="E:System.Data.SQLite.SQLiteDataAdapter.RowUpdating"> |
||
2954 | <summary> |
||
2955 | Row updating event handler |
||
2956 | </summary> |
||
2957 | </member> |
||
2958 | <member name="E:System.Data.SQLite.SQLiteDataAdapter.RowUpdated"> |
||
2959 | <summary> |
||
2960 | Row updated event handler |
||
2961 | </summary> |
||
2962 | </member> |
||
2963 | <member name="P:System.Data.SQLite.SQLiteDataAdapter.SelectCommand"> |
||
2964 | <summary> |
||
2965 | Gets/sets the select command for this DataAdapter |
||
2966 | </summary> |
||
2967 | </member> |
||
2968 | <member name="P:System.Data.SQLite.SQLiteDataAdapter.InsertCommand"> |
||
2969 | <summary> |
||
2970 | Gets/sets the insert command for this DataAdapter |
||
2971 | </summary> |
||
2972 | </member> |
||
2973 | <member name="P:System.Data.SQLite.SQLiteDataAdapter.UpdateCommand"> |
||
2974 | <summary> |
||
2975 | Gets/sets the update command for this DataAdapter |
||
2976 | </summary> |
||
2977 | </member> |
||
2978 | <member name="P:System.Data.SQLite.SQLiteDataAdapter.DeleteCommand"> |
||
2979 | <summary> |
||
2980 | Gets/sets the delete command for this DataAdapter |
||
2981 | </summary> |
||
2982 | </member> |
||
2983 | <member name="T:System.Data.SQLite.SQLiteDataReader"> |
||
2984 | <summary> |
||
2985 | SQLite implementation of DbDataReader. |
||
2986 | </summary> |
||
2987 | </member> |
||
2988 | <member name="F:System.Data.SQLite.SQLiteDataReader._command"> |
||
2989 | <summary> |
||
2990 | Underlying command this reader is attached to |
||
2991 | </summary> |
||
2992 | </member> |
||
2993 | <member name="F:System.Data.SQLite.SQLiteDataReader._activeStatementIndex"> |
||
2994 | <summary> |
||
2995 | Index of the current statement in the command being processed |
||
2996 | </summary> |
||
2997 | </member> |
||
2998 | <member name="F:System.Data.SQLite.SQLiteDataReader._activeStatement"> |
||
2999 | <summary> |
||
3000 | Current statement being Read() |
||
3001 | </summary> |
||
3002 | </member> |
||
3003 | <member name="F:System.Data.SQLite.SQLiteDataReader._readingState"> |
||
3004 | <summary> |
||
3005 | State of the current statement being processed. |
||
3006 | -1 = First Step() executed, so the first Read() will be ignored |
||
3007 | |||
3008 | 1 = Finished reading |
||
3009 | 2 = Non-row-returning statement, no records |
||
3010 | </summary> |
||
3011 | </member> |
||
3012 | <member name="F:System.Data.SQLite.SQLiteDataReader._rowsAffected"> |
||
3013 | <summary> |
||
3014 | Number of records affected by the insert/update statements executed on the command |
||
3015 | </summary> |
||
3016 | </member> |
||
3017 | <member name="F:System.Data.SQLite.SQLiteDataReader._fieldCount"> |
||
3018 | <summary> |
||
3019 | Count of fields (columns) in the row-returning statement currently being processed |
||
3020 | </summary> |
||
3021 | </member> |
||
3022 | <member name="F:System.Data.SQLite.SQLiteDataReader._fieldIndexes"> |
||
3023 | <summary> |
||
3024 | Maps the field (column) names to their corresponding indexes within the results. |
||
3025 | </summary> |
||
3026 | </member> |
||
3027 | <member name="F:System.Data.SQLite.SQLiteDataReader._fieldTypeArray"> |
||
3028 | <summary> |
||
3029 | Datatypes of active fields (columns) in the current statement, used for type-restricting data |
||
3030 | </summary> |
||
3031 | </member> |
||
3032 | <member name="F:System.Data.SQLite.SQLiteDataReader._commandBehavior"> |
||
3033 | <summary> |
||
3034 | The behavior of the datareader |
||
3035 | </summary> |
||
3036 | </member> |
||
3037 | <member name="F:System.Data.SQLite.SQLiteDataReader._disposeCommand"> |
||
3038 | <summary> |
||
3039 | If set, then dispose of the command object when the reader is finished |
||
3040 | </summary> |
||
3041 | </member> |
||
3042 | <member name="F:System.Data.SQLite.SQLiteDataReader._throwOnDisposed"> |
||
3043 | <summary> |
||
3044 | If set, then raise an exception when the object is accessed after being disposed. |
||
3045 | </summary> |
||
3046 | </member> |
||
3047 | <member name="F:System.Data.SQLite.SQLiteDataReader._keyInfo"> |
||
3048 | <summary> |
||
3049 | An array of rowid's for the active statement if CommandBehavior.KeyInfo is specified |
||
3050 | </summary> |
||
3051 | </member> |
||
3052 | <member name="F:System.Data.SQLite.SQLiteDataReader._version"> |
||
3053 | <summary> |
||
3054 | Matches the version of the connection. |
||
3055 | </summary> |
||
3056 | </member> |
||
3057 | <member name="F:System.Data.SQLite.SQLiteDataReader._baseSchemaName"> |
||
3058 | <summary> |
||
3059 | The "stub" (i.e. placeholder) base schema name to use when returning |
||
3060 | column schema information. Matches the base schema name used by the |
||
3061 | associated connection. |
||
3062 | </summary> |
||
3063 | </member> |
||
3064 | <member name="M:System.Data.SQLite.SQLiteDataReader.#ctor(System.Data.SQLite.SQLiteCommand,System.Data.CommandBehavior)"> |
||
3065 | <summary> |
||
3066 | Internal constructor, initializes the datareader and sets up to begin executing statements |
||
3067 | </summary> |
||
3068 | <param name="cmd">The SQLiteCommand this data reader is for</param> |
||
3069 | <param name="behave">The expected behavior of the data reader</param> |
||
3070 | </member> |
||
3071 | <member name="M:System.Data.SQLite.SQLiteDataReader.Dispose(System.Boolean)"> |
||
3072 | <summary> |
||
3073 | Dispose of all resources used by this datareader. |
||
3074 | </summary> |
||
3075 | <param name="disposing"></param> |
||
3076 | </member> |
||
3077 | <member name="M:System.Data.SQLite.SQLiteDataReader.Close"> |
||
3078 | <summary> |
||
3079 | Closes the datareader, potentially closing the connection as well if CommandBehavior.CloseConnection was specified. |
||
3080 | </summary> |
||
3081 | </member> |
||
3082 | <member name="M:System.Data.SQLite.SQLiteDataReader.CheckClosed"> |
||
3083 | <summary> |
||
3084 | Throw an error if the datareader is closed |
||
3085 | </summary> |
||
3086 | </member> |
||
3087 | <member name="M:System.Data.SQLite.SQLiteDataReader.CheckValidRow"> |
||
3088 | <summary> |
||
3089 | Throw an error if a row is not loaded |
||
3090 | </summary> |
||
3091 | </member> |
||
3092 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetEnumerator"> |
||
3093 | <summary> |
||
3094 | Enumerator support |
||
3095 | </summary> |
||
3096 | <returns>Returns a DbEnumerator object.</returns> |
||
3097 | </member> |
||
3098 | <member name="M:System.Data.SQLite.SQLiteDataReader.VerifyType(System.Int32,System.Data.DbType)"> |
||
3099 | <summary> |
||
3100 | SQLite is inherently un-typed. All datatypes in SQLite are natively strings. The definition of the columns of a table |
||
3101 | and the affinity of returned types are all we have to go on to type-restrict data in the reader. |
||
3102 | |||
3103 | This function attempts to verify that the type of data being requested of a column matches the datatype of the column. In |
||
3104 | the case of columns that are not backed into a table definition, we attempt to match up the affinity of a column (int, double, string or blob) |
||
3105 | to a set of known types that closely match that affinity. It's not an exact science, but its the best we can do. |
||
3106 | </summary> |
||
3107 | <returns> |
||
3108 | This function throws an InvalidTypeCast() exception if the requested type doesn't match the column's definition or affinity. |
||
3109 | </returns> |
||
3110 | <param name="i">The index of the column to type-check</param> |
||
3111 | <param name="typ">The type we want to get out of the column</param> |
||
3112 | </member> |
||
3113 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetBoolean(System.Int32)"> |
||
3114 | <summary> |
||
3115 | Retrieves the column as a boolean value |
||
3116 | </summary> |
||
3117 | <param name="i">The index of the column to retrieve</param> |
||
3118 | <returns>bool</returns> |
||
3119 | </member> |
||
3120 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetByte(System.Int32)"> |
||
3121 | <summary> |
||
3122 | Retrieves the column as a single byte value |
||
3123 | </summary> |
||
3124 | <param name="i">The index of the column to retrieve</param> |
||
3125 | <returns>byte</returns> |
||
3126 | </member> |
||
3127 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"> |
||
3128 | <summary> |
||
3129 | Retrieves a column as an array of bytes (blob) |
||
3130 | </summary> |
||
3131 | <param name="i">The index of the column to retrieve</param> |
||
3132 | <param name="fieldOffset">The zero-based index of where to begin reading the data</param> |
||
3133 | <param name="buffer">The buffer to write the bytes into</param> |
||
3134 | <param name="bufferoffset">The zero-based index of where to begin writing into the array</param> |
||
3135 | <param name="length">The number of bytes to retrieve</param> |
||
3136 | <returns>The actual number of bytes written into the array</returns> |
||
3137 | <remarks> |
||
3138 | To determine the number of bytes in the column, pass a null value for the buffer. The total length will be returned. |
||
3139 | </remarks> |
||
3140 | </member> |
||
3141 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetChar(System.Int32)"> |
||
3142 | <summary> |
||
3143 | Returns the column as a single character |
||
3144 | </summary> |
||
3145 | <param name="i">The index of the column to retrieve</param> |
||
3146 | <returns>char</returns> |
||
3147 | </member> |
||
3148 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"> |
||
3149 | <summary> |
||
3150 | Retrieves a column as an array of chars (blob) |
||
3151 | </summary> |
||
3152 | <param name="i">The index of the column to retrieve</param> |
||
3153 | <param name="fieldoffset">The zero-based index of where to begin reading the data</param> |
||
3154 | <param name="buffer">The buffer to write the characters into</param> |
||
3155 | <param name="bufferoffset">The zero-based index of where to begin writing into the array</param> |
||
3156 | <param name="length">The number of bytes to retrieve</param> |
||
3157 | <returns>The actual number of characters written into the array</returns> |
||
3158 | <remarks> |
||
3159 | To determine the number of characters in the column, pass a null value for the buffer. The total length will be returned. |
||
3160 | </remarks> |
||
3161 | </member> |
||
3162 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetDataTypeName(System.Int32)"> |
||
3163 | <summary> |
||
3164 | Retrieves the name of the back-end datatype of the column |
||
3165 | </summary> |
||
3166 | <param name="i">The index of the column to retrieve</param> |
||
3167 | <returns>string</returns> |
||
3168 | </member> |
||
3169 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetDateTime(System.Int32)"> |
||
3170 | <summary> |
||
3171 | Retrieve the column as a date/time value |
||
3172 | </summary> |
||
3173 | <param name="i">The index of the column to retrieve</param> |
||
3174 | <returns>DateTime</returns> |
||
3175 | </member> |
||
3176 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetDecimal(System.Int32)"> |
||
3177 | <summary> |
||
3178 | Retrieve the column as a decimal value |
||
3179 | </summary> |
||
3180 | <param name="i">The index of the column to retrieve</param> |
||
3181 | <returns>decimal</returns> |
||
3182 | </member> |
||
3183 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetDouble(System.Int32)"> |
||
3184 | <summary> |
||
3185 | Returns the column as a double |
||
3186 | </summary> |
||
3187 | <param name="i">The index of the column to retrieve</param> |
||
3188 | <returns>double</returns> |
||
3189 | </member> |
||
3190 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetFieldType(System.Int32)"> |
||
3191 | <summary> |
||
3192 | Returns the .NET type of a given column |
||
3193 | </summary> |
||
3194 | <param name="i">The index of the column to retrieve</param> |
||
3195 | <returns>Type</returns> |
||
3196 | </member> |
||
3197 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetFloat(System.Int32)"> |
||
3198 | <summary> |
||
3199 | Returns a column as a float value |
||
3200 | </summary> |
||
3201 | <param name="i">The index of the column to retrieve</param> |
||
3202 | <returns>float</returns> |
||
3203 | </member> |
||
3204 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetGuid(System.Int32)"> |
||
3205 | <summary> |
||
3206 | Returns the column as a Guid |
||
3207 | </summary> |
||
3208 | <param name="i">The index of the column to retrieve</param> |
||
3209 | <returns>Guid</returns> |
||
3210 | </member> |
||
3211 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetInt16(System.Int32)"> |
||
3212 | <summary> |
||
3213 | Returns the column as a short |
||
3214 | </summary> |
||
3215 | <param name="i">The index of the column to retrieve</param> |
||
3216 | <returns>Int16</returns> |
||
3217 | </member> |
||
3218 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetInt32(System.Int32)"> |
||
3219 | <summary> |
||
3220 | Retrieves the column as an int |
||
3221 | </summary> |
||
3222 | <param name="i">The index of the column to retrieve</param> |
||
3223 | <returns>Int32</returns> |
||
3224 | </member> |
||
3225 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetInt64(System.Int32)"> |
||
3226 | <summary> |
||
3227 | Retrieves the column as a long |
||
3228 | </summary> |
||
3229 | <param name="i">The index of the column to retrieve</param> |
||
3230 | <returns>Int64</returns> |
||
3231 | </member> |
||
3232 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetName(System.Int32)"> |
||
3233 | <summary> |
||
3234 | Retrieves the name of the column |
||
3235 | </summary> |
||
3236 | <param name="i">The index of the column to retrieve</param> |
||
3237 | <returns>string</returns> |
||
3238 | </member> |
||
3239 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetOrdinal(System.String)"> |
||
3240 | <summary> |
||
3241 | Retrieves the i of a column, given its name |
||
3242 | </summary> |
||
3243 | <param name="name">The name of the column to retrieve</param> |
||
3244 | <returns>The int i of the column</returns> |
||
3245 | </member> |
||
3246 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetSchemaTable"> |
||
3247 | <summary> |
||
3248 | Schema information in SQLite is difficult to map into .NET conventions, so a lot of work must be done |
||
3249 | to gather the necessary information so it can be represented in an ADO.NET manner. |
||
3250 | </summary> |
||
3251 | <returns>Returns a DataTable containing the schema information for the active SELECT statement being processed.</returns> |
||
3252 | </member> |
||
3253 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetString(System.Int32)"> |
||
3254 | <summary> |
||
3255 | Retrieves the column as a string |
||
3256 | </summary> |
||
3257 | <param name="i">The index of the column to retrieve</param> |
||
3258 | <returns>string</returns> |
||
3259 | </member> |
||
3260 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetValue(System.Int32)"> |
||
3261 | <summary> |
||
3262 | Retrieves the column as an object corresponding to the underlying datatype of the column |
||
3263 | </summary> |
||
3264 | <param name="i">The index of the column to retrieve</param> |
||
3265 | <returns>object</returns> |
||
3266 | </member> |
||
3267 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetValues(System.Object[])"> |
||
3268 | <summary> |
||
3269 | Retreives the values of multiple columns, up to the size of the supplied array |
||
3270 | </summary> |
||
3271 | <param name="values">The array to fill with values from the columns in the current resultset</param> |
||
3272 | <returns>The number of columns retrieved</returns> |
||
3273 | </member> |
||
3274 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetValues"> |
||
3275 | <summary> |
||
3276 | Returns a collection containing all the column names and values for the |
||
3277 | current row of data in the current resultset, if any. If there is no |
||
3278 | current row or no current resultset, an exception may be thrown. |
||
3279 | </summary> |
||
3280 | <returns> |
||
3281 | The collection containing the column name and value information for the |
||
3282 | current row of data in the current resultset or null if this information |
||
3283 | cannot be obtained. |
||
3284 | </returns> |
||
3285 | </member> |
||
3286 | <member name="M:System.Data.SQLite.SQLiteDataReader.IsDBNull(System.Int32)"> |
||
3287 | <summary> |
||
3288 | Returns True if the specified column is null |
||
3289 | </summary> |
||
3290 | <param name="i">The index of the column to retrieve</param> |
||
3291 | <returns>True or False</returns> |
||
3292 | </member> |
||
3293 | <member name="M:System.Data.SQLite.SQLiteDataReader.NextResult"> |
||
3294 | <summary> |
||
3295 | Moves to the next resultset in multiple row-returning SQL command. |
||
3296 | </summary> |
||
3297 | <returns>True if the command was successful and a new resultset is available, False otherwise.</returns> |
||
3298 | </member> |
||
3299 | <member name="M:System.Data.SQLite.SQLiteDataReader.GetSQLiteType(System.Int32)"> |
||
3300 | <summary> |
||
3301 | Retrieves the SQLiteType for a given column, and caches it to avoid repetetive interop calls. |
||
3302 | </summary> |
||
3303 | <param name="i">The index of the column to retrieve</param> |
||
3304 | <returns>A SQLiteType structure</returns> |
||
3305 | </member> |
||
3306 | <member name="M:System.Data.SQLite.SQLiteDataReader.Read"> |
||
3307 | <summary> |
||
3308 | Reads the next row from the resultset |
||
3309 | </summary> |
||
3310 | <returns>True if a new row was successfully loaded and is ready for processing</returns> |
||
3311 | </member> |
||
3312 | <member name="P:System.Data.SQLite.SQLiteDataReader.Depth"> |
||
3313 | <summary> |
||
3314 | Not implemented. Returns 0 |
||
3315 | </summary> |
||
3316 | </member> |
||
3317 | <member name="P:System.Data.SQLite.SQLiteDataReader.FieldCount"> |
||
3318 | <summary> |
||
3319 | Returns the number of columns in the current resultset |
||
3320 | </summary> |
||
3321 | </member> |
||
3322 | <member name="P:System.Data.SQLite.SQLiteDataReader.VisibleFieldCount"> |
||
3323 | <summary> |
||
3324 | Returns the number of visible fields in the current resultset |
||
3325 | </summary> |
||
3326 | </member> |
||
3327 | <member name="P:System.Data.SQLite.SQLiteDataReader.HasRows"> |
||
3328 | <summary> |
||
3329 | Returns True if the resultset has rows that can be fetched |
||
3330 | </summary> |
||
3331 | </member> |
||
3332 | <member name="P:System.Data.SQLite.SQLiteDataReader.IsClosed"> |
||
3333 | <summary> |
||
3334 | Returns True if the data reader is closed |
||
3335 | </summary> |
||
3336 | </member> |
||
3337 | <member name="P:System.Data.SQLite.SQLiteDataReader.RecordsAffected"> |
||
3338 | <summary> |
||
3339 | Retrieve the count of records affected by an update/insert command. Only valid once the data reader is closed! |
||
3340 | </summary> |
||
3341 | </member> |
||
3342 | <member name="P:System.Data.SQLite.SQLiteDataReader.Item(System.String)"> |
||
3343 | <summary> |
||
3344 | Indexer to retrieve data from a column given its name |
||
3345 | </summary> |
||
3346 | <param name="name">The name of the column to retrieve data for</param> |
||
3347 | <returns>The value contained in the column</returns> |
||
3348 | </member> |
||
3349 | <member name="P:System.Data.SQLite.SQLiteDataReader.Item(System.Int32)"> |
||
3350 | <summary> |
||
3351 | Indexer to retrieve data from a column given its i |
||
3352 | </summary> |
||
3353 | <param name="i">The index of the column to retrieve</param> |
||
3354 | <returns>The value contained in the column</returns> |
||
3355 | </member> |
||
3356 | <member name="T:System.Data.SQLite.SQLiteException"> |
||
3357 | <summary> |
||
3358 | SQLite exception class. |
||
3359 | </summary> |
||
3360 | </member> |
||
3361 | <member name="M:System.Data.SQLite.SQLiteException.#ctor(System.Data.SQLite.SQLiteErrorCode,System.String)"> |
||
3362 | <summary> |
||
3363 | Public constructor for generating a SQLite exception given the error |
||
3364 | code and message. |
||
3365 | </summary> |
||
3366 | <param name="errorCode"> |
||
3367 | The SQLite return code to report. |
||
3368 | </param> |
||
3369 | <param name="message"> |
||
3370 | Message text to go along with the return code message text. |
||
3371 | </param> |
||
3372 | </member> |
||
3373 | <member name="M:System.Data.SQLite.SQLiteException.#ctor(System.String)"> |
||
3374 | <summary> |
||
3375 | Public constructor that uses the base class constructor for the error |
||
3376 | message. |
||
3377 | </summary> |
||
3378 | <param name="message">Error message text.</param> |
||
3379 | </member> |
||
3380 | <member name="M:System.Data.SQLite.SQLiteException.#ctor"> |
||
3381 | <summary> |
||
3382 | Public constructor that uses the default base class constructor. |
||
3383 | </summary> |
||
3384 | </member> |
||
3385 | <member name="M:System.Data.SQLite.SQLiteException.#ctor(System.String,System.Exception)"> |
||
3386 | <summary> |
||
3387 | Public constructor that uses the base class constructor for the error |
||
3388 | message and inner exception. |
||
3389 | </summary> |
||
3390 | <param name="message">Error message text.</param> |
||
3391 | <param name="innerException">The original (inner) exception.</param> |
||
3392 | </member> |
||
3393 | <member name="M:System.Data.SQLite.SQLiteException.GetErrorString(System.Data.SQLite.SQLiteErrorCode)"> |
||
3394 | <summary> |
||
3395 | Returns the error message for the specified SQLite return code. |
||
3396 | </summary> |
||
3397 | <param name="errorCode">The SQLite return code.</param> |
||
3398 | <returns>The error message or null if it cannot be found.</returns> |
||
3399 | </member> |
||
3400 | <member name="M:System.Data.SQLite.SQLiteException.GetStockErrorMessage(System.Data.SQLite.SQLiteErrorCode,System.String)"> |
||
3401 | <summary> |
||
3402 | Returns the composite error message based on the SQLite return code |
||
3403 | and the optional detailed error message. |
||
3404 | </summary> |
||
3405 | <param name="errorCode">The SQLite return code.</param> |
||
3406 | <param name="message">Optional detailed error message.</param> |
||
3407 | <returns>Error message text for the return code.</returns> |
||
3408 | </member> |
||
3409 | <member name="P:System.Data.SQLite.SQLiteException.ReturnCode"> |
||
3410 | <summary> |
||
3411 | Gets the associated SQLite return code for this exception as a |
||
3412 | <see cref="T:System.Data.SQLite.SQLiteErrorCode"/>. This property returns the same |
||
3413 | underlying value as the <see cref="P:System.Data.SQLite.SQLiteException.ErrorCode"/> property. |
||
3414 | </summary> |
||
3415 | </member> |
||
3416 | <member name="P:System.Data.SQLite.SQLiteException.ErrorCode"> |
||
3417 | <summary> |
||
3418 | Gets the associated SQLite return code for this exception as an |
||
3419 | <see cref="T:System.Int32"/>. For desktop versions of the .NET Framework, |
||
3420 | this property overrides the property of the same name within the |
||
3421 | <see cref="T:System.Runtime.InteropServices.ExternalException"/> |
||
3422 | class. This property returns the same underlying value as the |
||
3423 | <see cref="P:System.Data.SQLite.SQLiteException.ReturnCode"/> property. |
||
3424 | </summary> |
||
3425 | </member> |
||
3426 | <member name="T:System.Data.SQLite.SQLiteErrorCode"> |
||
3427 | <summary> |
||
3428 | SQLite error codes. Actually, this enumeration represents a return code, |
||
3429 | which may also indicate success in one of several ways (e.g. SQLITE_OK, |
||
3430 | SQLITE_ROW, and SQLITE_DONE). Therefore, the name of this enumeration is |
||
3431 | something of a misnomer. |
||
3432 | </summary> |
||
3433 | </member> |
||
3434 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Ok"> |
||
3435 | <summary> |
||
3436 | Successful result |
||
3437 | </summary> |
||
3438 | </member> |
||
3439 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Error"> |
||
3440 | <summary> |
||
3441 | SQL error or missing database |
||
3442 | </summary> |
||
3443 | </member> |
||
3444 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Internal"> |
||
3445 | <summary> |
||
3446 | Internal logic error in SQLite |
||
3447 | </summary> |
||
3448 | </member> |
||
3449 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Perm"> |
||
3450 | <summary> |
||
3451 | Access permission denied |
||
3452 | </summary> |
||
3453 | </member> |
||
3454 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Abort"> |
||
3455 | <summary> |
||
3456 | Callback routine requested an abort |
||
3457 | </summary> |
||
3458 | </member> |
||
3459 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Busy"> |
||
3460 | <summary> |
||
3461 | The database file is locked |
||
3462 | </summary> |
||
3463 | </member> |
||
3464 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Locked"> |
||
3465 | <summary> |
||
3466 | A table in the database is locked |
||
3467 | </summary> |
||
3468 | </member> |
||
3469 | <member name="F:System.Data.SQLite.SQLiteErrorCode.NoMem"> |
||
3470 | <summary> |
||
3471 | A malloc() failed |
||
3472 | </summary> |
||
3473 | </member> |
||
3474 | <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly"> |
||
3475 | <summary> |
||
3476 | Attempt to write a readonly database |
||
3477 | </summary> |
||
3478 | </member> |
||
3479 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Interrupt"> |
||
3480 | <summary> |
||
3481 | Operation terminated by sqlite3_interrupt() |
||
3482 | </summary> |
||
3483 | </member> |
||
3484 | <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr"> |
||
3485 | <summary> |
||
3486 | Some kind of disk I/O error occurred |
||
3487 | </summary> |
||
3488 | </member> |
||
3489 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Corrupt"> |
||
3490 | <summary> |
||
3491 | The database disk image is malformed |
||
3492 | </summary> |
||
3493 | </member> |
||
3494 | <member name="F:System.Data.SQLite.SQLiteErrorCode.NotFound"> |
||
3495 | <summary> |
||
3496 | Unknown opcode in sqlite3_file_control() |
||
3497 | </summary> |
||
3498 | </member> |
||
3499 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Full"> |
||
3500 | <summary> |
||
3501 | Insertion failed because database is full |
||
3502 | </summary> |
||
3503 | </member> |
||
3504 | <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen"> |
||
3505 | <summary> |
||
3506 | Unable to open the database file |
||
3507 | </summary> |
||
3508 | </member> |
||
3509 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Protocol"> |
||
3510 | <summary> |
||
3511 | Database lock protocol error |
||
3512 | </summary> |
||
3513 | </member> |
||
3514 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Empty"> |
||
3515 | <summary> |
||
3516 | Database is empty |
||
3517 | </summary> |
||
3518 | </member> |
||
3519 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Schema"> |
||
3520 | <summary> |
||
3521 | The database schema changed |
||
3522 | </summary> |
||
3523 | </member> |
||
3524 | <member name="F:System.Data.SQLite.SQLiteErrorCode.TooBig"> |
||
3525 | <summary> |
||
3526 | String or BLOB exceeds size limit |
||
3527 | </summary> |
||
3528 | </member> |
||
3529 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint"> |
||
3530 | <summary> |
||
3531 | Abort due to constraint violation |
||
3532 | </summary> |
||
3533 | </member> |
||
3534 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Mismatch"> |
||
3535 | <summary> |
||
3536 | Data type mismatch |
||
3537 | </summary> |
||
3538 | </member> |
||
3539 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Misuse"> |
||
3540 | <summary> |
||
3541 | Library used incorrectly |
||
3542 | </summary> |
||
3543 | </member> |
||
3544 | <member name="F:System.Data.SQLite.SQLiteErrorCode.NoLfs"> |
||
3545 | <summary> |
||
3546 | Uses OS features not supported on host |
||
3547 | </summary> |
||
3548 | </member> |
||
3549 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Auth"> |
||
3550 | <summary> |
||
3551 | Authorization denied |
||
3552 | </summary> |
||
3553 | </member> |
||
3554 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Format"> |
||
3555 | <summary> |
||
3556 | Auxiliary database format error |
||
3557 | </summary> |
||
3558 | </member> |
||
3559 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Range"> |
||
3560 | <summary> |
||
3561 | 2nd parameter to sqlite3_bind out of range |
||
3562 | </summary> |
||
3563 | </member> |
||
3564 | <member name="F:System.Data.SQLite.SQLiteErrorCode.NotADb"> |
||
3565 | <summary> |
||
3566 | File opened that is not a database file |
||
3567 | </summary> |
||
3568 | </member> |
||
3569 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Row"> |
||
3570 | <summary> |
||
3571 | sqlite3_step() has another row ready |
||
3572 | </summary> |
||
3573 | </member> |
||
3574 | <member name="F:System.Data.SQLite.SQLiteErrorCode.Done"> |
||
3575 | <summary> |
||
3576 | sqlite3_step() has finished executing |
||
3577 | </summary> |
||
3578 | </member> |
||
3579 | <member name="T:System.Data.SQLite.SQLiteFunction"> |
||
3580 | <summary> |
||
3581 | This abstract class is designed to handle user-defined functions easily. An instance of the derived class is made for each |
||
3582 | connection to the database. |
||
3583 | </summary> |
||
3584 | <remarks> |
||
3585 | Although there is one instance of a class derived from SQLiteFunction per database connection, the derived class has no access |
||
3586 | to the underlying connection. This is necessary to deter implementers from thinking it would be a good idea to make database |
||
3587 | calls during processing. |
||
3588 | |||
3589 | It is important to distinguish between a per-connection instance, and a per-SQL statement context. One instance of this class |
||
3590 | services all SQL statements being stepped through on that connection, and there can be many. One should never store per-statement |
||
3591 | information in member variables of user-defined function classes. |
||
3592 | |||
3593 | For aggregate functions, always create and store your per-statement data in the contextData object on the 1st step. This data will |
||
3594 | be automatically freed for you (and Dispose() called if the item supports IDisposable) when the statement completes. |
||
3595 | </remarks> |
||
3596 | </member> |
||
3597 | <member name="F:System.Data.SQLite.SQLiteFunction.COR_E_EXCEPTION"> |
||
3598 | <summary> |
||
3599 | The error code used for logging exceptions caught in user-provided |
||
3600 | code. |
||
3601 | </summary> |
||
3602 | </member> |
||
3603 | <member name="F:System.Data.SQLite.SQLiteFunction._base"> |
||
3604 | <summary> |
||
3605 | The base connection this function is attached to |
||
3606 | </summary> |
||
3607 | </member> |
||
3608 | <member name="F:System.Data.SQLite.SQLiteFunction._contextDataList"> |
||
3609 | <summary> |
||
3610 | Internal array used to keep track of aggregate function context data |
||
3611 | </summary> |
||
3612 | </member> |
||
3613 | <member name="F:System.Data.SQLite.SQLiteFunction._flags"> |
||
3614 | <summary> |
||
3615 | The connection flags associated with this object (this should be the |
||
3616 | same value as the flags associated with the parent connection object). |
||
3617 | </summary> |
||
3618 | </member> |
||
3619 | <member name="F:System.Data.SQLite.SQLiteFunction._InvokeFunc"> |
||
3620 | <summary> |
||
3621 | Holds a reference to the callback function for user functions |
||
3622 | </summary> |
||
3623 | </member> |
||
3624 | <member name="F:System.Data.SQLite.SQLiteFunction._StepFunc"> |
||
3625 | <summary> |
||
3626 | Holds a reference to the callbakc function for stepping in an aggregate function |
||
3627 | </summary> |
||
3628 | </member> |
||
3629 | <member name="F:System.Data.SQLite.SQLiteFunction._FinalFunc"> |
||
3630 | <summary> |
||
3631 | Holds a reference to the callback function for finalizing an aggregate function |
||
3632 | </summary> |
||
3633 | </member> |
||
3634 | <member name="F:System.Data.SQLite.SQLiteFunction._CompareFunc"> |
||
3635 | <summary> |
||
3636 | Holds a reference to the callback function for collation sequences |
||
3637 | </summary> |
||
3638 | </member> |
||
3639 | <member name="F:System.Data.SQLite.SQLiteFunction._context"> |
||
3640 | <summary> |
||
3641 | Current context of the current callback. Only valid during a callback |
||
3642 | </summary> |
||
3643 | </member> |
||
3644 | <member name="F:System.Data.SQLite.SQLiteFunction._registeredFunctions"> |
||
3645 | <summary> |
||
3646 | This static list contains all the user-defined functions declared using the proper attributes. |
||
3647 | </summary> |
||
3648 | </member> |
||
3649 | <member name="M:System.Data.SQLite.SQLiteFunction.#ctor"> |
||
3650 | <summary> |
||
3651 | Internal constructor, initializes the function's internal variables. |
||
3652 | </summary> |
||
3653 | </member> |
||
3654 | <member name="M:System.Data.SQLite.SQLiteFunction.Dispose"> |
||
3655 | <summary> |
||
3656 | Disposes of any active contextData variables that were not automatically cleaned up. Sometimes this can happen if |
||
3657 | someone closes the connection while a DataReader is open. |
||
3658 | </summary> |
||
3659 | </member> |
||
3660 | <member name="M:System.Data.SQLite.SQLiteFunction.Dispose(System.Boolean)"> |
||
3661 | <summary> |
||
3662 | Placeholder for a user-defined disposal routine |
||
3663 | </summary> |
||
3664 | <param name="disposing">True if the object is being disposed explicitly</param> |
||
3665 | </member> |
||
3666 | <member name="M:System.Data.SQLite.SQLiteFunction.Invoke(System.Object[])"> |
||
3667 | <summary> |
||
3668 | Scalar functions override this method to do their magic. |
||
3669 | </summary> |
||
3670 | <remarks> |
||
3671 | Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available |
||
3672 | to force them into a certain type. Therefore the only types you will ever see as parameters are |
||
3673 | DBNull.Value, Int64, Double, String or byte[] array. |
||
3674 | </remarks> |
||
3675 | <param name="args">The arguments for the command to process</param> |
||
3676 | <returns>You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or |
||
3677 | you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error, |
||
3678 | just return it!</returns> |
||
3679 | </member> |
||
3680 | <member name="M:System.Data.SQLite.SQLiteFunction.Step(System.Object[],System.Int32,System.Object@)"> |
||
3681 | <summary> |
||
3682 | Aggregate functions override this method to do their magic. |
||
3683 | </summary> |
||
3684 | <remarks> |
||
3685 | Typically you'll be updating whatever you've placed in the contextData field and returning as quickly as possible. |
||
3686 | </remarks> |
||
3687 | <param name="args">The arguments for the command to process</param> |
||
3688 | <param name="stepNumber">The 1-based step number. This is incrememted each time the step method is called.</param> |
||
3689 | <param name="contextData">A placeholder for implementers to store contextual data pertaining to the current context.</param> |
||
3690 | </member> |
||
3691 | <member name="M:System.Data.SQLite.SQLiteFunction.Final(System.Object)"> |
||
3692 | <summary> |
||
3693 | Aggregate functions override this method to finish their aggregate processing. |
||
3694 | </summary> |
||
3695 | <remarks> |
||
3696 | If you implemented your aggregate function properly, |
||
3697 | you've been recording and keeping track of your data in the contextData object provided, and now at this stage you should have |
||
3698 | all the information you need in there to figure out what to return. |
||
3699 | NOTE: It is possible to arrive here without receiving a previous call to Step(), in which case the contextData will |
||
3700 | be null. This can happen when no rows were returned. You can either return null, or 0 or some other custom return value |
||
3701 | if that is the case. |
||
3702 | </remarks> |
||
3703 | <param name="contextData">Your own assigned contextData, provided for you so you can return your final results.</param> |
||
3704 | <returns>You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or |
||
3705 | you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error, |
||
3706 | just return it! |
||
3707 | </returns> |
||
3708 | </member> |
||
3709 | <member name="M:System.Data.SQLite.SQLiteFunction.Compare(System.String,System.String)"> |
||
3710 | <summary> |
||
3711 | User-defined collation sequences override this method to provide a custom string sorting algorithm. |
||
3712 | </summary> |
||
3713 | <param name="param1">The first string to compare</param> |
||
3714 | <param name="param2">The second strnig to compare</param> |
||
3715 | <returns>1 if param1 is greater than param2, 0 if they are equal, or -1 if param1 is less than param2</returns> |
||
3716 | </member> |
||
3717 | <member name="M:System.Data.SQLite.SQLiteFunction.ConvertParams(System.Int32,System.IntPtr)"> |
||
3718 | <summary> |
||
3719 | Converts an IntPtr array of context arguments to an object array containing the resolved parameters the pointers point to. |
||
3720 | </summary> |
||
3721 | <remarks> |
||
3722 | Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available |
||
3723 | to force them into a certain type. Therefore the only types you will ever see as parameters are |
||
3724 | DBNull.Value, Int64, Double, String or byte[] array. |
||
3725 | </remarks> |
||
3726 | <param name="nArgs">The number of arguments</param> |
||
3727 | <param name="argsptr">A pointer to the array of arguments</param> |
||
3728 | <returns>An object array of the arguments once they've been converted to .NET values</returns> |
||
3729 | </member> |
||
3730 | <member name="M:System.Data.SQLite.SQLiteFunction.SetReturnValue(System.IntPtr,System.Object)"> |
||
3731 | <summary> |
||
3732 | Takes the return value from Invoke() and Final() and figures out how to return it to SQLite's context. |
||
3733 | </summary> |
||
3734 | <param name="context">The context the return value applies to</param> |
||
3735 | <param name="returnValue">The parameter to return to SQLite</param> |
||
3736 | </member> |
||
3737 | <member name="M:System.Data.SQLite.SQLiteFunction.ScalarCallback(System.IntPtr,System.Int32,System.IntPtr)"> |
||
3738 | <summary> |
||
3739 | Internal scalar callback function, which wraps the raw context pointer and calls the virtual Invoke() method. |
||
3740 | WARNING: Must not throw exceptions. |
||
3741 | </summary> |
||
3742 | <param name="context">A raw context pointer</param> |
||
3743 | <param name="nArgs">Number of arguments passed in</param> |
||
3744 | <param name="argsptr">A pointer to the array of arguments</param> |
||
3745 | </member> |
||
3746 | <member name="M:System.Data.SQLite.SQLiteFunction.CompareCallback(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"> |
||
3747 | <summary> |
||
3748 | Internal collation sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. |
||
3749 | WARNING: Must not throw exceptions. |
||
3750 | </summary> |
||
3751 | <param name="ptr">Not used</param> |
||
3752 | <param name="len1">Length of the string pv1</param> |
||
3753 | <param name="ptr1">Pointer to the first string to compare</param> |
||
3754 | <param name="len2">Length of the string pv2</param> |
||
3755 | <param name="ptr2">Pointer to the second string to compare</param> |
||
3756 | <returns>Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater |
||
3757 | than the second. Returns 0 if an exception is caught.</returns> |
||
3758 | </member> |
||
3759 | <member name="M:System.Data.SQLite.SQLiteFunction.CompareCallback16(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"> |
||
3760 | <summary> |
||
3761 | Internal collation sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. |
||
3762 | WARNING: Must not throw exceptions. |
||
3763 | </summary> |
||
3764 | <param name="ptr">Not used</param> |
||
3765 | <param name="len1">Length of the string pv1</param> |
||
3766 | <param name="ptr1">Pointer to the first string to compare</param> |
||
3767 | <param name="len2">Length of the string pv2</param> |
||
3768 | <param name="ptr2">Pointer to the second string to compare</param> |
||
3769 | <returns>Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater |
||
3770 | than the second. Returns 0 if an exception is caught.</returns> |
||
3771 | </member> |
||
3772 | <member name="M:System.Data.SQLite.SQLiteFunction.StepCallback(System.IntPtr,System.Int32,System.IntPtr)"> |
||
3773 | <summary> |
||
3774 | The internal aggregate Step function callback, which wraps the raw context pointer and calls the virtual Step() method. |
||
3775 | WARNING: Must not throw exceptions. |
||
3776 | </summary> |
||
3777 | <remarks> |
||
3778 | This function takes care of doing the lookups and getting the important information put together to call the Step() function. |
||
3779 | That includes pulling out the user's contextData and updating it after the call is made. We use a sorted list for this so |
||
3780 | binary searches can be done to find the data. |
||
3781 | </remarks> |
||
3782 | <param name="context">A raw context pointer</param> |
||
3783 | <param name="nArgs">Number of arguments passed in</param> |
||
3784 | <param name="argsptr">A pointer to the array of arguments</param> |
||
3785 | </member> |
||
3786 | <member name="M:System.Data.SQLite.SQLiteFunction.FinalCallback(System.IntPtr)"> |
||
3787 | <summary> |
||
3788 | An internal aggregate Final function callback, which wraps the context pointer and calls the virtual Final() method. |
||
3789 | WARNING: Must not throw exceptions. |
||
3790 | </summary> |
||
3791 | <param name="context">A raw context pointer</param> |
||
3792 | </member> |
||
3793 | <member name="M:System.Data.SQLite.SQLiteFunction.#cctor"> |
||
3794 | <summary> |
||
3795 | Using reflection, enumerate all assemblies in the current appdomain looking for classes that |
||
3796 | have a SQLiteFunctionAttribute attribute, and registering them accordingly. |
||
3797 | </summary> |
||
3798 | </member> |
||
3799 | <member name="M:System.Data.SQLite.SQLiteFunction.RegisterFunction(System.Type)"> |
||
3800 | <summary> |
||
3801 | Manual method of registering a function. The type must still have the SQLiteFunctionAttributes in order to work |
||
3802 | properly, but this is a workaround for the Compact Framework where enumerating assemblies is not currently supported. |
||
3803 | </summary> |
||
3804 | <param name="typ">The type of the function to register</param> |
||
3805 | </member> |
||
3806 | <member name="M:System.Data.SQLite.SQLiteFunction.BindFunctions(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteConnectionFlags)"> |
||
3807 | <summary> |
||
3808 | Called by SQLiteBase derived classes, this function binds all user-defined functions to a connection. |
||
3809 | It is done this way so that all user-defined functions will access the database using the same encoding scheme |
||
3810 | as the connection (UTF-8 or UTF-16). |
||
3811 | </summary> |
||
3812 | <remarks> |
||
3813 | The wrapper functions that interop with SQLite will create a unique cookie value, which internally is a pointer to |
||
3814 | all the wrapped callback functions. The interop function uses it to map CDecl callbacks to StdCall callbacks. |
||
3815 | </remarks> |
||
3816 | <param name="sqlbase">The base object on which the functions are to bind</param> |
||
3817 | <param name="flags">The flags associated with the parent connection object</param> |
||
3818 | <returns>Returns an array of functions which the connection object should retain until the connection is closed.</returns> |
||
3819 | </member> |
||
3820 | <member name="P:System.Data.SQLite.SQLiteFunction.SQLiteConvert"> |
||
3821 | <summary> |
||
3822 | Returns a reference to the underlying connection's SQLiteConvert class, which can be used to convert |
||
3823 | strings and DateTime's into the current connection's encoding schema. |
||
3824 | </summary> |
||
3825 | </member> |
||
3826 | <member name="T:System.Data.SQLite.SQLiteFunctionEx"> |
||
3827 | <summary> |
||
3828 | Extends SQLiteFunction and allows an inherited class to obtain the collating sequence associated with a function call. |
||
3829 | </summary> |
||
3830 | <remarks> |
||
3831 | User-defined functions can call the GetCollationSequence() method in this class and use it to compare strings and char arrays. |
||
3832 | </remarks> |
||
3833 | </member> |
||
3834 | <member name="M:System.Data.SQLite.SQLiteFunctionEx.GetCollationSequence"> |
||
3835 | <summary> |
||
3836 | Obtains the collating sequence in effect for the given function. |
||
3837 | </summary> |
||
3838 | <returns></returns> |
||
3839 | </member> |
||
3840 | <member name="T:System.Data.SQLite.FunctionType"> |
||
3841 | <summary> |
||
3842 | The type of user-defined function to declare |
||
3843 | </summary> |
||
3844 | </member> |
||
3845 | <member name="F:System.Data.SQLite.FunctionType.Scalar"> |
||
3846 | <summary> |
||
3847 | Scalar functions are designed to be called and return a result immediately. Examples include ABS(), Upper(), Lower(), etc. |
||
3848 | </summary> |
||
3849 | </member> |
||
3850 | <member name="F:System.Data.SQLite.FunctionType.Aggregate"> |
||
3851 | <summary> |
||
3852 | Aggregate functions are designed to accumulate data until the end of a call and then return a result gleaned from the accumulated data. |
||
3853 | Examples include SUM(), COUNT(), AVG(), etc. |
||
3854 | </summary> |
||
3855 | </member> |
||
3856 | <member name="F:System.Data.SQLite.FunctionType.Collation"> |
||
3857 | <summary> |
||
3858 | Collation sequences are used to sort textual data in a custom manner, and appear in an ORDER BY clause. Typically text in an ORDER BY is |
||
3859 | sorted using a straight case-insensitive comparison function. Custom collating sequences can be used to alter the behavior of text sorting |
||
3860 | in a user-defined manner. |
||
3861 | </summary> |
||
3862 | </member> |
||
3863 | <member name="T:System.Data.SQLite.SQLiteCallback"> |
||
3864 | <summary> |
||
3865 | An internal callback delegate declaration. |
||
3866 | </summary> |
||
3867 | <param name="context">Raw context pointer for the user function</param> |
||
3868 | <param name="nArgs">Count of arguments to the function</param> |
||
3869 | <param name="argsptr">A pointer to the array of argument pointers</param> |
||
3870 | </member> |
||
3871 | <member name="T:System.Data.SQLite.SQLiteFinalCallback"> |
||
3872 | <summary> |
||
3873 | An internal final callback delegate declaration. |
||
3874 | </summary> |
||
3875 | <param name="context">Raw context pointer for the user function</param> |
||
3876 | </member> |
||
3877 | <member name="T:System.Data.SQLite.SQLiteCollation"> |
||
3878 | <summary> |
||
3879 | Internal callback delegate for implementing collation sequences |
||
3880 | </summary> |
||
3881 | <param name="puser">Not used</param> |
||
3882 | <param name="len1">Length of the string pv1</param> |
||
3883 | <param name="pv1">Pointer to the first string to compare</param> |
||
3884 | <param name="len2">Length of the string pv2</param> |
||
3885 | <param name="pv2">Pointer to the second string to compare</param> |
||
3886 | <returns>Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater |
||
3887 | than the second.</returns> |
||
3888 | </member> |
||
3889 | <member name="T:System.Data.SQLite.CollationTypeEnum"> |
||
3890 | <summary> |
||
3891 | The type of collating sequence |
||
3892 | </summary> |
||
3893 | </member> |
||
3894 | <member name="F:System.Data.SQLite.CollationTypeEnum.Binary"> |
||
3895 | <summary> |
||
3896 | The built-in BINARY collating sequence |
||
3897 | </summary> |
||
3898 | </member> |
||
3899 | <member name="F:System.Data.SQLite.CollationTypeEnum.NoCase"> |
||
3900 | <summary> |
||
3901 | The built-in NOCASE collating sequence |
||
3902 | </summary> |
||
3903 | </member> |
||
3904 | <member name="F:System.Data.SQLite.CollationTypeEnum.Reverse"> |
||
3905 | <summary> |
||
3906 | The built-in REVERSE collating sequence |
||
3907 | </summary> |
||
3908 | </member> |
||
3909 | <member name="F:System.Data.SQLite.CollationTypeEnum.Custom"> |
||
3910 | <summary> |
||
3911 | A custom user-defined collating sequence |
||
3912 | </summary> |
||
3913 | </member> |
||
3914 | <member name="T:System.Data.SQLite.CollationEncodingEnum"> |
||
3915 | <summary> |
||
3916 | The encoding type the collation sequence uses |
||
3917 | </summary> |
||
3918 | </member> |
||
3919 | <member name="F:System.Data.SQLite.CollationEncodingEnum.UTF8"> |
||
3920 | <summary> |
||
3921 | The collation sequence is UTF8 |
||
3922 | </summary> |
||
3923 | </member> |
||
3924 | <member name="F:System.Data.SQLite.CollationEncodingEnum.UTF16LE"> |
||
3925 | <summary> |
||
3926 | The collation sequence is UTF16 little-endian |
||
3927 | </summary> |
||
3928 | </member> |
||
3929 | <member name="F:System.Data.SQLite.CollationEncodingEnum.UTF16BE"> |
||
3930 | <summary> |
||
3931 | The collation sequence is UTF16 big-endian |
||
3932 | </summary> |
||
3933 | </member> |
||
3934 | <member name="T:System.Data.SQLite.CollationSequence"> |
||
3935 | <summary> |
||
3936 | A struct describing the collating sequence a function is executing in |
||
3937 | </summary> |
||
3938 | </member> |
||
3939 | <member name="F:System.Data.SQLite.CollationSequence.Name"> |
||
3940 | <summary> |
||
3941 | The name of the collating sequence |
||
3942 | </summary> |
||
3943 | </member> |
||
3944 | <member name="F:System.Data.SQLite.CollationSequence.Type"> |
||
3945 | <summary> |
||
3946 | The type of collating sequence |
||
3947 | </summary> |
||
3948 | </member> |
||
3949 | <member name="F:System.Data.SQLite.CollationSequence.Encoding"> |
||
3950 | <summary> |
||
3951 | The text encoding of the collation sequence |
||
3952 | </summary> |
||
3953 | </member> |
||
3954 | <member name="F:System.Data.SQLite.CollationSequence._func"> |
||
3955 | <summary> |
||
3956 | Context of the function that requested the collating sequence |
||
3957 | </summary> |
||
3958 | </member> |
||
3959 | <member name="M:System.Data.SQLite.CollationSequence.Compare(System.String,System.String)"> |
||
3960 | <summary> |
||
3961 | Calls the base collating sequence to compare two strings |
||
3962 | </summary> |
||
3963 | <param name="s1">The first string to compare</param> |
||
3964 | <param name="s2">The second string to compare</param> |
||
3965 | <returns>-1 if s1 is less than s2, 0 if s1 is equal to s2, and 1 if s1 is greater than s2</returns> |
||
3966 | </member> |
||
3967 | <member name="M:System.Data.SQLite.CollationSequence.Compare(System.Char[],System.Char[])"> |
||
3968 | <summary> |
||
3969 | Calls the base collating sequence to compare two character arrays |
||
3970 | </summary> |
||
3971 | <param name="c1">The first array to compare</param> |
||
3972 | <param name="c2">The second array to compare</param> |
||
3973 | <returns>-1 if c1 is less than c2, 0 if c1 is equal to c2, and 1 if c1 is greater than c2</returns> |
||
3974 | </member> |
||
3975 | <member name="T:System.Data.SQLite.SQLiteFunctionAttribute"> |
||
3976 | <summary> |
||
3977 | A simple custom attribute to enable us to easily find user-defined functions in |
||
3978 | the loaded assemblies and initialize them in SQLite as connections are made. |
||
3979 | </summary> |
||
3980 | </member> |
||
3981 | <member name="M:System.Data.SQLite.SQLiteFunctionAttribute.#ctor"> |
||
3982 | <summary> |
||
3983 | Default constructor, initializes the internal variables for the function. |
||
3984 | </summary> |
||
3985 | </member> |
||
3986 | <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.Name"> |
||
3987 | <summary> |
||
3988 | The function's name as it will be used in SQLite command text. |
||
3989 | </summary> |
||
3990 | </member> |
||
3991 | <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.Arguments"> |
||
3992 | <summary> |
||
3993 | The number of arguments this function expects. -1 if the number of arguments is variable. |
||
3994 | </summary> |
||
3995 | </member> |
||
3996 | <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.FuncType"> |
||
3997 | <summary> |
||
3998 | The type of function this implementation will be. |
||
3999 | </summary> |
||
4000 | </member> |
||
4001 | <member name="T:System.Data.SQLite.SQLiteKeyReader"> |
||
4002 | <summary> |
||
4003 | This class provides key info for a given SQLite statement. |
||
4004 | <remarks> |
||
4005 | Providing key information for a given statement is non-trivial :( |
||
4006 | </remarks> |
||
4007 | </summary> |
||
4008 | </member> |
||
4009 | <member name="M:System.Data.SQLite.SQLiteKeyReader.#ctor(System.Data.SQLite.SQLiteConnection,System.Data.SQLite.SQLiteDataReader,System.Data.SQLite.SQLiteStatement)"> |
||
4010 | <summary> |
||
4011 | This function does all the nasty work at determining what keys need to be returned for |
||
4012 | a given statement. |
||
4013 | </summary> |
||
4014 | <param name="cnn"></param> |
||
4015 | <param name="reader"></param> |
||
4016 | <param name="stmt"></param> |
||
4017 | </member> |
||
4018 | <member name="M:System.Data.SQLite.SQLiteKeyReader.Sync"> |
||
4019 | <summary> |
||
4020 | Make sure all the subqueries are open and ready and sync'd with the current rowid |
||
4021 | of the table they're supporting |
||
4022 | </summary> |
||
4023 | </member> |
||
4024 | <member name="M:System.Data.SQLite.SQLiteKeyReader.Reset"> |
||
4025 | <summary> |
||
4026 | Release any readers on any subqueries |
||
4027 | </summary> |
||
4028 | </member> |
||
4029 | <member name="M:System.Data.SQLite.SQLiteKeyReader.AppendSchemaTable(System.Data.DataTable)"> |
||
4030 | <summary> |
||
4031 | Append all the columns we've added to the original query to the schema |
||
4032 | </summary> |
||
4033 | <param name="tbl"></param> |
||
4034 | </member> |
||
4035 | <member name="P:System.Data.SQLite.SQLiteKeyReader.Count"> |
||
4036 | <summary> |
||
4037 | How many additional columns of keyinfo we're holding |
||
4038 | </summary> |
||
4039 | </member> |
||
4040 | <member name="T:System.Data.SQLite.SQLiteKeyReader.KeyInfo"> |
||
4041 | <summary> |
||
4042 | Used to support CommandBehavior.KeyInfo |
||
4043 | </summary> |
||
4044 | </member> |
||
4045 | <member name="T:System.Data.SQLite.SQLiteKeyReader.KeyQuery"> |
||
4046 | <summary> |
||
4047 | A single sub-query for a given table/database. |
||
4048 | </summary> |
||
4049 | </member> |
||
4050 | <member name="T:System.Data.SQLite.LogEventArgs"> |
||
4051 | <summary> |
||
4052 | Event data for logging event handlers. |
||
4053 | </summary> |
||
4054 | </member> |
||
4055 | <member name="F:System.Data.SQLite.LogEventArgs.ErrorCode"> |
||
4056 | <summary> |
||
4057 | The error code. The type of this object value should be |
||
4058 | <see cref="T:System.Int32"/> or <see cref="T:System.Data.SQLite.SQLiteErrorCode"/>. |
||
4059 | </summary> |
||
4060 | </member> |
||
4061 | <member name="F:System.Data.SQLite.LogEventArgs.Message"> |
||
4062 | <summary> |
||
4063 | SQL statement text as the statement first begins executing |
||
4064 | </summary> |
||
4065 | </member> |
||
4066 | <member name="F:System.Data.SQLite.LogEventArgs.Data"> |
||
4067 | <summary> |
||
4068 | Extra data associated with this event, if any. |
||
4069 | </summary> |
||
4070 | </member> |
||
4071 | <member name="M:System.Data.SQLite.LogEventArgs.#ctor(System.IntPtr,System.Object,System.String,System.Object)"> |
||
4072 | <summary> |
||
4073 | Constructs the object. |
||
4074 | </summary> |
||
4075 | <param name="pUserData">Should be null.</param> |
||
4076 | <param name="errorCode"> |
||
4077 | The error code. The type of this object value should be |
||
4078 | <see cref="T:System.Int32"/> or <see cref="T:System.Data.SQLite.SQLiteErrorCode"/>. |
||
4079 | </param> |
||
4080 | <param name="message">The error message, if any.</param> |
||
4081 | <param name="data">The extra data, if any.</param> |
||
4082 | </member> |
||
4083 | <member name="T:System.Data.SQLite.SQLiteLogEventHandler"> |
||
4084 | <summary> |
||
4085 | Raised when a log event occurs. |
||
4086 | </summary> |
||
4087 | <param name="sender">The current connection</param> |
||
4088 | <param name="e">Event arguments of the trace</param> |
||
4089 | </member> |
||
4090 | <member name="T:System.Data.SQLite.SQLiteMetaDataCollectionNames"> |
||
4091 | <summary> |
||
4092 | MetaDataCollections specific to SQLite |
||
4093 | </summary> |
||
4094 | </member> |
||
4095 | <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Catalogs"> |
||
4096 | <summary> |
||
4097 | Returns a list of databases attached to the connection |
||
4098 | </summary> |
||
4099 | </member> |
||
4100 | <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Columns"> |
||
4101 | <summary> |
||
4102 | Returns column information for the specified table |
||
4103 | </summary> |
||
4104 | </member> |
||
4105 | <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Indexes"> |
||
4106 | <summary> |
||
4107 | Returns index information for the optionally-specified table |
||
4108 | </summary> |
||
4109 | </member> |
||
4110 | <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.IndexColumns"> |
||
4111 | <summary> |
||
4112 | Returns base columns for the given index |
||
4113 | </summary> |
||
4114 | </member> |
||
4115 | <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Tables"> |
||
4116 | <summary> |
||
4117 | Returns the tables in the given catalog |
||
4118 | </summary> |
||
4119 | </member> |
||
4120 | <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Views"> |
||
4121 | <summary> |
||
4122 | Returns user-defined views in the given catalog |
||
4123 | </summary> |
||
4124 | </member> |
||
4125 | <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.ViewColumns"> |
||
4126 | <summary> |
||
4127 | Returns underlying column information on the given view |
||
4128 | </summary> |
||
4129 | </member> |
||
4130 | <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.ForeignKeys"> |
||
4131 | <summary> |
||
4132 | Returns foreign key information for the given catalog |
||
4133 | </summary> |
||
4134 | </member> |
||
4135 | <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Triggers"> |
||
4136 | <summary> |
||
4137 | Returns the triggers on the database |
||
4138 | </summary> |
||
4139 | </member> |
||
4140 | <member name="T:System.Data.SQLite.SQLiteParameter"> |
||
4141 | <summary> |
||
4142 | SQLite implementation of DbParameter. |
||
4143 | </summary> |
||
4144 | </member> |
||
4145 | <member name="F:System.Data.SQLite.SQLiteParameter._dbType"> |
||
4146 | <summary> |
||
4147 | The data type of the parameter |
||
4148 | </summary> |
||
4149 | </member> |
||
4150 | <member name="F:System.Data.SQLite.SQLiteParameter._rowVersion"> |
||
4151 | <summary> |
||
4152 | The version information for mapping the parameter |
||
4153 | </summary> |
||
4154 | </member> |
||
4155 | <member name="F:System.Data.SQLite.SQLiteParameter._objValue"> |
||
4156 | <summary> |
||
4157 | The value of the data in the parameter |
||
4158 | </summary> |
||
4159 | </member> |
||
4160 | <member name="F:System.Data.SQLite.SQLiteParameter._sourceColumn"> |
||
4161 | <summary> |
||
4162 | The source column for the parameter |
||
4163 | </summary> |
||
4164 | </member> |
||
4165 | <member name="F:System.Data.SQLite.SQLiteParameter._parameterName"> |
||
4166 | <summary> |
||
4167 | The column name |
||
4168 | </summary> |
||
4169 | </member> |
||
4170 | <member name="F:System.Data.SQLite.SQLiteParameter._dataSize"> |
||
4171 | <summary> |
||
4172 | The data size, unused by SQLite |
||
4173 | </summary> |
||
4174 | </member> |
||
4175 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor"> |
||
4176 | <summary> |
||
4177 | Default constructor |
||
4178 | </summary> |
||
4179 | </member> |
||
4180 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String)"> |
||
4181 | <summary> |
||
4182 | Constructs a named parameter given the specified parameter name |
||
4183 | </summary> |
||
4184 | <param name="parameterName">The parameter name</param> |
||
4185 | </member> |
||
4186 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Object)"> |
||
4187 | <summary> |
||
4188 | Constructs a named parameter given the specified parameter name and initial value |
||
4189 | </summary> |
||
4190 | <param name="parameterName">The parameter name</param> |
||
4191 | <param name="value">The initial value of the parameter</param> |
||
4192 | </member> |
||
4193 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType)"> |
||
4194 | <summary> |
||
4195 | Constructs a named parameter of the specified type |
||
4196 | </summary> |
||
4197 | <param name="parameterName">The parameter name</param> |
||
4198 | <param name="dbType">The datatype of the parameter</param> |
||
4199 | </member> |
||
4200 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.String)"> |
||
4201 | <summary> |
||
4202 | Constructs a named parameter of the specified type and source column reference |
||
4203 | </summary> |
||
4204 | <param name="parameterName">The parameter name</param> |
||
4205 | <param name="dbType">The data type</param> |
||
4206 | <param name="sourceColumn">The source column</param> |
||
4207 | </member> |
||
4208 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.String,System.Data.DataRowVersion)"> |
||
4209 | <summary> |
||
4210 | Constructs a named parameter of the specified type, source column and row version |
||
4211 | </summary> |
||
4212 | <param name="parameterName">The parameter name</param> |
||
4213 | <param name="dbType">The data type</param> |
||
4214 | <param name="sourceColumn">The source column</param> |
||
4215 | <param name="rowVersion">The row version information</param> |
||
4216 | </member> |
||
4217 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType)"> |
||
4218 | <summary> |
||
4219 | Constructs an unnamed parameter of the specified data type |
||
4220 | </summary> |
||
4221 | <param name="dbType">The datatype of the parameter</param> |
||
4222 | </member> |
||
4223 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Object)"> |
||
4224 | <summary> |
||
4225 | Constructs an unnamed parameter of the specified data type and sets the initial value |
||
4226 | </summary> |
||
4227 | <param name="dbType">The datatype of the parameter</param> |
||
4228 | <param name="value">The initial value of the parameter</param> |
||
4229 | </member> |
||
4230 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.String)"> |
||
4231 | <summary> |
||
4232 | Constructs an unnamed parameter of the specified data type and source column |
||
4233 | </summary> |
||
4234 | <param name="dbType">The datatype of the parameter</param> |
||
4235 | <param name="sourceColumn">The source column</param> |
||
4236 | </member> |
||
4237 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.String,System.Data.DataRowVersion)"> |
||
4238 | <summary> |
||
4239 | Constructs an unnamed parameter of the specified data type, source column and row version |
||
4240 | </summary> |
||
4241 | <param name="dbType">The data type</param> |
||
4242 | <param name="sourceColumn">The source column</param> |
||
4243 | <param name="rowVersion">The row version information</param> |
||
4244 | </member> |
||
4245 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32)"> |
||
4246 | <summary> |
||
4247 | Constructs a named parameter of the specified type and size |
||
4248 | </summary> |
||
4249 | <param name="parameterName">The parameter name</param> |
||
4250 | <param name="parameterType">The data type</param> |
||
4251 | <param name="parameterSize">The size of the parameter</param> |
||
4252 | </member> |
||
4253 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.String)"> |
||
4254 | <summary> |
||
4255 | Constructs a named parameter of the specified type, size and source column |
||
4256 | </summary> |
||
4257 | <param name="parameterName">The name of the parameter</param> |
||
4258 | <param name="parameterType">The data type</param> |
||
4259 | <param name="parameterSize">The size of the parameter</param> |
||
4260 | <param name="sourceColumn">The source column</param> |
||
4261 | </member> |
||
4262 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.String,System.Data.DataRowVersion)"> |
||
4263 | <summary> |
||
4264 | Constructs a named parameter of the specified type, size, source column and row version |
||
4265 | </summary> |
||
4266 | <param name="parameterName">The name of the parameter</param> |
||
4267 | <param name="parameterType">The data type</param> |
||
4268 | <param name="parameterSize">The size of the parameter</param> |
||
4269 | <param name="sourceColumn">The source column</param> |
||
4270 | <param name="rowVersion">The row version information</param> |
||
4271 | </member> |
||
4272 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.Data.ParameterDirection,System.Boolean,System.Byte,System.Byte,System.String,System.Data.DataRowVersion,System.Object)"> |
||
4273 | <summary> |
||
4274 | Constructs a named parameter of the specified type, size, source column and row version |
||
4275 | </summary> |
||
4276 | <param name="parameterName">The name of the parameter</param> |
||
4277 | <param name="parameterType">The data type</param> |
||
4278 | <param name="parameterSize">The size of the parameter</param> |
||
4279 | <param name="direction">Only input parameters are supported in SQLite</param> |
||
4280 | <param name="isNullable">Ignored</param> |
||
4281 | <param name="precision">Ignored</param> |
||
4282 | <param name="scale">Ignored</param> |
||
4283 | <param name="sourceColumn">The source column</param> |
||
4284 | <param name="rowVersion">The row version information</param> |
||
4285 | <param name="value">The initial value to assign the parameter</param> |
||
4286 | </member> |
||
4287 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.Data.ParameterDirection,System.Byte,System.Byte,System.String,System.Data.DataRowVersion,System.Boolean,System.Object)"> |
||
4288 | <summary> |
||
4289 | Constructs a named parameter, yet another flavor |
||
4290 | </summary> |
||
4291 | <param name="parameterName">The name of the parameter</param> |
||
4292 | <param name="parameterType">The data type</param> |
||
4293 | <param name="parameterSize">The size of the parameter</param> |
||
4294 | <param name="direction">Only input parameters are supported in SQLite</param> |
||
4295 | <param name="precision">Ignored</param> |
||
4296 | <param name="scale">Ignored</param> |
||
4297 | <param name="sourceColumn">The source column</param> |
||
4298 | <param name="rowVersion">The row version information</param> |
||
4299 | <param name="sourceColumnNullMapping">Whether or not this parameter is for comparing NULL's</param> |
||
4300 | <param name="value">The intial value to assign the parameter</param> |
||
4301 | </member> |
||
4302 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Int32)"> |
||
4303 | <summary> |
||
4304 | Constructs an unnamed parameter of the specified type and size |
||
4305 | </summary> |
||
4306 | <param name="parameterType">The data type</param> |
||
4307 | <param name="parameterSize">The size of the parameter</param> |
||
4308 | </member> |
||
4309 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Int32,System.String)"> |
||
4310 | <summary> |
||
4311 | Constructs an unnamed parameter of the specified type, size, and source column |
||
4312 | </summary> |
||
4313 | <param name="parameterType">The data type</param> |
||
4314 | <param name="parameterSize">The size of the parameter</param> |
||
4315 | <param name="sourceColumn">The source column</param> |
||
4316 | </member> |
||
4317 | <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Int32,System.String,System.Data.DataRowVersion)"> |
||
4318 | <summary> |
||
4319 | Constructs an unnamed parameter of the specified type, size, source column and row version |
||
4320 | </summary> |
||
4321 | <param name="parameterType">The data type</param> |
||
4322 | <param name="parameterSize">The size of the parameter</param> |
||
4323 | <param name="sourceColumn">The source column</param> |
||
4324 | <param name="rowVersion">The row version information</param> |
||
4325 | </member> |
||
4326 | <member name="M:System.Data.SQLite.SQLiteParameter.ResetDbType"> |
||
4327 | <summary> |
||
4328 | Resets the DbType of the parameter so it can be inferred from the value |
||
4329 | </summary> |
||
4330 | </member> |
||
4331 | <member name="M:System.Data.SQLite.SQLiteParameter.Clone"> |
||
4332 | <summary> |
||
4333 | Clones a parameter |
||
4334 | </summary> |
||
4335 | <returns>A new, unassociated SQLiteParameter</returns> |
||
4336 | </member> |
||
4337 | <member name="P:System.Data.SQLite.SQLiteParameter.IsNullable"> |
||
4338 | <summary> |
||
4339 | Whether or not the parameter can contain a null value |
||
4340 | </summary> |
||
4341 | </member> |
||
4342 | <member name="P:System.Data.SQLite.SQLiteParameter.DbType"> |
||
4343 | <summary> |
||
4344 | Returns the datatype of the parameter |
||
4345 | </summary> |
||
4346 | </member> |
||
4347 | <member name="P:System.Data.SQLite.SQLiteParameter.Direction"> |
||
4348 | <summary> |
||
4349 | Supports only input parameters |
||
4350 | </summary> |
||
4351 | </member> |
||
4352 | <member name="P:System.Data.SQLite.SQLiteParameter.ParameterName"> |
||
4353 | <summary> |
||
4354 | Returns the parameter name |
||
4355 | </summary> |
||
4356 | </member> |
||
4357 | <member name="P:System.Data.SQLite.SQLiteParameter.Size"> |
||
4358 | <summary> |
||
4359 | Returns the size of the parameter |
||
4360 | </summary> |
||
4361 | </member> |
||
4362 | <member name="P:System.Data.SQLite.SQLiteParameter.SourceColumn"> |
||
4363 | <summary> |
||
4364 | Gets/sets the source column |
||
4365 | </summary> |
||
4366 | </member> |
||
4367 | <member name="P:System.Data.SQLite.SQLiteParameter.SourceColumnNullMapping"> |
||
4368 | <summary> |
||
4369 | Used by DbCommandBuilder to determine the mapping for nullable fields |
||
4370 | </summary> |
||
4371 | </member> |
||
4372 | <member name="P:System.Data.SQLite.SQLiteParameter.SourceVersion"> |
||
4373 | <summary> |
||
4374 | Gets and sets the row version |
||
4375 | </summary> |
||
4376 | </member> |
||
4377 | <member name="P:System.Data.SQLite.SQLiteParameter.Value"> |
||
4378 | <summary> |
||
4379 | Gets and sets the parameter value. If no datatype was specified, the datatype will assume the type from the value given. |
||
4380 | </summary> |
||
4381 | </member> |
||
4382 | <member name="T:System.Data.SQLite.SQLiteParameterCollection"> |
||
4383 | <summary> |
||
4384 | SQLite implementation of DbParameterCollection. |
||
4385 | </summary> |
||
4386 | </member> |
||
4387 | <member name="F:System.Data.SQLite.SQLiteParameterCollection._command"> |
||
4388 | <summary> |
||
4389 | The underlying command to which this collection belongs |
||
4390 | </summary> |
||
4391 | </member> |
||
4392 | <member name="F:System.Data.SQLite.SQLiteParameterCollection._parameterList"> |
||
4393 | <summary> |
||
4394 | The internal array of parameters in this collection |
||
4395 | </summary> |
||
4396 | </member> |
||
4397 | <member name="F:System.Data.SQLite.SQLiteParameterCollection._unboundFlag"> |
||
4398 | <summary> |
||
4399 | Determines whether or not all parameters have been bound to their statement(s) |
||
4400 | </summary> |
||
4401 | </member> |
||
4402 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.#ctor(System.Data.SQLite.SQLiteCommand)"> |
||
4403 | <summary> |
||
4404 | Initializes the collection |
||
4405 | </summary> |
||
4406 | <param name="cmd">The command to which the collection belongs</param> |
||
4407 | </member> |
||
4408 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.GetEnumerator"> |
||
4409 | <summary> |
||
4410 | Retrieves an enumerator for the collection |
||
4411 | </summary> |
||
4412 | <returns>An enumerator for the underlying array</returns> |
||
4413 | </member> |
||
4414 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.String,System.Data.DbType,System.Int32,System.String)"> |
||
4415 | <summary> |
||
4416 | Adds a parameter to the collection |
||
4417 | </summary> |
||
4418 | <param name="parameterName">The parameter name</param> |
||
4419 | <param name="parameterType">The data type</param> |
||
4420 | <param name="parameterSize">The size of the value</param> |
||
4421 | <param name="sourceColumn">The source column</param> |
||
4422 | <returns>A SQLiteParameter object</returns> |
||
4423 | </member> |
||
4424 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.String,System.Data.DbType,System.Int32)"> |
||
4425 | <summary> |
||
4426 | Adds a parameter to the collection |
||
4427 | </summary> |
||
4428 | <param name="parameterName">The parameter name</param> |
||
4429 | <param name="parameterType">The data type</param> |
||
4430 | <param name="parameterSize">The size of the value</param> |
||
4431 | <returns>A SQLiteParameter object</returns> |
||
4432 | </member> |
||
4433 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.String,System.Data.DbType)"> |
||
4434 | <summary> |
||
4435 | Adds a parameter to the collection |
||
4436 | </summary> |
||
4437 | <param name="parameterName">The parameter name</param> |
||
4438 | <param name="parameterType">The data type</param> |
||
4439 | <returns>A SQLiteParameter object</returns> |
||
4440 | </member> |
||
4441 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.Data.SQLite.SQLiteParameter)"> |
||
4442 | <summary> |
||
4443 | Adds a parameter to the collection |
||
4444 | </summary> |
||
4445 | <param name="parameter">The parameter to add</param> |
||
4446 | <returns>A zero-based index of where the parameter is located in the array</returns> |
||
4447 | </member> |
||
4448 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.Object)"> |
||
4449 | <summary> |
||
4450 | Adds a parameter to the collection |
||
4451 | </summary> |
||
4452 | <param name="value">The parameter to add</param> |
||
4453 | <returns>A zero-based index of where the parameter is located in the array</returns> |
||
4454 | </member> |
||
4455 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.AddWithValue(System.String,System.Object)"> |
||
4456 | <summary> |
||
4457 | Adds a named/unnamed parameter and its value to the parameter collection. |
||
4458 | </summary> |
||
4459 | <param name="parameterName">Name of the parameter, or null to indicate an unnamed parameter</param> |
||
4460 | <param name="value">The initial value of the parameter</param> |
||
4461 | <returns>Returns the SQLiteParameter object created during the call.</returns> |
||
4462 | </member> |
||
4463 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.AddRange(System.Data.SQLite.SQLiteParameter[])"> |
||
4464 | <summary> |
||
4465 | Adds an array of parameters to the collection |
||
4466 | </summary> |
||
4467 | <param name="values">The array of parameters to add</param> |
||
4468 | </member> |
||
4469 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.AddRange(System.Array)"> |
||
4470 | <summary> |
||
4471 | Adds an array of parameters to the collection |
||
4472 | </summary> |
||
4473 | <param name="values">The array of parameters to add</param> |
||
4474 | </member> |
||
4475 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.Clear"> |
||
4476 | <summary> |
||
4477 | Clears the array and resets the collection |
||
4478 | </summary> |
||
4479 | </member> |
||
4480 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.Contains(System.String)"> |
||
4481 | <summary> |
||
4482 | Determines if the named parameter exists in the collection |
||
4483 | </summary> |
||
4484 | <param name="parameterName">The name of the parameter to check</param> |
||
4485 | <returns>True if the parameter is in the collection</returns> |
||
4486 | </member> |
||
4487 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.Contains(System.Object)"> |
||
4488 | <summary> |
||
4489 | Determines if the parameter exists in the collection |
||
4490 | </summary> |
||
4491 | <param name="value">The SQLiteParameter to check</param> |
||
4492 | <returns>True if the parameter is in the collection</returns> |
||
4493 | </member> |
||
4494 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.CopyTo(System.Array,System.Int32)"> |
||
4495 | <summary> |
||
4496 | Not implemented |
||
4497 | </summary> |
||
4498 | <param name="array"></param> |
||
4499 | <param name="index"></param> |
||
4500 | </member> |
||
4501 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.GetParameter(System.String)"> |
||
4502 | <summary> |
||
4503 | Retrieve a parameter by name from the collection |
||
4504 | </summary> |
||
4505 | <param name="parameterName">The name of the parameter to fetch</param> |
||
4506 | <returns>A DbParameter object</returns> |
||
4507 | </member> |
||
4508 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.GetParameter(System.Int32)"> |
||
4509 | <summary> |
||
4510 | Retrieves a parameter by its index in the collection |
||
4511 | </summary> |
||
4512 | <param name="index">The index of the parameter to retrieve</param> |
||
4513 | <returns>A DbParameter object</returns> |
||
4514 | </member> |
||
4515 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.IndexOf(System.String)"> |
||
4516 | <summary> |
||
4517 | Returns the index of a parameter given its name |
||
4518 | </summary> |
||
4519 | <param name="parameterName">The name of the parameter to find</param> |
||
4520 | <returns>-1 if not found, otherwise a zero-based index of the parameter</returns> |
||
4521 | </member> |
||
4522 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.IndexOf(System.Object)"> |
||
4523 | <summary> |
||
4524 | Returns the index of a parameter |
||
4525 | </summary> |
||
4526 | <param name="value">The parameter to find</param> |
||
4527 | <returns>-1 if not found, otherwise a zero-based index of the parameter</returns> |
||
4528 | </member> |
||
4529 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.Insert(System.Int32,System.Object)"> |
||
4530 | <summary> |
||
4531 | Inserts a parameter into the array at the specified location |
||
4532 | </summary> |
||
4533 | <param name="index">The zero-based index to insert the parameter at</param> |
||
4534 | <param name="value">The parameter to insert</param> |
||
4535 | </member> |
||
4536 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.Remove(System.Object)"> |
||
4537 | <summary> |
||
4538 | Removes a parameter from the collection |
||
4539 | </summary> |
||
4540 | <param name="value">The parameter to remove</param> |
||
4541 | </member> |
||
4542 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.RemoveAt(System.String)"> |
||
4543 | <summary> |
||
4544 | Removes a parameter from the collection given its name |
||
4545 | </summary> |
||
4546 | <param name="parameterName">The name of the parameter to remove</param> |
||
4547 | </member> |
||
4548 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.RemoveAt(System.Int32)"> |
||
4549 | <summary> |
||
4550 | Removes a parameter from the collection given its index |
||
4551 | </summary> |
||
4552 | <param name="index">The zero-based parameter index to remove</param> |
||
4553 | </member> |
||
4554 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.SetParameter(System.String,System.Data.Common.DbParameter)"> |
||
4555 | <summary> |
||
4556 | Re-assign the named parameter to a new parameter object |
||
4557 | </summary> |
||
4558 | <param name="parameterName">The name of the parameter to replace</param> |
||
4559 | <param name="value">The new parameter</param> |
||
4560 | </member> |
||
4561 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.SetParameter(System.Int32,System.Data.Common.DbParameter)"> |
||
4562 | <summary> |
||
4563 | Re-assign a parameter at the specified index |
||
4564 | </summary> |
||
4565 | <param name="index">The zero-based index of the parameter to replace</param> |
||
4566 | <param name="value">The new parameter</param> |
||
4567 | </member> |
||
4568 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.Unbind"> |
||
4569 | <summary> |
||
4570 | Un-binds all parameters from their statements |
||
4571 | </summary> |
||
4572 | </member> |
||
4573 | <member name="M:System.Data.SQLite.SQLiteParameterCollection.MapParameters(System.Data.SQLite.SQLiteStatement)"> |
||
4574 | <summary> |
||
4575 | This function attempts to map all parameters in the collection to all statements in a Command. |
||
4576 | Since named parameters may span multiple statements, this function makes sure all statements are bound |
||
4577 | to the same named parameter. Unnamed parameters are bound in sequence. |
||
4578 | </summary> |
||
4579 | </member> |
||
4580 | <member name="P:System.Data.SQLite.SQLiteParameterCollection.IsSynchronized"> |
||
4581 | <summary> |
||
4582 | Returns true |
||
4583 | </summary> |
||
4584 | </member> |
||
4585 | <member name="P:System.Data.SQLite.SQLiteParameterCollection.IsFixedSize"> |
||
4586 | <summary> |
||
4587 | Returns false |
||
4588 | </summary> |
||
4589 | </member> |
||
4590 | <member name="P:System.Data.SQLite.SQLiteParameterCollection.IsReadOnly"> |
||
4591 | <summary> |
||
4592 | Returns false |
||
4593 | </summary> |
||
4594 | </member> |
||
4595 | <member name="P:System.Data.SQLite.SQLiteParameterCollection.SyncRoot"> |
||
4596 | <summary> |
||
4597 | Returns null |
||
4598 | </summary> |
||
4599 | </member> |
||
4600 | <member name="P:System.Data.SQLite.SQLiteParameterCollection.Count"> |
||
4601 | <summary> |
||
4602 | Returns a count of parameters in the collection |
||
4603 | </summary> |
||
4604 | </member> |
||
4605 | <member name="P:System.Data.SQLite.SQLiteParameterCollection.Item(System.String)"> |
||
4606 | <summary> |
||
4607 | Overloaded to specialize the return value of the default indexer |
||
4608 | </summary> |
||
4609 | <param name="parameterName">Name of the parameter to get/set</param> |
||
4610 | <returns>The specified named SQLite parameter</returns> |
||
4611 | </member> |
||
4612 | <member name="P:System.Data.SQLite.SQLiteParameterCollection.Item(System.Int32)"> |
||
4613 | <summary> |
||
4614 | Overloaded to specialize the return value of the default indexer |
||
4615 | </summary> |
||
4616 | <param name="index">The index of the parameter to get/set</param> |
||
4617 | <returns>The specified SQLite parameter</returns> |
||
4618 | </member> |
||
4619 | <member name="T:System.Data.SQLite.SQLiteStatement"> |
||
4620 | <summary> |
||
4621 | Represents a single SQL statement in SQLite. |
||
4622 | </summary> |
||
4623 | </member> |
||
4624 | <member name="F:System.Data.SQLite.SQLiteStatement._sql"> |
||
4625 | <summary> |
||
4626 | The underlying SQLite object this statement is bound to |
||
4627 | </summary> |
||
4628 | </member> |
||
4629 | <member name="F:System.Data.SQLite.SQLiteStatement._sqlStatement"> |
||
4630 | <summary> |
||
4631 | The command text of this SQL statement |
||
4632 | </summary> |
||
4633 | </member> |
||
4634 | <member name="F:System.Data.SQLite.SQLiteStatement._sqlite_stmt"> |
||
4635 | <summary> |
||
4636 | The actual statement pointer |
||
4637 | </summary> |
||
4638 | </member> |
||
4639 | <member name="F:System.Data.SQLite.SQLiteStatement._unnamedParameters"> |
||
4640 | <summary> |
||
4641 | An index from which unnamed parameters begin |
||
4642 | </summary> |
||
4643 | </member> |
||
4644 | <member name="F:System.Data.SQLite.SQLiteStatement._paramNames"> |
||
4645 | <summary> |
||
4646 | Names of the parameters as SQLite understands them to be |
||
4647 | </summary> |
||
4648 | </member> |
||
4649 | <member name="F:System.Data.SQLite.SQLiteStatement._paramValues"> |
||
4650 | <summary> |
||
4651 | Parameters for this statement |
||
4652 | </summary> |
||
4653 | </member> |
||
4654 | <member name="F:System.Data.SQLite.SQLiteStatement._command"> |
||
4655 | <summary> |
||
4656 | Command this statement belongs to (if any) |
||
4657 | </summary> |
||
4658 | </member> |
||
4659 | <member name="F:System.Data.SQLite.SQLiteStatement._flags"> |
||
4660 | <summary> |
||
4661 | The flags associated with the parent connection object. |
||
4662 | </summary> |
||
4663 | </member> |
||
4664 | <member name="M:System.Data.SQLite.SQLiteStatement.#ctor(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteStatementHandle,System.String,System.Data.SQLite.SQLiteStatement)"> |
||
4665 | <summary> |
||
4666 | Initializes the statement and attempts to get all information about parameters in the statement |
||
4667 | </summary> |
||
4668 | <param name="sqlbase">The base SQLite object</param> |
||
4669 | <param name="flags">The flags associated with the parent connection object</param> |
||
4670 | <param name="stmt">The statement</param> |
||
4671 | <param name="strCommand">The command text for this statement</param> |
||
4672 | <param name="previous">The previous command in a multi-statement command</param> |
||
4673 | </member> |
||
4674 | <member name="M:System.Data.SQLite.SQLiteStatement.Dispose"> |
||
4675 | <summary> |
||
4676 | Disposes and finalizes the statement |
||
4677 | </summary> |
||
4678 | </member> |
||
4679 | <member name="M:System.Data.SQLite.SQLiteStatement.TryGetChanges(System.Int32@)"> |
||
4680 | <summary> |
||
4681 | If the underlying database connection is open, fetches the number of changed rows |
||
4682 | resulting from the most recent query; otherwise, does nothing. |
||
4683 | </summary> |
||
4684 | <param name="changes"> |
||
4685 | The number of changes when true is returned. |
||
4686 | Undefined if false is returned. |
||
4687 | </param> |
||
4688 | <returns>Non-zero if the number of changed rows was fetched.</returns> |
||
4689 | </member> |
||
4690 | <member name="M:System.Data.SQLite.SQLiteStatement.MapParameter(System.String,System.Data.SQLite.SQLiteParameter)"> |
||
4691 | <summary> |
||
4692 | Called by SQLiteParameterCollection, this function determines if the specified parameter name belongs to |
||
4693 | this statement, and if so, keeps a reference to the parameter so it can be bound later. |
||
4694 | </summary> |
||
4695 | <param name="s">The parameter name to map</param> |
||
4696 | <param name="p">The parameter to assign it</param> |
||
4697 | </member> |
||
4698 | <member name="M:System.Data.SQLite.SQLiteStatement.BindParameters"> |
||
4699 | <summary> |
||
4700 | Bind all parameters, making sure the caller didn't miss any |
||
4701 | </summary> |
||
4702 | </member> |
||
4703 | <member name="M:System.Data.SQLite.SQLiteStatement.ToBoolean(System.Object,System.IFormatProvider)"> |
||
4704 | <summary> |
||
4705 | Attempts to convert an arbitrary object to the Boolean data type. |
||
4706 | Null object values are converted to false. Throws a SQLiteException |
||
4707 | upon failure. |
||
4708 | </summary> |
||
4709 | <param name="obj">The object value to convert.</param> |
||
4710 | <param name="provider">The format provider to use.</param> |
||
4711 | <returns>The converted boolean value.</returns> |
||
4712 | </member> |
||
4713 | <member name="M:System.Data.SQLite.SQLiteStatement.BindParameter(System.Int32,System.Data.SQLite.SQLiteParameter)"> |
||
4714 | <summary> |
||
4715 | Perform the bind operation for an individual parameter |
||
4716 | </summary> |
||
4717 | <param name="index">The index of the parameter to bind</param> |
||
4718 | <param name="param">The parameter we're binding</param> |
||
4719 | </member> |
||
4720 | <member name="T:System.Data.SQLite.SQLiteTransaction"> |
||
4721 | <summary> |
||
4722 | SQLite implementation of DbTransaction. |
||
4723 | </summary> |
||
4724 | </member> |
||
4725 | <member name="F:System.Data.SQLite.SQLiteTransaction._cnn"> |
||
4726 | <summary> |
||
4727 | The connection to which this transaction is bound |
||
4728 | </summary> |
||
4729 | </member> |
||
4730 | <member name="M:System.Data.SQLite.SQLiteTransaction.#ctor(System.Data.SQLite.SQLiteConnection,System.Boolean)"> |
||
4731 | <summary> |
||
4732 | Constructs the transaction object, binding it to the supplied connection |
||
4733 | </summary> |
||
4734 | <param name="connection">The connection to open a transaction on</param> |
||
4735 | <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param> |
||
4736 | </member> |
||
4737 | <member name="M:System.Data.SQLite.SQLiteTransaction.Dispose(System.Boolean)"> |
||
4738 | <summary> |
||
4739 | Disposes the transaction. If it is currently active, any changes are rolled back. |
||
4740 | </summary> |
||
4741 | </member> |
||
4742 | <member name="M:System.Data.SQLite.SQLiteTransaction.Commit"> |
||
4743 | <summary> |
||
4744 | Commits the current transaction. |
||
4745 | </summary> |
||
4746 | </member> |
||
4747 | <member name="M:System.Data.SQLite.SQLiteTransaction.Rollback"> |
||
4748 | <summary> |
||
4749 | Rolls back the active transaction. |
||
4750 | </summary> |
||
4751 | </member> |
||
4752 | <member name="P:System.Data.SQLite.SQLiteTransaction.Connection"> |
||
4753 | <summary> |
||
4754 | Returns the underlying connection to which this transaction applies. |
||
4755 | </summary> |
||
4756 | </member> |
||
4757 | <member name="P:System.Data.SQLite.SQLiteTransaction.DbConnection"> |
||
4758 | <summary> |
||
4759 | Forwards to the local Connection property |
||
4760 | </summary> |
||
4761 | </member> |
||
4762 | <member name="P:System.Data.SQLite.SQLiteTransaction.IsolationLevel"> |
||
4763 | <summary> |
||
4764 | Gets the isolation level of the transaction. SQLite only supports Serializable transactions. |
||
4765 | </summary> |
||
4766 | </member> |
||
4767 | <member name="T:System.Data.SQLite.SR"> |
||
4768 | <summary> |
||
4769 | A strongly-typed resource class, for looking up localized strings, etc. |
||
4770 | </summary> |
||
4771 | </member> |
||
4772 | <member name="P:System.Data.SQLite.SR.ResourceManager"> |
||
4773 | <summary> |
||
4774 | Returns the cached ResourceManager instance used by this class. |
||
4775 | </summary> |
||
4776 | </member> |
||
4777 | <member name="P:System.Data.SQLite.SR.Culture"> |
||
4778 | <summary> |
||
4779 | Overrides the current thread's CurrentUICulture property for all |
||
4780 | resource lookups using this strongly typed resource class. |
||
4781 | </summary> |
||
4782 | </member> |
||
4783 | <member name="P:System.Data.SQLite.SR.DataTypes"> |
||
4784 | <summary> |
||
4785 | Looks up a localized string similar to <?xml version="1.0" standalone="yes"?> |
||
4786 | <DocumentElement> |
||
4787 | <DataTypes> |
||
4788 | <TypeName>smallint</TypeName> |
||
4789 | <ProviderDbType>10</ProviderDbType> |
||
4790 | <ColumnSize>5</ColumnSize> |
||
4791 | <DataType>System.Int16</DataType> |
||
4792 | <CreateFormat>smallint</CreateFormat> |
||
4793 | <IsAutoIncrementable>false</IsAutoIncrementable> |
||
4794 | <IsCaseSensitive>false</IsCaseSensitive> |
||
4795 | <IsFixedLength>true</IsFixedLength> |
||
4796 | <IsFixedPrecisionScale>true</IsFixedPrecisionScale> |
||
4797 | <IsLong>false</IsLong> |
||
4798 | <IsNullable>true</ [rest of string was truncated]";. |
||
4799 | </summary> |
||
4800 | </member> |
||
4801 | <member name="P:System.Data.SQLite.SR.Keywords"> |
||
4802 | <summary> |
||
4803 | Looks up a localized string similar to ALL,ALTER,AND,AS,AUTOINCREMENT,BETWEEN,BY,CASE,CHECK,COLLATE,COMMIT,CONSTRAINT,CREATE,CROSS,DEFAULT,DEFERRABLE,DELETE,DISTINCT,DROP,ELSE,ESCAPE,EXCEPT,FOREIGN,FROM,FULL,GROUP,HAVING,IN,INDEX,INNER,INSERT,INTERSECT,INTO,IS,ISNULL,JOIN,LEFT,LIMIT,NATURAL,NOT,NOTNULL,NULL,ON,OR,ORDER,OUTER,PRIMARY,REFERENCES,RIGHT,ROLLBACK,SELECT,SET,TABLE,THEN,TO,TRANSACTION,UNION,UNIQUE,UPDATE,USING,VALUES,WHEN,WHERE. |
||
4804 | </summary> |
||
4805 | </member> |
||
4806 | <member name="P:System.Data.SQLite.SR.MetaDataCollections"> |
||
4807 | <summary> |
||
4808 | Looks up a localized string similar to <?xml version="1.0" encoding="utf-8" ?> |
||
4809 | <DocumentElement> |
||
4810 | <MetaDataCollections> |
||
4811 | <CollectionName>MetaDataCollections</CollectionName> |
||
4812 | <NumberOfRestrictions>0</NumberOfRestrictions> |
||
4813 | <NumberOfIdentifierParts>0</NumberOfIdentifierParts> |
||
4814 | </MetaDataCollections> |
||
4815 | <MetaDataCollections> |
||
4816 | <CollectionName>DataSourceInformation</CollectionName> |
||
4817 | <NumberOfRestrictions>0</NumberOfRestrictions> |
||
4818 | <NumberOfIdentifierParts>0</NumberOfIdentifierParts> |
||
4819 | </MetaDataCollections> |
||
4820 | <MetaDataC [rest of string was truncated]";. |
||
4821 | </summary> |
||
4822 | </member> |
||
4823 | <member name="M:System.Data.SQLite.UnsafeNativeMethods.LoadLibrary(System.String)"> |
||
4824 | <summary> |
||
4825 | This is the P/Invoke method that wraps the native Win32 LoadLibrary |
||
4826 | function. See the MSDN documentation for full details on what it |
||
4827 | does. |
||
4828 | </summary> |
||
4829 | <param name="fileName"> |
||
4830 | The name of the executable library. |
||
4831 | </param> |
||
4832 | <returns> |
||
4833 | The native module handle upon success -OR- IntPtr.Zero on failure. |
||
4834 | </returns> |
||
4835 | </member> |
||
4836 | <member name="F:System.Data.SQLite.UnsafeNativeMethods.staticSyncRoot"> |
||
4837 | <summary> |
||
4838 | This lock is used to protect the static _SQLiteModule and |
||
4839 | processorArchitecturePlatforms fields, below. |
||
4840 | </summary> |
||
4841 | </member> |
||
4842 | <member name="F:System.Data.SQLite.UnsafeNativeMethods.processorArchitecturePlatforms"> |
||
4843 | <summary> |
||
4844 | Stores the mappings between processor architecture names and platform |
||
4845 | names. |
||
4846 | </summary> |
||
4847 | </member> |
||
4848 | <member name="F:System.Data.SQLite.UnsafeNativeMethods._SQLiteModule"> |
||
4849 | <summary> |
||
4850 | The native module handle for the native SQLite library or the value |
||
4851 | IntPtr.Zero. |
||
4852 | </summary> |
||
4853 | </member> |
||
4854 | <member name="M:System.Data.SQLite.UnsafeNativeMethods.#cctor"> |
||
4855 | <summary> |
||
4856 | For now, this method simply calls the Initialize method. |
||
4857 | </summary> |
||
4858 | </member> |
||
4859 | <member name="M:System.Data.SQLite.UnsafeNativeMethods.Initialize"> |
||
4860 | <summary> |
||
4861 | Attempts to initialize this class by pre-loading the native SQLite |
||
4862 | library for the processor architecture of the current process. |
||
4863 | </summary> |
||
4864 | </member> |
||
4865 | <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetBaseDirectory"> |
||
4866 | <summary> |
||
4867 | Queries and returns the base directory of the current application |
||
4868 | domain. |
||
4869 | </summary> |
||
4870 | <returns> |
||
4871 | The base directory for the current application domain -OR- null if it |
||
4872 | cannot be determined. |
||
4873 | </returns> |
||
4874 | </member> |
||
4875 | <member name="M:System.Data.SQLite.UnsafeNativeMethods.FixUpDllFileName(System.String)"> |
||
4876 | <summary> |
||
4877 | Determines if the dynamic link library file name requires a suffix |
||
4878 | and adds it if necessary. |
||
4879 | </summary> |
||
4880 | <param name="fileName"> |
||
4881 | The original dynamic link library file name to inspect. |
||
4882 | </param> |
||
4883 | <returns> |
||
4884 | The dynamic link library file name, possibly modified to include an |
||
4885 | extension. |
||
4886 | </returns> |
||
4887 | </member> |
||
4888 | <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetProcessorArchitecture"> |
||
4889 | <summary> |
||
4890 | Queries and returns the processor architecture of the current |
||
4891 | process. |
||
4892 | </summary> |
||
4893 | <returns> |
||
4894 | The processor architecture of the current process -OR- null if it |
||
4895 | cannot be determined. Always returns an empty string when running on |
||
4896 | the .NET Compact Framework. |
||
4897 | </returns> |
||
4898 | </member> |
||
4899 | <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetPlatformName(System.String)"> |
||
4900 | <summary> |
||
4901 | Given the processor architecture, returns the name of the platform. |
||
4902 | </summary> |
||
4903 | <param name="processorArchitecture"> |
||
4904 | The processor architecture to be translated to a platform name. |
||
4905 | </param> |
||
4906 | <returns> |
||
4907 | The platform name for the specified processor architecture -OR- null |
||
4908 | if it cannot be determined. |
||
4909 | </returns> |
||
4910 | </member> |
||
4911 | <member name="M:System.Data.SQLite.UnsafeNativeMethods.PreLoadSQLiteDll(System.String,System.String)"> |
||
4912 | <summary> |
||
4913 | Attempts to load the native SQLite library based on the specified |
||
4914 | directory and processor architecture. |
||
4915 | </summary> |
||
4916 | <param name="directory"> |
||
4917 | The base directory to use, null for default (the base directory of |
||
4918 | the current application domain). This directory should contain the |
||
4919 | processor architecture specific sub-directories. |
||
4920 | </param> |
||
4921 | <param name="processorArchitecture"> |
||
4922 | The requested processor architecture, null for default (the |
||
4923 | processor architecture of the current process). This caller should |
||
4924 | almost always specify null for this parameter. |
||
4925 | </param> |
||
4926 | <returns> |
||
4927 | The native module handle as returned by LoadLibrary -OR- IntPtr.Zero |
||
4928 | if the loading fails for any reason. |
||
4929 | </returns> |
||
4930 | </member> |
||
4931 | </members> |
||
4932 | </doc> |