0,0 → 1,4932 |
<?xml version="1.0"?> |
<doc> |
<assembly> |
<name>System.Data.SQLite</name> |
</assembly> |
<members> |
<member name="T:System.Data.SQLite.SQLiteLogCallback"> |
<summary> |
This is the method signature for the SQLite core library logging callback |
function for use with sqlite3_log() and the SQLITE_CONFIG_LOG. |
|
WARNING: This delegate is used more-or-less directly by native code, do |
not modify its type signature. |
</summary> |
<param name="pUserData"> |
The extra data associated with this message, if any. |
</param> |
<param name="errorCode"> |
The error code associated with this message. |
</param> |
<param name="pMessage"> |
The message string to be logged. |
</param> |
</member> |
<member name="T:System.Data.SQLite.SQLite3"> |
<summary> |
This class implements SQLiteBase completely, and is the guts of the code that interop's SQLite with .NET |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteBase"> |
<summary> |
This internal class provides the foundation of SQLite support. It defines all the abstract members needed to implement |
a SQLite data provider, and inherits from SQLiteConvert which allows for simple translations of string to and from SQLite. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteConvert"> |
<summary> |
This base class provides datatype conversion services for the SQLite provider. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConvert.FullFormat"> |
<summary> |
The format string for DateTime values when using the InvariantCulture or CurrentCulture formats. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConvert.UnixEpoch"> |
<summary> |
The value for the Unix epoch (e.g. January 1, 1970 at midnight, in UTC). |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConvert.OleAutomationEpochAsJulianDay"> |
<summary> |
The value of the OLE Automation epoch represented as a Julian day. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormats"> |
<summary> |
An array of ISO8601 datetime formats we support conversion from |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormatUtc"> |
<summary> |
The internal default format for UTC DateTime values when converting |
to a string. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormatLocal"> |
<summary> |
The internal default format for local DateTime values when converting |
to a string. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConvert._utf8"> |
<summary> |
An UTF-8 Encoding instance, so we can convert strings to and from UTF-8 |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormat"> |
<summary> |
The default DateTime format for this instance |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConvert._datetimeKind"> |
<summary> |
The default DateTimeKind for this instance. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.#ctor(System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind)"> |
<summary> |
Initializes the conversion class |
</summary> |
<param name="fmt">The default date/time format to use for this instance</param> |
<param name="kind">The DateTimeKind to use.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToUTF8(System.String)"> |
<summary> |
Converts a string to a UTF-8 encoded byte array sized to include a null-terminating character. |
</summary> |
<param name="sourceText">The string to convert to UTF-8</param> |
<returns>A byte array containing the converted string plus an extra 0 terminating byte at the end of the array.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToUTF8(System.DateTime)"> |
<summary> |
Convert a DateTime to a UTF-8 encoded, zero-terminated byte array. |
</summary> |
<remarks> |
This function is a convenience function, which first calls ToString() on the DateTime, and then calls ToUTF8() with the |
string result. |
</remarks> |
<param name="dateTimeValue">The DateTime to convert.</param> |
<returns>The UTF-8 encoded string, including a 0 terminating byte at the end of the array.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.IntPtr,System.Int32)"> |
<summary> |
Converts a UTF-8 encoded IntPtr of the specified length into a .NET string |
</summary> |
<param name="nativestring">The pointer to the memory where the UTF-8 string is encoded</param> |
<param name="nativestringlen">The number of bytes to decode</param> |
<returns>A string containing the translated character(s)</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.UTF8ToString(System.IntPtr,System.Int32)"> |
<summary> |
Converts a UTF-8 encoded IntPtr of the specified length into a .NET string |
</summary> |
<param name="nativestring">The pointer to the memory where the UTF-8 string is encoded</param> |
<param name="nativestringlen">The number of bytes to decode</param> |
<returns>A string containing the translated character(s)</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.String)"> |
<summary> |
Converts a string into a DateTime, using the current DateTimeFormat specified for the connection when it was opened. |
</summary> |
<remarks> |
Acceptable ISO8601 DateTime formats are: |
<list type="bullet"> |
<item><description>THHmmssK</description></item> |
<item><description>THHmmK</description></item> |
<item><description>HH:mm:ss.FFFFFFFK</description></item> |
<item><description>HH:mm:ssK</description></item> |
<item><description>HH:mmK</description></item> |
<item><description>yyyy-MM-dd HH:mm:ss.FFFFFFFK</description></item> |
<item><description>yyyy-MM-dd HH:mm:ssK</description></item> |
<item><description>yyyy-MM-dd HH:mmK</description></item> |
<item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFFK</description></item> |
<item><description>yyyy-MM-ddTHH:mmK</description></item> |
<item><description>yyyy-MM-ddTHH:mm:ssK</description></item> |
<item><description>yyyyMMddHHmmssK</description></item> |
<item><description>yyyyMMddHHmmK</description></item> |
<item><description>yyyyMMddTHHmmssFFFFFFFK</description></item> |
<item><description>THHmmss</description></item> |
<item><description>THHmm</description></item> |
<item><description>HH:mm:ss.FFFFFFF</description></item> |
<item><description>HH:mm:ss</description></item> |
<item><description>HH:mm</description></item> |
<item><description>yyyy-MM-dd HH:mm:ss.FFFFFFF</description></item> |
<item><description>yyyy-MM-dd HH:mm:ss</description></item> |
<item><description>yyyy-MM-dd HH:mm</description></item> |
<item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFF</description></item> |
<item><description>yyyy-MM-ddTHH:mm</description></item> |
<item><description>yyyy-MM-ddTHH:mm:ss</description></item> |
<item><description>yyyyMMddHHmmss</description></item> |
<item><description>yyyyMMddHHmm</description></item> |
<item><description>yyyyMMddTHHmmssFFFFFFF</description></item> |
<item><description>yyyy-MM-dd</description></item> |
<item><description>yyyyMMdd</description></item> |
<item><description>yy-MM-dd</description></item> |
</list> |
If the string cannot be matched to one of the above formats, an exception will be thrown. |
</remarks> |
<param name="dateText">The string containing either a long integer number of 100-nanosecond units since |
System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a |
culture-independent formatted date and time string, a formatted date and time string in the current |
culture, or an ISO8601-format string.</param> |
<returns>A DateTime value</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.String,System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind)"> |
<summary> |
Converts a string into a DateTime, using the specified DateTimeFormat and DateTimeKind. |
</summary> |
<remarks> |
Acceptable ISO8601 DateTime formats are: |
<list type="bullet"> |
<item><description>THHmmssK</description></item> |
<item><description>THHmmK</description></item> |
<item><description>HH:mm:ss.FFFFFFFK</description></item> |
<item><description>HH:mm:ssK</description></item> |
<item><description>HH:mmK</description></item> |
<item><description>yyyy-MM-dd HH:mm:ss.FFFFFFFK</description></item> |
<item><description>yyyy-MM-dd HH:mm:ssK</description></item> |
<item><description>yyyy-MM-dd HH:mmK</description></item> |
<item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFFK</description></item> |
<item><description>yyyy-MM-ddTHH:mmK</description></item> |
<item><description>yyyy-MM-ddTHH:mm:ssK</description></item> |
<item><description>yyyyMMddHHmmssK</description></item> |
<item><description>yyyyMMddHHmmK</description></item> |
<item><description>yyyyMMddTHHmmssFFFFFFFK</description></item> |
<item><description>THHmmss</description></item> |
<item><description>THHmm</description></item> |
<item><description>HH:mm:ss.FFFFFFF</description></item> |
<item><description>HH:mm:ss</description></item> |
<item><description>HH:mm</description></item> |
<item><description>yyyy-MM-dd HH:mm:ss.FFFFFFF</description></item> |
<item><description>yyyy-MM-dd HH:mm:ss</description></item> |
<item><description>yyyy-MM-dd HH:mm</description></item> |
<item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFF</description></item> |
<item><description>yyyy-MM-ddTHH:mm</description></item> |
<item><description>yyyy-MM-ddTHH:mm:ss</description></item> |
<item><description>yyyyMMddHHmmss</description></item> |
<item><description>yyyyMMddHHmm</description></item> |
<item><description>yyyyMMddTHHmmssFFFFFFF</description></item> |
<item><description>yyyy-MM-dd</description></item> |
<item><description>yyyyMMdd</description></item> |
<item><description>yy-MM-dd</description></item> |
</list> |
If the string cannot be matched to one of the above formats, an exception will be thrown. |
</remarks> |
<param name="dateText">The string containing either a long integer number of 100-nanosecond units since |
System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a |
culture-independent formatted date and time string, a formatted date and time string in the current |
culture, or an ISO8601-format string.</param> |
<param name="format">The SQLiteDateFormats to use.</param> |
<param name="kind">The DateTimeKind to use.</param> |
<returns>A DateTime value</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.Double)"> |
<summary> |
Converts a julianday value into a DateTime |
</summary> |
<param name="julianDay">The value to convert</param> |
<returns>A .NET DateTime</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.Double,System.DateTimeKind)"> |
<summary> |
Converts a julianday value into a DateTime |
</summary> |
<param name="julianDay">The value to convert</param> |
<param name="kind">The DateTimeKind to use.</param> |
<returns>A .NET DateTime</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToJulianDay(System.DateTime)"> |
<summary> |
Converts a DateTime struct to a JulianDay double |
</summary> |
<param name="value">The DateTime to convert</param> |
<returns>The JulianDay value the Datetime represents</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToUnixEpoch(System.DateTime)"> |
<summary> |
Converts a DateTime struct to the whole number of seconds since the |
Unix epoch. |
</summary> |
<param name="value">The DateTime to convert</param> |
<returns>The whole number of seconds since the Unix epoch</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.GetDateTimeKindFormat(System.DateTimeKind)"> |
<summary> |
Returns the default DateTime format string to use for the specified |
DateTimeKind. |
</summary> |
<param name="kind">The DateTimeKind to use.</param> |
<returns> |
The default DateTime format string to use for the specified DateTimeKind. |
</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.DateTime)"> |
<summary> |
Converts a DateTime to a string value, using the current DateTimeFormat specified for the connection when it was opened. |
</summary> |
<param name="dateValue">The DateTime value to convert</param> |
<returns>Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a |
Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time |
string, a formatted date and time string in the current culture, or an ISO8601-format date/time string.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.IntPtr,System.Int32)"> |
<summary> |
Internal function to convert a UTF-8 encoded IntPtr of the specified length to a DateTime. |
</summary> |
<remarks> |
This is a convenience function, which first calls ToString() on the IntPtr to convert it to a string, then calls |
ToDateTime() on the string to return a DateTime. |
</remarks> |
<param name="ptr">A pointer to the UTF-8 encoded string</param> |
<param name="len">The length in bytes of the string</param> |
<returns>The parsed DateTime value</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.Split(System.String,System.Char)"> |
<summary> |
Smart method of splitting a string. Skips quoted elements, removes the quotes. |
</summary> |
<remarks> |
This split function works somewhat like the String.Split() function in that it breaks apart a string into |
pieces and returns the pieces as an array. The primary differences are: |
<list type="bullet"> |
<item><description>Only one character can be provided as a separator character</description></item> |
<item><description>Quoted text inside the string is skipped over when searching for the separator, and the quotes are removed.</description></item> |
</list> |
Thus, if splitting the following string looking for a comma:<br/> |
One,Two, "Three, Four", Five<br/> |
<br/> |
The resulting array would contain<br/> |
[0] One<br/> |
[1] Two<br/> |
[2] Three, Four<br/> |
[3] Five<br/> |
<br/> |
Note that the leading and trailing spaces were removed from each item during the split. |
</remarks> |
<param name="source">Source string to split apart</param> |
<param name="separator">Separator character</param> |
<returns>A string array of the split up elements</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.Object)"> |
<summary> |
Convert a value to true or false. |
</summary> |
<param name="source">A string or number representing true or false</param> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.String)"> |
<summary> |
Convert a string to true or false. |
</summary> |
<param name="source">A string representing true or false</param> |
<returns></returns> |
<remarks> |
"yes", "no", "y", "n", "0", "1", "on", "off" as well as Boolean.FalseString and Boolean.TrueString will all be |
converted to a proper boolean value. |
</remarks> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.ColumnToType(System.Data.SQLite.SQLiteStatement,System.Int32,System.Data.SQLite.SQLiteType)"> |
<summary> |
Determines the data type of a column in a statement |
</summary> |
<param name="stmt">The statement to retrieve information for</param> |
<param name="i">The column to retrieve type information on</param> |
<param name="typ">The SQLiteType to receive the affinity for the given column</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.SQLiteTypeToType(System.Data.SQLite.SQLiteType)"> |
<summary> |
Converts a SQLiteType to a .NET Type object |
</summary> |
<param name="t">The SQLiteType to convert</param> |
<returns>Returns a .NET Type object</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.TypeToDbType(System.Type)"> |
<summary> |
For a given intrinsic type, return a DbType |
</summary> |
<param name="typ">The native type to convert</param> |
<returns>The corresponding (closest match) DbType</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.DbTypeToColumnSize(System.Data.DbType)"> |
<summary> |
Returns the ColumnSize for the given DbType |
</summary> |
<param name="typ">The DbType to get the size of</param> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.DbTypeToType(System.Data.DbType)"> |
<summary> |
Convert a DbType to a Type |
</summary> |
<param name="typ">The DbType to convert from</param> |
<returns>The closest-match .NET type</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.TypeToAffinity(System.Type)"> |
<summary> |
For a given type, return the closest-match SQLite TypeAffinity, which only understands a very limited subset of types. |
</summary> |
<param name="typ">The type to evaluate</param> |
<returns>The SQLite type affinity for that type.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConvert.TypeNameToDbType(System.String)"> |
<summary> |
For a given type name, return a closest-match .NET type |
</summary> |
<param name="Name">The name of the type to match</param> |
<returns>The .NET DBType the text evaluates to.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.SetMemoryStatus(System.Boolean)"> |
<summary> |
Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled. |
If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is |
global to the process. |
</summary> |
<param name="value">Non-zero to enable memory usage tracking, zero otherwise.</param> |
<returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.Shutdown"> |
<summary> |
Shutdown the SQLite engine so that it can be restarted with different config options. |
We depend on auto initialization to recover. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.IsOpen"> |
<summary> |
Returns non-zero if a database connection is open. |
</summary> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.Open(System.String,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteOpenFlagsEnum,System.Int32,System.Boolean)"> |
<summary> |
Opens a database. |
</summary> |
<remarks> |
Implementers should call SQLiteFunction.BindFunctions() and save the array after opening a connection |
to bind all attributed user-defined functions and collating sequences to the new connection. |
</remarks> |
<param name="strFilename">The filename of the database to open. SQLite automatically creates it if it doesn't exist.</param> |
<param name="connectionFlags">The flags associated with the parent connection object</param> |
<param name="openFlags">The open flags to use when creating the connection</param> |
<param name="maxPoolSize">The maximum size of the pool for the given filename</param> |
<param name="usePool">If true, the connection can be pulled from the connection pool</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.Close(System.Boolean)"> |
<summary> |
Closes the currently-open database. |
</summary> |
<remarks> |
After the database has been closed implemeters should call SQLiteFunction.UnbindFunctions() to deallocate all interop allocated |
memory associated with the user-defined functions and collating sequences tied to the closed connection. |
</remarks> |
<param name="canThrow">Non-zero if the operation is allowed to throw exceptions, zero otherwise.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.SetTimeout(System.Int32)"> |
<summary> |
Sets the busy timeout on the connection. SQLiteCommand will call this before executing any command. |
</summary> |
<param name="nTimeoutMS">The number of milliseconds to wait before returning SQLITE_BUSY</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.GetLastError"> |
<summary> |
Returns the text of the last error issued by SQLite |
</summary> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.ClearPool"> |
<summary> |
When pooling is enabled, force this connection to be disposed rather than returned to the pool |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.CountPool"> |
<summary> |
When pooling is enabled, returns the number of pool entries matching the current file name. |
</summary> |
<returns>The number of pool entries matching the current file name.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.Prepare(System.Data.SQLite.SQLiteConnection,System.String,System.Data.SQLite.SQLiteStatement,System.UInt32,System.String@)"> |
<summary> |
Prepares a SQL statement for execution. |
</summary> |
<param name="cnn">The source connection preparing the command. Can be null for any caller except LINQ</param> |
<param name="strSql">The SQL command text to prepare</param> |
<param name="previous">The previous statement in a multi-statement command, or null if no previous statement exists</param> |
<param name="timeoutMS">The timeout to wait before aborting the prepare</param> |
<param name="strRemain">The remainder of the statement that was not processed. Each call to prepare parses the |
SQL up to to either the end of the text or to the first semi-colon delimiter. The remaining text is returned |
here for a subsequent call to Prepare() until all the text has been processed.</param> |
<returns>Returns an initialized SQLiteStatement.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.Step(System.Data.SQLite.SQLiteStatement)"> |
<summary> |
Steps through a prepared statement. |
</summary> |
<param name="stmt">The SQLiteStatement to step through</param> |
<returns>True if a row was returned, False if not.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.Reset(System.Data.SQLite.SQLiteStatement)"> |
<summary> |
Resets a prepared statement so it can be executed again. If the error returned is SQLITE_SCHEMA, |
transparently attempt to rebuild the SQL statement and throw an error if that was not possible. |
</summary> |
<param name="stmt">The statement to reset</param> |
<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> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.SetLoadExtension(System.Boolean)"> |
<summary> |
Enables or disabled extension loading by SQLite. |
</summary> |
<param name="bOnOff"> |
True to enable loading of extensions, false to disable. |
</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.LoadExtension(System.String,System.String)"> |
<summary> |
Loads a SQLite extension library from the named file. |
</summary> |
<param name="fileName"> |
The name of the dynamic link library file containing the extension. |
</param> |
<param name="procName"> |
The name of the exported function used to initialize the extension. |
If null, the default "sqlite3_extension_init" will be used. |
</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.SetExtendedResultCodes(System.Boolean)"> |
<summary> |
Enables or disabled extened result codes returned by SQLite |
</summary> |
<param name="bOnOff">true to enable extended result codes, false to disable.</param> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.ResultCode"> |
<summary> |
Returns the numeric result code for the most recent failed SQLite API call |
associated with the database connection. |
</summary> |
<returns>Result code</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.ExtendedResultCode"> |
<summary> |
Returns the extended numeric result code for the most recent failed SQLite API call |
associated with the database connection. |
</summary> |
<returns>Extended result code</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)"> |
<summary> |
Add a log message via the SQLite sqlite3_log interface. |
</summary> |
<param name="iErrCode">Error code to be logged with the message.</param> |
<param name="zMessage">String to be logged. Unlike the SQLite sqlite3_log() |
interface, this should be pre-formatted. Consider using the |
String.Format() function.</param> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.IsInitialized"> |
<summary> |
Checks if the SQLite core library has been initialized in the current process. |
</summary> |
<returns> |
Non-zero if the SQLite core library has been initialized in the current process, |
zero otherwise. |
</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.InitializeBackup(System.Data.SQLite.SQLiteConnection,System.String,System.String)"> |
<summary> |
Creates a new SQLite backup object based on the provided destination |
database connection. The source database connection is the one |
associated with this object. The source and destination database |
connections cannot be the same. |
</summary> |
<param name="destCnn">The destination database connection.</param> |
<param name="destName">The destination database name.</param> |
<param name="sourceName">The source database name.</param> |
<returns>The newly created backup object.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.StepBackup(System.Data.SQLite.SQLiteBackup,System.Int32,System.Boolean@)"> |
<summary> |
Copies up to N pages from the source database to the destination |
database associated with the specified backup object. |
</summary> |
<param name="backup">The backup object to use.</param> |
<param name="nPage"> |
The number of pages to copy or negative to copy all remaining pages. |
</param> |
<param name="retry"> |
Set to true if the operation needs to be retried due to database |
locking issues. |
</param> |
<returns> |
True if there are more pages to be copied, false otherwise. |
</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.RemainingBackup(System.Data.SQLite.SQLiteBackup)"> |
<summary> |
Returns the number of pages remaining to be copied from the source |
database to the destination database associated with the specified |
backup object. |
</summary> |
<param name="backup">The backup object to check.</param> |
<returns>The number of pages remaining to be copied.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.PageCountBackup(System.Data.SQLite.SQLiteBackup)"> |
<summary> |
Returns the total number of pages in the source database associated |
with the specified backup object. |
</summary> |
<param name="backup">The backup object to check.</param> |
<returns>The total number of pages in the source database.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.FinishBackup(System.Data.SQLite.SQLiteBackup)"> |
<summary> |
Destroys the backup object, rolling back any backup that may be in |
progess. |
</summary> |
<param name="backup">The backup object to destroy.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.FallbackGetErrorString(System.Data.SQLite.SQLiteErrorCode)"> |
<summary> |
Returns the error message for the specified SQLite return code using |
the internal static lookup table. |
</summary> |
<param name="rc">The SQLite return code.</param> |
<returns>The error message or null if it cannot be found.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBase.GetErrorString(System.Data.SQLite.SQLiteErrorCode)"> |
<summary> |
Returns the error message for the specified SQLite return code using |
the sqlite3_errstr() function, falling back to the internal lookup |
table if necessary. |
</summary> |
<param name="rc">The SQLite return code.</param> |
<returns>The error message or null if it cannot be found.</returns> |
</member> |
<member name="P:System.Data.SQLite.SQLiteBase.Version"> |
<summary> |
Returns a string representing the active version of SQLite |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteBase.VersionNumber"> |
<summary> |
Returns an integer representing the active version of SQLite |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteBase.LastInsertRowId"> |
<summary> |
Returns the rowid of the most recent successful INSERT into the database from this connection. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteBase.Changes"> |
<summary> |
Returns the number of changes the last executing insert/update caused. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteBase.MemoryUsed"> |
<summary> |
Returns the amount of memory (in bytes) currently in use by the SQLite core library. This is not really a per-connection |
value, it is global to the process. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteBase.MemoryHighwater"> |
<summary> |
Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset. |
This is not really a per-connection value, it is global to the process. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLite3._sql"> |
<summary> |
The opaque pointer returned to us by the sqlite provider |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLite3._functionsArray"> |
<summary> |
The user-defined functions registered on this connection |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLite3.Shutdown"> |
<summary> |
Shutdown the SQLite engine so that it can be restarted with different config options. |
We depend on auto initialization to recover. |
</summary> |
<returns>Returns a result code</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLite3.SetLoadExtension(System.Boolean)"> |
<summary> |
Enables or disabled extension loading by SQLite. |
</summary> |
<param name="bOnOff"> |
True to enable loading of extensions, false to disable. |
</param> |
</member> |
<member name="M:System.Data.SQLite.SQLite3.LoadExtension(System.String,System.String)"> |
<summary> |
Loads a SQLite extension library from the named file. |
</summary> |
<param name="fileName"> |
The name of the dynamic link library file containing the extension. |
</param> |
<param name="procName"> |
The name of the exported function used to initialize the extension. |
If null, the default "sqlite3_extension_init" will be used. |
</param> |
</member> |
<member name="M:System.Data.SQLite.SQLite3.SetExtendedResultCodes(System.Boolean)"> |
Enables or disabled extended result codes returned by SQLite |
</member> |
<member name="M:System.Data.SQLite.SQLite3.ResultCode"> |
Gets the last SQLite error code |
</member> |
<member name="M:System.Data.SQLite.SQLite3.ExtendedResultCode"> |
Gets the last SQLite extended error code |
</member> |
<member name="M:System.Data.SQLite.SQLite3.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)"> |
Add a log message via the SQLite sqlite3_log interface. |
</member> |
<member name="M:System.Data.SQLite.SQLite3.SetLogCallback(System.Data.SQLite.SQLiteLogCallback)"> |
<summary> |
Allows the setting of a logging callback invoked by SQLite when a |
log event occurs. Only one callback may be set. If NULL is passed, |
the logging callback is unregistered. |
</summary> |
<param name="func">The callback function to invoke.</param> |
<returns>Returns a result code</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLite3.InitializeBackup(System.Data.SQLite.SQLiteConnection,System.String,System.String)"> |
<summary> |
Creates a new SQLite backup object based on the provided destination |
database connection. The source database connection is the one |
associated with this object. The source and destination database |
connections cannot be the same. |
</summary> |
<param name="destCnn">The destination database connection.</param> |
<param name="destName">The destination database name.</param> |
<param name="sourceName">The source database name.</param> |
<returns>The newly created backup object.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLite3.StepBackup(System.Data.SQLite.SQLiteBackup,System.Int32,System.Boolean@)"> |
<summary> |
Copies up to N pages from the source database to the destination |
database associated with the specified backup object. |
</summary> |
<param name="backup">The backup object to use.</param> |
<param name="nPage"> |
The number of pages to copy, negative to copy all remaining pages. |
</param> |
<param name="retry"> |
Set to true if the operation needs to be retried due to database |
locking issues; otherwise, set to false. |
</param> |
<returns> |
True if there are more pages to be copied, false otherwise. |
</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLite3.RemainingBackup(System.Data.SQLite.SQLiteBackup)"> |
<summary> |
Returns the number of pages remaining to be copied from the source |
database to the destination database associated with the specified |
backup object. |
</summary> |
<param name="backup">The backup object to check.</param> |
<returns>The number of pages remaining to be copied.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLite3.PageCountBackup(System.Data.SQLite.SQLiteBackup)"> |
<summary> |
Returns the total number of pages in the source database associated |
with the specified backup object. |
</summary> |
<param name="backup">The backup object to check.</param> |
<returns>The total number of pages in the source database.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLite3.FinishBackup(System.Data.SQLite.SQLiteBackup)"> |
<summary> |
Destroys the backup object, rolling back any backup that may be in |
progess. |
</summary> |
<param name="backup">The backup object to destroy.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLite3.IsInitialized"> |
<summary> |
Determines if the SQLite core library has been initialized for the |
current process. |
</summary> |
<returns> |
A boolean indicating whether or not the SQLite core library has been |
initialized for the current process. |
</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLite3.StaticIsInitialized"> |
<summary> |
Determines if the SQLite core library has been initialized for the |
current process. |
</summary> |
<returns> |
A boolean indicating whether or not the SQLite core library has been |
initialized for the current process. |
</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLite3.GetValue(System.Data.SQLite.SQLiteStatement,System.Int32,System.Data.SQLite.SQLiteType)"> |
<summary> |
Helper function to retrieve a column of data from an active statement. |
</summary> |
<param name="stmt">The statement being step()'d through</param> |
<param name="index">The column index to retrieve</param> |
<param name="typ">The type of data contained in the column. If Uninitialized, this function will retrieve the datatype information.</param> |
<returns>Returns the data in the column</returns> |
</member> |
<member name="T:System.Data.SQLite.SQLite3_UTF16"> |
<summary> |
Alternate SQLite3 object, overriding many text behaviors to support UTF-16 (Unicode) |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLite3_UTF16.ToString(System.IntPtr,System.Int32)"> |
<summary> |
Overrides SQLiteConvert.ToString() to marshal UTF-16 strings instead of UTF-8 |
</summary> |
<param name="b">A pointer to a UTF-16 string</param> |
<param name="nbytelen">The length (IN BYTES) of the string</param> |
<returns>A .NET string</returns> |
</member> |
<member name="T:System.Data.SQLite.SQLiteBackup"> |
<summary> |
Represents a single SQL backup in SQLite. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteBackup._sql"> |
<summary> |
The underlying SQLite object this backup is bound to. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteBackup._sqlite_backup"> |
<summary> |
The actual backup handle. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteBackup._destDb"> |
<summary> |
The destination database for the backup. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteBackup._zDestName"> |
<summary> |
The destination database name for the backup. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteBackup._sourceDb"> |
<summary> |
The source database for the backup. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteBackup._zSourceName"> |
<summary> |
The source database name for the backup. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteBackup._stepResult"> |
<summary> |
The last result from the StepBackup method of the SQLite3 class. |
This is used to determine if the call to the FinishBackup method of |
the SQLite3 class should throw an exception when it receives a non-Ok |
return code from the core SQLite library. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBackup.#ctor(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteBackupHandle,System.IntPtr,System.Byte[],System.IntPtr,System.Byte[])"> |
<summary> |
Initializes the backup. |
</summary> |
<param name="sqlbase">The base SQLite object.</param> |
<param name="backup">The backup handle.</param> |
<param name="destDb">The destination database for the backup.</param> |
<param name="zDestName">The destination database name for the backup.</param> |
<param name="sourceDb">The source database for the backup.</param> |
<param name="zSourceName">The source database name for the backup.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteBackup.Dispose"> |
<summary> |
Disposes and finalizes the backup. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteConnectionFlags"> |
<summary> |
The extra behavioral flags that can be applied to a connection. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionFlags.None"> |
<summary> |
No extra flags. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogPrepare"> |
<summary> |
Enable logging of all SQL statements to be prepared. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogPreBind"> |
<summary> |
Enable logging of all bound parameter types and raw values. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogBind"> |
<summary> |
Enable logging of all bound parameter strongly typed values. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogCallbackException"> |
<summary> |
Enable logging of all exceptions caught from user-provided |
managed code called from native code via delegates. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogBackup"> |
<summary> |
Enable logging of backup API errors. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoExtensionFunctions"> |
<summary> |
Skip adding the extension functions provided by the native |
interop assembly. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogAll"> |
<summary> |
Enable all logging. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionFlags.Default"> |
<summary> |
The default extra flags for new connections. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteCommand"> |
<summary> |
SQLite implementation of DbCommand. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteCommand._commandText"> |
<summary> |
The command text this command is based on |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteCommand._cnn"> |
<summary> |
The connection the command is associated with |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteCommand._version"> |
<summary> |
The version of the connection the command is associated with |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteCommand._activeReader"> |
<summary> |
Indicates whether or not a DataReader is active on the command. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteCommand._commandTimeout"> |
<summary> |
The timeout for the command, kludged because SQLite doesn't support per-command timeout values |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteCommand._designTimeVisible"> |
<summary> |
Designer support |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteCommand._updateRowSource"> |
<summary> |
Used by DbDataAdapter to determine updating behavior |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteCommand._parameterCollection"> |
<summary> |
The collection of parameters for the command |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteCommand._statementList"> |
<summary> |
The SQL command text, broken into individual SQL statements as they are executed |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteCommand._remainingText"> |
<summary> |
Unprocessed SQL text that has not been executed |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteCommand._transaction"> |
<summary> |
Transaction associated with this command |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.#ctor"> |
<overloads> |
Constructs a new SQLiteCommand |
</overloads> |
<summary> |
Default constructor |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String)"> |
<summary> |
Initializes the command with the given command text |
</summary> |
<param name="commandText">The SQL command text</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String,System.Data.SQLite.SQLiteConnection)"> |
<summary> |
Initializes the command with the given SQL command text and attach the command to the specified |
connection. |
</summary> |
<param name="commandText">The SQL command text</param> |
<param name="connection">The connection to associate with the command</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.Data.SQLite.SQLiteConnection)"> |
<summary> |
Initializes the command and associates it with the specified connection. |
</summary> |
<param name="connection">The connection to associate with the command</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String,System.Data.SQLite.SQLiteConnection,System.Data.SQLite.SQLiteTransaction)"> |
<summary> |
Initializes a command with the given SQL, connection and transaction |
</summary> |
<param name="commandText">The SQL command text</param> |
<param name="connection">The connection to associate with the command</param> |
<param name="transaction">The transaction the command should be associated with</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.Dispose(System.Boolean)"> |
<summary> |
Disposes of the command and clears all member variables |
</summary> |
<param name="disposing">Whether or not the class is being explicitly or implicitly disposed</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.ClearCommands"> |
<summary> |
Clears and destroys all statements currently prepared |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.BuildNextCommand"> |
<summary> |
Builds an array of prepared statements for each complete SQL statement in the command text |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.Cancel"> |
<summary> |
Not implemented |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.CreateDbParameter"> |
<summary> |
Forwards to the local CreateParameter() function |
</summary> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.CreateParameter"> |
<summary> |
Create a new parameter |
</summary> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.InitializeForReader"> |
<summary> |
This function ensures there are no active readers, that we have a valid connection, |
that the connection is open, that all statements are prepared and all parameters are assigned |
in preparation for allocating a data reader. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.ExecuteDbDataReader(System.Data.CommandBehavior)"> |
<summary> |
Creates a new SQLiteDataReader to execute/iterate the array of SQLite prepared statements |
</summary> |
<param name="behavior">The behavior the data reader should adopt</param> |
<returns>Returns a SQLiteDataReader object</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.ExecuteReader(System.Data.CommandBehavior)"> |
<summary> |
Overrides the default behavior to return a SQLiteDataReader specialization class |
</summary> |
<param name="behavior">The flags to be associated with the reader</param> |
<returns>A SQLiteDataReader</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.ExecuteReader"> |
<summary> |
Overrides the default behavior of DbDataReader to return a specialized SQLiteDataReader class |
</summary> |
<returns>A SQLiteDataReader</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.ClearDataReader"> |
<summary> |
Called by the SQLiteDataReader when the data reader is closed. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.ExecuteNonQuery"> |
<summary> |
Execute the command and return the number of rows inserted/updated affected by it. |
</summary> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.ExecuteScalar"> |
<summary> |
Execute the command and return the first column of the first row of the resultset |
(if present), or null if no resultset was returned. |
</summary> |
<returns>The first column of the first row of the first resultset from the query</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.Prepare"> |
<summary> |
Does nothing. Commands are prepared as they are executed the first time, and kept in prepared state afterwards. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommand.Clone"> |
<summary> |
Clones a command, including all its parameters |
</summary> |
<returns>A new SQLiteCommand with the same commandtext, connection and parameters</returns> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommand.CommandText"> |
<summary> |
The SQL command text associated with the command |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommand.CommandTimeout"> |
<summary> |
The amount of time to wait for the connection to become available before erroring out |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommand.CommandType"> |
<summary> |
The type of the command. SQLite only supports CommandType.Text |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommand.Connection"> |
<summary> |
The connection associated with this command |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommand.DbConnection"> |
<summary> |
Forwards to the local Connection property |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommand.Parameters"> |
<summary> |
Returns the SQLiteParameterCollection for the given command |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommand.DbParameterCollection"> |
<summary> |
Forwards to the local Parameters property |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommand.Transaction"> |
<summary> |
The transaction associated with this command. SQLite only supports one transaction per connection, so this property forwards to the |
command's underlying connection. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommand.DbTransaction"> |
<summary> |
Forwards to the local Transaction property |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommand.UpdatedRowSource"> |
<summary> |
Sets the method the SQLiteCommandBuilder uses to determine how to update inserted or updated rows in a DataTable. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommand.DesignTimeVisible"> |
<summary> |
Determines if the command is visible at design time. Defaults to True. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteCommandBuilder"> |
<summary> |
SQLite implementation of DbCommandBuilder. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.#ctor"> |
<summary> |
Default constructor |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.#ctor(System.Data.SQLite.SQLiteDataAdapter)"> |
<summary> |
Initializes the command builder and associates it with the specified data adapter. |
</summary> |
<param name="adp"></param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.ApplyParameterInfo(System.Data.Common.DbParameter,System.Data.DataRow,System.Data.StatementType,System.Boolean)"> |
<summary> |
Minimal amount of parameter processing. Primarily sets the DbType for the parameter equal to the provider type in the schema |
</summary> |
<param name="parameter">The parameter to use in applying custom behaviors to a row</param> |
<param name="row">The row to apply the parameter to</param> |
<param name="statementType">The type of statement</param> |
<param name="whereClause">Whether the application of the parameter is part of a WHERE clause</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterName(System.String)"> |
<summary> |
Returns a valid named parameter |
</summary> |
<param name="parameterName">The name of the parameter</param> |
<returns>Error</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterName(System.Int32)"> |
<summary> |
Returns a named parameter for the given ordinal |
</summary> |
<param name="parameterOrdinal">The i of the parameter</param> |
<returns>Error</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterPlaceholder(System.Int32)"> |
<summary> |
Returns a placeholder character for the specified parameter i. |
</summary> |
<param name="parameterOrdinal">The index of the parameter to provide a placeholder for</param> |
<returns>Returns a named parameter</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.SetRowUpdatingHandler(System.Data.Common.DbDataAdapter)"> |
<summary> |
Sets the handler for receiving row updating events. Used by the DbCommandBuilder to autogenerate SQL |
statements that may not have previously been generated. |
</summary> |
<param name="adapter">A data adapter to receive events on.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetDeleteCommand"> |
<summary> |
Returns the automatically-generated SQLite command to delete rows from the database |
</summary> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetDeleteCommand(System.Boolean)"> |
<summary> |
Returns the automatically-generated SQLite command to delete rows from the database |
</summary> |
<param name="useColumnsForParameterNames"></param> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetUpdateCommand"> |
<summary> |
Returns the automatically-generated SQLite command to update rows in the database |
</summary> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetUpdateCommand(System.Boolean)"> |
<summary> |
Returns the automatically-generated SQLite command to update rows in the database |
</summary> |
<param name="useColumnsForParameterNames"></param> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetInsertCommand"> |
<summary> |
Returns the automatically-generated SQLite command to insert rows into the database |
</summary> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetInsertCommand(System.Boolean)"> |
<summary> |
Returns the automatically-generated SQLite command to insert rows into the database |
</summary> |
<param name="useColumnsForParameterNames"></param> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.QuoteIdentifier(System.String)"> |
<summary> |
Places brackets around an identifier |
</summary> |
<param name="unquotedIdentifier">The identifier to quote</param> |
<returns>The bracketed identifier</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.UnquoteIdentifier(System.String)"> |
<summary> |
Removes brackets around an identifier |
</summary> |
<param name="quotedIdentifier">The quoted (bracketed) identifier</param> |
<returns>The undecorated identifier</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetSchemaTable(System.Data.Common.DbCommand)"> |
<summary> |
Override helper, which can help the base command builder choose the right keys for the given query |
</summary> |
<param name="sourceCommand"></param> |
<returns></returns> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommandBuilder.DataAdapter"> |
<summary> |
Gets/sets the DataAdapter for this CommandBuilder |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommandBuilder.CatalogLocation"> |
<summary> |
Overridden to hide its property from the designer |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommandBuilder.CatalogSeparator"> |
<summary> |
Overridden to hide its property from the designer |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommandBuilder.QuotePrefix"> |
<summary> |
Overridden to hide its property from the designer |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommandBuilder.QuoteSuffix"> |
<summary> |
Overridden to hide its property from the designer |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteCommandBuilder.SchemaSeparator"> |
<summary> |
Overridden to hide its property from the designer |
</summary> |
</member> |
<member name="T:System.Data.SQLite.ConnectionEventArgs"> |
<summary> |
Event data for connection event handlers. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.ConnectionEventArgs.EventType"> |
<summary> |
The type of event being raised. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.ConnectionEventArgs.EventArgs"> |
<summary> |
The <see cref="T:System.Data.StateChangeEventArgs"/> associated with this event, if any. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.ConnectionEventArgs.Transaction"> |
<summary> |
The transaction associated with this event, if any. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.ConnectionEventArgs.Command"> |
<summary> |
The command associated with this event, if any. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.ConnectionEventArgs.Text"> |
<summary> |
Command or message text associated with this event, if any. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.ConnectionEventArgs.Data"> |
<summary> |
Extra data associated with this event, if any. |
</summary> |
</member> |
<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)"> |
<summary> |
Constructs the object. |
</summary> |
<param name="eventType">The type of event being raised.</param> |
<param name="eventArgs">The base <see cref="F:System.Data.SQLite.ConnectionEventArgs.EventArgs"/> associated |
with this event, if any.</param> |
<param name="transaction">The transaction associated with this event, if any.</param> |
<param name="command">The command associated with this event, if any.</param> |
<param name="text">The command or message text, if any.</param> |
<param name="data">The extra data, if any.</param> |
</member> |
<member name="T:System.Data.SQLite.SQLiteConnectionEventHandler"> |
<summary> |
Raised when an event pertaining to a connection occurs. |
</summary> |
<param name="sender">The connection involved.</param> |
<param name="e">Extra information about the event.</param> |
</member> |
<member name="T:System.Data.SQLite.SQLiteConnection"> |
<summary> |
SQLite implentation of DbConnection. |
</summary> |
<remarks> |
The <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString"/> property can contain the following parameter(s), delimited with a semi-colon: |
<list type="table"> |
<listheader> |
<term>Parameter</term> |
<term>Values</term> |
<term>Required</term> |
<term>Default</term> |
</listheader> |
<item> |
<description>Data Source</description> |
<description>This may be a file name, the string ":memory:", or any supported URI (starting with SQLite 3.7.7).</description> |
<description>Y</description> |
<description></description> |
</item> |
<item> |
<description>Version</description> |
<description>3</description> |
<description>N</description> |
<description>3</description> |
</item> |
<item> |
<description>UseUTF16Encoding</description> |
<description><b>True</b><br/><b>False</b></description> |
<description>N</description> |
<description>False</description> |
</item> |
<item> |
<description>DateTimeFormat</description> |
<description> |
<b>Ticks</b> - Use the value of DateTime.Ticks.<br/> |
<b>ISO8601</b> - Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC |
DateTime values and "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values).<br/> |
<b>JulianDay</b> - The interval of time in days and fractions of a day since January 1, 4713 BC.<br/> |
<b>UnixEpoch</b> - The whole number of seconds since the Unix epoch (January 1, 1970).<br/> |
<b>InvariantCulture</b> - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime.<br/> |
<b>CurrentCulture</b> - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture.</description> |
<description>N</description> |
<description>ISO8601</description> |
</item> |
<item> |
<description>DateTimeKind</description> |
<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> |
<description>N</description> |
<description>Unspecified</description> |
</item> |
<item> |
<description>BaseSchemaName</description> |
<description>Some base data classes in the framework (e.g. those that build SQL queries dynamically) |
assume that an ADO.NET provider cannot support an alternate catalog (i.e. database) without supporting |
alternate schemas as well; however, SQLite does not fit into this model. Therefore, this value is used |
as a placeholder and removed prior to preparing any SQL statements that may contain it.</description> |
<description>N</description> |
<description>sqlite_default_schema</description> |
</item> |
<item> |
<description>BinaryGUID</description> |
<description><b>True</b> - Store GUID columns in binary form<br/><b>False</b> - Store GUID columns as text</description> |
<description>N</description> |
<description>True</description> |
</item> |
<item> |
<description>Cache Size</description> |
<description>{size in bytes}</description> |
<description>N</description> |
<description>2000</description> |
</item> |
<item> |
<description>Synchronous</description> |
<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> |
<description>N</description> |
<description>Full</description> |
</item> |
<item> |
<description>Page Size</description> |
<description>{size in bytes}</description> |
<description>N</description> |
<description>1024</description> |
</item> |
<item> |
<description>Password</description> |
<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> |
<description>N</description> |
<description></description> |
</item> |
<item> |
<description>Enlist</description> |
<description><b>Y</b> - Automatically enlist in distributed transactions<br/><b>N</b> - No automatic enlistment</description> |
<description>N</description> |
<description>Y</description> |
</item> |
<item> |
<description>Pooling</description> |
<description><b>True</b> - Use connection pooling<br/><b>False</b> - Do not use connection pooling</description> |
<description>N</description> |
<description>False</description> |
</item> |
<item> |
<description>FailIfMissing</description> |
<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> |
<description>N</description> |
<description>False</description> |
</item> |
<item> |
<description>Max Page Count</description> |
<description>{size in pages} - Limits the maximum number of pages (limits the size) of the database</description> |
<description>N</description> |
<description>0</description> |
</item> |
<item> |
<description>Legacy Format</description> |
<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> |
<description>N</description> |
<description>False</description> |
</item> |
<item> |
<description>Default Timeout</description> |
<description>{time in seconds}<br/>The default command timeout</description> |
<description>N</description> |
<description>30</description> |
</item> |
<item> |
<description>Journal Mode</description> |
<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> |
<description>N</description> |
<description>Delete</description> |
</item> |
<item> |
<description>Read Only</description> |
<description><b>True</b> - Open the database for read only access<br/><b>False</b> - Open the database for normal read/write access</description> |
<description>N</description> |
<description>False</description> |
</item> |
<item> |
<description>Max Pool Size</description> |
<description>The maximum number of connections for the given connection string that can be in the connection pool</description> |
<description>N</description> |
<description>100</description> |
</item> |
<item> |
<description>Default IsolationLevel</description> |
<description>The default transaciton isolation level</description> |
<description>N</description> |
<description>Serializable</description> |
</item> |
<item> |
<description>Foreign Keys</description> |
<description>Enable foreign key constraints</description> |
<description>N</description> |
<description>False</description> |
</item> |
<item> |
<description>Flags</description> |
<description>Extra behavioral flags for the connection. See the <see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> enumeration for possible values.</description> |
<description>N</description> |
<description>Default</description> |
</item> |
<item> |
<description>SetDefaults</description> |
<description> |
<b>True</b> - Apply the default connection settings to the opened database.<br/> |
<b>False</b> - Skip applying the default connection settings to the opened database. |
</description> |
<description>N</description> |
<description>True</description> |
</item> |
<item> |
<description>ToFullPath</description> |
<description> |
<b>True</b> - Attempt to expand the data source file name to a fully qualified path before opening.<br/> |
<b>False</b> - Skip attempting to expand the data source file name to a fully qualified path before opening. |
</description> |
<description>N</description> |
<description>True</description> |
</item> |
</list> |
</remarks> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection.DefaultBaseSchemaName"> |
<summary> |
The default "stub" (i.e. placeholder) base schema name to use when |
returning column schema information. Used as the initial value of |
the BaseSchemaName property. This should start with "sqlite_*" |
because those names are reserved for use by SQLite (i.e. they cannot |
be confused with the names of user objects). |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._syncRoot"> |
<summary> |
Object used to synchronize access to the static instance data |
for this class. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._connectionState"> |
<summary> |
State of the current connection |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._connectionString"> |
<summary> |
The connection string |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._transactionLevel"> |
<summary> |
Nesting level of the transactions open on the connection |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._disposing"> |
<summary> |
If set, then the connection is currently being disposed. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._defaultIsolation"> |
<summary> |
The default isolation level for new transactions |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._sql"> |
<summary> |
The base SQLite object to interop with |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._dataSource"> |
<summary> |
The database filename minus path and extension |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._password"> |
<summary> |
Temporary password storage, emptied after the database has been opened |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._baseSchemaName"> |
<summary> |
The "stub" (i.e. placeholder) base schema name to use when returning |
column schema information. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._flags"> |
<summary> |
The extra behavioral flags for this connection, if any. See the |
<see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> enumeration for a list of |
possible values. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._defaultTimeout"> |
<summary> |
Default command timeout |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnection._parseViaFramework"> |
<summary> |
Non-zero if the built-in (i.e. framework provided) connection string |
parser should be used when opening the connection. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.#ctor"> |
<overloads> |
Constructs a new SQLiteConnection object |
</overloads> |
<summary> |
Default constructor |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.String)"> |
<summary> |
Initializes the connection with the specified connection string. |
</summary> |
<param name="connectionString">The connection string to use.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.String,System.Boolean)"> |
<summary> |
Initializes the connection with the specified connection string. |
</summary> |
<param name="connectionString"> |
The connection string to use on. |
</param> |
<param name="parseViaFramework"> |
Non-zero to parse the connection string using the built-in (i.e. |
framework provided) parser when opening the connection. |
</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.Data.SQLite.SQLiteConnection)"> |
<summary> |
Clones the settings and connection string from an existing connection. If the existing connection is already open, this |
function will open its own connection, enumerate any attached databases of the original connection, and automatically |
attach to them. |
</summary> |
<param name="connection">The connection to copy the settings from.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.OnChanged(System.Data.SQLite.SQLiteConnection,System.Data.SQLite.ConnectionEventArgs)"> |
<summary> |
Raises the <see cref="E:System.Data.SQLite.SQLiteConnection.Changed"/> event. |
</summary> |
<param name="connection"> |
The connection associated with this event. |
</param> |
<param name="e"> |
A <see cref="T:System.Data.SQLite.ConnectionEventArgs"/> that contains the event data. |
</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.BackupDatabase(System.Data.SQLite.SQLiteConnection,System.String,System.String,System.Int32,System.Data.SQLite.SQLiteBackupCallback,System.Int32)"> |
<summary> |
Backs up the database, using the specified database connection as the |
destination. |
</summary> |
<param name="destination">The destination database connection.</param> |
<param name="destinationName">The destination database name.</param> |
<param name="sourceName">The source database name.</param> |
<param name="pages"> |
The number of pages to copy or negative to copy all remaining pages. |
</param> |
<param name="callback"> |
The method to invoke between each step of the backup process. This |
parameter may be null (i.e. no callbacks will be performed). |
</param> |
<param name="retryMilliseconds"> |
The number of milliseconds to sleep after encountering a locking error |
during the backup process. A value less than zero means that no sleep |
should be performed. |
</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Clone"> |
<summary> |
Creates a clone of the connection. All attached databases and user-defined functions are cloned. If the existing connection is open, the cloned connection |
will also be opened. |
</summary> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.CreateFile(System.String)"> |
<summary> |
Creates a database file. This just creates a zero-byte file which SQLite |
will turn into a database when the file is opened properly. |
</summary> |
<param name="databaseFileName">The file to create</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.OnStateChange(System.Data.ConnectionState,System.Data.StateChangeEventArgs@)"> |
<summary> |
Raises the state change event when the state of the connection changes |
</summary> |
<param name="newState">The new connection state. If this is different |
from the previous state, the <see cref="E:System.Data.SQLite.SQLiteConnection.StateChange"/> event is |
raised.</param> |
<param name="eventArgs">The event data created for the raised event, if |
it was actually raised.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel,System.Boolean)"> |
<summary> |
OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection. |
</summary> |
<param name="isolationLevel">This parameter is ignored.</param> |
<param name="deferredLock">When TRUE, SQLite defers obtaining a write lock until a write operation is requested. |
When FALSE, a writelock is obtained immediately. The default is TRUE, but in a multi-threaded multi-writer |
environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock.</param> |
<returns>Returns a SQLiteTransaction object.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Boolean)"> |
<summary> |
OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection. |
</summary> |
<param name="deferredLock">When TRUE, SQLite defers obtaining a write lock until a write operation is requested. |
When FALSE, a writelock is obtained immediately. The default is false, but in a multi-threaded multi-writer |
environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock.</param> |
<returns>Returns a SQLiteTransaction object.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel)"> |
<summary> |
Creates a new <see cref="T:System.Data.SQLite.SQLiteTransaction"/> if one isn't already active on the connection. |
</summary> |
<param name="isolationLevel">Supported isolation levels are Serializable, ReadCommitted and Unspecified.</param> |
<remarks> |
Unspecified will use the default isolation level specified in the connection string. If no isolation level is specified in the |
connection string, Serializable is used. |
Serializable transactions are the default. In this mode, the engine gets an immediate lock on the database, and no other threads |
may begin a transaction. Other threads may read from the database, but not write. |
With a ReadCommitted isolation level, locks are deferred and elevated as needed. It is possible for multiple threads to start |
a transaction in ReadCommitted mode, but if a thread attempts to commit a transaction while another thread |
has a ReadCommitted lock, it may timeout or cause a deadlock on both threads until both threads' CommandTimeout's are reached. |
</remarks> |
<returns>Returns a SQLiteTransaction object.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction"> |
<summary> |
Creates a new <see cref="T:System.Data.SQLite.SQLiteTransaction"/> if one isn't already |
active on the connection. |
</summary> |
<returns>Returns the new transaction object.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.BeginDbTransaction(System.Data.IsolationLevel)"> |
<summary> |
Forwards to the local <see cref="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel)"/> function |
</summary> |
<param name="isolationLevel">Supported isolation levels are Unspecified, Serializable, and ReadCommitted</param> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.ChangeDatabase(System.String)"> |
<summary> |
This method is not implemented; however, the <see cref="E:System.Data.SQLite.SQLiteConnection.Changed"/> |
event will still be raised. |
</summary> |
<param name="databaseName"></param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Close"> |
<summary> |
When the database connection is closed, all commands linked to this connection are automatically reset. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.ClearPool(System.Data.SQLite.SQLiteConnection)"> |
<summary> |
Clears the connection pool associated with the connection. Any other active connections using the same database file |
will be discarded instead of returned to the pool when they are closed. |
</summary> |
<param name="connection"></param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.ClearAllPools"> |
<summary> |
Clears all connection pools. Any active connections will be discarded instead of sent to the pool when they are closed. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.CreateCommand"> |
<summary> |
Create a new <see cref="T:System.Data.SQLite.SQLiteCommand"/> and associate it with this connection. |
</summary> |
<returns>Returns a new command object already assigned to this connection.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.CreateDbCommand"> |
<summary> |
Forwards to the local <see cref="M:System.Data.SQLite.SQLiteConnection.CreateCommand"/> function. |
</summary> |
<returns></returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionString(System.String)"> |
<summary> |
Parses the connection string into component parts using the custom |
connection string parser. |
</summary> |
<param name="connectionString">The connection string to parse</param> |
<returns>An array of key-value pairs representing each parameter of the connection string</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionStringViaFramework(System.String,System.Boolean)"> |
<summary> |
Parses a connection string using the built-in (i.e. framework provided) |
connection string parser class and returns the key/value pairs. An |
exception may be thrown if the connection string is invalid or cannot be |
parsed. When compiled for the .NET Compact Framework, the custom |
connection string parser is always used instead because the framework |
provided one is unavailable there. |
</summary> |
<param name="connectionString"> |
The connection string to parse. |
</param> |
<param name="strict"> |
Non-zero to throw an exception if any connection string values are not of |
the <see cref="T:System.String"/> type. |
</param> |
<returns>The list of key/value pairs.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.FindKey(System.Collections.Generic.SortedList{System.String,System.String},System.String,System.String)"> |
<summary> |
Looks for a key in the array of key/values of the parameter string. If not found, return the specified default value |
</summary> |
<param name="items">The list to look in</param> |
<param name="key">The key to find</param> |
<param name="defValue">The default value to return if the key is not found</param> |
<returns>The value corresponding to the specified key, or the default value if not found.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.TryParseEnum(System.Type,System.String,System.Boolean)"> |
<summary> |
Attempts to convert the string value to an enumerated value of the specified type. |
</summary> |
<param name="type">The enumerated type to convert the string value to.</param> |
<param name="value">The string value to be converted.</param> |
<param name="ignoreCase">Non-zero to make the conversion case-insensitive.</param> |
<returns>The enumerated value upon success or null upon error.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.EnableExtensions(System.Boolean)"> |
<summary> |
Enables or disabled extension loading. |
</summary> |
<param name="enable"> |
True to enable loading of extensions, false to disable. |
</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.LoadExtension(System.String)"> |
<summary> |
Loads a SQLite extension library from the named dynamic link library file. |
</summary> |
<param name="fileName"> |
The name of the dynamic link library file containing the extension. |
</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.LoadExtension(System.String,System.String)"> |
<summary> |
Loads a SQLite extension library from the named dynamic link library file. |
</summary> |
<param name="fileName"> |
The name of the dynamic link library file containing the extension. |
</param> |
<param name="procName"> |
The name of the exported function used to initialize the extension. |
If null, the default "sqlite3_extension_init" will be used. |
</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Open"> |
<summary> |
Opens the connection using the parameters found in the <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString"/>. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.OpenAndReturn"> |
<summary> |
Opens the connection using the parameters found in the <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString"/> and then returns it. |
</summary> |
<returns>The current connection object.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Cancel"> |
<summary> |
This method causes any pending database operation to abort and return at |
its earliest opportunity. This routine is typically called in response |
to a user action such as pressing "Cancel" or Ctrl-C where the user wants |
a long query operation to halt immediately. It is safe to call this |
routine from any thread. However, it is not safe to call this routine |
with a database connection that is closed or might close before this method |
returns. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.SetMemoryStatus(System.Boolean)"> |
<summary> |
Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled. |
If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is |
global to the process. |
</summary> |
<param name="value">Non-zero to enable memory usage tracking, zero otherwise.</param> |
<returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Shutdown"> |
Passes a shutdown request off to SQLite. |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.SetExtendedResultCodes(System.Boolean)"> |
Enables or disabled extended result codes returned by SQLite |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.ResultCode"> |
Enables or disabled extended result codes returned by SQLite |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.ExtendedResultCode"> |
Enables or disabled extended result codes returned by SQLite |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)"> |
Add a log message via the SQLite sqlite3_log interface. |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.LogMessage(System.Int32,System.String)"> |
Add a log message via the SQLite sqlite3_log interface. |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.ChangePassword(System.String)"> |
<summary> |
Change the password (or assign a password) to an open database. |
</summary> |
<remarks> |
No readers or writers may be active for this process. The database must already be open |
and if it already was password protected, the existing password must already have been supplied. |
</remarks> |
<param name="newPassword">The new password to assign to the database</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.ChangePassword(System.Byte[])"> |
<summary> |
Change the password (or assign a password) to an open database. |
</summary> |
<remarks> |
No readers or writers may be active for this process. The database must already be open |
and if it already was password protected, the existing password must already have been supplied. |
</remarks> |
<param name="newPassword">The new password to assign to the database</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.SetPassword(System.String)"> |
<summary> |
Sets the password for a password-protected database. A password-protected database is |
unusable for any operation until the password has been set. |
</summary> |
<param name="databasePassword">The password for the database</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.SetPassword(System.Byte[])"> |
<summary> |
Sets the password for a password-protected database. A password-protected database is |
unusable for any operation until the password has been set. |
</summary> |
<param name="databasePassword">The password for the database</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.SetAvRetry(System.Int32@,System.Int32@)"> |
<summary> |
Queries or modifies the number of retries or the retry interval (in milliseconds) for |
certain I/O operations that may fail due to anti-virus software. |
</summary> |
<param name="count">The number of times to retry the I/O operation. A negative value |
will cause the current count to be queried and replace that negative value.</param> |
<param name="interval">The number of milliseconds to wait before retrying the I/O |
operation. This number is multiplied by the number of retry attempts so far to come |
up with the final number of milliseconds to wait. A negative value will cause the |
current interval to be queried and replace that negative value.</param> |
<returns>Zero for success, non-zero for error.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.UnwrapString(System.String)"> |
<summary> |
Removes one set of surrounding single -OR- double quotes from the string |
value and returns the resulting string value. If the string is null, empty, |
or contains quotes that are not balanced, nothing is done and the original |
string value will be returned. |
</summary> |
<param name="value">The string value to process.</param> |
<returns> |
The string value, modified to remove one set of surrounding single -OR- |
double quotes, if applicable. |
</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.ExpandFileName(System.String,System.Boolean)"> |
<summary> |
Expand the filename of the data source, resolving the |DataDirectory| |
macro as appropriate. |
</summary> |
<param name="sourceFile">The database filename to expand</param> |
<param name="toFullPath"> |
Non-zero if the returned file name should be converted to a full path |
(except when using the .NET Compact Framework). |
</param> |
<returns>The expanded path and filename of the filename</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.GetSchema"> |
<overloads> |
The following commands are used to extract schema information out of the database. Valid schema types are: |
<list type="bullet"> |
<item> |
<description>MetaDataCollections</description> |
</item> |
<item> |
<description>DataSourceInformation</description> |
</item> |
<item> |
<description>Catalogs</description> |
</item> |
<item> |
<description>Columns</description> |
</item> |
<item> |
<description>ForeignKeys</description> |
</item> |
<item> |
<description>Indexes</description> |
</item> |
<item> |
<description>IndexColumns</description> |
</item> |
<item> |
<description>Tables</description> |
</item> |
<item> |
<description>Views</description> |
</item> |
<item> |
<description>ViewColumns</description> |
</item> |
</list> |
</overloads> |
<summary> |
Returns the MetaDataCollections schema |
</summary> |
<returns>A DataTable of the MetaDataCollections schema</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.GetSchema(System.String)"> |
<summary> |
Returns schema information of the specified collection |
</summary> |
<param name="collectionName">The schema collection to retrieve</param> |
<returns>A DataTable of the specified collection</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.GetSchema(System.String,System.String[])"> |
<summary> |
Retrieves schema information using the specified constraint(s) for the specified collection |
</summary> |
<param name="collectionName">The collection to retrieve</param> |
<param name="restrictionValues">The restrictions to impose</param> |
<returns>A DataTable of the specified collection</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_MetaDataCollections"> |
<summary> |
Builds a MetaDataCollections schema datatable |
</summary> |
<returns>DataTable</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_DataSourceInformation"> |
<summary> |
Builds a DataSourceInformation datatable |
</summary> |
<returns>DataTable</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_Columns(System.String,System.String,System.String)"> |
<summary> |
Build a Columns schema |
</summary> |
<param name="strCatalog">The catalog (attached database) to query, can be null</param> |
<param name="strTable">The table to retrieve schema information for, must not be null</param> |
<param name="strColumn">The column to retrieve schema information for, can be null</param> |
<returns>DataTable</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_Indexes(System.String,System.String,System.String)"> |
<summary> |
Returns index information for the given database and catalog |
</summary> |
<param name="strCatalog">The catalog (attached database) to query, can be null</param> |
<param name="strIndex">The name of the index to retrieve information for, can be null</param> |
<param name="strTable">The table to retrieve index information for, can be null</param> |
<returns>DataTable</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_Tables(System.String,System.String,System.String)"> |
<summary> |
Retrieves table schema information for the database and catalog |
</summary> |
<param name="strCatalog">The catalog (attached database) to retrieve tables on</param> |
<param name="strTable">The table to retrieve, can be null</param> |
<param name="strType">The table type, can be null</param> |
<returns>DataTable</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_Views(System.String,System.String)"> |
<summary> |
Retrieves view schema information for the database |
</summary> |
<param name="strCatalog">The catalog (attached database) to retrieve views on</param> |
<param name="strView">The view name, can be null</param> |
<returns>DataTable</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_Catalogs(System.String)"> |
<summary> |
Retrieves catalog (attached databases) schema information for the database |
</summary> |
<param name="strCatalog">The catalog to retrieve, can be null</param> |
<returns>DataTable</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_IndexColumns(System.String,System.String,System.String,System.String)"> |
<summary> |
Returns the base column information for indexes in a database |
</summary> |
<param name="strCatalog">The catalog to retrieve indexes for (can be null)</param> |
<param name="strTable">The table to restrict index information by (can be null)</param> |
<param name="strIndex">The index to restrict index information by (can be null)</param> |
<param name="strColumn">The source column to restrict index information by (can be null)</param> |
<returns>A DataTable containing the results</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_ViewColumns(System.String,System.String,System.String)"> |
<summary> |
Returns detailed column information for a specified view |
</summary> |
<param name="strCatalog">The catalog to retrieve columns for (can be null)</param> |
<param name="strView">The view to restrict column information by (can be null)</param> |
<param name="strColumn">The source column to restrict column information by (can be null)</param> |
<returns>A DataTable containing the results</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_ForeignKeys(System.String,System.String,System.String)"> |
<summary> |
Retrieves foreign key information from the specified set of filters |
</summary> |
<param name="strCatalog">An optional catalog to restrict results on</param> |
<param name="strTable">An optional table to restrict results on</param> |
<param name="strKeyName">An optional foreign key name to restrict results on</param> |
<returns>A DataTable with the results of the query</returns> |
</member> |
<member name="E:System.Data.SQLite.SQLiteConnection._handlers"> |
<summary> |
Static variable to store the connection event handlers to call. |
</summary> |
</member> |
<member name="E:System.Data.SQLite.SQLiteConnection.StateChange"> |
<summary> |
This event is raised whenever the database is opened or closed. |
</summary> |
</member> |
<member name="E:System.Data.SQLite.SQLiteConnection.Changed"> |
<summary> |
This event is raised when events related to the lifecycle of a |
SQLiteConnection object occur. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.ConnectionTimeout"> |
<summary> |
Obsolete |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.PoolCount"> |
<summary> |
Returns the number of pool entries for the file name associated with this connection. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.ConnectionString"> |
<summary> |
The connection string containing the parameters for the connection |
</summary> |
<remarks> |
<list type="table"> |
<listheader> |
<term>Parameter</term> |
<term>Values</term> |
<term>Required</term> |
<term>Default</term> |
</listheader> |
<item> |
<description>Data Source</description> |
<description>This may be a file name, the string ":memory:", or any supported URI (starting with SQLite 3.7.7).</description> |
<description>Y</description> |
<description></description> |
</item> |
<item> |
<description>Version</description> |
<description>3</description> |
<description>N</description> |
<description>3</description> |
</item> |
<item> |
<description>UseUTF16Encoding</description> |
<description><b>True</b><br/><b>False</b></description> |
<description>N</description> |
<description>False</description> |
</item> |
<item> |
<description>DateTimeFormat</description> |
<description> |
<b>Ticks</b> - Use the value of DateTime.Ticks.<br/> |
<b>ISO8601</b> - Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC |
DateTime values and "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values).<br/> |
<b>JulianDay</b> - The interval of time in days and fractions of a day since January 1, 4713 BC.<br/> |
<b>UnixEpoch</b> - The whole number of seconds since the Unix epoch (January 1, 1970).<br/> |
<b>InvariantCulture</b> - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime.<br/> |
<b>CurrentCulture</b> - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture.</description> |
<description>N</description> |
<description>ISO8601</description> |
</item> |
<item> |
<description>DateTimeKind</description> |
<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> |
<description>N</description> |
<description>Unspecified</description> |
</item> |
<item> |
<description>BaseSchemaName</description> |
<description>Some base data classes in the framework (e.g. those that build SQL queries dynamically) |
assume that an ADO.NET provider cannot support an alternate catalog (i.e. database) without supporting |
alternate schemas as well; however, SQLite does not fit into this model. Therefore, this value is used |
as a placeholder and removed prior to preparing any SQL statements that may contain it.</description> |
<description>N</description> |
<description>sqlite_default_schema</description> |
</item> |
<item> |
<description>BinaryGUID</description> |
<description><b>True</b> - Store GUID columns in binary form<br/><b>False</b> - Store GUID columns as text</description> |
<description>N</description> |
<description>True</description> |
</item> |
<item> |
<description>Cache Size</description> |
<description>{size in bytes}</description> |
<description>N</description> |
<description>2000</description> |
</item> |
<item> |
<description>Synchronous</description> |
<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> |
<description>N</description> |
<description>Full</description> |
</item> |
<item> |
<description>Page Size</description> |
<description>{size in bytes}</description> |
<description>N</description> |
<description>1024</description> |
</item> |
<item> |
<description>Password</description> |
<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> |
<description>N</description> |
<description></description> |
</item> |
<item> |
<description>Enlist</description> |
<description><b>Y</b> - Automatically enlist in distributed transactions<br/><b>N</b> - No automatic enlistment</description> |
<description>N</description> |
<description>Y</description> |
</item> |
<item> |
<description>Pooling</description> |
<description><b>True</b> - Use connection pooling<br/><b>False</b> - Do not use connection pooling</description> |
<description>N</description> |
<description>False</description> |
</item> |
<item> |
<description>FailIfMissing</description> |
<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> |
<description>N</description> |
<description>False</description> |
</item> |
<item> |
<description>Max Page Count</description> |
<description>{size in pages} - Limits the maximum number of pages (limits the size) of the database</description> |
<description>N</description> |
<description>0</description> |
</item> |
<item> |
<description>Legacy Format</description> |
<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> |
<description>N</description> |
<description>False</description> |
</item> |
<item> |
<description>Default Timeout</description> |
<description>{time in seconds}<br/>The default command timeout</description> |
<description>N</description> |
<description>30</description> |
</item> |
<item> |
<description>Journal Mode</description> |
<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> |
<description>N</description> |
<description>Delete</description> |
</item> |
<item> |
<description>Read Only</description> |
<description><b>True</b> - Open the database for read only access<br/><b>False</b> - Open the database for normal read/write access</description> |
<description>N</description> |
<description>False</description> |
</item> |
<item> |
<description>Max Pool Size</description> |
<description>The maximum number of connections for the given connection string that can be in the connection pool</description> |
<description>N</description> |
<description>100</description> |
</item> |
<item> |
<description>Default IsolationLevel</description> |
<description>The default transaciton isolation level</description> |
<description>N</description> |
<description>Serializable</description> |
</item> |
<item> |
<description>Foreign Keys</description> |
<description>Enable foreign key constraints</description> |
<description>N</description> |
<description>False</description> |
</item> |
<item> |
<description>Flags</description> |
<description>Extra behavioral flags for the connection. See the <see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> enumeration for possible values.</description> |
<description>N</description> |
<description>Default</description> |
</item> |
<item> |
<description>SetDefaults</description> |
<description> |
<b>True</b> - Apply the default connection settings to the opened database.<br/> |
<b>False</b> - Skip applying the default connection settings to the opened database. |
</description> |
<description>N</description> |
<description>True</description> |
</item> |
<item> |
<description>ToFullPath</description> |
<description> |
<b>True</b> - Attempt to expand the data source file name to a fully qualified path before opening.<br/> |
<b>False</b> - Skip attempting to expand the data source file name to a fully qualified path before opening. |
</description> |
<description>N</description> |
<description>True</description> |
</item> |
</list> |
</remarks> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.DataSource"> |
<summary> |
Returns the data source file name without extension or path. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.Database"> |
<summary> |
Returns the string "main". |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.DefaultTimeout"> |
<summary> |
Gets/sets the default command timeout for newly-created commands. This is especially useful for |
commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible. |
This can also be set in the ConnectionString with "Default Timeout" |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.ParseViaFramework"> |
<summary> |
Non-zero if the built-in (i.e. framework provided) connection string |
parser should be used when opening the connection. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.Flags"> |
<summary> |
Gets/sets the extra behavioral flags for this connection. See the |
<see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> enumeration for a list of |
possible values. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.ServerVersion"> |
<summary> |
Returns the version of the underlying SQLite database engine |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.LastInsertRowId"> |
<summary> |
Returns the rowid of the most recent successful INSERT into the database from this connection. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.Changes"> |
<summary> |
Returns the number of rows changed by the last INSERT, UPDATE, or DELETE statement executed on |
this connection. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.MemoryUsed"> |
<summary> |
Returns the amount of memory (in bytes) currently in use by the SQLite core library. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.MemoryHighwater"> |
<summary> |
Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.DefineConstants"> |
<summary> |
Returns a string containing the define constants (i.e. compile-time |
options) used to compile the core managed assembly, delimited with |
spaces. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.SQLiteVersion"> |
<summary> |
Returns the version of the underlying SQLite database engine |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.SQLiteSourceId"> |
<summary> |
This method returns the string whose value is the same as the |
SQLITE_SOURCE_ID C preprocessor macro used when compiling the |
SQLite core library. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteConnection.State"> |
<summary> |
Returns the state of the connection. |
</summary> |
</member> |
<member name="E:System.Data.SQLite.SQLiteConnection.Update"> |
<summary> |
This event is raised whenever SQLite makes an update/delete/insert into the database on |
this connection. It only applies to the given connection. |
</summary> |
</member> |
<member name="E:System.Data.SQLite.SQLiteConnection.Commit"> |
<summary> |
This event is raised whenever SQLite is committing a transaction. |
Return non-zero to trigger a rollback. |
</summary> |
</member> |
<member name="E:System.Data.SQLite.SQLiteConnection.Trace"> |
<summary> |
This event is raised whenever SQLite statement first begins executing on |
this connection. It only applies to the given connection. |
</summary> |
</member> |
<member name="E:System.Data.SQLite.SQLiteConnection.RollBack"> |
<summary> |
This event is raised whenever SQLite is rolling back a transaction. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SynchronizationModes"> |
<summary> |
The I/O file cache flushing behavior for the connection |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SynchronizationModes.Normal"> |
<summary> |
Normal file flushing at critical sections of the code |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SynchronizationModes.Full"> |
<summary> |
Full file flushing after every write operation |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SynchronizationModes.Off"> |
<summary> |
Use the default operating system's file flushing, SQLite does not explicitly flush the file buffers after writing |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteCommitHandler"> |
<summary> |
Raised when a transaction is about to be committed. To roll back a transaction, set the |
rollbackTrans boolean value to true. |
</summary> |
<param name="sender">The connection committing the transaction</param> |
<param name="e">Event arguments on the transaction</param> |
</member> |
<member name="T:System.Data.SQLite.SQLiteUpdateEventHandler"> |
<summary> |
Raised when data is inserted, updated and deleted on a given connection |
</summary> |
<param name="sender">The connection committing the transaction</param> |
<param name="e">The event parameters which triggered the event</param> |
</member> |
<member name="T:System.Data.SQLite.SQLiteTraceEventHandler"> |
<summary> |
Raised when a statement first begins executing on a given connection |
</summary> |
<param name="sender">The connection executing the statement</param> |
<param name="e">Event arguments of the trace</param> |
</member> |
<member name="T:System.Data.SQLite.SQLiteBackupCallback"> |
<summary> |
Raised between each backup step. |
</summary> |
<param name="source"> |
The source database connection. |
</param> |
<param name="sourceName"> |
The source database name. |
</param> |
<param name="destination"> |
The destination database connection. |
</param> |
<param name="destinationName"> |
The destination database name. |
</param> |
<param name="pages"> |
The number of pages copied with each step. |
</param> |
<param name="remainingPages"> |
The number of pages remaining to be copied. |
</param> |
<param name="totalPages"> |
The total number of pages in the source database. |
</param> |
<param name="retry"> |
Set to true if the operation needs to be retried due to database |
locking issues; otherwise, set to false. |
</param> |
<returns> |
True to continue with the backup process or false to halt the backup |
process, rolling back any changes that have been made so far. |
</returns> |
</member> |
<member name="T:System.Data.SQLite.UpdateEventType"> |
<summary> |
Whenever an update event is triggered on a connection, this enum will indicate |
exactly what type of operation is being performed. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.UpdateEventType.Delete"> |
<summary> |
A row is being deleted from the given database and table |
</summary> |
</member> |
<member name="F:System.Data.SQLite.UpdateEventType.Insert"> |
<summary> |
A row is being inserted into the table. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.UpdateEventType.Update"> |
<summary> |
A row is being updated in the table. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.UpdateEventArgs"> |
<summary> |
Passed during an Update callback, these event arguments detail the type of update operation being performed |
on the given connection. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.UpdateEventArgs.Database"> |
<summary> |
The name of the database being updated (usually "main" but can be any attached or temporary database) |
</summary> |
</member> |
<member name="F:System.Data.SQLite.UpdateEventArgs.Table"> |
<summary> |
The name of the table being updated |
</summary> |
</member> |
<member name="F:System.Data.SQLite.UpdateEventArgs.Event"> |
<summary> |
The type of update being performed (insert/update/delete) |
</summary> |
</member> |
<member name="F:System.Data.SQLite.UpdateEventArgs.RowId"> |
<summary> |
The RowId affected by this update. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.CommitEventArgs"> |
<summary> |
Event arguments raised when a transaction is being committed |
</summary> |
</member> |
<member name="F:System.Data.SQLite.CommitEventArgs.AbortTransaction"> |
<summary> |
Set to true to abort the transaction and trigger a rollback |
</summary> |
</member> |
<member name="T:System.Data.SQLite.TraceEventArgs"> |
<summary> |
Passed during an Trace callback, these event arguments contain the UTF-8 rendering of the SQL statement text |
</summary> |
</member> |
<member name="F:System.Data.SQLite.TraceEventArgs.Statement"> |
<summary> |
SQL statement text as the statement first begins executing |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionPool._connections"> |
<summary> |
The connection pool object |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionPool._poolVersion"> |
<summary> |
The default version number new pools will get |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionPool._poolOpened"> |
<summary> |
The number of connections successfully opened from any pool. |
This value is incremented by the Remove method. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionPool._poolClosed"> |
<summary> |
The number of connections successfully closed from any pool. |
This value is incremented by the Add method. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnectionPool.GetCounts(System.String,System.Collections.Generic.Dictionary{System.String,System.Int32}@,System.Int32@,System.Int32@,System.Int32@)"> |
<summary> |
Counts the number of pool entries matching the specified file name. |
</summary> |
<param name="fileName">The file name to match or null to match all files.</param> |
<param name="counts">The pool entry counts for each matching file.</param> |
<param name="openCount">The total number of connections successfully opened from any pool.</param> |
<param name="closeCount">The total number of connections successfully closed from any pool.</param> |
<param name="totalCount">The total number of pool entries for all matching files.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnectionPool.Remove(System.String,System.Int32,System.Int32@)"> |
<summary> |
Attempt to pull a pooled connection out of the queue for active duty |
</summary> |
<param name="fileName">The filename for a desired connection</param> |
<param name="maxPoolSize">The maximum size the connection pool for the filename can be</param> |
<param name="version">The pool version the returned connection will belong to</param> |
<returns>Returns NULL if no connections were available. Even if none are, the poolversion will still be a valid pool version</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnectionPool.ClearAllPools"> |
<summary> |
Clears out all pooled connections and rev's up the default pool version to force all old active objects |
not in the pool to get discarded rather than returned to their pools. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnectionPool.ClearPool(System.String)"> |
<summary> |
Clear a given pool for a given filename. Discards anything in the pool for the given file, and revs the pool |
version so current active objects on the old version of the pool will get discarded rather than be returned to the pool. |
</summary> |
<param name="fileName">The filename of the pool to clear</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnectionPool.Add(System.String,System.Data.SQLite.SQLiteConnectionHandle,System.Int32)"> |
<summary> |
Return a connection to the pool for someone else to use. |
</summary> |
<param name="fileName">The filename of the pool to use</param> |
<param name="hdl">The connection handle to pool</param> |
<param name="version">The pool version the handle was created under</param> |
<remarks> |
If the version numbers don't match between the connection and the pool, then the handle is discarded. |
</remarks> |
</member> |
<member name="M:System.Data.SQLite.SQLiteConnectionPool.ResizePool(System.Data.SQLite.SQLiteConnectionPool.Pool,System.Boolean)"> |
<summary> |
We don't have to thread-lock anything in this function, because it's only called by other functions above |
which already have a thread-safe lock. |
</summary> |
<param name="queue">The queue to resize</param> |
<param name="forAdding">If a function intends to add to the pool, this is true, which forces the resize |
to take one more than it needs from the pool</param> |
</member> |
<member name="T:System.Data.SQLite.SQLiteConnectionPool.Pool"> |
<summary> |
Keeps track of connections made on a specified file. The PoolVersion dictates whether old objects get |
returned to the pool or discarded when no longer in use. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.TypeAffinity"> |
<summary> |
SQLite has very limited types, and is inherently text-based. The first 5 types below represent the sum of all types SQLite |
understands. The DateTime extension to the spec is for internal use only. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.TypeAffinity.Uninitialized"> |
<summary> |
Not used |
</summary> |
</member> |
<member name="F:System.Data.SQLite.TypeAffinity.Int64"> |
<summary> |
All integers in SQLite default to Int64 |
</summary> |
</member> |
<member name="F:System.Data.SQLite.TypeAffinity.Double"> |
<summary> |
All floating point numbers in SQLite default to double |
</summary> |
</member> |
<member name="F:System.Data.SQLite.TypeAffinity.Text"> |
<summary> |
The default data type of SQLite is text |
</summary> |
</member> |
<member name="F:System.Data.SQLite.TypeAffinity.Blob"> |
<summary> |
Typically blob types are only seen when returned from a function |
</summary> |
</member> |
<member name="F:System.Data.SQLite.TypeAffinity.Null"> |
<summary> |
Null types can be returned from functions |
</summary> |
</member> |
<member name="F:System.Data.SQLite.TypeAffinity.DateTime"> |
<summary> |
Used internally by this provider |
</summary> |
</member> |
<member name="F:System.Data.SQLite.TypeAffinity.None"> |
<summary> |
Used internally |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteConnectionEventType"> |
<summary> |
These are the event types associated with the |
<see cref="T:System.Data.SQLite.SQLiteConnectionEventHandler"/> |
delegate (and its corresponding event) and the |
<see cref="T:System.Data.SQLite.ConnectionEventArgs"/> class. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionEventType.Invalid"> |
<summary> |
Not used. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionEventType.Unknown"> |
<summary> |
Not used. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionEventType.Opening"> |
<summary> |
The connection is being opened. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionEventType.ConnectionString"> |
<summary> |
The connection string has been parsed. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionEventType.Opened"> |
<summary> |
The connection was opened. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionEventType.ChangeDatabase"> |
<summary> |
The <see cref="F:System.Data.SQLite.SQLiteConnectionEventType.ChangeDatabase"/> method was called on the |
connection. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionEventType.NewTransaction"> |
<summary> |
A transaction was created using the connection. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionEventType.EnlistTransaction"> |
<summary> |
The connection was enlisted into a transaction. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionEventType.NewCommand"> |
<summary> |
A command was created using the connection. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionEventType.Closing"> |
<summary> |
The connection is being closed. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteConnectionEventType.Closed"> |
<summary> |
The connection was closed. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteDateFormats"> |
<summary> |
This implementation of SQLite for ADO.NET can process date/time fields in databases in only one of three formats. Ticks, ISO8601 |
and JulianDay. |
</summary> |
<remarks> |
ISO8601 is more compatible, readable, fully-processable, but less accurate as it doesn't provide time down to fractions of a second. |
JulianDay is the numeric format the SQLite uses internally and is arguably the most compatible with 3rd party tools. It is |
not readable as text without post-processing. |
Ticks less compatible with 3rd party tools that query the database, and renders the DateTime field unreadable as text without post-processing. |
|
The preferred order of choosing a datetime format is JulianDay, ISO8601, and then Ticks. Ticks is mainly present for legacy |
code support. |
</remarks> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDateFormats.Ticks"> |
<summary> |
Use the value of DateTime.Ticks. This value is not recommended and is not well supported with LINQ. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDateFormats.ISO8601"> |
<summary> |
Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC DateTime values and |
"yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values). |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDateFormats.JulianDay"> |
<summary> |
The interval of time in days and fractions of a day since January 1, 4713 BC. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDateFormats.UnixEpoch"> |
<summary> |
The whole number of seconds since the Unix epoch (January 1, 1970). |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDateFormats.InvariantCulture"> |
<summary> |
Any culture-independent string value that the .NET Framework can interpret as a valid DateTime. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDateFormats.CurrentCulture"> |
<summary> |
Any string value that the .NET Framework can interpret as a valid DateTime using the current culture. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDateFormats.Default"> |
<summary> |
The default format for this provider. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteJournalModeEnum"> |
<summary> |
This enum determines how SQLite treats its journal file. |
</summary> |
<remarks> |
By default SQLite will create and delete the journal file when needed during a transaction. |
However, for some computers running certain filesystem monitoring tools, the rapid |
creation and deletion of the journal file can cause those programs to fail, or to interfere with SQLite. |
|
If a program or virus scanner is interfering with SQLite's journal file, you may receive errors like "unable to open database file" |
when starting a transaction. If this is happening, you may want to change the default journal mode to Persist. |
</remarks> |
</member> |
<member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Default"> |
<summary> |
The default mode, this causes SQLite to use the existing journaling mode for the database. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Delete"> |
<summary> |
SQLite will create and destroy the journal file as-needed. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Persist"> |
<summary> |
When this is set, SQLite will keep the journal file even after a transaction has completed. It's contents will be erased, |
and the journal re-used as often as needed. If it is deleted, it will be recreated the next time it is needed. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Off"> |
<summary> |
This option disables the rollback journal entirely. Interrupted transactions or a program crash can cause database |
corruption in this mode! |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Truncate"> |
<summary> |
SQLite will truncate the journal file to zero-length instead of deleting it. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Memory"> |
<summary> |
SQLite will store the journal in volatile RAM. This saves disk I/O but at the expense of database safety and integrity. |
If the application using SQLite crashes in the middle of a transaction when the MEMORY journaling mode is set, then the |
database file will very likely go corrupt. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Wal"> |
<summary> |
SQLite uses a write-ahead log instead of a rollback journal to implement transactions. The WAL journaling mode is persistent; |
after being set it stays in effect across multiple database connections and after closing and reopening the database. A database |
in WAL journaling mode can only be accessed by SQLite version 3.7.0 or later. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteSynchronousEnum"> |
<summary> |
Possible values for the "synchronous" database setting. This setting determines |
how often the database engine calls the xSync method of the VFS. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Default"> |
<summary> |
Use the default "synchronous" database setting. Currently, this should be |
the same as using the FULL mode. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Off"> |
<summary> |
The database engine continues without syncing as soon as it has handed |
data off to the operating system. If the application running SQLite |
crashes, the data will be safe, but the database might become corrupted |
if the operating system crashes or the computer loses power before that |
data has been written to the disk surface. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Normal"> |
<summary> |
The database engine will still sync at the most critical moments, but |
less often than in FULL mode. There is a very small (though non-zero) |
chance that a power failure at just the wrong time could corrupt the |
database in NORMAL mode. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Full"> |
<summary> |
The database engine will use the xSync method of the VFS to ensure that |
all content is safely written to the disk surface prior to continuing. |
This ensures that an operating system crash or power failure will not |
corrupt the database. FULL synchronous is very safe, but it is also |
slower. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteType"> |
<summary> |
Struct used internally to determine the datatype of a column in a resultset |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteType.Type"> |
<summary> |
The DbType of the column, or DbType.Object if it cannot be determined |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteType.Affinity"> |
<summary> |
The affinity of a column, used for expressions or when Type is DbType.Object |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteDataAdapter"> |
<summary> |
SQLite implementation of DbDataAdapter. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor"> |
<overloads> |
This class is just a shell around the DbDataAdapter. Nothing from DbDataAdapter is overridden here, just a few constructors are defined. |
</overloads> |
<summary> |
Default constructor. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.Data.SQLite.SQLiteCommand)"> |
<summary> |
Constructs a data adapter using the specified select command. |
</summary> |
<param name="cmd">The select command to associate with the adapter.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.String,System.Data.SQLite.SQLiteConnection)"> |
<summary> |
Constructs a data adapter with the supplied select command text and associated with the specified connection. |
</summary> |
<param name="commandText">The select command text to associate with the data adapter.</param> |
<param name="connection">The connection to associate with the select command.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.String,System.String)"> |
<summary> |
Constructs a data adapter with the specified select command text, and using the specified database connection string. |
</summary> |
<param name="commandText">The select command text to use to construct a select command.</param> |
<param name="connectionString">A connection string suitable for passing to a new SQLiteConnection, which is associated with the select command.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)"> |
<summary> |
Raised by the underlying DbDataAdapter when a row is being updated |
</summary> |
<param name="value">The event's specifics</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)"> |
<summary> |
Raised by DbDataAdapter after a row is updated |
</summary> |
<param name="value">The event's specifics</param> |
</member> |
<member name="E:System.Data.SQLite.SQLiteDataAdapter.RowUpdating"> |
<summary> |
Row updating event handler |
</summary> |
</member> |
<member name="E:System.Data.SQLite.SQLiteDataAdapter.RowUpdated"> |
<summary> |
Row updated event handler |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteDataAdapter.SelectCommand"> |
<summary> |
Gets/sets the select command for this DataAdapter |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteDataAdapter.InsertCommand"> |
<summary> |
Gets/sets the insert command for this DataAdapter |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteDataAdapter.UpdateCommand"> |
<summary> |
Gets/sets the update command for this DataAdapter |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteDataAdapter.DeleteCommand"> |
<summary> |
Gets/sets the delete command for this DataAdapter |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteDataReader"> |
<summary> |
SQLite implementation of DbDataReader. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._command"> |
<summary> |
Underlying command this reader is attached to |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._activeStatementIndex"> |
<summary> |
Index of the current statement in the command being processed |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._activeStatement"> |
<summary> |
Current statement being Read() |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._readingState"> |
<summary> |
State of the current statement being processed. |
-1 = First Step() executed, so the first Read() will be ignored |
0 = Actively reading |
1 = Finished reading |
2 = Non-row-returning statement, no records |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._rowsAffected"> |
<summary> |
Number of records affected by the insert/update statements executed on the command |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._fieldCount"> |
<summary> |
Count of fields (columns) in the row-returning statement currently being processed |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._fieldIndexes"> |
<summary> |
Maps the field (column) names to their corresponding indexes within the results. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._fieldTypeArray"> |
<summary> |
Datatypes of active fields (columns) in the current statement, used for type-restricting data |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._commandBehavior"> |
<summary> |
The behavior of the datareader |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._disposeCommand"> |
<summary> |
If set, then dispose of the command object when the reader is finished |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._throwOnDisposed"> |
<summary> |
If set, then raise an exception when the object is accessed after being disposed. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._keyInfo"> |
<summary> |
An array of rowid's for the active statement if CommandBehavior.KeyInfo is specified |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._version"> |
<summary> |
Matches the version of the connection. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteDataReader._baseSchemaName"> |
<summary> |
The "stub" (i.e. placeholder) base schema name to use when returning |
column schema information. Matches the base schema name used by the |
associated connection. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.#ctor(System.Data.SQLite.SQLiteCommand,System.Data.CommandBehavior)"> |
<summary> |
Internal constructor, initializes the datareader and sets up to begin executing statements |
</summary> |
<param name="cmd">The SQLiteCommand this data reader is for</param> |
<param name="behave">The expected behavior of the data reader</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.Dispose(System.Boolean)"> |
<summary> |
Dispose of all resources used by this datareader. |
</summary> |
<param name="disposing"></param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.Close"> |
<summary> |
Closes the datareader, potentially closing the connection as well if CommandBehavior.CloseConnection was specified. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.CheckClosed"> |
<summary> |
Throw an error if the datareader is closed |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.CheckValidRow"> |
<summary> |
Throw an error if a row is not loaded |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetEnumerator"> |
<summary> |
Enumerator support |
</summary> |
<returns>Returns a DbEnumerator object.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.VerifyType(System.Int32,System.Data.DbType)"> |
<summary> |
SQLite is inherently un-typed. All datatypes in SQLite are natively strings. The definition of the columns of a table |
and the affinity of returned types are all we have to go on to type-restrict data in the reader. |
|
This function attempts to verify that the type of data being requested of a column matches the datatype of the column. In |
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) |
to a set of known types that closely match that affinity. It's not an exact science, but its the best we can do. |
</summary> |
<returns> |
This function throws an InvalidTypeCast() exception if the requested type doesn't match the column's definition or affinity. |
</returns> |
<param name="i">The index of the column to type-check</param> |
<param name="typ">The type we want to get out of the column</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetBoolean(System.Int32)"> |
<summary> |
Retrieves the column as a boolean value |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>bool</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetByte(System.Int32)"> |
<summary> |
Retrieves the column as a single byte value |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>byte</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"> |
<summary> |
Retrieves a column as an array of bytes (blob) |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<param name="fieldOffset">The zero-based index of where to begin reading the data</param> |
<param name="buffer">The buffer to write the bytes into</param> |
<param name="bufferoffset">The zero-based index of where to begin writing into the array</param> |
<param name="length">The number of bytes to retrieve</param> |
<returns>The actual number of bytes written into the array</returns> |
<remarks> |
To determine the number of bytes in the column, pass a null value for the buffer. The total length will be returned. |
</remarks> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetChar(System.Int32)"> |
<summary> |
Returns the column as a single character |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>char</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"> |
<summary> |
Retrieves a column as an array of chars (blob) |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<param name="fieldoffset">The zero-based index of where to begin reading the data</param> |
<param name="buffer">The buffer to write the characters into</param> |
<param name="bufferoffset">The zero-based index of where to begin writing into the array</param> |
<param name="length">The number of bytes to retrieve</param> |
<returns>The actual number of characters written into the array</returns> |
<remarks> |
To determine the number of characters in the column, pass a null value for the buffer. The total length will be returned. |
</remarks> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetDataTypeName(System.Int32)"> |
<summary> |
Retrieves the name of the back-end datatype of the column |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>string</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetDateTime(System.Int32)"> |
<summary> |
Retrieve the column as a date/time value |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>DateTime</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetDecimal(System.Int32)"> |
<summary> |
Retrieve the column as a decimal value |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>decimal</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetDouble(System.Int32)"> |
<summary> |
Returns the column as a double |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>double</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetFieldType(System.Int32)"> |
<summary> |
Returns the .NET type of a given column |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>Type</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetFloat(System.Int32)"> |
<summary> |
Returns a column as a float value |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>float</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetGuid(System.Int32)"> |
<summary> |
Returns the column as a Guid |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>Guid</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetInt16(System.Int32)"> |
<summary> |
Returns the column as a short |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>Int16</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetInt32(System.Int32)"> |
<summary> |
Retrieves the column as an int |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>Int32</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetInt64(System.Int32)"> |
<summary> |
Retrieves the column as a long |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>Int64</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetName(System.Int32)"> |
<summary> |
Retrieves the name of the column |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>string</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetOrdinal(System.String)"> |
<summary> |
Retrieves the i of a column, given its name |
</summary> |
<param name="name">The name of the column to retrieve</param> |
<returns>The int i of the column</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetSchemaTable"> |
<summary> |
Schema information in SQLite is difficult to map into .NET conventions, so a lot of work must be done |
to gather the necessary information so it can be represented in an ADO.NET manner. |
</summary> |
<returns>Returns a DataTable containing the schema information for the active SELECT statement being processed.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetString(System.Int32)"> |
<summary> |
Retrieves the column as a string |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>string</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetValue(System.Int32)"> |
<summary> |
Retrieves the column as an object corresponding to the underlying datatype of the column |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>object</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetValues(System.Object[])"> |
<summary> |
Retreives the values of multiple columns, up to the size of the supplied array |
</summary> |
<param name="values">The array to fill with values from the columns in the current resultset</param> |
<returns>The number of columns retrieved</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetValues"> |
<summary> |
Returns a collection containing all the column names and values for the |
current row of data in the current resultset, if any. If there is no |
current row or no current resultset, an exception may be thrown. |
</summary> |
<returns> |
The collection containing the column name and value information for the |
current row of data in the current resultset or null if this information |
cannot be obtained. |
</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.IsDBNull(System.Int32)"> |
<summary> |
Returns True if the specified column is null |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>True or False</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.NextResult"> |
<summary> |
Moves to the next resultset in multiple row-returning SQL command. |
</summary> |
<returns>True if the command was successful and a new resultset is available, False otherwise.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.GetSQLiteType(System.Int32)"> |
<summary> |
Retrieves the SQLiteType for a given column, and caches it to avoid repetetive interop calls. |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>A SQLiteType structure</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteDataReader.Read"> |
<summary> |
Reads the next row from the resultset |
</summary> |
<returns>True if a new row was successfully loaded and is ready for processing</returns> |
</member> |
<member name="P:System.Data.SQLite.SQLiteDataReader.Depth"> |
<summary> |
Not implemented. Returns 0 |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteDataReader.FieldCount"> |
<summary> |
Returns the number of columns in the current resultset |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteDataReader.VisibleFieldCount"> |
<summary> |
Returns the number of visible fields in the current resultset |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteDataReader.HasRows"> |
<summary> |
Returns True if the resultset has rows that can be fetched |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteDataReader.IsClosed"> |
<summary> |
Returns True if the data reader is closed |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteDataReader.RecordsAffected"> |
<summary> |
Retrieve the count of records affected by an update/insert command. Only valid once the data reader is closed! |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteDataReader.Item(System.String)"> |
<summary> |
Indexer to retrieve data from a column given its name |
</summary> |
<param name="name">The name of the column to retrieve data for</param> |
<returns>The value contained in the column</returns> |
</member> |
<member name="P:System.Data.SQLite.SQLiteDataReader.Item(System.Int32)"> |
<summary> |
Indexer to retrieve data from a column given its i |
</summary> |
<param name="i">The index of the column to retrieve</param> |
<returns>The value contained in the column</returns> |
</member> |
<member name="T:System.Data.SQLite.SQLiteException"> |
<summary> |
SQLite exception class. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteException.#ctor(System.Data.SQLite.SQLiteErrorCode,System.String)"> |
<summary> |
Public constructor for generating a SQLite exception given the error |
code and message. |
</summary> |
<param name="errorCode"> |
The SQLite return code to report. |
</param> |
<param name="message"> |
Message text to go along with the return code message text. |
</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteException.#ctor(System.String)"> |
<summary> |
Public constructor that uses the base class constructor for the error |
message. |
</summary> |
<param name="message">Error message text.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteException.#ctor"> |
<summary> |
Public constructor that uses the default base class constructor. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteException.#ctor(System.String,System.Exception)"> |
<summary> |
Public constructor that uses the base class constructor for the error |
message and inner exception. |
</summary> |
<param name="message">Error message text.</param> |
<param name="innerException">The original (inner) exception.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteException.GetErrorString(System.Data.SQLite.SQLiteErrorCode)"> |
<summary> |
Returns the error message for the specified SQLite return code. |
</summary> |
<param name="errorCode">The SQLite return code.</param> |
<returns>The error message or null if it cannot be found.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteException.GetStockErrorMessage(System.Data.SQLite.SQLiteErrorCode,System.String)"> |
<summary> |
Returns the composite error message based on the SQLite return code |
and the optional detailed error message. |
</summary> |
<param name="errorCode">The SQLite return code.</param> |
<param name="message">Optional detailed error message.</param> |
<returns>Error message text for the return code.</returns> |
</member> |
<member name="P:System.Data.SQLite.SQLiteException.ReturnCode"> |
<summary> |
Gets the associated SQLite return code for this exception as a |
<see cref="T:System.Data.SQLite.SQLiteErrorCode"/>. This property returns the same |
underlying value as the <see cref="P:System.Data.SQLite.SQLiteException.ErrorCode"/> property. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteException.ErrorCode"> |
<summary> |
Gets the associated SQLite return code for this exception as an |
<see cref="T:System.Int32"/>. For desktop versions of the .NET Framework, |
this property overrides the property of the same name within the |
<see cref="T:System.Runtime.InteropServices.ExternalException"/> |
class. This property returns the same underlying value as the |
<see cref="P:System.Data.SQLite.SQLiteException.ReturnCode"/> property. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteErrorCode"> |
<summary> |
SQLite error codes. Actually, this enumeration represents a return code, |
which may also indicate success in one of several ways (e.g. SQLITE_OK, |
SQLITE_ROW, and SQLITE_DONE). Therefore, the name of this enumeration is |
something of a misnomer. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Ok"> |
<summary> |
Successful result |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Error"> |
<summary> |
SQL error or missing database |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Internal"> |
<summary> |
Internal logic error in SQLite |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Perm"> |
<summary> |
Access permission denied |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Abort"> |
<summary> |
Callback routine requested an abort |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Busy"> |
<summary> |
The database file is locked |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Locked"> |
<summary> |
A table in the database is locked |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.NoMem"> |
<summary> |
A malloc() failed |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly"> |
<summary> |
Attempt to write a readonly database |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Interrupt"> |
<summary> |
Operation terminated by sqlite3_interrupt() |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr"> |
<summary> |
Some kind of disk I/O error occurred |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Corrupt"> |
<summary> |
The database disk image is malformed |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.NotFound"> |
<summary> |
Unknown opcode in sqlite3_file_control() |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Full"> |
<summary> |
Insertion failed because database is full |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen"> |
<summary> |
Unable to open the database file |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Protocol"> |
<summary> |
Database lock protocol error |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Empty"> |
<summary> |
Database is empty |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Schema"> |
<summary> |
The database schema changed |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.TooBig"> |
<summary> |
String or BLOB exceeds size limit |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint"> |
<summary> |
Abort due to constraint violation |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Mismatch"> |
<summary> |
Data type mismatch |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Misuse"> |
<summary> |
Library used incorrectly |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.NoLfs"> |
<summary> |
Uses OS features not supported on host |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Auth"> |
<summary> |
Authorization denied |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Format"> |
<summary> |
Auxiliary database format error |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Range"> |
<summary> |
2nd parameter to sqlite3_bind out of range |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.NotADb"> |
<summary> |
File opened that is not a database file |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Row"> |
<summary> |
sqlite3_step() has another row ready |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteErrorCode.Done"> |
<summary> |
sqlite3_step() has finished executing |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteFunction"> |
<summary> |
This abstract class is designed to handle user-defined functions easily. An instance of the derived class is made for each |
connection to the database. |
</summary> |
<remarks> |
Although there is one instance of a class derived from SQLiteFunction per database connection, the derived class has no access |
to the underlying connection. This is necessary to deter implementers from thinking it would be a good idea to make database |
calls during processing. |
|
It is important to distinguish between a per-connection instance, and a per-SQL statement context. One instance of this class |
services all SQL statements being stepped through on that connection, and there can be many. One should never store per-statement |
information in member variables of user-defined function classes. |
|
For aggregate functions, always create and store your per-statement data in the contextData object on the 1st step. This data will |
be automatically freed for you (and Dispose() called if the item supports IDisposable) when the statement completes. |
</remarks> |
</member> |
<member name="F:System.Data.SQLite.SQLiteFunction.COR_E_EXCEPTION"> |
<summary> |
The error code used for logging exceptions caught in user-provided |
code. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteFunction._base"> |
<summary> |
The base connection this function is attached to |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteFunction._contextDataList"> |
<summary> |
Internal array used to keep track of aggregate function context data |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteFunction._flags"> |
<summary> |
The connection flags associated with this object (this should be the |
same value as the flags associated with the parent connection object). |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteFunction._InvokeFunc"> |
<summary> |
Holds a reference to the callback function for user functions |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteFunction._StepFunc"> |
<summary> |
Holds a reference to the callbakc function for stepping in an aggregate function |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteFunction._FinalFunc"> |
<summary> |
Holds a reference to the callback function for finalizing an aggregate function |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteFunction._CompareFunc"> |
<summary> |
Holds a reference to the callback function for collation sequences |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteFunction._context"> |
<summary> |
Current context of the current callback. Only valid during a callback |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteFunction._registeredFunctions"> |
<summary> |
This static list contains all the user-defined functions declared using the proper attributes. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.#ctor"> |
<summary> |
Internal constructor, initializes the function's internal variables. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.Dispose"> |
<summary> |
Disposes of any active contextData variables that were not automatically cleaned up. Sometimes this can happen if |
someone closes the connection while a DataReader is open. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.Dispose(System.Boolean)"> |
<summary> |
Placeholder for a user-defined disposal routine |
</summary> |
<param name="disposing">True if the object is being disposed explicitly</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.Invoke(System.Object[])"> |
<summary> |
Scalar functions override this method to do their magic. |
</summary> |
<remarks> |
Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available |
to force them into a certain type. Therefore the only types you will ever see as parameters are |
DBNull.Value, Int64, Double, String or byte[] array. |
</remarks> |
<param name="args">The arguments for the command to process</param> |
<returns>You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or |
you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error, |
just return it!</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.Step(System.Object[],System.Int32,System.Object@)"> |
<summary> |
Aggregate functions override this method to do their magic. |
</summary> |
<remarks> |
Typically you'll be updating whatever you've placed in the contextData field and returning as quickly as possible. |
</remarks> |
<param name="args">The arguments for the command to process</param> |
<param name="stepNumber">The 1-based step number. This is incrememted each time the step method is called.</param> |
<param name="contextData">A placeholder for implementers to store contextual data pertaining to the current context.</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.Final(System.Object)"> |
<summary> |
Aggregate functions override this method to finish their aggregate processing. |
</summary> |
<remarks> |
If you implemented your aggregate function properly, |
you've been recording and keeping track of your data in the contextData object provided, and now at this stage you should have |
all the information you need in there to figure out what to return. |
NOTE: It is possible to arrive here without receiving a previous call to Step(), in which case the contextData will |
be null. This can happen when no rows were returned. You can either return null, or 0 or some other custom return value |
if that is the case. |
</remarks> |
<param name="contextData">Your own assigned contextData, provided for you so you can return your final results.</param> |
<returns>You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or |
you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error, |
just return it! |
</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.Compare(System.String,System.String)"> |
<summary> |
User-defined collation sequences override this method to provide a custom string sorting algorithm. |
</summary> |
<param name="param1">The first string to compare</param> |
<param name="param2">The second strnig to compare</param> |
<returns>1 if param1 is greater than param2, 0 if they are equal, or -1 if param1 is less than param2</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.ConvertParams(System.Int32,System.IntPtr)"> |
<summary> |
Converts an IntPtr array of context arguments to an object array containing the resolved parameters the pointers point to. |
</summary> |
<remarks> |
Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available |
to force them into a certain type. Therefore the only types you will ever see as parameters are |
DBNull.Value, Int64, Double, String or byte[] array. |
</remarks> |
<param name="nArgs">The number of arguments</param> |
<param name="argsptr">A pointer to the array of arguments</param> |
<returns>An object array of the arguments once they've been converted to .NET values</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.SetReturnValue(System.IntPtr,System.Object)"> |
<summary> |
Takes the return value from Invoke() and Final() and figures out how to return it to SQLite's context. |
</summary> |
<param name="context">The context the return value applies to</param> |
<param name="returnValue">The parameter to return to SQLite</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.ScalarCallback(System.IntPtr,System.Int32,System.IntPtr)"> |
<summary> |
Internal scalar callback function, which wraps the raw context pointer and calls the virtual Invoke() method. |
WARNING: Must not throw exceptions. |
</summary> |
<param name="context">A raw context pointer</param> |
<param name="nArgs">Number of arguments passed in</param> |
<param name="argsptr">A pointer to the array of arguments</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.CompareCallback(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"> |
<summary> |
Internal collation sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. |
WARNING: Must not throw exceptions. |
</summary> |
<param name="ptr">Not used</param> |
<param name="len1">Length of the string pv1</param> |
<param name="ptr1">Pointer to the first string to compare</param> |
<param name="len2">Length of the string pv2</param> |
<param name="ptr2">Pointer to the second string to compare</param> |
<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 |
than the second. Returns 0 if an exception is caught.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.CompareCallback16(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"> |
<summary> |
Internal collation sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. |
WARNING: Must not throw exceptions. |
</summary> |
<param name="ptr">Not used</param> |
<param name="len1">Length of the string pv1</param> |
<param name="ptr1">Pointer to the first string to compare</param> |
<param name="len2">Length of the string pv2</param> |
<param name="ptr2">Pointer to the second string to compare</param> |
<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 |
than the second. Returns 0 if an exception is caught.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.StepCallback(System.IntPtr,System.Int32,System.IntPtr)"> |
<summary> |
The internal aggregate Step function callback, which wraps the raw context pointer and calls the virtual Step() method. |
WARNING: Must not throw exceptions. |
</summary> |
<remarks> |
This function takes care of doing the lookups and getting the important information put together to call the Step() function. |
That includes pulling out the user's contextData and updating it after the call is made. We use a sorted list for this so |
binary searches can be done to find the data. |
</remarks> |
<param name="context">A raw context pointer</param> |
<param name="nArgs">Number of arguments passed in</param> |
<param name="argsptr">A pointer to the array of arguments</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.FinalCallback(System.IntPtr)"> |
<summary> |
An internal aggregate Final function callback, which wraps the context pointer and calls the virtual Final() method. |
WARNING: Must not throw exceptions. |
</summary> |
<param name="context">A raw context pointer</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.#cctor"> |
<summary> |
Using reflection, enumerate all assemblies in the current appdomain looking for classes that |
have a SQLiteFunctionAttribute attribute, and registering them accordingly. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.RegisterFunction(System.Type)"> |
<summary> |
Manual method of registering a function. The type must still have the SQLiteFunctionAttributes in order to work |
properly, but this is a workaround for the Compact Framework where enumerating assemblies is not currently supported. |
</summary> |
<param name="typ">The type of the function to register</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunction.BindFunctions(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteConnectionFlags)"> |
<summary> |
Called by SQLiteBase derived classes, this function binds all user-defined functions to a connection. |
It is done this way so that all user-defined functions will access the database using the same encoding scheme |
as the connection (UTF-8 or UTF-16). |
</summary> |
<remarks> |
The wrapper functions that interop with SQLite will create a unique cookie value, which internally is a pointer to |
all the wrapped callback functions. The interop function uses it to map CDecl callbacks to StdCall callbacks. |
</remarks> |
<param name="sqlbase">The base object on which the functions are to bind</param> |
<param name="flags">The flags associated with the parent connection object</param> |
<returns>Returns an array of functions which the connection object should retain until the connection is closed.</returns> |
</member> |
<member name="P:System.Data.SQLite.SQLiteFunction.SQLiteConvert"> |
<summary> |
Returns a reference to the underlying connection's SQLiteConvert class, which can be used to convert |
strings and DateTime's into the current connection's encoding schema. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteFunctionEx"> |
<summary> |
Extends SQLiteFunction and allows an inherited class to obtain the collating sequence associated with a function call. |
</summary> |
<remarks> |
User-defined functions can call the GetCollationSequence() method in this class and use it to compare strings and char arrays. |
</remarks> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunctionEx.GetCollationSequence"> |
<summary> |
Obtains the collating sequence in effect for the given function. |
</summary> |
<returns></returns> |
</member> |
<member name="T:System.Data.SQLite.FunctionType"> |
<summary> |
The type of user-defined function to declare |
</summary> |
</member> |
<member name="F:System.Data.SQLite.FunctionType.Scalar"> |
<summary> |
Scalar functions are designed to be called and return a result immediately. Examples include ABS(), Upper(), Lower(), etc. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.FunctionType.Aggregate"> |
<summary> |
Aggregate functions are designed to accumulate data until the end of a call and then return a result gleaned from the accumulated data. |
Examples include SUM(), COUNT(), AVG(), etc. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.FunctionType.Collation"> |
<summary> |
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 |
sorted using a straight case-insensitive comparison function. Custom collating sequences can be used to alter the behavior of text sorting |
in a user-defined manner. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteCallback"> |
<summary> |
An internal callback delegate declaration. |
</summary> |
<param name="context">Raw context pointer for the user function</param> |
<param name="nArgs">Count of arguments to the function</param> |
<param name="argsptr">A pointer to the array of argument pointers</param> |
</member> |
<member name="T:System.Data.SQLite.SQLiteFinalCallback"> |
<summary> |
An internal final callback delegate declaration. |
</summary> |
<param name="context">Raw context pointer for the user function</param> |
</member> |
<member name="T:System.Data.SQLite.SQLiteCollation"> |
<summary> |
Internal callback delegate for implementing collation sequences |
</summary> |
<param name="puser">Not used</param> |
<param name="len1">Length of the string pv1</param> |
<param name="pv1">Pointer to the first string to compare</param> |
<param name="len2">Length of the string pv2</param> |
<param name="pv2">Pointer to the second string to compare</param> |
<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 |
than the second.</returns> |
</member> |
<member name="T:System.Data.SQLite.CollationTypeEnum"> |
<summary> |
The type of collating sequence |
</summary> |
</member> |
<member name="F:System.Data.SQLite.CollationTypeEnum.Binary"> |
<summary> |
The built-in BINARY collating sequence |
</summary> |
</member> |
<member name="F:System.Data.SQLite.CollationTypeEnum.NoCase"> |
<summary> |
The built-in NOCASE collating sequence |
</summary> |
</member> |
<member name="F:System.Data.SQLite.CollationTypeEnum.Reverse"> |
<summary> |
The built-in REVERSE collating sequence |
</summary> |
</member> |
<member name="F:System.Data.SQLite.CollationTypeEnum.Custom"> |
<summary> |
A custom user-defined collating sequence |
</summary> |
</member> |
<member name="T:System.Data.SQLite.CollationEncodingEnum"> |
<summary> |
The encoding type the collation sequence uses |
</summary> |
</member> |
<member name="F:System.Data.SQLite.CollationEncodingEnum.UTF8"> |
<summary> |
The collation sequence is UTF8 |
</summary> |
</member> |
<member name="F:System.Data.SQLite.CollationEncodingEnum.UTF16LE"> |
<summary> |
The collation sequence is UTF16 little-endian |
</summary> |
</member> |
<member name="F:System.Data.SQLite.CollationEncodingEnum.UTF16BE"> |
<summary> |
The collation sequence is UTF16 big-endian |
</summary> |
</member> |
<member name="T:System.Data.SQLite.CollationSequence"> |
<summary> |
A struct describing the collating sequence a function is executing in |
</summary> |
</member> |
<member name="F:System.Data.SQLite.CollationSequence.Name"> |
<summary> |
The name of the collating sequence |
</summary> |
</member> |
<member name="F:System.Data.SQLite.CollationSequence.Type"> |
<summary> |
The type of collating sequence |
</summary> |
</member> |
<member name="F:System.Data.SQLite.CollationSequence.Encoding"> |
<summary> |
The text encoding of the collation sequence |
</summary> |
</member> |
<member name="F:System.Data.SQLite.CollationSequence._func"> |
<summary> |
Context of the function that requested the collating sequence |
</summary> |
</member> |
<member name="M:System.Data.SQLite.CollationSequence.Compare(System.String,System.String)"> |
<summary> |
Calls the base collating sequence to compare two strings |
</summary> |
<param name="s1">The first string to compare</param> |
<param name="s2">The second string to compare</param> |
<returns>-1 if s1 is less than s2, 0 if s1 is equal to s2, and 1 if s1 is greater than s2</returns> |
</member> |
<member name="M:System.Data.SQLite.CollationSequence.Compare(System.Char[],System.Char[])"> |
<summary> |
Calls the base collating sequence to compare two character arrays |
</summary> |
<param name="c1">The first array to compare</param> |
<param name="c2">The second array to compare</param> |
<returns>-1 if c1 is less than c2, 0 if c1 is equal to c2, and 1 if c1 is greater than c2</returns> |
</member> |
<member name="T:System.Data.SQLite.SQLiteFunctionAttribute"> |
<summary> |
A simple custom attribute to enable us to easily find user-defined functions in |
the loaded assemblies and initialize them in SQLite as connections are made. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteFunctionAttribute.#ctor"> |
<summary> |
Default constructor, initializes the internal variables for the function. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteFunctionAttribute.Name"> |
<summary> |
The function's name as it will be used in SQLite command text. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteFunctionAttribute.Arguments"> |
<summary> |
The number of arguments this function expects. -1 if the number of arguments is variable. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteFunctionAttribute.FuncType"> |
<summary> |
The type of function this implementation will be. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteKeyReader"> |
<summary> |
This class provides key info for a given SQLite statement. |
<remarks> |
Providing key information for a given statement is non-trivial :( |
</remarks> |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteKeyReader.#ctor(System.Data.SQLite.SQLiteConnection,System.Data.SQLite.SQLiteDataReader,System.Data.SQLite.SQLiteStatement)"> |
<summary> |
This function does all the nasty work at determining what keys need to be returned for |
a given statement. |
</summary> |
<param name="cnn"></param> |
<param name="reader"></param> |
<param name="stmt"></param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteKeyReader.Sync"> |
<summary> |
Make sure all the subqueries are open and ready and sync'd with the current rowid |
of the table they're supporting |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteKeyReader.Reset"> |
<summary> |
Release any readers on any subqueries |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteKeyReader.AppendSchemaTable(System.Data.DataTable)"> |
<summary> |
Append all the columns we've added to the original query to the schema |
</summary> |
<param name="tbl"></param> |
</member> |
<member name="P:System.Data.SQLite.SQLiteKeyReader.Count"> |
<summary> |
How many additional columns of keyinfo we're holding |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteKeyReader.KeyInfo"> |
<summary> |
Used to support CommandBehavior.KeyInfo |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteKeyReader.KeyQuery"> |
<summary> |
A single sub-query for a given table/database. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.LogEventArgs"> |
<summary> |
Event data for logging event handlers. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.LogEventArgs.ErrorCode"> |
<summary> |
The error code. The type of this object value should be |
<see cref="T:System.Int32"/> or <see cref="T:System.Data.SQLite.SQLiteErrorCode"/>. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.LogEventArgs.Message"> |
<summary> |
SQL statement text as the statement first begins executing |
</summary> |
</member> |
<member name="F:System.Data.SQLite.LogEventArgs.Data"> |
<summary> |
Extra data associated with this event, if any. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.LogEventArgs.#ctor(System.IntPtr,System.Object,System.String,System.Object)"> |
<summary> |
Constructs the object. |
</summary> |
<param name="pUserData">Should be null.</param> |
<param name="errorCode"> |
The error code. The type of this object value should be |
<see cref="T:System.Int32"/> or <see cref="T:System.Data.SQLite.SQLiteErrorCode"/>. |
</param> |
<param name="message">The error message, if any.</param> |
<param name="data">The extra data, if any.</param> |
</member> |
<member name="T:System.Data.SQLite.SQLiteLogEventHandler"> |
<summary> |
Raised when a log event occurs. |
</summary> |
<param name="sender">The current connection</param> |
<param name="e">Event arguments of the trace</param> |
</member> |
<member name="T:System.Data.SQLite.SQLiteMetaDataCollectionNames"> |
<summary> |
MetaDataCollections specific to SQLite |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Catalogs"> |
<summary> |
Returns a list of databases attached to the connection |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Columns"> |
<summary> |
Returns column information for the specified table |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Indexes"> |
<summary> |
Returns index information for the optionally-specified table |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.IndexColumns"> |
<summary> |
Returns base columns for the given index |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Tables"> |
<summary> |
Returns the tables in the given catalog |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Views"> |
<summary> |
Returns user-defined views in the given catalog |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.ViewColumns"> |
<summary> |
Returns underlying column information on the given view |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.ForeignKeys"> |
<summary> |
Returns foreign key information for the given catalog |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Triggers"> |
<summary> |
Returns the triggers on the database |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteParameter"> |
<summary> |
SQLite implementation of DbParameter. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteParameter._dbType"> |
<summary> |
The data type of the parameter |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteParameter._rowVersion"> |
<summary> |
The version information for mapping the parameter |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteParameter._objValue"> |
<summary> |
The value of the data in the parameter |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteParameter._sourceColumn"> |
<summary> |
The source column for the parameter |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteParameter._parameterName"> |
<summary> |
The column name |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteParameter._dataSize"> |
<summary> |
The data size, unused by SQLite |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor"> |
<summary> |
Default constructor |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String)"> |
<summary> |
Constructs a named parameter given the specified parameter name |
</summary> |
<param name="parameterName">The parameter name</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Object)"> |
<summary> |
Constructs a named parameter given the specified parameter name and initial value |
</summary> |
<param name="parameterName">The parameter name</param> |
<param name="value">The initial value of the parameter</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType)"> |
<summary> |
Constructs a named parameter of the specified type |
</summary> |
<param name="parameterName">The parameter name</param> |
<param name="dbType">The datatype of the parameter</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.String)"> |
<summary> |
Constructs a named parameter of the specified type and source column reference |
</summary> |
<param name="parameterName">The parameter name</param> |
<param name="dbType">The data type</param> |
<param name="sourceColumn">The source column</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.String,System.Data.DataRowVersion)"> |
<summary> |
Constructs a named parameter of the specified type, source column and row version |
</summary> |
<param name="parameterName">The parameter name</param> |
<param name="dbType">The data type</param> |
<param name="sourceColumn">The source column</param> |
<param name="rowVersion">The row version information</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType)"> |
<summary> |
Constructs an unnamed parameter of the specified data type |
</summary> |
<param name="dbType">The datatype of the parameter</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Object)"> |
<summary> |
Constructs an unnamed parameter of the specified data type and sets the initial value |
</summary> |
<param name="dbType">The datatype of the parameter</param> |
<param name="value">The initial value of the parameter</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.String)"> |
<summary> |
Constructs an unnamed parameter of the specified data type and source column |
</summary> |
<param name="dbType">The datatype of the parameter</param> |
<param name="sourceColumn">The source column</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.String,System.Data.DataRowVersion)"> |
<summary> |
Constructs an unnamed parameter of the specified data type, source column and row version |
</summary> |
<param name="dbType">The data type</param> |
<param name="sourceColumn">The source column</param> |
<param name="rowVersion">The row version information</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32)"> |
<summary> |
Constructs a named parameter of the specified type and size |
</summary> |
<param name="parameterName">The parameter name</param> |
<param name="parameterType">The data type</param> |
<param name="parameterSize">The size of the parameter</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.String)"> |
<summary> |
Constructs a named parameter of the specified type, size and source column |
</summary> |
<param name="parameterName">The name of the parameter</param> |
<param name="parameterType">The data type</param> |
<param name="parameterSize">The size of the parameter</param> |
<param name="sourceColumn">The source column</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.String,System.Data.DataRowVersion)"> |
<summary> |
Constructs a named parameter of the specified type, size, source column and row version |
</summary> |
<param name="parameterName">The name of the parameter</param> |
<param name="parameterType">The data type</param> |
<param name="parameterSize">The size of the parameter</param> |
<param name="sourceColumn">The source column</param> |
<param name="rowVersion">The row version information</param> |
</member> |
<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)"> |
<summary> |
Constructs a named parameter of the specified type, size, source column and row version |
</summary> |
<param name="parameterName">The name of the parameter</param> |
<param name="parameterType">The data type</param> |
<param name="parameterSize">The size of the parameter</param> |
<param name="direction">Only input parameters are supported in SQLite</param> |
<param name="isNullable">Ignored</param> |
<param name="precision">Ignored</param> |
<param name="scale">Ignored</param> |
<param name="sourceColumn">The source column</param> |
<param name="rowVersion">The row version information</param> |
<param name="value">The initial value to assign the parameter</param> |
</member> |
<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)"> |
<summary> |
Constructs a named parameter, yet another flavor |
</summary> |
<param name="parameterName">The name of the parameter</param> |
<param name="parameterType">The data type</param> |
<param name="parameterSize">The size of the parameter</param> |
<param name="direction">Only input parameters are supported in SQLite</param> |
<param name="precision">Ignored</param> |
<param name="scale">Ignored</param> |
<param name="sourceColumn">The source column</param> |
<param name="rowVersion">The row version information</param> |
<param name="sourceColumnNullMapping">Whether or not this parameter is for comparing NULL's</param> |
<param name="value">The intial value to assign the parameter</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Int32)"> |
<summary> |
Constructs an unnamed parameter of the specified type and size |
</summary> |
<param name="parameterType">The data type</param> |
<param name="parameterSize">The size of the parameter</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Int32,System.String)"> |
<summary> |
Constructs an unnamed parameter of the specified type, size, and source column |
</summary> |
<param name="parameterType">The data type</param> |
<param name="parameterSize">The size of the parameter</param> |
<param name="sourceColumn">The source column</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Int32,System.String,System.Data.DataRowVersion)"> |
<summary> |
Constructs an unnamed parameter of the specified type, size, source column and row version |
</summary> |
<param name="parameterType">The data type</param> |
<param name="parameterSize">The size of the parameter</param> |
<param name="sourceColumn">The source column</param> |
<param name="rowVersion">The row version information</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.ResetDbType"> |
<summary> |
Resets the DbType of the parameter so it can be inferred from the value |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameter.Clone"> |
<summary> |
Clones a parameter |
</summary> |
<returns>A new, unassociated SQLiteParameter</returns> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameter.IsNullable"> |
<summary> |
Whether or not the parameter can contain a null value |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameter.DbType"> |
<summary> |
Returns the datatype of the parameter |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameter.Direction"> |
<summary> |
Supports only input parameters |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameter.ParameterName"> |
<summary> |
Returns the parameter name |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameter.Size"> |
<summary> |
Returns the size of the parameter |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameter.SourceColumn"> |
<summary> |
Gets/sets the source column |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameter.SourceColumnNullMapping"> |
<summary> |
Used by DbCommandBuilder to determine the mapping for nullable fields |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameter.SourceVersion"> |
<summary> |
Gets and sets the row version |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameter.Value"> |
<summary> |
Gets and sets the parameter value. If no datatype was specified, the datatype will assume the type from the value given. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SQLiteParameterCollection"> |
<summary> |
SQLite implementation of DbParameterCollection. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteParameterCollection._command"> |
<summary> |
The underlying command to which this collection belongs |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteParameterCollection._parameterList"> |
<summary> |
The internal array of parameters in this collection |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteParameterCollection._unboundFlag"> |
<summary> |
Determines whether or not all parameters have been bound to their statement(s) |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.#ctor(System.Data.SQLite.SQLiteCommand)"> |
<summary> |
Initializes the collection |
</summary> |
<param name="cmd">The command to which the collection belongs</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.GetEnumerator"> |
<summary> |
Retrieves an enumerator for the collection |
</summary> |
<returns>An enumerator for the underlying array</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.String,System.Data.DbType,System.Int32,System.String)"> |
<summary> |
Adds a parameter to the collection |
</summary> |
<param name="parameterName">The parameter name</param> |
<param name="parameterType">The data type</param> |
<param name="parameterSize">The size of the value</param> |
<param name="sourceColumn">The source column</param> |
<returns>A SQLiteParameter object</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.String,System.Data.DbType,System.Int32)"> |
<summary> |
Adds a parameter to the collection |
</summary> |
<param name="parameterName">The parameter name</param> |
<param name="parameterType">The data type</param> |
<param name="parameterSize">The size of the value</param> |
<returns>A SQLiteParameter object</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.String,System.Data.DbType)"> |
<summary> |
Adds a parameter to the collection |
</summary> |
<param name="parameterName">The parameter name</param> |
<param name="parameterType">The data type</param> |
<returns>A SQLiteParameter object</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.Data.SQLite.SQLiteParameter)"> |
<summary> |
Adds a parameter to the collection |
</summary> |
<param name="parameter">The parameter to add</param> |
<returns>A zero-based index of where the parameter is located in the array</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.Object)"> |
<summary> |
Adds a parameter to the collection |
</summary> |
<param name="value">The parameter to add</param> |
<returns>A zero-based index of where the parameter is located in the array</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.AddWithValue(System.String,System.Object)"> |
<summary> |
Adds a named/unnamed parameter and its value to the parameter collection. |
</summary> |
<param name="parameterName">Name of the parameter, or null to indicate an unnamed parameter</param> |
<param name="value">The initial value of the parameter</param> |
<returns>Returns the SQLiteParameter object created during the call.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.AddRange(System.Data.SQLite.SQLiteParameter[])"> |
<summary> |
Adds an array of parameters to the collection |
</summary> |
<param name="values">The array of parameters to add</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.AddRange(System.Array)"> |
<summary> |
Adds an array of parameters to the collection |
</summary> |
<param name="values">The array of parameters to add</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.Clear"> |
<summary> |
Clears the array and resets the collection |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.Contains(System.String)"> |
<summary> |
Determines if the named parameter exists in the collection |
</summary> |
<param name="parameterName">The name of the parameter to check</param> |
<returns>True if the parameter is in the collection</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.Contains(System.Object)"> |
<summary> |
Determines if the parameter exists in the collection |
</summary> |
<param name="value">The SQLiteParameter to check</param> |
<returns>True if the parameter is in the collection</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.CopyTo(System.Array,System.Int32)"> |
<summary> |
Not implemented |
</summary> |
<param name="array"></param> |
<param name="index"></param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.GetParameter(System.String)"> |
<summary> |
Retrieve a parameter by name from the collection |
</summary> |
<param name="parameterName">The name of the parameter to fetch</param> |
<returns>A DbParameter object</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.GetParameter(System.Int32)"> |
<summary> |
Retrieves a parameter by its index in the collection |
</summary> |
<param name="index">The index of the parameter to retrieve</param> |
<returns>A DbParameter object</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.IndexOf(System.String)"> |
<summary> |
Returns the index of a parameter given its name |
</summary> |
<param name="parameterName">The name of the parameter to find</param> |
<returns>-1 if not found, otherwise a zero-based index of the parameter</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.IndexOf(System.Object)"> |
<summary> |
Returns the index of a parameter |
</summary> |
<param name="value">The parameter to find</param> |
<returns>-1 if not found, otherwise a zero-based index of the parameter</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.Insert(System.Int32,System.Object)"> |
<summary> |
Inserts a parameter into the array at the specified location |
</summary> |
<param name="index">The zero-based index to insert the parameter at</param> |
<param name="value">The parameter to insert</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.Remove(System.Object)"> |
<summary> |
Removes a parameter from the collection |
</summary> |
<param name="value">The parameter to remove</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.RemoveAt(System.String)"> |
<summary> |
Removes a parameter from the collection given its name |
</summary> |
<param name="parameterName">The name of the parameter to remove</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.RemoveAt(System.Int32)"> |
<summary> |
Removes a parameter from the collection given its index |
</summary> |
<param name="index">The zero-based parameter index to remove</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.SetParameter(System.String,System.Data.Common.DbParameter)"> |
<summary> |
Re-assign the named parameter to a new parameter object |
</summary> |
<param name="parameterName">The name of the parameter to replace</param> |
<param name="value">The new parameter</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.SetParameter(System.Int32,System.Data.Common.DbParameter)"> |
<summary> |
Re-assign a parameter at the specified index |
</summary> |
<param name="index">The zero-based index of the parameter to replace</param> |
<param name="value">The new parameter</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.Unbind"> |
<summary> |
Un-binds all parameters from their statements |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteParameterCollection.MapParameters(System.Data.SQLite.SQLiteStatement)"> |
<summary> |
This function attempts to map all parameters in the collection to all statements in a Command. |
Since named parameters may span multiple statements, this function makes sure all statements are bound |
to the same named parameter. Unnamed parameters are bound in sequence. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameterCollection.IsSynchronized"> |
<summary> |
Returns true |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameterCollection.IsFixedSize"> |
<summary> |
Returns false |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameterCollection.IsReadOnly"> |
<summary> |
Returns false |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameterCollection.SyncRoot"> |
<summary> |
Returns null |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameterCollection.Count"> |
<summary> |
Returns a count of parameters in the collection |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameterCollection.Item(System.String)"> |
<summary> |
Overloaded to specialize the return value of the default indexer |
</summary> |
<param name="parameterName">Name of the parameter to get/set</param> |
<returns>The specified named SQLite parameter</returns> |
</member> |
<member name="P:System.Data.SQLite.SQLiteParameterCollection.Item(System.Int32)"> |
<summary> |
Overloaded to specialize the return value of the default indexer |
</summary> |
<param name="index">The index of the parameter to get/set</param> |
<returns>The specified SQLite parameter</returns> |
</member> |
<member name="T:System.Data.SQLite.SQLiteStatement"> |
<summary> |
Represents a single SQL statement in SQLite. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteStatement._sql"> |
<summary> |
The underlying SQLite object this statement is bound to |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteStatement._sqlStatement"> |
<summary> |
The command text of this SQL statement |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteStatement._sqlite_stmt"> |
<summary> |
The actual statement pointer |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteStatement._unnamedParameters"> |
<summary> |
An index from which unnamed parameters begin |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteStatement._paramNames"> |
<summary> |
Names of the parameters as SQLite understands them to be |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteStatement._paramValues"> |
<summary> |
Parameters for this statement |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteStatement._command"> |
<summary> |
Command this statement belongs to (if any) |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteStatement._flags"> |
<summary> |
The flags associated with the parent connection object. |
</summary> |
</member> |
<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)"> |
<summary> |
Initializes the statement and attempts to get all information about parameters in the statement |
</summary> |
<param name="sqlbase">The base SQLite object</param> |
<param name="flags">The flags associated with the parent connection object</param> |
<param name="stmt">The statement</param> |
<param name="strCommand">The command text for this statement</param> |
<param name="previous">The previous command in a multi-statement command</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteStatement.Dispose"> |
<summary> |
Disposes and finalizes the statement |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteStatement.TryGetChanges(System.Int32@)"> |
<summary> |
If the underlying database connection is open, fetches the number of changed rows |
resulting from the most recent query; otherwise, does nothing. |
</summary> |
<param name="changes"> |
The number of changes when true is returned. |
Undefined if false is returned. |
</param> |
<returns>Non-zero if the number of changed rows was fetched.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteStatement.MapParameter(System.String,System.Data.SQLite.SQLiteParameter)"> |
<summary> |
Called by SQLiteParameterCollection, this function determines if the specified parameter name belongs to |
this statement, and if so, keeps a reference to the parameter so it can be bound later. |
</summary> |
<param name="s">The parameter name to map</param> |
<param name="p">The parameter to assign it</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteStatement.BindParameters"> |
<summary> |
Bind all parameters, making sure the caller didn't miss any |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteStatement.ToBoolean(System.Object,System.IFormatProvider)"> |
<summary> |
Attempts to convert an arbitrary object to the Boolean data type. |
Null object values are converted to false. Throws a SQLiteException |
upon failure. |
</summary> |
<param name="obj">The object value to convert.</param> |
<param name="provider">The format provider to use.</param> |
<returns>The converted boolean value.</returns> |
</member> |
<member name="M:System.Data.SQLite.SQLiteStatement.BindParameter(System.Int32,System.Data.SQLite.SQLiteParameter)"> |
<summary> |
Perform the bind operation for an individual parameter |
</summary> |
<param name="index">The index of the parameter to bind</param> |
<param name="param">The parameter we're binding</param> |
</member> |
<member name="T:System.Data.SQLite.SQLiteTransaction"> |
<summary> |
SQLite implementation of DbTransaction. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.SQLiteTransaction._cnn"> |
<summary> |
The connection to which this transaction is bound |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteTransaction.#ctor(System.Data.SQLite.SQLiteConnection,System.Boolean)"> |
<summary> |
Constructs the transaction object, binding it to the supplied connection |
</summary> |
<param name="connection">The connection to open a transaction on</param> |
<param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param> |
</member> |
<member name="M:System.Data.SQLite.SQLiteTransaction.Dispose(System.Boolean)"> |
<summary> |
Disposes the transaction. If it is currently active, any changes are rolled back. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteTransaction.Commit"> |
<summary> |
Commits the current transaction. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.SQLiteTransaction.Rollback"> |
<summary> |
Rolls back the active transaction. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteTransaction.Connection"> |
<summary> |
Returns the underlying connection to which this transaction applies. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteTransaction.DbConnection"> |
<summary> |
Forwards to the local Connection property |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SQLiteTransaction.IsolationLevel"> |
<summary> |
Gets the isolation level of the transaction. SQLite only supports Serializable transactions. |
</summary> |
</member> |
<member name="T:System.Data.SQLite.SR"> |
<summary> |
A strongly-typed resource class, for looking up localized strings, etc. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SR.ResourceManager"> |
<summary> |
Returns the cached ResourceManager instance used by this class. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SR.Culture"> |
<summary> |
Overrides the current thread's CurrentUICulture property for all |
resource lookups using this strongly typed resource class. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SR.DataTypes"> |
<summary> |
Looks up a localized string similar to <?xml version="1.0" standalone="yes"?> |
<DocumentElement> |
<DataTypes> |
<TypeName>smallint</TypeName> |
<ProviderDbType>10</ProviderDbType> |
<ColumnSize>5</ColumnSize> |
<DataType>System.Int16</DataType> |
<CreateFormat>smallint</CreateFormat> |
<IsAutoIncrementable>false</IsAutoIncrementable> |
<IsCaseSensitive>false</IsCaseSensitive> |
<IsFixedLength>true</IsFixedLength> |
<IsFixedPrecisionScale>true</IsFixedPrecisionScale> |
<IsLong>false</IsLong> |
<IsNullable>true</ [rest of string was truncated]";. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SR.Keywords"> |
<summary> |
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. |
</summary> |
</member> |
<member name="P:System.Data.SQLite.SR.MetaDataCollections"> |
<summary> |
Looks up a localized string similar to <?xml version="1.0" encoding="utf-8" ?> |
<DocumentElement> |
<MetaDataCollections> |
<CollectionName>MetaDataCollections</CollectionName> |
<NumberOfRestrictions>0</NumberOfRestrictions> |
<NumberOfIdentifierParts>0</NumberOfIdentifierParts> |
</MetaDataCollections> |
<MetaDataCollections> |
<CollectionName>DataSourceInformation</CollectionName> |
<NumberOfRestrictions>0</NumberOfRestrictions> |
<NumberOfIdentifierParts>0</NumberOfIdentifierParts> |
</MetaDataCollections> |
<MetaDataC [rest of string was truncated]";. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.UnsafeNativeMethods.LoadLibrary(System.String)"> |
<summary> |
This is the P/Invoke method that wraps the native Win32 LoadLibrary |
function. See the MSDN documentation for full details on what it |
does. |
</summary> |
<param name="fileName"> |
The name of the executable library. |
</param> |
<returns> |
The native module handle upon success -OR- IntPtr.Zero on failure. |
</returns> |
</member> |
<member name="F:System.Data.SQLite.UnsafeNativeMethods.staticSyncRoot"> |
<summary> |
This lock is used to protect the static _SQLiteModule and |
processorArchitecturePlatforms fields, below. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.UnsafeNativeMethods.processorArchitecturePlatforms"> |
<summary> |
Stores the mappings between processor architecture names and platform |
names. |
</summary> |
</member> |
<member name="F:System.Data.SQLite.UnsafeNativeMethods._SQLiteModule"> |
<summary> |
The native module handle for the native SQLite library or the value |
IntPtr.Zero. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.UnsafeNativeMethods.#cctor"> |
<summary> |
For now, this method simply calls the Initialize method. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.UnsafeNativeMethods.Initialize"> |
<summary> |
Attempts to initialize this class by pre-loading the native SQLite |
library for the processor architecture of the current process. |
</summary> |
</member> |
<member name="M:System.Data.SQLite.UnsafeNativeMethods.GetBaseDirectory"> |
<summary> |
Queries and returns the base directory of the current application |
domain. |
</summary> |
<returns> |
The base directory for the current application domain -OR- null if it |
cannot be determined. |
</returns> |
</member> |
<member name="M:System.Data.SQLite.UnsafeNativeMethods.FixUpDllFileName(System.String)"> |
<summary> |
Determines if the dynamic link library file name requires a suffix |
and adds it if necessary. |
</summary> |
<param name="fileName"> |
The original dynamic link library file name to inspect. |
</param> |
<returns> |
The dynamic link library file name, possibly modified to include an |
extension. |
</returns> |
</member> |
<member name="M:System.Data.SQLite.UnsafeNativeMethods.GetProcessorArchitecture"> |
<summary> |
Queries and returns the processor architecture of the current |
process. |
</summary> |
<returns> |
The processor architecture of the current process -OR- null if it |
cannot be determined. Always returns an empty string when running on |
the .NET Compact Framework. |
</returns> |
</member> |
<member name="M:System.Data.SQLite.UnsafeNativeMethods.GetPlatformName(System.String)"> |
<summary> |
Given the processor architecture, returns the name of the platform. |
</summary> |
<param name="processorArchitecture"> |
The processor architecture to be translated to a platform name. |
</param> |
<returns> |
The platform name for the specified processor architecture -OR- null |
if it cannot be determined. |
</returns> |
</member> |
<member name="M:System.Data.SQLite.UnsafeNativeMethods.PreLoadSQLiteDll(System.String,System.String)"> |
<summary> |
Attempts to load the native SQLite library based on the specified |
directory and processor architecture. |
</summary> |
<param name="directory"> |
The base directory to use, null for default (the base directory of |
the current application domain). This directory should contain the |
processor architecture specific sub-directories. |
</param> |
<param name="processorArchitecture"> |
The requested processor architecture, null for default (the |
processor architecture of the current process). This caller should |
almost always specify null for this parameter. |
</param> |
<returns> |
The native module handle as returned by LoadLibrary -OR- IntPtr.Zero |
if the loading fails for any reason. |
</returns> |
</member> |
</members> |
</doc> |