diff --git a/src/Libraries/Sqlite/README.txt b/src/Libraries/Sqlite/README.txt new file mode 100644 index 000000000..29af7f54e --- /dev/null +++ b/src/Libraries/Sqlite/README.txt @@ -0,0 +1,10 @@ +Windows sqlite3.dll binary from here: +https://www.sqlite.org/2019/sqlite-dll-win32-x86-3280000.zip + +MacOS libsqlite3.0.dylib from azure pipeline here: +https://dev.azure.com/Lidarr/Lidarr/_build?definitionId=4&_a=summary + +System.Data.SQLite netstandard2.0 dll compiled in same pipeline with: +/p:Configuration=ReleaseManagedOnly /p:UseInteropDll=false /p:UseSqliteStandard=true + +Both MacOS and System.Data.SQLite from revision 40e714a of https://github.com/lidarr/SQLite.Build diff --git a/src/Libraries/Sqlite/System.Data.SQLite.dll b/src/Libraries/Sqlite/System.Data.SQLite.dll index 1e7145a8d..f27c9cd70 100644 Binary files a/src/Libraries/Sqlite/System.Data.SQLite.dll and b/src/Libraries/Sqlite/System.Data.SQLite.dll differ diff --git a/src/Libraries/Sqlite/System.Data.SQLite.xml b/src/Libraries/Sqlite/System.Data.SQLite.xml index 6e533f0a6..1dea1eccf 100644 --- a/src/Libraries/Sqlite/System.Data.SQLite.xml +++ b/src/Libraries/Sqlite/System.Data.SQLite.xml @@ -67,1032 +67,13 @@ This class implements SQLiteBase completely, and is the guts of the code that interop's SQLite with .NET - + - 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. - - - - - This base class provides datatype conversion services for the SQLite provider. - - - - - The fallback default database type when one cannot be obtained from an - existing connection instance. - - - - - The format string for DateTime values when using the InvariantCulture or CurrentCulture formats. - - - - - The fallback default database type name when one cannot be obtained from - an existing connection instance. - - - - - The value for the Unix epoch (e.g. January 1, 1970 at midnight, in UTC). - - - - - The value of the OLE Automation epoch represented as a Julian day. - - - - - An array of ISO-8601 DateTime formats that we support parsing. - - - - - The internal default format for UTC DateTime values when converting - to a string. - - - - - The internal default format for local DateTime values when converting - to a string. - - - - - An UTF-8 Encoding instance, so we can convert strings to and from UTF-8 - - - - - The default DateTime format for this instance. - - - - - The default DateTimeKind for this instance. - - - - - The default DateTime format string for this instance. - - - - - Initializes the conversion class - - The default date/time format to use for this instance - The DateTimeKind to use. - The DateTime format string to use. - - - - Converts a string to a UTF-8 encoded byte array sized to include a null-terminating character. - - The string to convert to UTF-8 - A byte array containing the converted string plus an extra 0 terminating byte at the end of the array. - - - - Convert a DateTime to a UTF-8 encoded, zero-terminated byte array. - - - This function is a convenience function, which first calls ToString() on the DateTime, and then calls ToUTF8() with the - string result. - - The DateTime to convert. - The UTF-8 encoded string, including a 0 terminating byte at the end of the array. - - - - Converts a UTF-8 encoded IntPtr of the specified length into a .NET string - - The pointer to the memory where the UTF-8 string is encoded - The number of bytes to decode - A string containing the translated character(s) - - - - Converts a UTF-8 encoded IntPtr of the specified length into a .NET string - - The pointer to the memory where the UTF-8 string is encoded - The number of bytes to decode - A string containing the translated character(s) - - - - Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, - and DateTimeFormatString specified for the connection when it was opened. - - - Acceptable ISO8601 DateTime formats are: - - THHmmssK - THHmmK - HH:mm:ss.FFFFFFFK - HH:mm:ssK - HH:mmK - yyyy-MM-dd HH:mm:ss.FFFFFFFK - yyyy-MM-dd HH:mm:ssK - yyyy-MM-dd HH:mmK - yyyy-MM-ddTHH:mm:ss.FFFFFFFK - yyyy-MM-ddTHH:mmK - yyyy-MM-ddTHH:mm:ssK - yyyyMMddHHmmssK - yyyyMMddHHmmK - yyyyMMddTHHmmssFFFFFFFK - THHmmss - THHmm - HH:mm:ss.FFFFFFF - HH:mm:ss - HH:mm - yyyy-MM-dd HH:mm:ss.FFFFFFF - yyyy-MM-dd HH:mm:ss - yyyy-MM-dd HH:mm - yyyy-MM-ddTHH:mm:ss.FFFFFFF - yyyy-MM-ddTHH:mm - yyyy-MM-ddTHH:mm:ss - yyyyMMddHHmmss - yyyyMMddHHmm - yyyyMMddTHHmmssFFFFFFF - yyyy-MM-dd - yyyyMMdd - yy-MM-dd - - If the string cannot be matched to one of the above formats -OR- - the DateTimeFormatString if one was provided, an exception will - be thrown. - - 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. - A DateTime value - - - - Converts a string into a DateTime, using the specified DateTimeFormat, - DateTimeKind and DateTimeFormatString. - - - Acceptable ISO8601 DateTime formats are: - - THHmmssK - THHmmK - HH:mm:ss.FFFFFFFK - HH:mm:ssK - HH:mmK - yyyy-MM-dd HH:mm:ss.FFFFFFFK - yyyy-MM-dd HH:mm:ssK - yyyy-MM-dd HH:mmK - yyyy-MM-ddTHH:mm:ss.FFFFFFFK - yyyy-MM-ddTHH:mmK - yyyy-MM-ddTHH:mm:ssK - yyyyMMddHHmmssK - yyyyMMddHHmmK - yyyyMMddTHHmmssFFFFFFFK - THHmmss - THHmm - HH:mm:ss.FFFFFFF - HH:mm:ss - HH:mm - yyyy-MM-dd HH:mm:ss.FFFFFFF - yyyy-MM-dd HH:mm:ss - yyyy-MM-dd HH:mm - yyyy-MM-ddTHH:mm:ss.FFFFFFF - yyyy-MM-ddTHH:mm - yyyy-MM-ddTHH:mm:ss - yyyyMMddHHmmss - yyyyMMddHHmm - yyyyMMddTHHmmssFFFFFFF - yyyy-MM-dd - yyyyMMdd - yy-MM-dd - - If the string cannot be matched to one of the above formats -OR- - the DateTimeFormatString if one was provided, an exception will - be thrown. - - 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. - The SQLiteDateFormats to use. - The DateTimeKind to use. - The DateTime format string to use. - A DateTime value - - - - Converts a julianday value into a DateTime - - The value to convert - A .NET DateTime - - - - Converts a julianday value into a DateTime - - The value to convert - The DateTimeKind to use. - A .NET DateTime - - - - Converts the specified number of seconds from the Unix epoch into a - value. - - - The number of whole seconds since the Unix epoch. - - - Either Utc or Local time. - - - The new value. - - - - - Converts the specified number of ticks since the epoch into a - value. - - - The number of whole ticks since the epoch. - - - Either Utc or Local time. - - - The new value. - - - - - Converts a DateTime struct to a JulianDay double - - The DateTime to convert - The JulianDay value the Datetime represents - - - - Converts a DateTime struct to the whole number of seconds since the - Unix epoch. - - The DateTime to convert - The whole number of seconds since the Unix epoch - - - - Returns the DateTime format string to use for the specified DateTimeKind. - If is not null, it will be returned verbatim. - - The DateTimeKind to use. - The DateTime format string to use. - - The DateTime format string to use for the specified DateTimeKind. - - - - - Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, - and DateTimeFormatString specified for the connection when it was opened. - - The DateTime value to convert - 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. - - - - Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, - and DateTimeFormatString specified for the connection when it was opened. - - The DateTime value to convert - The SQLiteDateFormats to use. - The DateTimeKind to use. - The DateTime format string to use. - 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. - - - - Internal function to convert a UTF-8 encoded IntPtr of the specified length to a DateTime. - - - 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. - - A pointer to the UTF-8 encoded string - The length in bytes of the string - The parsed DateTime value - - - - Smart method of splitting a string. Skips quoted elements, removes the quotes. - - - 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: - - Only one character can be provided as a separator character - Quoted text inside the string is skipped over when searching for the separator, and the quotes are removed. - - Thus, if splitting the following string looking for a comma:
- One,Two, "Three, Four", Five
-
- The resulting array would contain
- [0] One
- [1] Two
- [2] Three, Four
- [3] Five
-
- Note that the leading and trailing spaces were removed from each item during the split. - - Source string to split apart - Separator character - A string array of the split up elements - - - - Splits the specified string into multiple strings based on a separator - and returns the result as an array of strings. - - - The string to split into pieces based on the separator character. If - this string is null, null will always be returned. If this string is - empty, an array of zero strings will always be returned. - - - The character used to divide the original string into sub-strings. - This character cannot be a backslash or a double-quote; otherwise, no - work will be performed and null will be returned. - - - If this parameter is non-zero, all double-quote characters will be - retained in the returned list of strings; otherwise, they will be - dropped. - - - Upon failure, this parameter will be modified to contain an appropriate - error message. - - - The new array of strings or null if the input string is null -OR- the - separator character is a backslash or a double-quote -OR- the string - contains an unbalanced backslash or double-quote character. - - - - - Queries and returns the string representation for an object, using the - specified (or current) format provider. - - - The object instance to return the string representation for. - - - The format provider to use -OR- null if the current format provider for - the thread should be used instead. - - - The string representation for the object instance -OR- null if the - object instance is also null. - - - - - Attempts to convert an arbitrary object to the Boolean data type. - Null object values are converted to false. Throws an exception - upon failure. - - - The object value to convert. - - - The format provider to use. - - - If non-zero, a string value will be converted using the - - method; otherwise, the - method will be used. - - - The converted boolean value. - - - - - Convert a value to true or false. - - A string or number representing true or false - - - - - Convert a string to true or false. - - A string representing true or false - - - "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. - - - - - Converts a SQLiteType to a .NET Type object - - The SQLiteType to convert - Returns a .NET Type object - - - - For a given intrinsic type, return a DbType - - The native type to convert - The corresponding (closest match) DbType - - - - Returns the ColumnSize for the given DbType - - The DbType to get the size of - - - - - Determines the default database type name to be used when a - per-connection value is not available. - - - The connection context for type mappings, if any. - - - The default database type name to use. - - - - - If applicable, issues a trace log message warning about falling back to - the default database type name. - - - The database value type. - - - The flags associated with the parent connection object. - - - The textual name of the database type. - - - - - If applicable, issues a trace log message warning about falling back to - the default database value type. - - - The textual name of the database type. - - - The flags associated with the parent connection object. - - - The database value type. - - - - - For a given database value type, return the "closest-match" textual database type name. - - The connection context for custom type mappings, if any. - The database value type. - The flags associated with the parent connection object. - The type name or an empty string if it cannot be determined. - - - - Convert a DbType to a Type - - The DbType to convert from - The closest-match .NET type - - - - For a given type, return the closest-match SQLite TypeAffinity, which only understands a very limited subset of types. - - The type to evaluate - The SQLite type affinity for that type. - - - - Builds and returns a map containing the database column types - recognized by this provider. - - - A map containing the database column types recognized by this - provider. - - - - - Determines if a database type is considered to be a string. - - - The database type to check. - - - Non-zero if the database type is considered to be a string, zero - otherwise. - - - - - Determines and returns the runtime configuration setting string that - should be used in place of the specified object value. - - - The object value to convert to a string. - - - Either the string to use in place of the object value -OR- null if it - cannot be determined. - - - - - Determines the default value to be used when a - per-connection value is not available. - - - The connection context for type mappings, if any. - - - The default value to use. - - - - - Determines if the specified textual value appears to be a - value. - - - The textual value to inspect. - - - Non-zero if the text looks like a value, - zero otherwise. - - - - - Determines if the specified textual value appears to be an - value. - - - The textual value to inspect. - - - Non-zero if the text looks like an value, - zero otherwise. - - - - - Determines if the specified textual value appears to be a - value. - - - The textual value to inspect. - - - Non-zero if the text looks like a value, - zero otherwise. - - - - - Determines if the specified textual value appears to be a - value. - - - The object instance configured with - the chosen format. - - - The textual value to inspect. - - - Non-zero if the text looks like a in the - configured format, zero otherwise. - - - - - For a given textual database type name, return the "closest-match" database type. - This method is called during query result processing; therefore, its performance - is critical. - - The connection context for custom type mappings, if any. - The textual name of the database type to match. - The flags associated with the parent connection object. - The .NET DBType the text evaluates to. - - - - The error code used for logging exceptions caught in user-provided - code. - - - - - 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. - - Non-zero to enable memory usage tracking, zero otherwise. - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Attempts to free as much heap memory as possible for the database connection. - - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Shutdown the SQLite engine so that it can be restarted with different config options. - We depend on auto initialization to recover. - - - - - Determines if the associated native connection handle is open. - - - Non-zero if a database connection is open. - - - - - Opens a database. - - - 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. - - The filename of the database to open. SQLite automatically creates it if it doesn't exist. - The flags associated with the parent connection object - The open flags to use when creating the connection - The maximum size of the pool for the given filename - If true, the connection can be pulled from the connection pool - - - - Closes the currently-open database. - - - 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. - - Non-zero if the operation is allowed to throw exceptions, zero otherwise. - - - - Sets the busy timeout on the connection. SQLiteCommand will call this before executing any command. - - The number of milliseconds to wait before returning SQLITE_BUSY - - - - Returns the text of the last error issued by SQLite - - - - - - Returns the text of the last error issued by SQLite -OR- the specified default error text if - none is available from the SQLite core library. - - - The error text to return in the event that one is not available from the SQLite core library. - - - The error text. - - - - - When pooling is enabled, force this connection to be disposed rather than returned to the pool - - - - - When pooling is enabled, returns the number of pool entries matching the current file name. - - The number of pool entries matching the current file name. - - - - Prepares a SQL statement for execution. - - The source connection preparing the command. Can be null for any caller except LINQ - The SQL command text to prepare - The previous statement in a multi-statement command, or null if no previous statement exists - The timeout to wait before aborting the prepare - 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. - Returns an initialized SQLiteStatement. - - - - Steps through a prepared statement. - - The SQLiteStatement to step through - True if a row was returned, False if not. - - - - 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. - - The statement to reset - 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 - - - - Attempts to interrupt the query currently executing on the associated - native database connection. - - - - - This function binds a user-defined functions to the connection. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - - - - Calls the native SQLite core library in order to create a disposable - module containing the implementation of a virtual table. - - - The module object to be used when creating the native disposable module. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to cleanup the resources - associated with a module containing the implementation of a virtual table. - - - The module object previously passed to the - method. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to declare a virtual table - in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - being declared. - - - The string containing the SQL statement describing the virtual table to - be declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Calls the native SQLite core library in order to declare a virtual table - function in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - function being declared. - - - The number of arguments to the function being declared. - - - The name of the function being declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Enables or disabled extension loading by SQLite. - - - True to enable loading of extensions, false to disable. - - - - - Loads a SQLite extension library from the named file. - - - The name of the dynamic link library file containing the extension. - - - The name of the exported function used to initialize the extension. - If null, the default "sqlite3_extension_init" will be used. - - - - - Enables or disabled extened result codes returned by SQLite - - true to enable extended result codes, false to disable. - - - - - Returns the numeric result code for the most recent failed SQLite API call - associated with the database connection. - - Result code - - - - Returns the extended numeric result code for the most recent failed SQLite API call - associated with the database connection. - - Extended result code - - - - Add a log message via the SQLite sqlite3_log interface. - - Error code to be logged with the message. - String to be logged. Unlike the SQLite sqlite3_log() - interface, this should be pre-formatted. Consider using the - String.Format() function. - - - - - Checks if the SQLite core library has been initialized in the current process. - - - Non-zero if the SQLite core library has been initialized in the current process, - zero otherwise. - - - - - 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. - - The destination database connection. - The destination database name. - The source database name. - The newly created backup object. - - - - Copies up to N pages from the source database to the destination - database associated with the specified backup object. - - The backup object to use. - - The number of pages to copy or negative to copy all remaining pages. - - - Set to true if the operation needs to be retried due to database - locking issues. - - - True if there are more pages to be copied, false otherwise. - - - - - Returns the number of pages remaining to be copied from the source - database to the destination database associated with the specified - backup object. - - The backup object to check. - The number of pages remaining to be copied. - - - - Returns the total number of pages in the source database associated - with the specified backup object. - - The backup object to check. - The total number of pages in the source database. - - - - Destroys the backup object, rolling back any backup that may be in - progess. - - The backup object to destroy. - - - - Returns the error message for the specified SQLite return code using - the internal static lookup table. - - The SQLite return code. - The error message or null if it cannot be found. - - - - Returns the error message for the specified SQLite return code using - the sqlite3_errstr() function, falling back to the internal lookup - table if necessary. - - The SQLite return code. - The error message or null if it cannot be found. - - - - Returns a string representing the active version of SQLite - - - - - Returns an integer representing the active version of SQLite - - - - - Returns the rowid of the most recent successful INSERT into the database from this connection. - - - - - Returns the number of changes the last executing insert/update caused. - - - - - 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. - - - - - 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. - - - - - Returns non-zero if the underlying native connection handle is owned by this instance. - - - - - Returns non-zero if the given database connection is in autocommit mode. - Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN - statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK. + This field is used to refer to memory allocated for the + SQLITE_DBCONFIG_MAINDBNAME value used with the native + "sqlite3_db_config" API. If allocated, the associated + memeory will be freed when the underlying connection is + closed. @@ -1105,6 +86,25 @@ The user-defined functions registered on this connection + + + This is the name of the native library file that contains the + "vtshim" extension [wrapper]. + + + + + This is the flag indicate whether the native library file that + contains the "vtshim" extension must be dynamically loaded by + this class prior to use. + + + + + This is the name of the native entry point for the "vtshim" + extension [wrapper]. + + The modules created using this connection. @@ -1120,7 +120,7 @@ DateTime and binding DateTime parameters. - The to be used when creating DateTime + The to be used when creating DateTime values. @@ -1135,15 +135,39 @@ Non-zero if the newly created object instance will need to dispose - of when it is no longer needed. + of when it is no longer needed. - This method attempts to dispose of all the derived + This method attempts to dispose of all the derived object instances currently associated with the native database connection. + + + Returns the number of times the method has been + called. + + + + + This method determines whether or not a + with a return code of should + be thrown after making a call into the SQLite core library. + + + Non-zero if a to be thrown. This method + will only return non-zero if the method was called + one or more times during a call into the SQLite core library (e.g. when + the sqlite3_prepare*() or sqlite3_step() APIs are used). + + + + + Resets the value of the field. + + Attempts to interrupt the query currently executing on the associated @@ -1166,6 +190,30 @@ The flags associated with the parent connection object. + + + This function binds a user-defined function to the connection. + + + The object instance containing + the metadata for the function to be unbound. + + + The flags associated with the parent connection object. + + Non-zero if the function was unbound and removed. + + + + Returns non-zero if the underlying native connection handle is owned + by this instance. + + + + + Returns the logical list of functions associated with this connection. + + Attempts to free as much heap memory as possible for the database connection. @@ -1232,6 +280,96 @@ Non-zero if the associated native connection handle is open. + + + Returns the fully qualified path and file name for the currently open + database, if any. + + + The name of the attached database to query. + + + The fully qualified path and file name for the currently open database, + if any. + + + + + This method attempts to determine if a database connection opened + with the specified should be + allowed into the connection pool. + + + The that were specified when the + connection was opened. + + + Non-zero if the connection should (eventually) be allowed into the + connection pool; otherwise, zero. + + + + + Has the sqlite3_errstr() core library API been checked for yet? + If so, is it present? + + + + + Returns the error message for the specified SQLite return code using + the sqlite3_errstr() function, falling back to the internal lookup + table if necessary. + + WARNING: Do not remove this method, it is used via reflection. + + The SQLite return code. + The error message or null if it cannot be found. + + + + Has the sqlite3_stmt_readonly() core library API been checked for yet? + If so, is it present? + + + + + Returns non-zero if the specified statement is read-only in nature. + + The statement to check. + True if the outer query is read-only. + + + + This field is used to keep track of whether or not the + "SQLite_ForceLogPrepare" environment variable has been queried. If so, + it will only be non-zero if the environment variable was present. + + + + + Determines if all calls to prepare a SQL query will be logged, + regardless of the flags for the associated connection. + + + Non-zero to log all calls to prepare a SQL query. + + + + + Determines the file name of the native library containing the native + "vtshim" extension -AND- whether it should be dynamically loaded by + this class. + + + This output parameter will be set to non-zero if the returned native + library file name should be dynamically loaded prior to attempting + the creation of native disposable extension modules. + + + The file name of the native library containing the native "vtshim" + extension -OR- null if it cannot be determined. + + Calls the native SQLite core library in order to create a disposable @@ -1241,7 +379,7 @@ The module object to be used when creating the native disposable module. - The flags for the associated object instance. + The flags for the associated object instance. @@ -1250,18 +388,18 @@ associated with a module containing the implementation of a virtual table. - The module object previously passed to the + The module object previously passed to the method. - The flags for the associated object instance. + The flags for the associated object instance. Calls the native SQLite core library in order to declare a virtual table - in response to a call into the - or virtual table methods. + in response to a call into the + or virtual table methods. The virtual table module that is to be responsible for the virtual table @@ -1282,8 +420,8 @@ Calls the native SQLite core library in order to declare a virtual table - function in response to a call into the - or virtual table methods. + function in response to a call into the + or virtual table methods. The virtual table module that is to be responsible for the virtual table @@ -1303,9 +441,65 @@ A standard SQLite return code. + + + Builds an error message string fragment containing the + defined values of the + enumeration. + + + The built string fragment. + + + + + Builds an error message string fragment containing the + defined values of the + enumeration. + + + The built string fragment. + + + + + Returns the current and/or highwater values for the specified + database status parameter. + + + The database status parameter to query. + + + Non-zero to reset the highwater value to the current value. + + + If applicable, receives the current value. + + + If applicable, receives the highwater value. + + + A standard SQLite return code. + + + + + Change a configuration option value for the database. + connection. + + + The database configuration option to change. + + + The new value for the specified configuration option. + + + A standard SQLite return code. + + - Enables or disabled extension loading by SQLite. + Enables or disables extension loading by SQLite. True to enable loading of extensions, false to disable. @@ -1324,7 +518,7 @@ - Enables or disabled extended result codes returned by SQLite + Enables or disables extended result codes returned by SQLite Gets the last SQLite error code @@ -1347,6 +541,54 @@ The callback function to invoke. Returns a result code + + + Appends an error message and an appropriate line-ending to a + instance. This is useful because the .NET Compact Framework has a slightly different set + of supported methods for the class. + + + The instance to append to. + + + The message to append. It will be followed by an appropriate line-ending. + + + + + This method attempts to cause the SQLite native library to invalidate + its function pointers that refer to this instance. This is necessary + to prevent calls from native code into delegates that may have been + garbage collected. Normally, these types of issues can only arise for + connections that are added to the pool; howver, it is good practice to + unconditionally invalidate function pointers that may refer to objects + being disposed. + + + Non-zero to also invalidate global function pointers (i.e. those that + are not directly associated with this connection on the native side). + + + Non-zero if this method is being executed within a context where it can + throw an exception in the event of failure; otherwise, zero. + + + Non-zero if this method was successful; otherwise, zero. + + + + + This method attempts to free the cached database name used with the + method. + + + Non-zero if this method is being executed within a context where it can + throw an exception in the event of failure; otherwise, zero. + + + Non-zero if this method was successful; otherwise, zero. + + Creates a new SQLite backup object based on the provided destination @@ -1430,12 +672,6 @@ The type of data contained in the column. If Uninitialized, this function will retrieve the datatype information. Returns the data in the column - - - Returns non-zero if the underlying native connection handle is owned - by this instance. - - Alternate SQLite3 object, overriding many text behaviors to support UTF-16 (Unicode) @@ -1451,7 +687,7 @@ DateTime and binding DateTime parameters. - The to be used when creating DateTime + The to be used when creating DateTime values. @@ -1462,11 +698,11 @@ The native handle to be associated with the database connection. - The fully qualified file name associated with . + The fully qualified file name associated with . Non-zero if the newly created object instance will need to dispose - of when it is no longer needed. + of when it is no longer needed. @@ -1536,11 +772,475 @@ Disposes and finalizes the backup. - + - + 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. + + + The error code used for logging exceptions caught in user-provided + code. + + + + + Returns a string representing the active version of SQLite + + + + + Returns an integer representing the active version of SQLite + + + + + Returns non-zero if this connection to the database is read-only. + + + + + Returns the rowid of the most recent successful INSERT into the database from this connection. + + + + + Returns the number of changes the last executing insert/update caused. + + + + + 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. + + + + + 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. + + + + + Returns non-zero if the underlying native connection handle is owned by this instance. + + + + + Returns the logical list of functions associated with this connection. + + + + + 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. + + Non-zero to enable memory usage tracking, zero otherwise. + A standard SQLite return code (i.e. zero for success and non-zero for failure). + + + + Attempts to free as much heap memory as possible for the database connection. + + A standard SQLite return code (i.e. zero for success and non-zero for failure). + + + + Shutdown the SQLite engine so that it can be restarted with different config options. + We depend on auto initialization to recover. + + + + + Determines if the associated native connection handle is open. + + + Non-zero if a database connection is open. + + + + + Returns the fully qualified path and file name for the currently open + database, if any. + + + The name of the attached database to query. + + + The fully qualified path and file name for the currently open database, + if any. + + + + + Opens a database. + + + 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. + + The filename of the database to open. SQLite automatically creates it if it doesn't exist. + The name of the VFS to use -OR- null to use the default VFS. + The flags associated with the parent connection object + The open flags to use when creating the connection + The maximum size of the pool for the given filename + If true, the connection can be pulled from the connection pool + + + + Closes the currently-open database. + + + 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. + + Non-zero if connection is being disposed, zero otherwise. + + + + Sets the busy timeout on the connection. SQLiteCommand will call this before executing any command. + + The number of milliseconds to wait before returning SQLITE_BUSY + + + + Returns the text of the last error issued by SQLite + + + + + + Returns the text of the last error issued by SQLite -OR- the specified default error text if + none is available from the SQLite core library. + + + The error text to return in the event that one is not available from the SQLite core library. + + + The error text. + + + + + When pooling is enabled, force this connection to be disposed rather than returned to the pool + + + + + When pooling is enabled, returns the number of pool entries matching the current file name. + + The number of pool entries matching the current file name. + + + + Prepares a SQL statement for execution. + + The source connection preparing the command. Can be null for any caller except LINQ + The SQL command text to prepare + The previous statement in a multi-statement command, or null if no previous statement exists + The timeout to wait before aborting the prepare + 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. + Returns an initialized SQLiteStatement. + + + + Steps through a prepared statement. + + The SQLiteStatement to step through + True if a row was returned, False if not. + + + + Returns non-zero if the specified statement is read-only in nature. + + The statement to check. + True if the outer query is read-only. + + + + 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. + + The statement to reset + 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 + + + + Attempts to interrupt the query currently executing on the associated + native database connection. + + + + + This function binds a user-defined function to the connection. + + + The object instance containing + the metadata for the function to be bound. + + + The object instance that implements the + function to be bound. + + + The flags associated with the parent connection object. + + + + + This function unbinds a user-defined function from the connection. + + + The object instance containing + the metadata for the function to be unbound. + + + The flags associated with the parent connection object. + + Non-zero if the function was unbound. + + + + Calls the native SQLite core library in order to create a disposable + module containing the implementation of a virtual table. + + + The module object to be used when creating the native disposable module. + + + The flags for the associated object instance. + + + + + Calls the native SQLite core library in order to cleanup the resources + associated with a module containing the implementation of a virtual table. + + + The module object previously passed to the + method. + + + The flags for the associated object instance. + + + + + Calls the native SQLite core library in order to declare a virtual table + in response to a call into the + or virtual table methods. + + + The virtual table module that is to be responsible for the virtual table + being declared. + + + The string containing the SQL statement describing the virtual table to + be declared. + + + Upon success, the contents of this parameter are undefined. Upon failure, + it should contain an appropriate error message. + + + A standard SQLite return code. + + + + + Calls the native SQLite core library in order to declare a virtual table + function in response to a call into the + or virtual table methods. + + + The virtual table module that is to be responsible for the virtual table + function being declared. + + + The number of arguments to the function being declared. + + + The name of the function being declared. + + + Upon success, the contents of this parameter are undefined. Upon failure, + it should contain an appropriate error message. + + + A standard SQLite return code. + + + + + Returns the current and/or highwater values for the specified database status parameter. + + + The database status parameter to query. + + + Non-zero to reset the highwater value to the current value. + + + If applicable, receives the current value. + + + If applicable, receives the highwater value. + + + A standard SQLite return code. + + + + + Change a configuration option value for the database. + + + The database configuration option to change. + + + The new value for the specified configuration option. + + + A standard SQLite return code. + + + + + Enables or disables extension loading by SQLite. + + + True to enable loading of extensions, false to disable. + + + + + Loads a SQLite extension library from the named file. + + + The name of the dynamic link library file containing the extension. + + + The name of the exported function used to initialize the extension. + If null, the default "sqlite3_extension_init" will be used. + + + + + Enables or disables extened result codes returned by SQLite + + true to enable extended result codes, false to disable. + + + + + Returns the numeric result code for the most recent failed SQLite API call + associated with the database connection. + + Result code + + + + Returns the extended numeric result code for the most recent failed SQLite API call + associated with the database connection. + + Extended result code + + + + Add a log message via the SQLite sqlite3_log interface. + + Error code to be logged with the message. + String to be logged. Unlike the SQLite sqlite3_log() + interface, this should be pre-formatted. Consider using the + String.Format() function. + + + + + Checks if the SQLite core library has been initialized in the current process. + + + Non-zero if the SQLite core library has been initialized in the current process, + zero otherwise. + + + + + Returns non-zero if the given database connection is in autocommit mode. + Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN + statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK. + + + + + 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. + + The destination database connection. + The destination database name. + The source database name. + The newly created backup object. + + + + Copies up to N pages from the source database to the destination + database associated with the specified backup object. + + The backup object to use. + + The number of pages to copy or negative to copy all remaining pages. + + + Set to true if the operation needs to be retried due to database + locking issues. + + + True if there are more pages to be copied, false otherwise. + + + + + Returns the number of pages remaining to be copied from the source + database to the destination database associated with the specified + backup object. + + The backup object to check. + The number of pages remaining to be copied. + + + + Returns the total number of pages in the source database associated + with the specified backup object. + + The backup object to check. + The total number of pages in the source database. + + + + Destroys the backup object, rolling back any backup that may be in + progess. + + The backup object to destroy. + + + + Returns the error message for the specified SQLite return code using + the internal static lookup table. + + The SQLite return code. + The error message or null if it cannot be found. + + + + + + Creates temporary tables on the connection so schema information can be queried. @@ -1593,8 +1293,8 @@ - When binding parameter values with the - type, use the interop method that accepts an + When binding parameter values with the + type, use the interop method that accepts an value. @@ -1614,13 +1314,13 @@ - Prevent this object instance from + Prevent this object instance from loading extensions. - Prevent this object instance from + Prevent this object instance from creating virtual table modules. @@ -1633,14 +1333,14 @@ Skip setting the logging related properties of the - object instance that was passed to - the method. + object instance that was passed to + the method. Enable logging of all virtual table module errors seen by the - method. + method. @@ -1672,7 +1372,7 @@ Disable using the connection pool by default. If the "Pooling" connection string property is specified, its value will override this flag. The precise outcome of combining this flag with the - flag is unspecified; however, + flag is unspecified; however, one of the flags will be in effect. @@ -1681,17 +1381,17 @@ Enable using the connection pool by default. If the "Pooling" connection string property is specified, its value will override this flag. The precise outcome of combining this flag with the - flag is unspecified; however, + flag is unspecified; however, one of the flags will be in effect. Enable using per-connection mappings between type names and - values. Also see the - , - , and - methods. These + values. Also see the + , + , and + methods. These per-connection mappings, when present, override the corresponding global mappings. @@ -1699,16 +1399,16 @@ Disable using global mappings between type names and - values. This may be useful in some very narrow + values. This may be useful in some very narrow cases; however, if there are no per-connection type mappings, the fallback defaults will be used for both type names and their - associated values. Therefore, use of this flag + associated values. Therefore, use of this flag is not recommended. - When the property is used, it + When the property is used, it should return non-zero if there were ever any rows in the associated result sets. @@ -1732,35 +1432,185 @@ When returning column values, attempt to detect the affinity of textual values by checking if they fully conform to those of the - , - , - , - or types. + , + , + , + or types. When returning column values, attempt to detect the type of string values by checking if they fully conform to those of - the , - , - , - or types. + the , + , + , + or types. Skip querying runtime configuration settings for use by the - class, including the default - value and default database type name. - NOTE: If the - and/or + class, including the default + value and default database type name. + NOTE: If the + and/or properties are not set explicitly nor set via their connection string properties and repeated calls to determine these runtime configuration settings are seen to be a problem, this flag should be set. + + + When binding parameter values with the + type, take their into account as + well as that of the associated . + + + + + If an exception is caught when raising the + event, the transaction + should be rolled back. If this is not specified, the transaction + will continue the commit process instead. + + + + + If an exception is caught when raising the + event, the action should + should be denied. If this is not specified, the action will be + allowed instead. + + + + + If an exception is caught when raising the + event, the operation + should be interrupted. If this is not specified, the operation + will simply continue. + + + + + Attempt to unbind all functions provided by other managed assemblies + when closing the connection. + + + + + When returning column values as a , skip + verifying their affinity. + + + + + Enable using per-connection mappings between type names and + values. Also see the + , + , and + methods. + + + + + Enable using per-connection mappings between type names and + values. Also see the + , + , and + methods. + + + + + If the database type name has not been explicitly set for the + parameter specified, fallback to using the parameter name. + + + + + If the database type name has not been explicitly set for the + parameter specified, fallback to using the database type name + associated with the value. + + + + + When returning column values, skip verifying their affinity. + + + + + Allow transactions to be nested. The outermost transaction still + controls whether or not any changes are ultimately committed or + rolled back. All non-outermost transactions are implemented using + the SAVEPOINT construct. + + + + + When binding parameter values, always bind + values as though they were plain text (i.e. not , + which is the legacy behavior). + + + + + When returning column values, always return + values as though they were plain text (i.e. not , + which is the legacy behavior). + + + + + When binding parameter values, always use + the invariant culture when converting their values to strings. + + + + + When returning column values, always use + the invariant culture when converting their values from strings. + + + + + EXPERIMENTAL -- + Enable waiting for the enlistment to be reset prior to attempting + to create a new enlistment. This may be necessary due to the + semantics used by distributed transactions, which complete + asynchronously. + + + + + When returning column values, always use + the invariant culture when converting their values from strings. + + + + + When returning column values, always use + the invariant culture when converting their values from strings. + + + + + EXPERIMENTAL -- + Enable strict conformance to the ADO.NET standard, e.g. use of + thrown exceptions to indicate common error conditions. + + + + + EXPERIMENTAL -- + When opening a connection, attempt to hide the password from the + connection string, etc. Given the memory architecture of the CLR, + (and P/Invoke) this is not 100% reliable and should not be relied + upon for security critical uses or applications. + + When binding parameter values or returning column values, always @@ -1791,11 +1641,27 @@ or from strings. + + + Enables use of all per-connection value handling callbacks. + + + + + Enables use of all applicable + properties as fallbacks for the database type name. + + Enable all logging. + + + The default logging related flags for new connections. + + The default extra flags for new connections. @@ -1806,6 +1672,367 @@ The default extra flags for new connections with all logging enabled. + + + These are the supported status parameters for use with the native + SQLite library. + + + + + This parameter returns the number of lookaside memory slots + currently checked out. + + + + + This parameter returns the approximate number of bytes of + heap memory used by all pager caches associated with the + database connection. The highwater mark associated with + SQLITE_DBSTATUS_CACHE_USED is always 0. + + + + + This parameter returns the approximate number of bytes of + heap memory used to store the schema for all databases + associated with the connection - main, temp, and any ATTACH-ed + databases. The full amount of memory used by the schemas is + reported, even if the schema memory is shared with other + database connections due to shared cache mode being enabled. + The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED + is always 0. + + + + + This parameter returns the number malloc attempts that might + have been satisfied using lookaside memory but failed due to + all lookaside memory already being in use. Only the high-water + value is meaningful; the current value is always zero. + + + + + This parameter returns the number malloc attempts that were + satisfied using lookaside memory. Only the high-water value + is meaningful; the current value is always zero. + + + + + This parameter returns the number malloc attempts that might + have been satisfied using lookaside memory but failed due to + the amount of memory requested being larger than the lookaside + slot size. Only the high-water value is meaningful; the current + value is always zero. + + + + + This parameter returns the number malloc attempts that might + have been satisfied using lookaside memory but failed due to + the amount of memory requested being larger than the lookaside + slot size. Only the high-water value is meaningful; the current + value is always zero. + + + + + This parameter returns the number of pager cache hits that + have occurred. The highwater mark associated with + SQLITE_DBSTATUS_CACHE_HIT is always 0. + + + + + This parameter returns the number of pager cache misses that + have occurred. The highwater mark associated with + SQLITE_DBSTATUS_CACHE_MISS is always 0. + + + + + This parameter returns the number of dirty cache entries that + have been written to disk. Specifically, the number of pages + written to the wal file in wal mode databases, or the number + of pages written to the database file in rollback mode + databases. Any pages written as part of transaction rollback + or database recovery operations are not included. If an IO or + other error occurs while writing a page to disk, the effect + on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is + undefined. The highwater mark associated with + SQLITE_DBSTATUS_CACHE_WRITE is always 0. + + + + + This parameter returns zero for the current value if and only + if all foreign key constraints (deferred or immediate) have + been resolved. The highwater mark is always 0. + + + + + This parameter is similar to DBSTATUS_CACHE_USED, except that + if a pager cache is shared between two or more connections the + bytes of heap memory used by that pager cache is divided evenly + between the attached connections. In other words, if none of + the pager caches associated with the database connection are + shared, this request returns the same value as DBSTATUS_CACHE_USED. + Or, if one or more or the pager caches are shared, the value + returned by this call will be smaller than that returned by + DBSTATUS_CACHE_USED. The highwater mark associated with + SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0. + + + + + These are the supported configuration verbs for use with the native + SQLite library. They are used with the + method. + + + + + This value represents an unknown (or invalid) option, do not use it. + + + + + This option is used to change the name of the "main" database + schema. The sole argument is a pointer to a constant UTF8 string + which will become the new schema name in place of "main". + + + + + This option is used to configure the lookaside memory allocator. + The value must be an array with three elements. The second element + must be an containing the size of each buffer + slot. The third element must be an containing + the number of slots. The first element must be an + that points to a native memory buffer of bytes equal to or greater + than the product of the second and third element values. + + + + + This option is used to enable or disable the enforcement of + foreign key constraints. + + + + + This option is used to enable or disable triggers. + + + + + This option is used to enable or disable the two-argument version + of the fts3_tokenizer() function which is part of the FTS3 full-text + search engine extension. + + + + + This option is used to enable or disable the loading of extensions. + + + + + This option is used to enable or disable the automatic checkpointing + when a WAL database is closed. + + + + + This option is used to enable or disable the query planner stability + guarantee (QPSG). + + + + + This option is used to enable or disable the extra EXPLAIN QUERY PLAN + output for trigger programs. + + + + + This option is used as part of the process to reset a database back + to an empty state. Because resetting a database is destructive and + irreversible, the process requires the use of this obscure flag and + multiple steps to help ensure that it does not happen by accident. + + + + + These constants are used with the sqlite3_trace_v2() API and the + callbacks registered by it. + + + + + Represents a single SQL blob in SQLite. + + + + + The underlying SQLite object this blob is bound to. + + + + + The actual blob handle. + + + + + Initializes the blob. + + The base SQLite object. + The blob handle. + + + + Creates a object. This will not work + for tables that were created WITHOUT ROWID -OR- if the query + does not include the "rowid" column or one of its aliases -OR- + if the was not created with the + flag. + + + The instance with a result set + containing the desired blob column. + + + The index of the blob column. + + + Non-zero to open the blob object for read-only access. + + + The newly created instance -OR- null + if an error occurs. + + + + + Creates a object. This will not work + for tables that were created WITHOUT ROWID. + + + The connection to use when opening the blob object. + + + The name of the database containing the blob object. + + + The name of the table containing the blob object. + + + The name of the column containing the blob object. + + + The integer identifier for the row associated with the desired + blob object. + + + Non-zero to open the blob object for read-only access. + + + The newly created instance -OR- null + if an error occurs. + + + + + Throws an exception if the blob object does not appear to be open. + + + + + Throws an exception if an invalid read/write parameter is detected. + + + When reading, this array will be populated with the bytes read from + the underlying database blob. When writing, this array contains new + values for the specified portion of the underlying database blob. + + + The number of bytes to read or write. + + + The byte offset, relative to the start of the underlying database + blob, where the read or write operation will begin. + + + + + Retargets this object to an underlying database blob for a + different row; the database, table, and column remain exactly + the same. If this operation fails for any reason, this blob + object is automatically disposed. + + + The integer identifier for the new row. + + + + + Queries the total number of bytes for the underlying database blob. + + + The total number of bytes for the underlying database blob. + + + + + Reads data from the underlying database blob. + + + This array will be populated with the bytes read from the + underlying database blob. + + + The number of bytes to read. + + + The byte offset, relative to the start of the underlying + database blob, where the read operation will begin. + + + + + Writes data into the underlying database blob. + + + This array contains the new values for the specified portion of + the underlying database blob. + + + The number of bytes to write. + + + The byte offset, relative to the start of the underlying + database blob, where the write operation will begin. + + + + + Closes the blob, freeing the associated resources. + + + + + Disposes and finalizes the blob. + + + + + The destructor. + + SQLite implementation of DbCommand. @@ -1815,8 +2042,8 @@ The default connection string to be used when creating a temporary connection to execute a command via the static - or - + or + methods. @@ -1945,6 +2172,21 @@ Not implemented + + + The SQL command text associated with the command + + + + + The amount of time to wait for the connection to become available before erroring out + + + + + The type of the command. SQLite only supports CommandType.Text + + Forwards to the local CreateParameter() function @@ -1957,6 +2199,44 @@ + + + The connection associated with this command + + + + + Forwards to the local Connection property + + + + + Returns the SQLiteParameterCollection for the given command + + + + + Forwards to the local Parameters property + + + + + The transaction associated with this command. SQLite only supports one transaction per connection, so this property forwards to the + command's underlying connection. + + + + + Forwards to the local Transaction property + + + + + Verifies that all SQL queries associated with the current command text + can be successfully compiled. A will be + raised if any errors occur. + + This function ensures there are no active readers, that we have a valid connection, @@ -2002,9 +2282,9 @@ This method creates a new connection, executes the query using the given - execution type and command behavior, closes the connection, and returns - the results. If the connection string is null, a temporary in-memory - database connection will be used. + execution type and command behavior, closes the connection unless a data + reader is created, and returns the results. If the connection string is + null, a temporary in-memory database connection will be used. The text of the command to be executed. @@ -2043,7 +2323,7 @@ A SQLiteDataReader - + Called by the SQLiteDataReader when the data reader is closed. @@ -2076,63 +2356,32 @@ The flags to be associated with the reader. The first column of the first row of the first resultset from the query. + + + This method resets all the prepared statements held by this instance + back to their initial states, ready to be re-executed. + + + + + This method resets all the prepared statements held by this instance + back to their initial states, ready to be re-executed. + + + Non-zero if the parameter bindings should be cleared as well. + + + If this is zero, a may be thrown for + any unsuccessful return codes from the native library; otherwise, a + will only be thrown if the connection + or its state is invalid. + + Does nothing. Commands are prepared as they are executed the first time, and kept in prepared state afterwards. - - - Clones a command, including all its parameters - - A new SQLiteCommand with the same commandtext, connection and parameters - - - - The SQL command text associated with the command - - - - - The amount of time to wait for the connection to become available before erroring out - - - - - The type of the command. SQLite only supports CommandType.Text - - - - - The connection associated with this command - - - - - Forwards to the local Connection property - - - - - Returns the SQLiteParameterCollection for the given command - - - - - Forwards to the local Parameters property - - - - - The transaction associated with this command. SQLite only supports one transaction per connection, so this property forwards to the - command's underlying connection. - - - - - Forwards to the local Transaction property - - Sets the method the SQLiteCommandBuilder uses to determine how to update inserted or updated rows in a DataTable. @@ -2143,6 +2392,12 @@ Determines if the command is visible at design time. Defaults to True. + + + Clones a command, including all its parameters + + A new SQLiteCommand with the same commandtext, connection and parameters + SQLite implementation of DbCommandBuilder. @@ -2159,6 +2414,14 @@ + + + Cleans up resources (native and managed) associated with the current instance. + + + Zero when being disposed via garbage collection; otherwise, non-zero. + + Minimal amount of parameter processing. Primarily sets the DbType for the parameter equal to the provider type in the schema @@ -2196,6 +2459,11 @@ A data adapter to receive events on. + + + Gets/sets the DataAdapter for this CommandBuilder + + Returns the automatically-generated SQLite command to delete rows from the database @@ -2235,32 +2503,6 @@ - - - Places brackets around an identifier - - The identifier to quote - The bracketed identifier - - - - Removes brackets around an identifier - - The quoted (bracketed) identifier - The undecorated identifier - - - - Override helper, which can help the base command builder choose the right keys for the given query - - - - - - - Gets/sets the DataAdapter for this CommandBuilder - - Overridden to hide its property from the designer @@ -2281,11 +2523,600 @@ Overridden to hide its property from the designer + + + Places brackets around an identifier + + The identifier to quote + The bracketed identifier + + + + Removes brackets around an identifier + + The quoted (bracketed) identifier + The undecorated identifier + Overridden to hide its property from the designer + + + Override helper, which can help the base command builder choose the right keys for the given query + + + + + + + This class represents a single value to be returned + from the class via + its , + , + , + , + , + , + , + , + , + , + , + , + , + , + , or + method. If the value of the + associated public field of this class is null upon returning from the + callback, the null value will only be used if the return type for the + method called is not a value type. + If the value to be returned from the + method is unsuitable (e.g. null with a value type), an exception will + be thrown. + + + + + The value to be returned from the + method -OR- null to + indicate an error. + + + + + The value to be returned from the + method -OR- null to + indicate an error. + + + + + The value to be returned from the + method -OR- null to + indicate an error. + + + + + The value to be returned from the + method. + + + + + The value to be returned from the + method -OR- null to + indicate an error. + + + + + The value to be returned from the + method. + + + + + The value to be returned from the + method -OR- null to + indicate an error. + + + + + The value to be returned from the + method -OR- null to + indicate an error. + + + + + The value to be returned from the + method -OR- null to + indicate an error. + + + + + The value to be returned from the + method -OR- null to + indicate an error. + + + + + The value to be returned from the + method -OR- null to + indicate an error. + + + + + The value to be returned from the + method -OR- null to + indicate an error. + + + + + The value to be returned from the + method -OR- null to + indicate an error. + + + + + The value to be returned from the + method -OR- null to + indicate an error. + + + + + The value to be returned from the + method. + + + + + The value to be returned from the + method. + + + + + This class represents the parameters that are provided + to the methods, with + the exception of the column index (provided separately). + + + + + This class represents the parameters that are provided to + the method, with + the exception of the column index (provided separately). + + + + + Provides the underlying storage for the + property. + + + + + Constructs an instance of this class to pass into a user-defined + callback associated with the + method. + + + The value that was originally specified for the "readOnly" + parameter to the method. + + + + + The value that was originally specified for the "readOnly" + parameter to the method. + + + + + This class represents the parameters that are provided + to the and + methods, with + the exception of the column index (provided separately). + + + + + Provides the underlying storage for the + property. + + + + + Provides the underlying storage for the + property. + + + + + Provides the underlying storage for the + property. + + + + + Provides the underlying storage for the + property. + + + + + Provides the underlying storage for the + property. + + + + + Constructs an instance of this class to pass into a user-defined + callback associated with the + method. + + + The value that was originally specified for the "dataOffset" + parameter to the or + methods. + + + The value that was originally specified for the "buffer" + parameter to the + method. + + + The value that was originally specified for the "bufferOffset" + parameter to the or + methods. + + + The value that was originally specified for the "length" + parameter to the or + methods. + + + + + Constructs an instance of this class to pass into a user-defined + callback associated with the + method. + + + The value that was originally specified for the "dataOffset" + parameter to the or + methods. + + + The value that was originally specified for the "buffer" + parameter to the + method. + + + The value that was originally specified for the "bufferOffset" + parameter to the or + methods. + + + The value that was originally specified for the "length" + parameter to the or + methods. + + + + + The value that was originally specified for the "dataOffset" + parameter to the or + methods. + + + + + The value that was originally specified for the "buffer" + parameter to the + method. + + + + + The value that was originally specified for the "buffer" + parameter to the + method. + + + + + The value that was originally specified for the "bufferOffset" + parameter to the or + methods. + + + + + The value that was originally specified for the "length" + parameter to the or + methods. + + + + + This class represents the parameters and return values for the + , + , + , + , + , + , + , + , + , + , + , + , + , + , + , and + methods. + + + + + Provides the underlying storage for the + property. + + + + + Provides the underlying storage for the + property. + + + + + Provides the underlying storage for the + property. + + + + + Constructs a new instance of this class. Depending on the method + being called, the and/or + parameters may be null. + + + The name of the method that was + responsible for invoking this callback. + + + If the or + method is being called, + this object will contain the array related parameters for that + method. If the method is + being called, this object will contain the blob related parameters + for that method. + + + This may be used by the callback to set the return value for the + called method. + + + + + The name of the method that was + responsible for invoking this callback. + + + + + If the or + method is being called, + this object will contain the array related parameters for that + method. If the method is + being called, this object will contain the blob related parameters + for that method. + + + + + This may be used by the callback to set the return value for the + called method. + + + + + This represents a method that will be called in response to a request to + bind a parameter to a command. If an exception is thrown, it will cause + the parameter binding operation to fail -AND- it will continue to unwind + the call stack. + + + The instance in use. + + + The instance in use. + + + The flags associated with the instance + in use. + + + The instance being bound to the command. + + + The database type name associated with this callback. + + + The ordinal of the parameter being bound to the command. + + + The data originally used when registering this callback. + + + Non-zero if the default handling for the parameter binding call should + be skipped (i.e. the parameter should not be bound at all). Great care + should be used when setting this to non-zero. + + + + + This represents a method that will be called in response to a request + to read a value from a data reader. If an exception is thrown, it will + cause the data reader operation to fail -AND- it will continue to unwind + the call stack. + + + The instance in use. + + + The instance in use. + + + The flags associated with the instance + in use. + + + The parameter and return type data for the column being read from the + data reader. + + + The database type name associated with this callback. + + + The zero based index of the column being read from the data reader. + + + The data originally used when registering this callback. + + + Non-zero if the default handling for the data reader call should be + skipped. If this is set to non-zero and the necessary return value + is unavailable or unsuitable, an exception will be thrown. + + + + + This class represents the custom data type handling callbacks + for a single type name. + + + + + Provides the underlying storage for the + property. + + + + + Provides the underlying storage for the + property. + + + + + Provides the underlying storage for the + property. + + + + + Provides the underlying storage for the + property. + + + + + Provides the underlying storage for the + property. + + + + + Constructs an instance of this class. + + + The custom paramater binding callback. This parameter may be null. + + + The custom data reader value callback. This parameter may be null. + + + The extra data to pass into the parameter binding callback. This + parameter may be null. + + + The extra data to pass into the data reader value callback. This + parameter may be null. + + + + + Creates an instance of the class. + + + The custom paramater binding callback. This parameter may be null. + + + The custom data reader value callback. This parameter may be null. + + + The extra data to pass into the parameter binding callback. This + parameter may be null. + + + The extra data to pass into the data reader value callback. This + parameter may be null. + + + + + The database type name that the callbacks contained in this class + will apply to. This value may not be null. + + + + + The custom paramater binding callback. This value may be null. + + + + + The custom data reader value callback. This value may be null. + + + + + The extra data to pass into the parameter binding callback. This + value may be null. + + + + + The extra data to pass into the data reader value callback. This + value may be null. + + + + + This class represents the mappings between database type names + and their associated custom data type handling callbacks. + + + + + Constructs an (empty) instance of this class. + + Event data for connection event handlers. @@ -2298,7 +3129,7 @@ - The associated with this event, if any. + The associated with this event, if any. @@ -2336,7 +3167,7 @@ Constructs the object. The type of event being raised. - The base associated + The base associated with this event, if any. The transaction associated with this event, if any. The command associated with this event, if any. @@ -2357,7 +3188,7 @@ SQLite implentation of DbConnection. - The property can contain the following parameter(s), delimited with a semi-colon: + The property can contain the following parameter(s), delimited with a semi-colon: Parameter @@ -2377,6 +3208,25 @@ + Uri + + If specified, this must be a file name that starts with "file://", "file:", or "/". Any leading + "file://" or "file:" prefix will be stripped off and the resulting file name will be used to open + the database. + + N + null + + + FullUri + + If specified, this must be a URI in a format recognized by the SQLite core library (starting with + SQLite 3.7.7). It will be passed verbatim to the SQLite core library. + + N + null + + Version 3 N @@ -2384,11 +3234,79 @@ UseUTF16Encoding - True
False + + True - The UTF-16 encoding should be used. +
+ False - The UTF-8 encoding should be used. + N False + DefaultDbType + + This is the default to use when one cannot be determined based on the + column metadata and the configured type mappings. + + N + null + + + DefaultTypeName + + This is the default type name to use when one cannot be determined based on the column metadata + and the configured type mappings. + + N + null + + + NoDefaultFlags + + True - Do not combine the specified (or existing) connection flags with the value of the + property. +
+ False - Combine the specified (or existing) connection flags with the value of the + property. + + N + False + + + NoSharedFlags + + True - Do not combine the specified (or existing) connection flags with the value of the + property. +
+ False - Combine the specified (or existing) connection flags with the value of the + property. + + N + False + + + VfsName + + The name of the VFS to use when opening the database connection. + If this is not specified, the default VFS will be used. + + N + null + + + ZipVfsVersion + + If non-null, this is the "version" of ZipVFS to use. This requires + the System.Data.SQLite interop assembly -AND- primary managed assembly + to be compiled with the INTEROP_INCLUDE_ZIPVFS option; otherwise, this + property does nothing. The valid values are "v2" and "v3". Using + anyother value will cause an exception to be thrown. Please see the + ZipVFS documentation for more information on how to use this parameter. + + N + null + + DateTimeFormat Ticks - Use the value of DateTime.Ticks.
@@ -2403,41 +3321,68 @@ DateTimeKind - Unspecified - Not specified as either UTC or local time.
Utc - The time represented is UTC.
Local - The time represented is local time. + + Unspecified - Not specified as either UTC or local time. +
+ Utc - The time represented is UTC. +
+ Local - The time represented is local time. + N Unspecified DateTimeFormatString - The exact DateTime format string to use for all formatting and parsing of all DateTime - values for this connection. + + The exact DateTime format string to use for all formatting and parsing of all DateTime + values for this connection. + N null BaseSchemaName - Some base data classes in the framework (e.g. those that build SQL queries dynamically) + + 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. + as a placeholder and removed prior to preparing any SQL statements that may contain it. + N sqlite_default_schema BinaryGUID - True - Store GUID columns in binary form
False - Store GUID columns as text + + True - Store GUID columns in binary form +
+ False - Store GUID columns as text + N True Cache Size - {size in bytes} + + If the argument N is positive then the suggested cache size is set to N. + If the argument N is negative, then the number of cache pages is adjusted + to use approximately abs(N*4096) bytes of memory. Backwards compatibility + note: The behavior of cache_size with a negative N was different in SQLite + versions prior to 3.7.10. In version 3.7.9 and earlier, the number of + pages in the cache was set to the absolute value of N. + N - 2000 + -2000 Synchronous - Normal - Normal file flushing behavior
Full - Full flushing after all writes
Off - Underlying OS flushes I/O's + + Normal - Normal file flushing behavior +
+ Full - Full flushing after all writes +
+ Off - Underlying OS flushes I/O's + N Full @@ -2445,23 +3390,40 @@ Page Size {size in bytes} N - 1024 + 4096 Password - {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. + + {password} - Using this parameter requires that the legacy CryptoAPI based + codec (or the SQLite Encryption Extension) 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. + N HexPassword - {hexPassword} - Must contain a sequence of zero or more hexadecimal encoded byte values without a leading "0x" prefix. 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. + + {hexPassword} - Must contain a sequence of zero or more hexadecimal encoded + byte values without a leading "0x" prefix. Using this parameter requires + that the legacy CryptoAPI based codec (or the SQLite Encryption Extension) + 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. + N Enlist - Y - Automatically enlist in distributed transactions
N - No automatic enlistment + + Y - Automatically enlist in distributed transactions +
+ N - No automatic enlistment + N Y @@ -2480,7 +3442,11 @@ FailIfMissing - True - Don't create the database if it does not exist, throw an error instead
False - Automatically create the database if it does not exist + + True - Don't create the database if it does not exist, throw an error instead +
+ False - Automatically create the database if it does not exist + N False @@ -2492,7 +3458,11 @@ Legacy Format - True - Use the more compatible legacy 3.x database format
False - Use the newer 3.3x database format which compresses numbers more effectively + + True - Use the more compatible legacy 3.x database format +
+ False - Use the newer 3.3x database format which compresses numbers more effectively + N False @@ -2503,14 +3473,54 @@ 30 + BusyTimeout + {time in milliseconds}
Sets the busy timeout for the core library. + N + 0 + + + WaitTimeout + {time in milliseconds}
+ EXPERIMENTAL -- The wait timeout to use with + method. This is only used when + waiting for the enlistment to be reset prior to enlisting in a transaction, + and then only when the appropriate connection flag is set. + N + 30000 + + Journal Mode - Delete - Delete the journal file after a commit
Persist - Zero out and leave the journal file on disk after a commit
Off - Disable the rollback journal entirely + + Delete - Delete the journal file after a commit. +
+ Persist - Zero out and leave the journal file on disk after a + commit. +
+ Off - Disable the rollback journal entirely. 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 this journaling + mode is set, then the database file will very likely go corrupt. +
+ Truncate - Truncate the journal file to zero-length instead of + deleting it. +
+ Memory - 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 this journaling + mode is set, then the database file will very likely go corrupt. +
+ Wal - Use a write-ahead log instead of a rollback journal. + N Delete Read Only - True - Open the database for read only access
False - Open the database for normal read/write access + + True - Open the database for read only access +
+ False - Open the database for normal read/write access + N False @@ -2534,7 +3544,7 @@ Flags - Extra behavioral flags for the connection. See the enumeration for possible values. + Extra behavioral flags for the connection. See the enumeration for possible values. N Default @@ -2550,19 +3560,49 @@ ToFullPath - True - Attempt to expand the data source file name to a fully qualified path before opening.
+ True - Attempt to expand the data source file name to a fully qualified path before opening. +
False - Skip attempting to expand the data source file name to a fully qualified path before opening. N True + + PrepareRetries + + The maximum number of retries when preparing SQL to be executed. This + normally only applies to preparation errors resulting from the database + schema being changed. + + N + 3 + + + ProgressOps + + The approximate number of virtual machine instructions between progress + events. In order for progress events to actually fire, the event handler + must be added to the event as well. + + N + 0 + + + Recursive Triggers + + True - Enable the recursive trigger capability. + False - Disable the recursive trigger capability. + + N + False + - The "invalid value" for the enumeration used - by the property. This constant is shared + The "invalid value" for the enumeration used + by the property. This constant is shared by this class and the SQLiteConnectionStringBuilder class. @@ -2586,11 +3626,22 @@ for this class. + + + Static variable to store the connection event handlers to call. + + The extra connection flags to be used for all opened connections. + + + The instance (for this thread) that + had the most recent call to . + + Used to hold the active library version number of SQLite. @@ -2611,6 +3662,19 @@ Nesting level of the transactions open on the connection + + + Transaction counter for the connection. Currently, this is only used + to build SAVEPOINT names. + + + + + If this flag is non-zero, the method will have + no effect; however, the method will continue to + behave as normal. + + If set, then the connection is currently being disposed. @@ -2621,6 +3685,12 @@ The default isolation level for new transactions + + + This object is used with lock statements to synchronize access to the + field, below. + + Whether or not the connection is enlisted in a distrubuted transaction @@ -2628,10 +3698,16 @@ - The per-connection mappings between type names and + The per-connection mappings between type names and values. These mappings override the corresponding global mappings. + + + The per-connection mappings between type names and optional callbacks + for parameter binding and value reading. + + The base SQLite object to interop with @@ -2642,11 +3718,6 @@ The database filename minus path and extension - - - Temporary password storage, emptied after the database has been opened - - The "stub" (i.e. placeholder) base schema name to use when returning @@ -2656,7 +3727,7 @@ The extra behavioral flags for this connection, if any. See the - enumeration for a list of + enumeration for a list of possible values. @@ -2664,34 +3735,73 @@ The cached values for all settings that have been fetched on behalf of this connection. This cache may be cleared by calling the - method. + method. The default databse type for this connection. This value will only - be used if the + be used if the flag is set. The default databse type name for this connection. This value will only - be used if the + be used if the flag is set. + + + The name of the VFS to be used when opening the database connection. + + Default command timeout + + + The default busy timeout to use with the SQLite core library. This is + only used when opening a connection. + + + + + The default wait timeout to use with + method. This is only used when waiting for the enlistment to be reset + prior to enlisting in a transaction, and then only when the appropriate + connection flag is set. + + + + + The maximum number of retries when preparing SQL to be executed. This + normally only applies to preparation errors resulting from the database + schema being changed. + + + + + The approximate number of virtual machine instructions between progress + events. In order for progress events to actually fire, the event handler + must be added to the event as + well. This value will only be used when opening the database. + + Non-zero if the built-in (i.e. framework provided) connection string parser should be used when opening the connection. + + + This event is raised whenever the database is opened or closed. + + Constructs a new SQLiteConnection object @@ -2710,7 +3820,7 @@ Initializes the connection with a pre-existing native connection handle. This constructor overload is intended to be used only by the private - method. + method. The native connection handle to use. @@ -2743,9 +3853,22 @@ The connection to copy the settings from. + + + Attempts to lookup the native handle associated with the connection. An exception will + be thrown if this cannot be accomplished. + + + The connection associated with the desired native handle. + + + The native handle associated with the connection or if it + cannot be determined. + + - Raises the event. + Raises the event. The connection associated with this event. If this parameter is not @@ -2753,14 +3876,27 @@ registered event handlers will not be invoked. - A that contains the event data. + A that contains the event data. + + + This event is raised when events related to the lifecycle of a + SQLiteConnection object occur. + + + + + This property is used to obtain or set the custom connection pool + implementation to use, if any. Setting this property to null will + cause the default connection pool implementation to be used. + + Creates and returns a new managed database connection handle. This method is intended to be used by implementations of the - interface only. In theory, it + interface only. In theory, it could be used by other classes; however, that usage is not supported. @@ -2782,11 +3918,14 @@ The destination database name. The source database name. - The number of pages to copy or negative to copy all remaining pages. + The number of pages to copy at a time -OR- a negative value to copy all + pages. When a negative value is used, the + may never be invoked. The method to invoke between each step of the backup process. This - parameter may be null (i.e. no callbacks will be performed). + parameter may be null (i.e. no callbacks will be performed). If the + callback returns false -OR- throws an exception, the backup is canceled. The number of milliseconds to sleep after encountering a locking error @@ -2802,7 +3941,7 @@ The total number of per-connection settings cleared. - + Queries and returns the value of the specified setting, using the cached setting names and values for this connection, when available. @@ -2862,12 +4001,12 @@ is not recommended. - The value that should be associated with the + The value that should be associated with the specified type name. Non-zero if this mapping should be considered to be the primary one - for the specified . + for the specified . A negative value if nothing was done. Zero if no per-connection type @@ -2875,20 +4014,170 @@ zero if some per-connection type mappings were replaced. + + + Clears the per-connection type callbacks. + + + The total number of per-connection type callbacks cleared. + + + + + Attempts to get the per-connection type callbacks for the specified + database type name. + + + The database type name. + + + Upon success, this parameter will contain the object holding the + callbacks for the database type name. Upon failure, this parameter + will be null. + + + Non-zero upon success; otherwise, zero. + + + + + Sets, resets, or clears the per-connection type callbacks for the + specified database type name. + + + The database type name. + + + The object holding the callbacks for the database type name. If + this parameter is null, any callbacks for the database type name + will be removed if they are present. + + + Non-zero if callbacks were set or removed; otherwise, zero. + + - Attempts to bind the specified object + Attempts to bind the specified object instance to this connection. - The object instance containing + The object instance containing the metadata for the function to be bound. - The object instance that implements the + The object instance that implements the function to be bound. + + + Attempts to bind the specified object + instance to this connection. + + + The object instance containing + the metadata for the function to be bound. + + + A object instance that helps implement the + function to be bound. For scalar functions, this corresponds to the + type. For aggregate functions, + this corresponds to the type. For + collation functions, this corresponds to the + type. + + + A object instance that helps implement the + function to be bound. For aggregate functions, this corresponds to the + type. For other callback types, it + is not used and must be null. + + + + + Attempts to unbind the specified object + instance to this connection. + + + The object instance containing + the metadata for the function to be unbound. + + Non-zero if the function was unbound. + + + + This method unbinds all registered (known) functions -OR- all previously + bound user-defined functions from this connection. + + + Non-zero to unbind all registered (known) functions -OR- zero to unbind + all functions currently bound to the connection. + + + Non-zero if all the specified user-defined functions were unbound. + + + + + Parses a connection string into component parts using the custom + connection string parser. An exception may be thrown if the syntax + of the connection string is incorrect. + + + The connection string to parse. + + + Non-zero to parse the connection string using the algorithm provided + by the framework itself. This is not applicable when running on the + .NET Compact Framework. + + + Non-zero if names are allowed without values. + + + The list of key/value pairs corresponding to the parameters specified + within the connection string. + + + + + Parses a connection string into component parts using the custom + connection string parser. An exception may be thrown if the syntax + of the connection string is incorrect. + + + The connection that will be using the parsed connection string. + + + The connection string to parse. + + + Non-zero to parse the connection string using the algorithm provided + by the framework itself. This is not applicable when running on the + .NET Compact Framework. + + + Non-zero if names are allowed without values. + + + The list of key/value pairs corresponding to the parameters specified + within the connection string. + + + + + Disposes and finalizes the connection, if applicable. + + + + + Cleans up resources (native and managed) associated with the current instance. + + + Zero when being disposed via garbage collection; otherwise, non-zero. + + Creates a clone of the connection. All attached databases and user-defined functions are cloned. If the existing connection is open, the cloned connection @@ -2908,7 +4197,7 @@ Raises the state change event when the state of the connection changes The new connection state. If this is different - from the previous state, the event is + from the previous state, the event is raised. The event data created for the raised event, if it was actually raised. @@ -2920,7 +4209,7 @@ The fallback default isolation level for this connection instance -OR- - if it cannot be determined. + if it cannot be determined. @@ -2929,7 +4218,7 @@ The default isolation level for this connection instance -OR- - if it cannot be determined. + if it cannot be determined. @@ -2953,7 +4242,7 @@ - Creates a new if one isn't already active on the connection. + Creates a new if one isn't already active on the connection. Supported isolation levels are Serializable, ReadCommitted and Unspecified. @@ -2969,21 +4258,21 @@ - Creates a new if one isn't already + Creates a new if one isn't already active on the connection. Returns the new transaction object. - Forwards to the local function + Forwards to the local function Supported isolation levels are Unspecified, Serializable, and ReadCommitted - This method is not implemented; however, the + This method is not implemented; however, the event will still be raised. @@ -2993,6 +4282,11 @@ When the database connection is closed, all commands linked to this connection are automatically reset. + + + Returns the number of pool entries for the file name associated with this connection. + + Clears the connection pool associated with the connection. Any other active connections using the same database file @@ -3005,27 +4299,177 @@ Clears all connection pools. Any active connections will be discarded instead of sent to the pool when they are closed. + + + The connection string containing the parameters for the connection + + + For the complete list of supported connection string properties, + please see . + + - Create a new and associate it with this connection. + Create a new and associate it with this connection. Returns a new command object already assigned to this connection. - Forwards to the local function. + Forwards to the local function. - + - Parses the connection string into component parts using the custom - connection string parser. + Attempts to create a new object instance + using this connection and the specified database name. - The connection string to parse - An array of key-value pairs representing each parameter of the connection string + + The name of the database for the newly created session. + + + The newly created session -OR- null if it cannot be created. + - + + + Attempts to create a new object instance + using this connection and the specified raw data. + + + The raw data that contains a change set (or patch set). + + + The newly created change set -OR- null if it cannot be created. + + + + + Attempts to create a new object instance + using this connection and the specified raw data. + + + The raw data that contains a change set (or patch set). + + + The flags used to create the change set iterator. + + + The newly created change set -OR- null if it cannot be created. + + + + + Attempts to create a new object instance + using this connection and the specified stream. + + + The stream where the raw data that contains a change set (or patch set) + may be read. + + + The stream where the raw data that contains a change set (or patch set) + may be written. + + + The newly created change set -OR- null if it cannot be created. + + + + + Attempts to create a new object instance + using this connection and the specified stream. + + + The stream where the raw data that contains a change set (or patch set) + may be read. + + + The stream where the raw data that contains a change set (or patch set) + may be written. + + + The flags used to create the change set iterator. + + + The newly created change set -OR- null if it cannot be created. + + + + + Attempts to create a new object + instance using this connection. + + + The newly created change group -OR- null if it cannot be created. + + + + + Returns the data source file name without extension or path. + + + + + Returns the fully qualified path and file name for the currently open + database, if any. + + + + + Returns the string "main". + + + + + Determines if the legacy connection string parser should be used. + + + The connection that will be using the parsed connection string. + + + Non-zero if the legacy connection string parser should be used. + + + + + Parses a connection string into component parts using the custom + connection string parser. An exception may be thrown if the syntax + of the connection string is incorrect. + + + The connection string to parse. + + + Non-zero if names are allowed without values. + + + The list of key/value pairs corresponding to the parameters specified + within the connection string. + + + + + Parses a connection string into component parts using the custom + connection string parser. An exception may be thrown if the syntax + of the connection string is incorrect. + + + The connection that will be using the parsed connection string. + + + The connection string to parse. + + + Non-zero if names are allowed without values. + + + The list of key/value pairs corresponding to the parameters specified + within the connection string. + + + Parses a connection string using the built-in (i.e. framework provided) connection string parser class and returns the key/value pairs. An @@ -3034,12 +4478,16 @@ connection string parser is always used instead because the framework provided one is unavailable there. + + The connection that will be using the parsed connection string. + The connection string to parse. Non-zero to throw an exception if any connection string values are not of - the type. + the type. This is not applicable when running on + the .NET Compact Framework. The list of key/value pairs. @@ -3049,6 +4497,31 @@ The distributed transaction to enlist in + + + EXPERIMENTAL -- + Waits for the enlistment associated with this connection to be reset. + This method always throws when + running on the .NET Compact Framework. + + + The approximate maximum number of milliseconds to wait before timing + out the wait operation. + + + The return value to use if the connection has been disposed; if this + value is null, will be raised + if the connection has been disposed. + + + Non-zero if the enlistment assciated with this connection was reset; + otherwise, zero. It should be noted that this method returning a + non-zero value does not necessarily guarantee that the connection + can enlist in a new transaction (i.e. due to potentical race with + other threads); therefore, callers should generally use try/catch + when calling the method. + + Looks for a key in the array of key/values of the parameter string. If not found, return the specified default value @@ -3085,9 +4558,20 @@ Non-zero upon success; zero on failure. + + + Change a configuration option value for the database. + + + The database configuration option to change. + + + The new value for the specified configuration option. + + - Enables or disabled extension loading. + Enables or disables extension loading. True to enable loading of extensions, false to disable. @@ -3195,15 +4679,100 @@ - Opens the connection using the parameters found in the . + Opens the connection using the parameters found in the . - Opens the connection using the parameters found in the and then returns it. + Opens the connection using the parameters found in the and then returns it. The current connection object. + + + 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" + + + + + Gets/sets the default busy timeout to use with the SQLite core library. This is only used when + opening a connection. + + + + + EXPERIMENTAL -- + The wait timeout to use with method. + This is only used when waiting for the enlistment to be reset prior to + enlisting in a transaction, and then only when the appropriate connection + flag is set. + + + + + The maximum number of retries when preparing SQL to be executed. This + normally only applies to preparation errors resulting from the database + schema being changed. + + + + + The approximate number of virtual machine instructions between progress + events. In order for progress events to actually fire, the event handler + must be added to the event as + well. This value will only be used when the underlying native progress + callback needs to be changed. + + + + + Non-zero if the built-in (i.e. framework provided) connection string + parser should be used when opening the connection. + + + + + Gets/sets the extra behavioral flags for this connection. See the + enumeration for a list of + possible values. + + + + + Gets/sets the default database type for this connection. This value + will only be used when not null. + + + + + Gets/sets the default database type name for this connection. This + value will only be used when not null. + + + + + Gets/sets the VFS name for this connection. This value will only be + used when opening the database. + + + + + Returns non-zero if the underlying native connection handle is + owned by this instance. + + + + + Returns the version of the underlying SQLite database engine + + + + + Returns the rowid of the most recent successful INSERT into the database from this connection. + + This method causes any pending database operation to abort and return at @@ -3215,13 +4784,51 @@ returns. + + + Returns the number of rows changed by the last INSERT, UPDATE, or DELETE statement executed on + this connection. + + + + + Checks if this connection to the specified database should be considered + read-only. An exception will be thrown if the database name specified + via cannot be found. + + + The name of a database associated with this connection -OR- null for the + main database. + + + Non-zero if this connection to the specified database should be considered + read-only. + + + + + Returns non-zero if the given database connection is in autocommit mode. + Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN + statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK. + + + + + Returns the amount of memory (in bytes) currently in use by the SQLite core library. + + + + + Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset. + + Returns various global memory statistics for the SQLite core library via a dictionary of key/value pairs. Currently, only the "MemoryUsed" and "MemoryHighwater" keys are returned and they have values that correspond - to the values that could be obtained via the - and connection properties. + to the values that could be obtained via the + and connection properties. This dictionary will be populated with the global memory statistics. It @@ -3275,6 +4882,121 @@ Non-zero to enable memory usage tracking, zero otherwise. A standard SQLite return code (i.e. zero for success and non-zero for failure). + + + Returns a string containing the define constants (i.e. compile-time + options) used to compile the core managed assembly, delimited with + spaces. + + + + + Returns the version of the underlying SQLite core library. + + + + + 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. + + + + + Returns a string containing the compile-time options used to + compile the SQLite core native library, delimited with spaces. + + + + + This method returns the version of the interop SQLite assembly + used. If the SQLite interop assembly is not in use or the + necessary information cannot be obtained for any reason, a null + value may be returned. + + + + + This method returns the string whose value contains the unique + identifier for the source checkout used to build the interop + assembly. If the SQLite interop assembly is not in use or the + necessary information cannot be obtained for any reason, a null + value may be returned. + + + + + Returns a string containing the compile-time options used to + compile the SQLite interop assembly, delimited with spaces. + + + + + This method returns the version of the managed components used + to interact with the SQLite core library. If the necessary + information cannot be obtained for any reason, a null value may + be returned. + + + + + This method returns the string whose value contains the unique + identifier for the source checkout used to build the managed + components currently executing. If the necessary information + cannot be obtained for any reason, a null value may be returned. + + + + + Queries and returns the value of the specified setting, using the + cached setting names and values for the last connection that used + the method, when available. + + + The name of the setting. + + + The value to be returned if the setting has not been set explicitly + or cannot be determined. + + + The value of the cached setting is stored here if found; otherwise, + the value of is stored here. + + + Non-zero if the cached setting was found; otherwise, zero. + + + + + Adds or sets the cached setting specified by + to the value specified by using the cached + setting names and values for the last connection that used the + method, when available. + + + The name of the cached setting to add or replace. + + + The new value of the cached setting. + + + + + The default connection flags to be used for all opened connections + when they are not present in the connection string. + + + + + The extra connection flags to be used for all opened connections. + + + + + Returns the state of the connection. + + Passes a shutdown request to the SQLite core library. Does not throw @@ -3300,13 +5022,13 @@ - Enables or disabled extended result codes returned by SQLite + Enables or disables extended result codes returned by SQLite - Enables or disabled extended result codes returned by SQLite + Enables or disables extended result codes returned by SQLite - Enables or disabled extended result codes returned by SQLite + Enables or disables extended result codes returned by SQLite Add a log message via the SQLite sqlite3_log interface. @@ -3314,40 +5036,6 @@ Add a log message via the SQLite sqlite3_log interface. - - - Change the password (or assign a password) to an open database. - - - 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. - - The new password to assign to the database - - - - Change the password (or assign a password) to an open database. - - - 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. - - The new password to assign to the database - - - - Sets the password for a password-protected database. A password-protected database is - unusable for any operation until the password has been set. - - The password for the database - - - - Sets the password for a password-protected database. A password-protected database is - unusable for any operation until the password has been set. - - The password for the database - Queries or modifies the number of retries or the retry interval (in milliseconds) for @@ -3386,6 +5074,16 @@ double quotes, if applicable. + + + Determines the directory to be used when dealing with the "|DataDirectory|" + macro in a database file name. + + + The directory to use in place of the "|DataDirectory|" macro -OR- null if it + cannot be determined. + + Expand the filename of the data source, resolving the |DataDirectory| @@ -3450,8 +5148,42 @@ Retrieves schema information using the specified constraint(s) for the specified collection - The collection to retrieve - The restrictions to impose + The collection to retrieve. + + The restrictions to impose. Typically, this may include: + + + restrictionValues element index + usage + + + 0 + The database (or catalog) name, if applicable. + + + 1 + The schema name. This is not used by this provider. + + + 2 + The table name, if applicable. + + + 3 + + Depends on . + When "IndexColumns", it is the index name; otherwise, it is the column name. + + + + 4 + + Depends on . + When "IndexColumns", it is the column name; otherwise, it is not used. + + + + A DataTable of the specified collection @@ -3471,7 +5203,7 @@ Build a Columns schema The catalog (attached database) to query, can be null - The table to retrieve schema information for, must not be null + The table to retrieve schema information for, can be null The column to retrieve schema information for, can be null DataTable @@ -3536,400 +5268,21 @@ An optional foreign key name to restrict results on A DataTable with the results of the query - + - Static variable to store the connection event handlers to call. - - - - - This event is raised whenever the database is opened or closed. - - - - - This event is raised when events related to the lifecycle of a - SQLiteConnection object occur. - - - - - This property is used to obtain or set the custom connection pool - implementation to use, if any. Setting this property to null will - cause the default connection pool implementation to be used. - - - - - Returns the number of pool entries for the file name associated with this connection. - - - - - The connection string containing the parameters for the connection - - - - - Parameter - Values - Required - Default - - - Data Source - - This may be a file name, the string ":memory:", or any supported URI (starting with SQLite 3.7.7). - Starting with release 1.0.86.0, in order to use more than one consecutive backslash (e.g. for a - UNC path), each of the adjoining backslash characters must be doubled (e.g. "\\Network\Share\test.db" - would become "\\\\Network\Share\test.db"). - - Y - - - - Version - 3 - N - 3 - - - UseUTF16Encoding - True
False - N - False - - - DateTimeFormat - - Ticks - Use the value of DateTime.Ticks.
- ISO8601 - 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).
- JulianDay - The interval of time in days and fractions of a day since January 1, 4713 BC.
- UnixEpoch - The whole number of seconds since the Unix epoch (January 1, 1970).
- InvariantCulture - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime.
- CurrentCulture - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture. - N - ISO8601 - - - DateTimeKind - Unspecified - Not specified as either UTC or local time.
Utc - The time represented is UTC.
Local - The time represented is local time. - N - Unspecified - - - DateTimeFormatString - The exact DateTime format string to use for all formatting and parsing of all DateTime - values for this connection. - N - null - - - BaseSchemaName - 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. - N - sqlite_default_schema - - - BinaryGUID - True - Store GUID columns in binary form
False - Store GUID columns as text - N - True - - - Cache Size - {size in bytes} - N - 2000 - - - Synchronous - Normal - Normal file flushing behavior
Full - Full flushing after all writes
Off - Underlying OS flushes I/O's - N - Full - - - Page Size - {size in bytes} - N - 1024 - - - Password - {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. - N - - - - HexPassword - {hexPassword} - Must contain a sequence of zero or more hexadecimal encoded byte values without a leading "0x" prefix. 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. - N - - - - Enlist - Y - Automatically enlist in distributed transactions
N - No automatic enlistment - N - Y - - - Pooling - - True - Use connection pooling.
- False - Do not use connection pooling.

- WARNING: When using the default connection pool implementation, - setting this property to True should be avoided by applications that - make use of COM (either directly or indirectly) due to possible - deadlocks that can occur during the finalization of some COM objects. - - N - False - - - FailIfMissing - True - Don't create the database if it does not exist, throw an error instead
False - Automatically create the database if it does not exist - N - False - - - Max Page Count - {size in pages} - Limits the maximum number of pages (limits the size) of the database - N - 0 - - - Legacy Format - True - Use the more compatible legacy 3.x database format
False - Use the newer 3.3x database format which compresses numbers more effectively - N - False - - - Default Timeout - {time in seconds}
The default command timeout - N - 30 - - - Journal Mode - Delete - Delete the journal file after a commit
Persist - Zero out and leave the journal file on disk after a commit
Off - Disable the rollback journal entirely - N - Delete - - - Read Only - True - Open the database for read only access
False - Open the database for normal read/write access - N - False - - - Max Pool Size - The maximum number of connections for the given connection string that can be in the connection pool - N - 100 - - - Default IsolationLevel - The default transaciton isolation level - N - Serializable - - - Foreign Keys - Enable foreign key constraints - N - False - - - Flags - Extra behavioral flags for the connection. See the enumeration for possible values. - N - Default - - - SetDefaults - - True - Apply the default connection settings to the opened database.
- False - Skip applying the default connection settings to the opened database. - - N - True - - - ToFullPath - - True - Attempt to expand the data source file name to a fully qualified path before opening.
- False - Skip attempting to expand the data source file name to a fully qualified path before opening. - - N - True - - - - - - - Returns the data source file name without extension or path. - - - - - Returns the string "main". - - - - - 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" - - - - - Non-zero if the built-in (i.e. framework provided) connection string - parser should be used when opening the connection. - - - - - Gets/sets the extra behavioral flags for this connection. See the - enumeration for a list of - possible values. - - - - - Gets/sets the default database type for this connection. This value - will only be used when not null. - - - - - Gets/sets the default database type name for this connection. This - value will only be used when not null. - - - - - Returns non-zero if the underlying native connection handle is - owned by this instance. - - - - - Returns the version of the underlying SQLite database engine - - - - - Returns the rowid of the most recent successful INSERT into the database from this connection. - - - - - Returns the number of rows changed by the last INSERT, UPDATE, or DELETE statement executed on - this connection. - - - - - Returns non-zero if the given database connection is in autocommit mode. - Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN - statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK. - - - - - Returns the amount of memory (in bytes) currently in use by the SQLite core library. - - - - - Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset. - - - - - Returns a string containing the define constants (i.e. compile-time - options) used to compile the core managed assembly, delimited with - spaces. - - - - - Returns the version of the underlying SQLite core library. - - - - - 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. - - - - - Returns a string containing the compile-time options used to - compile the SQLite core native library, delimited with spaces. - - - - - This method returns the version of the interop SQLite assembly - used. If the SQLite interop assembly is not in use or the - necessary information cannot be obtained for any reason, a null - value may be returned. - - - - - This method returns the string whose value contains the unique - identifier for the source checkout used to build the interop - assembly. If the SQLite interop assembly is not in use or the - necessary information cannot be obtained for any reason, a null - value may be returned. - - - - - Returns a string containing the compile-time options used to - compile the SQLite interop assembly, delimited with spaces. - - - - - This method returns the version of the managed components used - to interact with the SQLite core library. If the necessary - information cannot be obtained for any reason, a null value may - be returned. - - - - - This method returns the string whose value contains the unique - identifier for the source checkout used to build the managed - components currently executing. If the necessary information - cannot be obtained for any reason, a null value may be returned. - - - - - The extra connection flags to be used for all opened connections. - - - - - Returns the state of the connection. + This event is raised periodically during long running queries. Changing + the value of the property will + determine if the operation in progress will continue or be interrupted. + For the entire duration of the event, the associated connection and + statement objects must not be modified, either directly or indirectly, by + the called code. This event is raised whenever SQLite encounters an action covered by the authorizer during query preparation. Changing the value of the - property will determine if + property will determine if the specific action will be allowed, ignored, or denied. For the entire duration of the event, the associated connection and statement objects must not be modified, either directly or indirectly, by the called code. @@ -3960,7 +5313,7 @@ - Returns the instance. + Returns the instance. @@ -3983,13 +5336,23 @@ Use the default operating system's file flushing, SQLite does not explicitly flush the file buffers after writing + + + Raised each time the number of virtual machine instructions is + approximately equal to the value of the + property. + + The connection performing the operation. + A that contains the + event data. + Raised when authorization is required to perform an action contained within a SQL query. The connection performing the action. - A that contains the + A that contains the event data. @@ -4048,6 +5411,38 @@ process, rolling back any changes that have been made so far. + + + The event data associated with progress reporting events. + + + + + The user-defined native data associated with this event. Currently, + this will always contain the value of . + + + + + The return code for the current call into the progress callback. + + + + + Constructs an instance of this class with default property values. + + + + + Constructs an instance of this class with specific property values. + + + The user-defined native data associated with this event. + + + The progress return code. + + The data associated with a call into the authorizer. @@ -4056,7 +5451,7 @@ The user-defined native data associated with this event. Currently, - this will always contain the value of . + this will always contain the value of . @@ -4068,7 +5463,7 @@ The first string argument for the current call into the authorizer. The exact value will vary based on the action code, see the - enumeration for possible + enumeration for possible values. @@ -4076,7 +5471,7 @@ The second string argument for the current call into the authorizer. The exact value will vary based on the action code, see the - enumeration for possible + enumeration for possible values. @@ -4286,6 +5681,44 @@ objects. + + + 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. + + + + + The queue of weak references to the actual database connection + handles. + + + + + This pool version associated with the database connection + handles in this pool queue. + + + + + The maximum size of this pool queue. + + + + + Constructs a connection pool queue using the specified version + and maximum size. Normally, all the database connection + handles in this pool are associated with a single database file + name. + + + The initial pool version for this connection pool queue. + + + The initial maximum size for this connection pool queue. + + This field is used to synchronize access to the private static data @@ -4429,44 +5862,6 @@ forces the resize to take one more than it needs from the pool. - - - 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. - - - - - The queue of weak references to the actual database connection - handles. - - - - - This pool version associated with the database connection - handles in this pool queue. - - - - - The maximum size of this pool queue. - - - - - Constructs a connection pool queue using the specified version - and maximum size. Normally, all the database connection - handles in this pool are associated with a single database file - name. - - - The initial pool version for this connection pool queue. - - - The initial maximum size for this connection pool queue. - - SQLite implementation of DbConnectionStringBuilder. @@ -4497,20 +5892,6 @@ The connection string to assign - - - Helper function for retrieving values from the connectionstring - - The keyword to retrieve settings for - The resulting parameter value - Returns true if the value was found and returned - - - - Fallback method for MONO, which doesn't implement DbConnectionStringBuilder.GetProperties() - - The hashtable to fill with property descriptors - Gets/Sets the default version of the SQLite engine to instantiate. Currently the only valid value is 3, indicating version 3 of the sqlite library. @@ -4554,10 +5935,40 @@ - Gets/sets the default command timeout for newly-created commands. This is especially useful for + 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. + + + Gets/sets the busy timeout to use with the SQLite core library. + + + + + EXPERIMENTAL -- + The wait timeout to use with + method. + This is only used when waiting for the enlistment to be reset + prior to enlisting in a transaction, and then only when the + appropriate connection flag is set. + + + + + Gets/sets the maximum number of retries when preparing SQL to be executed. + This normally only applies to preparation errors resulting from the database + schema being changed. + + + + + Gets/sets the approximate number of virtual machine instructions between + progress events. In order for progress events to actually fire, the event + handler must be added to the event + as well. + + Determines whether or not the connection will automatically participate @@ -4648,11 +6059,29 @@ Gets/sets the default type name for the connection. + + + Gets/sets the VFS name for the connection. + + If enabled, use foreign key constraints + + + Enable or disable the recursive trigger capability. + + + + + If non-null, this is the version of ZipVFS to use. This requires the + System.Data.SQLite interop assembly -AND- primary managed assembly to + be compiled with the INTEROP_INCLUDE_ZIPVFS option; otherwise, this + property does nothing. + + Gets/Sets the extra behavioral flags. @@ -4669,11 +6098,854 @@ full path before opening. + + + If enabled, skip using the configured default connection flags. + + If enabled, skip using the configured shared connection flags. + + + Helper function for retrieving values from the connectionstring + + The keyword to retrieve settings for + The resulting parameter value + Returns true if the value was found and returned + + + + Fallback method for MONO, which doesn't implement DbConnectionStringBuilder.GetProperties() + + The hashtable to fill with property descriptors + + + + This base class provides datatype conversion services for the SQLite provider. + + + + + This character is used to escape other characters, including itself, in + connection string property names and values. + + + + + This character can be used to wrap connection string property names and + values. Normally, it is optional; however, when used, it must be the + first -AND- last character of that connection string property name -OR- + value. + + + + + This character can be used to wrap connection string property names and + values. Normally, it is optional; however, when used, it must be the + first -AND- last character of that connection string property name -OR- + value. + + + + + The character is used to separate the name and value for a connection + string property. This character cannot be present in any connection + string property name. This character can be present in a connection + string property value; however, this should be avoided unless deemed + absolutely necessary. + + + + + This character is used to separate connection string properties. When + the "No_SQLiteConnectionNewParser" setting is enabled, this character + may not appear in connection string property names -OR- values. + + + + + These are the characters that are special to the connection string + parser. + + + + + The fallback default database type when one cannot be obtained from an + existing connection instance. + + + + + The fallback default database type name when one cannot be obtained from + an existing connection instance. + + + + + The value for the Unix epoch (e.g. January 1, 1970 at midnight, in UTC). + + + + + The value of the OLE Automation epoch represented as a Julian day. This + field cannot be removed as the test suite relies upon it. + + + + + The format string for DateTime values when using the InvariantCulture or CurrentCulture formats. + + + + + This is the minimum Julian Day value supported by this library + (148731163200000). + + + + + This is the maximum Julian Day value supported by this library + (464269060799000). + + + + + An array of ISO-8601 DateTime formats that we support parsing. + + + + + The internal default format for UTC DateTime values when converting + to a string. + + + + + The internal default format for local DateTime values when converting + to a string. + + + + + An UTF-8 Encoding instance, so we can convert strings to and from UTF-8 + + + + + The default DateTime format for this instance. + + + + + The default DateTimeKind for this instance. + + + + + The default DateTime format string for this instance. + + + + + Initializes the conversion class + + The default date/time format to use for this instance + The DateTimeKind to use. + The DateTime format string to use. + + + + Converts a string to a UTF-8 encoded byte array sized to include a null-terminating character. + + The string to convert to UTF-8 + A byte array containing the converted string plus an extra 0 terminating byte at the end of the array. + + + + Convert a DateTime to a UTF-8 encoded, zero-terminated byte array. + + + This function is a convenience function, which first calls ToString() on the DateTime, and then calls ToUTF8() with the + string result. + + The DateTime to convert. + The UTF-8 encoded string, including a 0 terminating byte at the end of the array. + + + + Converts a UTF-8 encoded IntPtr of the specified length into a .NET string + + The pointer to the memory where the UTF-8 string is encoded + The number of bytes to decode + A string containing the translated character(s) + + + + Converts a UTF-8 encoded IntPtr of the specified length into a .NET string + + The pointer to the memory where the UTF-8 string is encoded + The number of bytes to decode + A string containing the translated character(s) + + + + Checks if the specified is within the + supported range for a Julian Day value. + + + The Julian Day value to check. + + + Non-zero if the specified Julian Day value is in the supported + range; otherwise, zero. + + + + + Converts a Julian Day value from a to an + . + + + The Julian Day value to convert. + + + The resulting Julian Day value. + + + + + Converts a Julian Day value from an to a + . + + + The Julian Day value to convert. + + + The resulting Julian Day value. + + + + + Converts a Julian Day value to a . + This method was translated from the "computeYMD" function in the + "date.c" file belonging to the SQLite core library. + + + The Julian Day value to convert. + + + The value to return in the event that the + Julian Day is out of the supported range. If this value is null, + an exception will be thrown instead. + + + A value that contains the year, month, and + day values that are closest to the specified Julian Day value. + + + + + Converts a Julian Day value to a . + This method was translated from the "computeHMS" function in the + "date.c" file belonging to the SQLite core library. + + + The Julian Day value to convert. + + + The value to return in the event that the + Julian Day value is out of the supported range. If this value is + null, an exception will be thrown instead. + + + A value that contains the hour, minute, and + second, and millisecond values that are closest to the specified + Julian Day value. + + + + + Converts a to a Julian Day value. + This method was translated from the "computeJD" function in + the "date.c" file belonging to the SQLite core library. + Since the range of Julian Day values supported by this method + includes all possible (valid) values of a + value, it should be extremely difficult for this method to + raise an exception or return an undefined result. + + + The value to convert. This value + will be within the range of + (00:00:00.0000000, January 1, 0001) to + (23:59:59.9999999, December + 31, 9999). + + + The nearest Julian Day value corresponding to the specified + value. + + + + + Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, + and DateTimeFormatString specified for the connection when it was opened. + + + Acceptable ISO8601 DateTime formats are: + + THHmmssK + THHmmK + HH:mm:ss.FFFFFFFK + HH:mm:ssK + HH:mmK + yyyy-MM-dd HH:mm:ss.FFFFFFFK + yyyy-MM-dd HH:mm:ssK + yyyy-MM-dd HH:mmK + yyyy-MM-ddTHH:mm:ss.FFFFFFFK + yyyy-MM-ddTHH:mmK + yyyy-MM-ddTHH:mm:ssK + yyyyMMddHHmmssK + yyyyMMddHHmmK + yyyyMMddTHHmmssFFFFFFFK + THHmmss + THHmm + HH:mm:ss.FFFFFFF + HH:mm:ss + HH:mm + yyyy-MM-dd HH:mm:ss.FFFFFFF + yyyy-MM-dd HH:mm:ss + yyyy-MM-dd HH:mm + yyyy-MM-ddTHH:mm:ss.FFFFFFF + yyyy-MM-ddTHH:mm + yyyy-MM-ddTHH:mm:ss + yyyyMMddHHmmss + yyyyMMddHHmm + yyyyMMddTHHmmssFFFFFFF + yyyy-MM-dd + yyyyMMdd + yy-MM-dd + + If the string cannot be matched to one of the above formats -OR- + the DateTimeFormatString if one was provided, an exception will + be thrown. + + 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. + A DateTime value + + + + Converts a string into a DateTime, using the specified DateTimeFormat, + DateTimeKind and DateTimeFormatString. + + + Acceptable ISO8601 DateTime formats are: + + THHmmssK + THHmmK + HH:mm:ss.FFFFFFFK + HH:mm:ssK + HH:mmK + yyyy-MM-dd HH:mm:ss.FFFFFFFK + yyyy-MM-dd HH:mm:ssK + yyyy-MM-dd HH:mmK + yyyy-MM-ddTHH:mm:ss.FFFFFFFK + yyyy-MM-ddTHH:mmK + yyyy-MM-ddTHH:mm:ssK + yyyyMMddHHmmssK + yyyyMMddHHmmK + yyyyMMddTHHmmssFFFFFFFK + THHmmss + THHmm + HH:mm:ss.FFFFFFF + HH:mm:ss + HH:mm + yyyy-MM-dd HH:mm:ss.FFFFFFF + yyyy-MM-dd HH:mm:ss + yyyy-MM-dd HH:mm + yyyy-MM-ddTHH:mm:ss.FFFFFFF + yyyy-MM-ddTHH:mm + yyyy-MM-ddTHH:mm:ss + yyyyMMddHHmmss + yyyyMMddHHmm + yyyyMMddTHHmmssFFFFFFF + yyyy-MM-dd + yyyyMMdd + yy-MM-dd + + If the string cannot be matched to one of the above formats -OR- + the DateTimeFormatString if one was provided, an exception will + be thrown. + + 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. + The SQLiteDateFormats to use. + The DateTimeKind to use. + The DateTime format string to use. + A DateTime value + + + + Converts a julianday value into a DateTime + + The value to convert + A .NET DateTime + + + + Converts a julianday value into a DateTime + + The value to convert + The DateTimeKind to use. + A .NET DateTime + + + + Converts the specified number of seconds from the Unix epoch into a + value. + + + The number of whole seconds since the Unix epoch. + + + Either Utc or Local time. + + + The new value. + + + + + Converts the specified number of ticks since the epoch into a + value. + + + The number of whole ticks since the epoch. + + + Either Utc or Local time. + + + The new value. + + + + + Converts a DateTime struct to a JulianDay double + + The DateTime to convert + The JulianDay value the Datetime represents + + + + Converts a DateTime struct to the whole number of seconds since the + Unix epoch. + + The DateTime to convert + The whole number of seconds since the Unix epoch + + + + Returns the DateTime format string to use for the specified DateTimeKind. + If is not null, it will be returned verbatim. + + The DateTimeKind to use. + The DateTime format string to use. + + The DateTime format string to use for the specified DateTimeKind. + + + + + Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, + and DateTimeFormatString specified for the connection when it was opened. + + The DateTime value to convert + 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. + + + + Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, + and DateTimeFormatString specified for the connection when it was opened. + + The DateTime value to convert + The SQLiteDateFormats to use. + The DateTimeKind to use. + The DateTime format string to use. + 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. + + + + Internal function to convert a UTF-8 encoded IntPtr of the specified length to a DateTime. + + + 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. + + A pointer to the UTF-8 encoded string + The length in bytes of the string + The parsed DateTime value + + + + Smart method of splitting a string. Skips quoted elements, removes the quotes. + + + 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: + + Only one character can be provided as a separator character + Quoted text inside the string is skipped over when searching for the separator, and the quotes are removed. + + Thus, if splitting the following string looking for a comma:
+ One,Two, "Three, Four", Five
+
+ The resulting array would contain
+ [0] One
+ [1] Two
+ [2] Three, Four
+ [3] Five
+
+ Note that the leading and trailing spaces were removed from each item during the split. + + Source string to split apart + Separator character + A string array of the split up elements + + + + Splits the specified string into multiple strings based on a separator + and returns the result as an array of strings. + + + The string to split into pieces based on the separator character. If + this string is null, null will always be returned. If this string is + empty, an array of zero strings will always be returned. + + + The character used to divide the original string into sub-strings. + This character cannot be a backslash or a double-quote; otherwise, no + work will be performed and null will be returned. + + + If this parameter is non-zero, all double-quote characters will be + retained in the returned list of strings; otherwise, they will be + dropped. + + + Upon failure, this parameter will be modified to contain an appropriate + error message. + + + The new array of strings or null if the input string is null -OR- the + separator character is a backslash or a double-quote -OR- the string + contains an unbalanced backslash or double-quote character. + + + + + Queries and returns the string representation for an object, using the + specified (or current) format provider. + + + The object instance to return the string representation for. + + + The format provider to use -OR- null if the current format provider for + the thread should be used instead. + + + The string representation for the object instance -OR- null if the + object instance is also null. + + + + + Attempts to convert an arbitrary object to the Boolean data type. + Null object values are converted to false. Throws an exception + upon failure. + + + The object value to convert. + + + The format provider to use. + + + If non-zero, a string value will be converted using the + + method; otherwise, the + method will be used. + + + The converted boolean value. + + + + + Convert a value to true or false. + + A string or number representing true or false + + + + + Converts an integer to a string that can be round-tripped using the + invariant culture. + + + The integer value to return the string representation for. + + + The string representation of the specified integer value, using the + invariant culture. + + + + + Attempts to convert a into a . + + + The to convert, cannot be null. + + + The converted value. + + + The supported strings are "yes", "no", "y", "n", "on", "off", "0", "1", + as well as any prefix of the strings + and . All strings are treated in a + case-insensitive manner. + + + + + Converts a SQLiteType to a .NET Type object + + The SQLiteType to convert + Returns a .NET Type object + + + + For a given intrinsic type, return a DbType + + The native type to convert + The corresponding (closest match) DbType + + + + Returns the ColumnSize for the given DbType + + The DbType to get the size of + + + + + Determines the default database type name to be used when a + per-connection value is not available. + + + The connection context for type mappings, if any. + + + The default database type name to use. + + + + + If applicable, issues a trace log message warning about falling back to + the default database type name. + + + The database value type. + + + The flags associated with the parent connection object. + + + The textual name of the database type. + + + + + If applicable, issues a trace log message warning about falling back to + the default database value type. + + + The textual name of the database type. + + + The flags associated with the parent connection object. + + + The database value type. + + + + + For a given database value type, return the "closest-match" textual database type name. + + The connection context for custom type mappings, if any. + The database value type. + The flags associated with the parent connection object. + The type name or an empty string if it cannot be determined. + + + + Convert a DbType to a Type + + The DbType to convert from + The closest-match .NET type + + + + For a given type, return the closest-match SQLite TypeAffinity, which only understands a very limited subset of types. + + The type to evaluate + The flags associated with the connection. + The SQLite type affinity for that type. + + + + Builds and returns a map containing the database column types + recognized by this provider. + + + A map containing the database column types recognized by this + provider. + + + + + Determines if a database type is considered to be a string. + + + The database type to check. + + + Non-zero if the database type is considered to be a string, zero + otherwise. + + + + + Determines and returns the runtime configuration setting string that + should be used in place of the specified object value. + + + The object value to convert to a string. + + + Either the string to use in place of the object value -OR- null if it + cannot be determined. + + + + + Determines the default value to be used when a + per-connection value is not available. + + + The connection context for type mappings, if any. + + + The default value to use. + + + + + Converts the object value, which is assumed to have originated + from a , to a string value. + + + The value to be converted to a string. + + + A null value will be returned if the original value is null -OR- + the original value is . Otherwise, + the original value will be converted to a string, using its + (possibly overridden) method and + then returned. + + + + + Determines if the specified textual value appears to be a + value. + + + The textual value to inspect. + + + Non-zero if the text looks like a value, + zero otherwise. + + + + + Determines if the specified textual value appears to be an + value. + + + The textual value to inspect. + + + Non-zero if the text looks like an value, + zero otherwise. + + + + + Determines if the specified textual value appears to be a + value. + + + The textual value to inspect. + + + Non-zero if the text looks like a value, + zero otherwise. + + + + + Determines if the specified textual value appears to be a + value. + + + The object instance configured with + the chosen format. + + + The textual value to inspect. + + + Non-zero if the text looks like a in the + configured format, zero otherwise. + + + + + For a given textual database type name, return the "closest-match" database type. + This method is called during query result processing; therefore, its performance + is critical. + + The connection context for custom type mappings, if any. + The textual name of the database type to match. + The flags associated with the parent connection object. + The .NET DBType the text evaluates to. + SQLite has very limited types, and is inherently text-based. The first 5 types below represent the sum of all types SQLite @@ -4723,9 +6995,9 @@ These are the event types associated with the - + delegate (and its corresponding event) and the - class. + class. @@ -4755,7 +7027,7 @@ - The method was called on the + The method was called on the connection. @@ -4781,7 +7053,7 @@ - An instance of a derived class has + An instance of a derived class has been created to wrap a native resource. @@ -4810,6 +7082,16 @@ A data reader is being closed. + + + A native resource was opened (i.e. obtained) from the pool. + + + + + A native resource was closed (i.e. released) to the pool. + + This implementation of SQLite for ADO.NET can process date/time fields in @@ -4963,7 +7245,7 @@ The requested command execution type. This controls which method of the - object will be called. + object will be called. @@ -4974,31 +7256,31 @@ The command is not expected to return a result -OR- the result is not - needed. The or - method + needed. The or + method will be called. The command is expected to return a scalar result -OR- the result should - be limited to a scalar result. The - or method will + be limited to a scalar result. The + or method will be called. - The command is expected to return result. - The or - method will + The command is expected to return result. + The or + method will be called. Use the default command execution type. Using this value is the same - as using the value. + as using the value. @@ -5218,6 +7500,21 @@ are two null values. + + + The possible return codes for the progress callback. + + + + + The operation should continue. + + + + + The operation should be interrupted. + + The return code for the current call into the authorizer. @@ -5337,6 +7634,24 @@ framework provided) parser when opening the connection. + + + Cleans up resources (native and managed) associated with the current instance. + + + Zero when being disposed via garbage collection; otherwise, non-zero. + + + + + Row updating event handler + + + + + Row updated event handler + + Raised by the underlying DbDataAdapter when a row is being updated @@ -5349,16 +7664,6 @@ The event's specifics - - - Row updating event handler - - - - - Row updated event handler - - Gets/sets the select command for this DataAdapter @@ -5505,12 +7810,37 @@ Returns a DbEnumerator object. + + + Not implemented. Returns 0 + + + + + Returns the number of columns in the current resultset + + Forces the connection flags cached by this data reader to be refreshed from the underlying connection. + + + Returns the number of rows seen so far in the current result set. + + + + + Returns the number of visible fields in the current resultset + + + + + This method is used to make sure the result set is open and a row is currently available. + + SQLite is inherently un-typed. All datatypes in SQLite are natively strings. The definition of the columns of a table @@ -5526,25 +7856,74 @@ The index of the column to type-check The type we want to get out of the column + + + Invokes the data reader value callback configured for the database + type name associated with the specified column. If no data reader + value callback is available for the database type name, do nothing. + + + The index of the column being read. + + + The extra event data to pass into the callback. + + + Non-zero if the default handling for the data reader call should be + skipped. If this is set to non-zero and the necessary return value + is unavailable or unsuitable, an exception will be thrown. + + + + + Attempts to query the integer identifier for the current row. This + will not work for tables that were created WITHOUT ROWID -OR- if the + query does not include the "rowid" column or one of its aliases -OR- + if the was not created with the + flag. + + + The index of the BLOB column. + + + The integer identifier for the current row -OR- null if it could not + be determined. + + + + + Retrieves the column as a object. + This will not work for tables that were created WITHOUT ROWID + -OR- if the query does not include the "rowid" column or one + of its aliases -OR- if the was + not created with the + flag. + + The index of the column. + + Non-zero to open the blob object for read-only access. + + A new object. + Retrieves the column as a boolean value - The index of the column to retrieve + The index of the column. bool Retrieves the column as a single byte value - The index of the column to retrieve + The index of the column. byte Retrieves a column as an array of bytes (blob) - The index of the column to retrieve + The index of the column. The zero-based index of where to begin reading the data The buffer to write the bytes into The zero-based index of where to begin writing into the array @@ -5558,14 +7937,14 @@ Returns the column as a single character - The index of the column to retrieve + The index of the column. char Retrieves a column as an array of chars (blob) - The index of the column to retrieve + The index of the column. The zero-based index of where to begin reading the data The buffer to write the characters into The zero-based index of where to begin writing into the array @@ -5579,77 +7958,111 @@ Retrieves the name of the back-end datatype of the column - The index of the column to retrieve + The index of the column. string Retrieve the column as a date/time value - The index of the column to retrieve + The index of the column. DateTime Retrieve the column as a decimal value - The index of the column to retrieve + The index of the column. decimal Returns the column as a double - The index of the column to retrieve + The index of the column. double + + + Determines and returns the of the + specified column. + + + The index of the column. + + + The associated with the specified + column, if any. + + Returns the .NET type of a given column - The index of the column to retrieve + The index of the column. Type Returns a column as a float value - The index of the column to retrieve + The index of the column. float Returns the column as a Guid - The index of the column to retrieve + The index of the column. Guid Returns the column as a short - The index of the column to retrieve + The index of the column. Int16 Retrieves the column as an int - The index of the column to retrieve + The index of the column. Int32 Retrieves the column as a long - The index of the column to retrieve + The index of the column. Int64 Retrieves the name of the column - The index of the column to retrieve + The index of the column. + string + + + + Returns the name of the database associated with the specified column. + + The index of the column. + string + + + + Returns the name of the table associated with the specified column. + + The index of the column. + string + + + + Returns the original name of the specified column. + + The index of the column. string @@ -5670,14 +8083,14 @@ Retrieves the column as a string - The index of the column to retrieve + The index of the column. string Retrieves the column as an object corresponding to the underlying datatype of the column - The index of the column to retrieve + The index of the column. object @@ -5699,11 +8112,21 @@ cannot be obtained. + + + Returns True if the resultset has rows that can be fetched + + + + + Returns True if the data reader is closed + + Returns True if the specified column is null - The index of the column to retrieve + The index of the column. True or False @@ -5741,7 +8164,7 @@ Retrieves the SQLiteType for a given column, and caches it to avoid repetetive interop calls. The flags associated with the parent connection object. - The index of the column to retrieve + The index of the column. A SQLiteType structure @@ -5750,39 +8173,14 @@ True if a new row was successfully loaded and is ready for processing - - - Not implemented. Returns 0 - - - - - Returns the number of columns in the current resultset - - - - - Returns the number of rows seen so far in the current result set. - - - - - Returns the number of visible fields in the current resultset - - - - - Returns True if the resultset has rows that can be fetched - - - - - Returns True if the data reader is closed - - - Retrieve the count of records affected by an update/insert command. Only valid once the data reader is closed! + Returns the number of rows affected by the statement being executed. + The value returned may not be accurate for DDL statements. Also, it + will be -1 for any statement that does not modify the database (e.g. + SELECT). If an otherwise read-only statement modifies the database + indirectly (e.g. via a virtual table or user-defined function), the + value returned is undefined. @@ -5796,7 +8194,7 @@ Indexer to retrieve data from a column given its i - The index of the column to retrieve + The index of the column. The value contained in the column @@ -5804,6 +8202,12 @@ SQLite exception class. + + + This value was copied from the "WinError.h" file included with the + Platform SDK for Windows 10. + + Private constructor for use with serialization. @@ -5859,6 +8263,59 @@ Contains contextual information about the source or destination. + + + Gets the associated SQLite result code for this exception as a + . This property returns the same + underlying value as the property. + + + + + Gets the associated SQLite return code for this exception as an + . For desktop versions of the .NET Framework, + this property overrides the property of the same name within the + + class. This property returns the same underlying value as the + property. + + + + + This method performs extra initialization tasks. It may be called by + any of the constructors of this class. It must not throw exceptions. + + + + + Maps a Win32 error code to an HRESULT. + + + The specified Win32 error code. It must be within the range of zero + (0) to 0xFFFF (65535). + + + Non-zero if the HRESULT should indicate success; otherwise, zero. + + + The integer value of the HRESULT. + + + + + Attempts to map the specified onto an + existing HRESULT -OR- a Win32 error code wrapped in an HRESULT. The + mappings may not have perfectly matching semantics; however, they do + have the benefit of being unique within the context of this exception + type. + + + The to map. + + + The integer HRESULT value -OR- null if there is no known mapping. + + Returns the error message for the specified SQLite return code. @@ -5875,23 +8332,6 @@ Optional detailed error message. Error message text for the return code. - - - Gets the associated SQLite result code for this exception as a - . This property returns the same - underlying value as the property. - - - - - Gets the associated SQLite return code for this exception as an - . For desktop versions of the .NET Framework, - this property overrides the property of the same name within the - - class. This property returns the same underlying value as the - property. - - SQLite error codes. Actually, this enumeration represents a return code, @@ -6066,12 +8506,339 @@ Used to mask off extended result codes + + + A collation sequence was referenced by a schema and it cannot be + found. + + + + + An internal operation failed and it may succeed if retried. + + + + + A file read operation failed. + + + + + A file read operation returned less data than requested. + + + + + A file write operation failed. + + + + + A file synchronization operation failed. + + + + + A directory synchronization operation failed. + + + + + A file truncate operation failed. + + + + + A file metadata operation failed. + + + + + A file unlock operation failed. + + + + + A file lock operation failed. + + + + + A file delete operation failed. + + + + + Not currently used. + + + + + Out-of-memory during a file operation. + + + + + A file existence/status operation failed. + + + + + A check for a reserved lock failed. + + + + + A file lock operation failed. + + + + + A file close operation failed. + + + + + A directory close operation failed. + + + + + A shared memory open operation failed. + + + + + A shared memory size operation failed. + + + + + A shared memory lock operation failed. + + + + + A shared memory map operation failed. + + + + + A file seek operation failed. + + + + + A file delete operation failed because it does not exist. + + + + + A file memory mapping operation failed. + + + + + The temporary directory path could not be obtained. + + + + + A path string conversion operation failed. + + + + + Reserved. + + + + + An attempt to authenticate failed. + + + + + An attempt to begin a file system transaction failed. + + + + + An attempt to commit a file system transaction failed. + + + + + An attempt to rollback a file system transaction failed. + + + + + A database table is locked in shared-cache mode. + + + + + A virtual table in the database is locked. + + + + + A database file is locked due to a recovery operation. + + + + + A database file is locked due to snapshot semantics. + + + + + A database file cannot be opened because no temporary directory is available. + + + + + A database file cannot be opened because its path represents a directory. + + + + + A database file cannot be opened because its full path could not be obtained. + + + + + A database file cannot be opened because a path string conversion operation failed. + + + + + A virtual table is malformed. + + + + + A required sequence table is missing or corrupt. + + + + + A database file is read-only due to a recovery operation. + + + + + A database file is read-only because a lock could not be obtained. + + + + + A database file is read-only because it needs rollback processing. + + + + + A database file is read-only because it was moved while open. + + + + + The shared-memory file is read-only and it should be read-write. + + + + + Unable to create journal file because the directory is read-only. + + + + + An operation is being aborted due to rollback processing. + + + + + A CHECK constraint failed. + + + + + A commit hook produced a unsuccessful return code. + + + + + A FOREIGN KEY constraint failed. + + + + + Not currently used. + + + + + A NOT NULL constraint failed. + + + + + A PRIMARY KEY constraint failed. + + + + + The RAISE function was used by a trigger-program. + + + + + A UNIQUE constraint failed. + + + + + Not currently used. + + + + + A ROWID constraint failed. + + + + + Frames were recovered from the WAL log file. + + + + + Pages were recovered from the journal file. + + + + + An automatic index was created to process a query. + + + + + User authentication failed. + + + + + Success. Prevents the extension from unloading until the process + terminates. + + - SQLite implementation of . + SQLite implementation of . - SQLite implementation of . + SQLite implementation of . @@ -6079,62 +8846,72 @@ Constructs a new instance. - + - Static instance member which returns an instanced class. + Cleans up resources (native and managed) associated with the current instance. - + - Creates and returns a new object. + Cleans up resources associated with the current instance. - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Will provide a object in .NET 3.5. - - The class or interface type to query for. - This event is raised whenever SQLite raises a logging event. Note that this should be set as one of the first things in the application. This event is provided for backward compatibility only. - New code should use the class instead. + New code should use the class instead. + + + Static instance member which returns an instanced class. + + + + + Creates and returns a new object. + + The new object. + + + + Creates and returns a new object. + + The new object. + + + + Creates and returns a new object. + + The new object. + + + + Creates and returns a new object. + + The new object. + + + + Creates and returns a new object. + + The new object. + + + + Creates and returns a new object. + + The new object. + + + + Will provide a object in .NET 3.5. + + The class or interface type to query for. + + This abstract class is designed to handle user-defined functions easily. An instance of the derived class is made for each @@ -6186,7 +8963,7 @@ - Holds a reference to the callback function for collation sequences + Holds a reference to the callback function for collating sequences @@ -6196,7 +8973,9 @@ - This static list contains all the user-defined functions declared using the proper attributes. + This static dictionary contains all the registered (known) user-defined + functions declared using the proper attributes. The contained dictionary + values are always null and are not currently used. @@ -6214,7 +8993,7 @@ DateTime and binding DateTime parameters. - The to be used when creating DateTime + The to be used when creating DateTime values. @@ -6238,6 +9017,17 @@ True if the object is being disposed explicitly + + + Cleans up resources associated with the current instance. + + + + + 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. + + Scalar functions override this method to do their magic. @@ -6283,11 +9073,11 @@ - User-defined collation sequences override this method to provide a custom string sorting algorithm. + User-defined collating sequences override this method to provide a custom string sorting algorithm. - The first string to compare - The second strnig to compare - 1 if param1 is greater than param2, 0 if they are equal, or -1 if param1 is less than param2 + The first string to compare. + The second strnig to compare. + 1 if param1 is greater than param2, 0 if they are equal, or -1 if param1 is less than param2. @@ -6320,7 +9110,7 @@ - Internal collation sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. + Internal collating sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. WARNING: Must not throw exceptions. Not used @@ -6333,7 +9123,7 @@ - Internal collation sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. + Internal collating sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. WARNING: Must not throw exceptions. Not used @@ -6378,9 +9168,74 @@ The type of the function to register + + + Alternative method of registering a function. This method + does not require the specified type to be annotated with + . + + + The name of the function to register. + + + The number of arguments accepted by the function. + + + The type of SQLite function being resitered (e.g. scalar, + aggregate, or collating sequence). + + + The that actually implements the function. + This will only be used if the + and parameters are null. + + + The to be used for all calls into the + , + , + and virtual methods. + + + The to be used for all calls into the + virtual method. This + parameter is only necessary for aggregate functions. + + + + + Replaces a registered function, disposing of the associated (old) + value if necessary. + + + The attribute that describes the function to replace. + + + The new value to use. + + + Non-zero if an existing registered function was replaced; otherwise, + zero. + + + + + Creates a instance based on the specified + . + + + The containing the metadata about + the function to create. + + + The created function -OR- null if the function could not be created. + + + Non-zero if the function was created; otherwise, zero. + + - Called by SQLiteBase derived classes, this function binds all user-defined functions to a connection. + Called by the SQLiteBase derived classes, this method binds all registered (known) 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). @@ -6388,17 +9243,30 @@ 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. - The base object on which the functions are to bind - The flags associated with the parent connection object + The base object on which the functions are to bind. + The flags associated with the parent connection object. Returns a logical list of functions which the connection should retain until it is closed. + + + Called by the SQLiteBase derived classes, this method unbinds all registered (known) + functions -OR- all previously bound user-defined functions from a connection. + + The base object from which the functions are to be unbound. + The flags associated with the parent connection object. + + Non-zero to unbind all registered (known) functions -OR- zero to unbind all functions + currently bound to the connection. + + Non-zero if all the specified user-defined functions were unbound. + - This function binds a user-defined functions to a connection. + This function binds a user-defined function to a connection. - The object instance associated with the - that the function should be bound to. + The object instance associated with the + that the function should be bound to. The object instance containing @@ -6412,11 +9280,331 @@ The flags associated with the parent connection object. - + - 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. + This function unbinds a user-defined functions from a connection. + + The object instance associated with the + that the function should be bound to. + + + The object instance containing + the metadata for the function to be bound. + + + The object instance that implements the + function to be bound. + + + The flags associated with the parent connection object. + + Non-zero if the function was unbound. + + + + This type is used with the + method. + + + This is always the string literal "Invoke". + + + The arguments for the scalar function. + + + The result of the scalar function. + + + + + This type is used with the + method. + + + This is always the string literal "Step". + + + The arguments for the aggregate function. + + + The step number (one based). This is incrememted each time the + method is called. + + + A placeholder for implementers to store contextual data pertaining + to the current context. + + + + + This type is used with the + method. + + + This is always the string literal "Final". + + + A placeholder for implementers to store contextual data pertaining + to the current context. + + + The result of the aggregate function. + + + + + This type is used with the + method. + + + This is always the string literal "Compare". + + + The first string to compare. + + + The second strnig to compare. + + + A positive integer if the parameter is + greater than the parameter, a negative + integer if the parameter is less than + the parameter, or zero if they are + equal. + + + + + This class implements a SQLite function using a . + All the virtual methods of the class are + implemented using calls to the , + , , + and strongly typed delegate types + or via the method. + The arguments are presented in the same order they appear in + the associated methods with one exception: + the first argument is the name of the virtual method being implemented. + + + + + This error message is used by the overridden virtual methods when + a required property (e.g. + or ) has not been + set. + + + + + This error message is used by the overridden + method when the result does not have a type of . + + + + + Constructs an empty instance of this class. + + + + + Constructs an instance of this class using the specified + as the + implementation. + + + The to be used for all calls into the + , , and + virtual methods needed by the + base class. + + + The to be used for all calls into the + virtual methods needed by the + base class. + + + + + Returns the list of arguments for the method, + as an of . The first + argument is always the literal string "Invoke". + + + The original arguments received by the method. + + + Non-zero if the returned arguments are going to be used with the + type; otherwise, zero. + + + The arguments to pass to the configured . + + + + + Returns the list of arguments for the method, + as an of . The first + argument is always the literal string "Step". + + + The original arguments received by the method. + + + The step number (one based). This is incrememted each time the + method is called. + + + A placeholder for implementers to store contextual data pertaining + to the current context. + + + Non-zero if the returned arguments are going to be used with the + type; otherwise, zero. + + + The arguments to pass to the configured . + + + + + Updates the output arguments for the method, + using an of . The first + argument is always the literal string "Step". Currently, only the + parameter is updated. + + + The original arguments received by the method. + + + A placeholder for implementers to store contextual data pertaining + to the current context. + + + Non-zero if the returned arguments are going to be used with the + type; otherwise, zero. + + + The arguments to pass to the configured . + + + + + Returns the list of arguments for the method, + as an of . The first + argument is always the literal string "Final". + + + A placeholder for implementers to store contextual data pertaining + to the current context. + + + Non-zero if the returned arguments are going to be used with the + type; otherwise, zero. + + + The arguments to pass to the configured . + + + + + Returns the list of arguments for the method, + as an of . The first + argument is always the literal string "Compare". + + + The first string to compare. + + + The second strnig to compare. + + + Non-zero if the returned arguments are going to be used with the + type; otherwise, zero. + + + The arguments to pass to the configured . + + + + + The to be used for all calls into the + , , and + virtual methods needed by the + base class. + + + + + The to be used for all calls into the + virtual methods needed by the + base class. + + + + + This virtual method is the implementation for scalar functions. + See the method for more + details. + + + The arguments for the scalar function. + + + The result of the scalar function. + + + + + This virtual method is part of the implementation for aggregate + functions. See the method + for more details. + + + The arguments for the aggregate function. + + + The step number (one based). This is incrememted each time the + method is called. + + + A placeholder for implementers to store contextual data pertaining + to the current context. + + + + + This virtual method is part of the implementation for aggregate + functions. See the method + for more details. + + + A placeholder for implementers to store contextual data pertaining + to the current context. + + + The result of the aggregate function. + + + + + This virtual method is part of the implementation for collating + sequences. See the method + for more details. + + + The first string to compare. + + + The second strnig to compare. + + + A positive integer if the parameter is + greater than the parameter, a negative + integer if the parameter is less than + the parameter, or zero if they are + equal. + @@ -6432,6 +9620,14 @@ + + + Cleans up resources (native and managed) associated with the current instance. + + + Zero when being disposed via garbage collection; otherwise, non-zero. + + The type of user-defined function to declare @@ -6450,7 +9646,7 @@ - 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 + Collating 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. @@ -6471,7 +9667,7 @@ - Internal callback delegate for implementing collation sequences + Internal callback delegate for implementing collating sequences Not used Length of the string pv1 @@ -6580,7 +9776,9 @@ - Constructs an instance of this class. + Constructs an instance of this class. This sets the initial + , , and + properties to null. The name of the function, as seen by the SQLite core library. @@ -6610,8 +9808,24 @@ - The object instance that describes the class - containing the implementation for the associated function. + The object instance that describes the class + containing the implementation for the associated function. The value of + this property will not be used if either the or + property values are set to non-null. + + + + + The that refers to the implementation for the + associated function. If this property value is set to non-null, it will + be used instead of the property value. + + + + + The that refers to the implementation for the + associated function. If this property value is set to non-null, it will + be used instead of the property value. @@ -6622,6 +9836,21 @@ + + + Used to support CommandBehavior.KeyInfo + + + + + Used to keep track of the per-table RowId column metadata. + + + + + A single sub-query for a given table/database. + + This function does all the nasty work at determining what keys need to be returned for @@ -6631,6 +9860,11 @@ + + + How many additional columns of keyinfo we're holding + + Make sure all the subqueries are open and ready and sync'd with the current rowid @@ -6648,21 +9882,6 @@ - - - How many additional columns of keyinfo we're holding - - - - - Used to support CommandBehavior.KeyInfo - - - - - A single sub-query for a given table/database. - - Event data for logging event handlers. @@ -6671,7 +9890,7 @@ The error code. The type of this object value should be - or . + or . @@ -6691,7 +9910,7 @@ Should be null. The error code. The type of this object value should be - or . + or . The error message, if any. The extra data, if any. @@ -6720,6 +9939,11 @@ Member variable to store the AppDomain.DomainUnload event handler. + + + Member variable to store the application log handler to call. + + The default log event handler. @@ -6736,6 +9960,20 @@ The base SQLite object to interop with. + + + The number of times that the + has been called when the logging subystem was actually eligible + to be initialized (i.e. without the "No_SQLiteLog" environment + variable being set). + + + + + This will be non-zero if an attempt was already made to initialize + the (managed) logging subsystem. + + This will be non-zero if logging is currently enabled. @@ -6746,6 +9984,15 @@ Initializes the SQLite logging facilities. + + + Initializes the SQLite logging facilities. + + + The name of the managed class that called this method. This + parameter may be null. + + Handles the AppDomain being unloaded. @@ -6753,6 +10000,19 @@ Should be null. The data associated with this event. + + + This event is raised whenever SQLite raises a logging event. + Note that this should be set as one of the first things in the + application. + + + + + If this property is true, logging is enabled; otherwise, logging is + disabled. When logging is disabled, no logging events will fire. + + Log a message to all the registered log event handlers without going @@ -6828,24 +10088,6 @@ Should be null. The data associated with this event. - - - Member variable to store the application log handler to call. - - - - - This event is raised whenever SQLite raises a logging event. - Note that this should be set as one of the first things in the - application. - - - - - If this property is true, logging is enabled; otherwise, logging is - disabled. When logging is disabled, no logging events will fire. - - MetaDataCollections specific to SQLite @@ -6901,6 +10143,16 @@ SQLite implementation of DbParameter. + + + This value represents an "unknown" . + + + + + The command associated with this parameter. + + The data type of the parameter @@ -6931,6 +10183,19 @@ The data size, unused by SQLite + + + The database type name associated with this parameter, if any. + + + + + Constructor used when creating for use with a specific command. + + + The command associated with this parameter. + + Default constructor @@ -7082,17 +10347,11 @@ The source column The row version information - + - Resets the DbType of the parameter so it can be inferred from the value + The command associated with this parameter. - - - Clones a parameter - - A new, unassociated SQLiteParameter - Whether or not the parameter can contain a null value @@ -7113,6 +10372,11 @@ Returns the parameter name + + + Resets the DbType of the parameter so it can be inferred from the value + + Returns the size of the parameter @@ -7138,6 +10402,17 @@ Gets and sets the parameter value. If no datatype was specified, the datatype will assume the type from the value given. + + + The database type name associated with this parameter, if any. + + + + + Clones a parameter + + A new, unassociated SQLiteParameter + SQLite implementation of DbParameterCollection. @@ -7164,6 +10439,26 @@ The command to which the collection belongs + + + Returns false + + + + + Returns false + + + + + Returns false + + + + + Returns null + + Retrieves an enumerator for the collection @@ -7257,6 +10552,25 @@ + + + Returns a count of parameters in the collection + + + + + Overloaded to specialize the return value of the default indexer + + Name of the parameter to get/set + The specified named SQLite parameter + + + + Overloaded to specialize the return value of the default indexer + + The index of the parameter to get/set + The specified SQLite parameter + Retrieve a parameter by name from the collection @@ -7336,45 +10650,6 @@ to the same named parameter. Unnamed parameters are bound in sequence. - - - Returns false - - - - - Returns false - - - - - Returns false - - - - - Returns null - - - - - Returns a count of parameters in the collection - - - - - Overloaded to specialize the return value of the default indexer - - Name of the parameter to get/set - The specified named SQLite parameter - - - - Overloaded to specialize the return value of the default indexer - - The index of the parameter to get/set - The specified SQLite parameter - Represents a single SQL statement in SQLite. @@ -7435,7 +10710,7 @@ Disposes and finalizes the statement - + If the underlying database connection is open, fetches the number of changed rows resulting from the most recent query; otherwise, does nothing. @@ -7444,6 +10719,10 @@ The number of changes when true is returned. Undefined if false is returned. + + The read-only flag when true is returned. + Undefined if false is returned. + Non-zero if the number of changed rows was fetched. @@ -7459,6 +10738,36 @@ Bind all parameters, making sure the caller didn't miss any + + + This method attempts to query the database connection associated with + the statement in use. If the underlying command or connection is + unavailable, a null value will be returned. + + + The connection object -OR- null if it is unavailable. + + + + + Invokes the parameter binding callback configured for the database + type name associated with the specified column. If no parameter + binding callback is available for the database type name, do + nothing. + + + The index of the column being read. + + + The instance being bound to the + command. + + + Non-zero if the default handling for the parameter binding call + should be skipped (i.e. the parameter should not be bound at all). + Great care should be used when setting this to non-zero. + + Perform the bind operation for an individual parameter @@ -7468,12 +10777,7 @@ - SQLite implementation of DbTransaction. - - - - - The connection to which this transaction is bound + SQLite implementation of DbTransaction that does not support nested transactions. @@ -7493,24 +10797,633 @@ Commits the current transaction. - + - Rolls back the active transaction. + Attempts to start a transaction. An exception will be thrown if the transaction cannot + be started for any reason. + + TRUE to defer the writelock, or FALSE to lock immediately + + + + Issue a ROLLBACK command against the database connection, + optionally re-throwing any caught exception. + + + Non-zero to re-throw caught exceptions. + + + + + SQLite implementation of DbTransaction that does support nested transactions. - + + + The original transaction level for the associated connection + when this transaction was created (i.e. begun). + + + + + The SAVEPOINT name for this transaction, if any. This will + only be non-null if this transaction is a nested one. + + + + + Constructs the transaction object, binding it to the supplied connection + + The connection to open a transaction on + TRUE to defer the writelock, or FALSE to lock immediately + + + + Disposes the transaction. If it is currently active, any changes are rolled back. + + + + + Commits the current transaction. + + + + + Attempts to start a transaction. An exception will be thrown if the transaction cannot + be started for any reason. + + TRUE to defer the writelock, or FALSE to lock immediately + + + + Issue a ROLLBACK command against the database connection, + optionally re-throwing any caught exception. + + + Non-zero to re-throw caught exceptions. + + + + + Constructs the name of a new savepoint for this transaction. It + should only be called from the constructor of this class. + + + The name of the new savepoint -OR- null if it cannot be constructed. + + + + + Base class used by to implement DbTransaction for SQLite. + + + + + The connection to which this transaction is bound. + + + + + Matches the version of the connection. + + + + + The isolation level for this transaction. + + + + + Constructs the transaction object, binding it to the supplied connection + + The connection to open a transaction on + TRUE to defer the writelock, or FALSE to lock immediately + + + + Gets the isolation level of the transaction. SQLite only supports Serializable transactions. + + + + + Disposes the transaction. If it is currently active, any changes are rolled back. + + + Returns the underlying connection to which this transaction applies. - + Forwards to the local Connection property - + - Gets the isolation level of the transaction. SQLite only supports Serializable transactions. + Rolls back the active transaction. + + + + + Attempts to start a transaction. An exception will be thrown if the transaction cannot + be started for any reason. + + TRUE to defer the writelock, or FALSE to lock immediately + + + + Issue a ROLLBACK command against the database connection, + optionally re-throwing any caught exception. + + + Non-zero to re-throw caught exceptions. + + + + + Checks the state of this transaction, optionally throwing an exception if a state + inconsistency is found. + + + Non-zero to throw an exception if a state inconsistency is found. + + + Non-zero if this transaction is valid; otherwise, false. + + + + + This static class provides some methods that are shared between the + native library pre-loader and other classes. + + + + + This lock is used to protect the static and + fields. + + + + + This type is only present when running on Mono. + + + + + This type is only present when running on .NET Core. + + + + + Keeps track of whether we are running on Mono. Initially null, it is + set by the method on its first call. Later, it + is returned verbatim by the method. + + + + + Keeps track of whether we are running on .NET Core. Initially null, + it is set by the method on its first + call. Later, it is returned verbatim by the + method. + + + + + Keeps track of whether we successfully invoked the + method. Initially null, it is set by + the method on its first call. + + + + + Determines the ID of the current process. Only used for debugging. + + + The ID of the current process -OR- zero if it cannot be determined. + + + + + Determines whether or not this assembly is running on Mono. + + + Non-zero if this assembly is running on Mono. + + + + + Determines whether or not this assembly is running on .NET Core. + + + Non-zero if this assembly is running on .NET Core. + + + + + Resets the cached value for the "PreLoadSQLite_BreakIntoDebugger" + configuration setting. + + + + + If the "PreLoadSQLite_BreakIntoDebugger" configuration setting is + present (e.g. via the environment), give the interactive user an + opportunity to attach a debugger to the current process; otherwise, + do nothing. + + + + + Determines the ID of the current thread. Only used for debugging. + + + The ID of the current thread -OR- zero if it cannot be determined. + + + + + Determines if the specified flags are present within the flags + associated with the parent connection object. + + + The flags associated with the parent connection object. + + + The flags to check for. + + + Non-zero if the specified flag or flags were present; otherwise, + zero. + + + + + Determines if preparing a query should be logged. + + + The flags associated with the parent connection object. + + + Non-zero if the query preparation should be logged; otherwise, zero. + + + + + Determines if pre-parameter binding should be logged. + + + The flags associated with the parent connection object. + + + Non-zero if the pre-parameter binding should be logged; otherwise, + zero. + + + + + Determines if parameter binding should be logged. + + + The flags associated with the parent connection object. + + + Non-zero if the parameter binding should be logged; otherwise, zero. + + + + + Determines if an exception in a native callback should be logged. + + + The flags associated with the parent connection object. + + + Non-zero if the exception should be logged; otherwise, zero. + + + + + Determines if backup API errors should be logged. + + + The flags associated with the parent connection object. + + + Non-zero if the backup API error should be logged; otherwise, zero. + + + + + Determines if logging for the class is + disabled. + + + The flags associated with the parent connection object. + + + Non-zero if logging for the class is + disabled; otherwise, zero. + + + + + Determines if errors should be logged. + + + The flags associated with the parent connection object. + + + Non-zero if the error should be logged; + otherwise, zero. + + + + + Determines if exceptions should be + logged. + + + The flags associated with the parent connection object. + + + Non-zero if the exception should be + logged; otherwise, zero. + + + + + Determines if the current process is running on one of the Windows + [sub-]platforms. + + + Non-zero when running on Windows; otherwise, zero. + + + + + This is a wrapper around the + method. + On Mono, it has to call the method overload without the + parameter, due to a bug in Mono. + + + This is used for culture-specific formatting. + + + The format string. + + + An array the objects to format. + + + The resulting string. + + + + + This static class provides a thin wrapper around the native library + loading features of the underlying platform. + + + + + This delegate is used to wrap the concept of loading a native + library, based on a file name, and returning the loaded module + handle. + + + The file name of the native library to load. + + + The native module handle upon success -OR- IntPtr.Zero on failure. + + + + + This delegate is used to wrap the concept of querying the machine + name of the current process. + + + The machine name for the current process -OR- null on failure. + + + + + Attempts to load the specified native library file using the Win32 + API. + + + The file name of the native library to load. + + + The native module handle upon success -OR- IntPtr.Zero on failure. + + + + + Attempts to determine the machine name of the current process using + the Win32 API. + + + The machine name for the current process -OR- null on failure. + + + + + Attempts to load the specified native library file using the POSIX + API. + + + The file name of the native library to load. + + + The native module handle upon success -OR- IntPtr.Zero on failure. + + + + + Attempts to determine the machine name of the current process using + the POSIX API. + + + The machine name for the current process -OR- null on failure. + + + + + Attempts to load the specified native library file. + + + The file name of the native library to load. + + + The native module handle upon success -OR- IntPtr.Zero on failure. + + + + + Attempts to determine the machine name of the current process. + + + The machine name for the current process -OR- null on failure. + + + + + This class declares P/Invoke methods to call native POSIX APIs. + + + + + This structure is used when running on POSIX operating systems + to store information about the current machine, including the + human readable name of the operating system as well as that of + the underlying hardware. + + + + + This structure is passed directly to the P/Invoke method to + obtain the information about the current machine, including + the human readable name of the operating system as well as + that of the underlying hardware. + + + + + This is the P/Invoke method that wraps the native Unix uname + function. See the POSIX documentation for full details on what it + does. + + + Structure containing a preallocated byte buffer to fill with the + requested information. + + + Zero for success and less than zero upon failure. + + + + + This is the P/Invoke method that wraps the native Unix dlopen + function. See the POSIX documentation for full details on what it + does. + + + The name of the executable library. + + + This must be a combination of the individual bit flags RTLD_LAZY, + RTLD_NOW, RTLD_GLOBAL, and/or RTLD_LOCAL. + + + The native module handle upon success -OR- IntPtr.Zero on failure. + + + + + This is the P/Invoke method that wraps the native Unix dlclose + function. See the POSIX documentation for full details on what it + does. + + + The handle to the loaded native library. + + + Zero upon success -OR- non-zero on failure. + + + + + For use with dlopen(), bind function calls lazily. + + + + + For use with dlopen(), bind function calls immediately. + + + + + For use with dlopen(), make symbols globally available. + + + + + For use with dlopen(), opposite of RTLD_GLOBAL, and the default. + + + + + For use with dlopen(), the defaults used by this class. + + + + + These are the characters used to separate the string fields within + the raw buffer returned by the P/Invoke method. + + + + + This method is a wrapper around the P/Invoke + method that extracts and returns the human readable strings from + the raw buffer. + + + This structure, which contains strings, will be filled based on the + data placed in the raw buffer returned by the + P/Invoke method. + + + Non-zero upon success; otherwise, zero. + + + + + This class declares P/Invoke methods to call native Win32 APIs. + + + + + This is the P/Invoke method that wraps the native Win32 LoadLibrary + function. See the MSDN documentation for full details on what it + does. + + + The name of the executable library. + + + The native module handle upon success -OR- IntPtr.Zero on failure. + + + + + This is the P/Invoke method that wraps the native Win32 GetSystemInfo + function. See the MSDN documentation for full details on what it + does. + + + The system information structure to be filled in by the function. + + + + + This enumeration contains the possible values for the processor + architecture field of the system information structure. + + + + + This structure contains information about the current computer. This + includes the processor type, page size, memory addresses, etc. + + + + + This class declares P/Invoke methods to call native SQLite APIs. @@ -7529,6 +11442,26 @@ System.Data.SQLite assembly. + + + This is the XML configuratrion file token that will be replaced with + the qualified path to the directory containing the XML configuration + file. + + + + + This is the environment variable token that will be replaced with + the qualified path to the directory containing this assembly. + + + + + This is the environment variable token that will be replaced with an + abbreviation of the target framework attribute value associated with + this assembly. + + This lock is used to protect the static _SQLiteNativeModuleFileName, @@ -7546,6 +11479,40 @@ SQLite interop assembly into the current process. + + + This is the cached return value from the + method -OR- null if that method + has never returned a valid value. + + + + + When this field is non-zero, it indicates the + method was not able to locate a + suitable assembly directory. The + method will check this + field and skips calls into the + method whenever it is non-zero. + + + + + This is the cached return value from the + method -OR- null if that method + has never returned a valid value. + + + + + When this field is non-zero, it indicates the + method was not able to locate a + suitable XML configuration file name. The + method will check this + field and skips calls into the + method whenever it is non-zero. + + For now, this method simply calls the Initialize method. @@ -7557,6 +11524,42 @@ library for the processor architecture of the current process. + + + Combines two path strings. + + + The first path -OR- null. + + + The second path -OR- null. + + + The combined path string -OR- null if both of the original path + strings are null. + + + + + Resets the cached XML configuration file name value, thus forcing the + next call to method to rely + upon the method to fetch the + XML configuration file name. + + + + + Queries and returns the cached XML configuration file name for the + assembly containing the managed System.Data.SQLite components, if + available. If the cached XML configuration file name value is not + available, the method will + be used to obtain the XML configuration file name. + + + The XML configuration file name -OR- null if it cannot be determined + or does not exist. + + Queries and returns the XML configuration file name for the assembly @@ -7567,6 +11570,94 @@ or does not exist. + + + If necessary, replaces all supported XML configuration file tokens + with their associated values. + + + The name of the XML configuration file being read. + + + A setting value read from the XML configuration file. + + + The value of the will all supported XML + configuration file tokens replaced. No return value is reserved + to indicate an error. This method cannot fail. + + + + + Queries and returns the value of the specified setting, using the + specified XML configuration file. + + + The name of the XML configuration file to read. + + + The name of the setting. + + + The value to be returned if the setting has not been set explicitly + or cannot be determined. + + + Non-zero to expand any environment variable references contained in + the setting value to be returned. This has no effect on the .NET + Compact Framework. + + + The value of the setting -OR- the default value specified by + if it has not been set explicitly or + cannot be determined. + + + + + Attempts to determine the target framework attribute value that is + associated with the specified managed assembly, if applicable. + + + The managed assembly to read the target framework attribute value + from. + + + The value of the target framework attribute value for the specified + managed assembly -OR- null if it cannot be determined. If this + assembly was compiled with a version of the .NET Framework prior to + version 4.0, the value returned MAY reflect that version of the .NET + Framework instead of the one associated with the specified managed + assembly. + + + + + Accepts a long target framework attribute value and makes it into a + much shorter version, suitable for use with NuGet packages. + + + The long target framework attribute value to convert. + + + The short target framework attribute value -OR- null if it cannot + be determined or converted. + + + + + If necessary, replaces all supported environment variable tokens + with their associated values. + + + A setting value read from an environment variable. + + + The value of the will all supported + environment variable tokens replaced. No return value is reserved + to indicate an error. This method cannot fail. + + Queries and returns the value of the specified setting, using the XML @@ -7590,6 +11681,26 @@ anything]. + + + Resets the cached assembly directory value, thus forcing the next + call to method to rely + upon the method to fetch the + assembly directory. + + + + + Queries and returns the cached directory for the assembly currently + being executed, if available. If the cached assembly directory value + is not available, the method will + be used to obtain the assembly directory. + + + The directory for the assembly currently being executed -OR- null if + it cannot be determined. + + Queries and returns the directory for the assembly currently being @@ -7606,19 +11717,6 @@ architecture of the current process. - - - This is the P/Invoke method that wraps the native Win32 LoadLibrary - function. See the MSDN documentation for full details on what it - does. - - - The name of the executable library. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - The native module file name for the native SQLite library or null. @@ -7630,7 +11728,17 @@ IntPtr.Zero. - + + + Determines the base file name (without any directory information) + for the native SQLite library to be pre-loaded by this class. + + + The base file name for the native SQLite library to be pre-loaded by + this class -OR- null if its value cannot be determined. + + + Searches for the native SQLite library in the directory containing the assembly currently being executed as well as the base directory @@ -7645,6 +11753,11 @@ of the immediate directory (i.e. the offset from the base directory) containing the native SQLite library. + + Upon success, this parameter will be modified to non-zero only if + the base directory itself should be allowed for loading the native + library. + Non-zero (success) if the native SQLite library was found; otherwise, zero (failure). @@ -7695,7 +11808,7 @@ if it cannot be determined. - + Attempts to load the native SQLite library based on the specified directory and processor architecture. @@ -7710,6 +11823,10 @@ processor architecture of the current process). This caller should almost always specify null for this parameter. + + Non-zero indicates that the native SQLite library can be loaded + from the base directory itself. + The candidate native module file name to load will be stored here, if necessary. @@ -7780,23 +11897,1526 @@ <MetaDataC [rest of string was truncated]";. + + + This interface represents a virtual table implementation written in + native code. + + + + + + int (*xCreate)(sqlite3 *db, void *pAux, + int argc, char *const*argv, + sqlite3_vtab **ppVTab, + char **pzErr); + + + The xCreate method is called to create a new instance of a virtual table + in response to a CREATE VIRTUAL TABLE statement. + If the xCreate method is the same pointer as the xConnect method, then the + virtual table is an eponymous virtual table. + If the xCreate method is omitted (if it is a NULL pointer) then the virtual + table is an eponymous-only virtual table. + + + The db parameter is a pointer to the SQLite database connection that + is executing the CREATE VIRTUAL TABLE statement. + The pAux argument is the copy of the client data pointer that was the + fourth argument to the sqlite3_create_module() or + sqlite3_create_module_v2() call that registered the + virtual table module. + The argv parameter is an array of argc pointers to null terminated strings. + The first string, argv[0], is the name of the module being invoked. The + module name is the name provided as the second argument to + sqlite3_create_module() and as the argument to the USING clause of the + CREATE VIRTUAL TABLE statement that is running. + The second, argv[1], is the name of the database in which the new virtual table is being created. The database name is "main" for the primary database, or + "temp" for TEMP database, or the name given at the end of the ATTACH + statement for attached databases. The third element of the array, argv[2], + is the name of the new virtual table, as specified following the TABLE + keyword in the CREATE VIRTUAL TABLE statement. + If present, the fourth and subsequent strings in the argv[] array report + the arguments to the module name in the CREATE VIRTUAL TABLE statement. + + + The job of this method is to construct the new virtual table object + (an sqlite3_vtab object) and return a pointer to it in *ppVTab. + + + As part of the task of creating a new sqlite3_vtab structure, this + method must invoke sqlite3_declare_vtab() to tell the SQLite + core about the columns and datatypes in the virtual table. + The sqlite3_declare_vtab() API has the following prototype: + + + int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable) + + + The first argument to sqlite3_declare_vtab() must be the same + database connection pointer as the first parameter to this method. + The second argument to sqlite3_declare_vtab() must a zero-terminated + UTF-8 string that contains a well-formed CREATE TABLE statement that + defines the columns in the virtual table and their data types. + The name of the table in this CREATE TABLE statement is ignored, + as are all constraints. Only the column names and datatypes matter. + The CREATE TABLE statement string need not to be + held in persistent memory. The string can be + deallocated and/or reused as soon as the sqlite3_declare_vtab() + routine returns. + + + The xCreate method need not initialize the pModule, nRef, and zErrMsg + fields of the sqlite3_vtab object. The SQLite core will take care of + that chore. + + + The xCreate should return SQLITE_OK if it is successful in + creating the new virtual table, or SQLITE_ERROR if it is not successful. + If not successful, the sqlite3_vtab structure must not be allocated. + An error message may optionally be returned in *pzErr if unsuccessful. + Space to hold the error message string must be allocated using + an SQLite memory allocation function like + sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will + attempt to free the space using sqlite3_free() after the error has + been reported up to the application. + + + If the xCreate method is omitted (left as a NULL pointer) then the + virtual table is an eponymous-only virtual table. New instances of + the virtual table cannot be created using CREATE VIRTUAL TABLE and the + virtual table can only be used via its module name. + Note that SQLite versions prior to 3.9.0 (2015-10-14) do not understand + eponymous-only virtual tables and will segfault if an attempt is made + to CREATE VIRTUAL TABLE on an eponymous-only virtual table because + the xCreate method was not checked for null. + + + If the xCreate method is the exact same pointer as the xConnect method, + that indicates that the virtual table does not need to initialize backing + store. Such a virtual table can be used as an eponymous virtual table + or as a named virtual table using CREATE VIRTUAL TABLE or both. + + + If a column datatype contains the special keyword "HIDDEN" + (in any combination of upper and lower case letters) then that keyword + it is omitted from the column datatype name and the column is marked + as a hidden column internally. + A hidden column differs from a normal column in three respects: + + + ]]> + ]]> Hidden columns are not listed in the dataset returned by + "PRAGMA table_info", + ]]>]]> Hidden columns are not included in the expansion of a "*" + expression in the result set of a SELECT, and + ]]>]]> Hidden columns are not included in the implicit column-list + used by an INSERT statement that lacks an explicit column-list. + ]]>]]> + + + For example, if the following SQL is passed to sqlite3_declare_vtab(): + + + CREATE TABLE x(a HIDDEN VARCHAR(12), b INTEGER, c INTEGER Hidden); + + + Then the virtual table would be created with two hidden columns, + and with datatypes of "VARCHAR(12)" and "INTEGER". + + + An example use of hidden columns can be seen in the FTS3 virtual + table implementation, where every FTS virtual table + contains an FTS hidden column that is used to pass information from the + virtual table into FTS auxiliary functions and to the FTS MATCH operator. + + + A virtual table that contains hidden columns can be used like + a table-valued function in the FROM clause of a SELECT statement. + The arguments to the table-valued function become constraints on + the HIDDEN columns of the virtual table. + + + For example, the "generate_series" extension (located in the + ext/misc/series.c + file in the source tree) + implements an eponymous virtual table with the following schema: + + + CREATE TABLE generate_series( + value, + start HIDDEN, + stop HIDDEN, + step HIDDEN + ); + + + The sqlite3_module.xBestIndex method in the implementation of this + table checks for equality constraints against the HIDDEN columns, and uses + those as input parameters to determine the range of integer "value" outputs + to generate. Reasonable defaults are used for any unconstrained columns. + For example, to list all integers between 5 and 50: + + + SELECT value FROM generate_series(5,50); + + + The previous query is equivalent to the following: + + + SELECT value FROM generate_series WHERE start=5 AND stop=50; + + + Arguments on the virtual table name are matched to hidden columns + in order. The number of arguments can be less than the + number of hidden columns, in which case the latter hidden columns are + unconstrained. However, an error results if there are more arguments + than there are hidden columns in the virtual table. + + + Beginning with SQLite version 3.14.0 (2016-08-08), + the CREATE TABLE statement that + is passed into sqlite3_declare_vtab() may contain a WITHOUT ROWID clause. + This is useful for cases where the virtual table rows + cannot easily be mapped into unique integers. A CREATE TABLE + statement that includes WITHOUT ROWID must define one or more columns as + the PRIMARY KEY. Every column of the PRIMARY KEY must individually be + NOT NULL and all columns for each row must be collectively unique. + + + Note that SQLite does not enforce the PRIMARY KEY for a WITHOUT ROWID + virtual table. Enforcement is the responsibility of the underlying + virtual table implementation. But SQLite does assume that the PRIMARY KEY + constraint is valid - that the identified columns really are UNIQUE and + NOT NULL - and it uses that assumption to optimize queries against the + virtual table. + + + The rowid column is not accessible on a + WITHOUT ROWID virtual table (of course). + + + The xUpdate method was originally designed around having a + ROWID as a single value. The xUpdate method has been expanded to + accommodate an arbitrary PRIMARY KEY in place of the ROWID, but the + PRIMARY KEY must still be only one column. For this reason, SQLite + will reject any WITHOUT ROWID virtual table that has more than one + PRIMARY KEY column and a non-NULL xUpdate method. + + + + The native database connection handle. + + + The original native pointer value that was provided to the + sqlite3_create_module(), sqlite3_create_module_v2() or + sqlite3_create_disposable_module() functions. + + + The number of arguments from the CREATE VIRTUAL TABLE statement. + + + The array of string arguments from the CREATE VIRTUAL TABLE + statement. + + + Upon success, this parameter must be modified to point to the newly + created native sqlite3_vtab derived structure. + + + Upon failure, this parameter must be modified to point to the error + message, with the underlying memory having been obtained from the + sqlite3_malloc() function. + + + A standard SQLite return code. + + + + + + int (*xConnect)(sqlite3*, void *pAux, + int argc, char *const*argv, + sqlite3_vtab **ppVTab, + char **pzErr); + + + The xConnect method is very similar to xCreate. + It has the same parameters and constructs a new sqlite3_vtab structure + just like xCreate. + And it must also call sqlite3_declare_vtab() like xCreate. + + + The difference is that xConnect is called to establish a new + connection to an existing virtual table whereas xCreate is called + to create a new virtual table from scratch. + + + The xCreate and xConnect methods are only different when the + virtual table has some kind of backing store that must be initialized + the first time the virtual table is created. The xCreate method creates + and initializes the backing store. The xConnect method just connects + to an existing backing store. When xCreate and xConnect are the same, + the table is an eponymous virtual table. + + + As an example, consider a virtual table implementation that + provides read-only access to existing comma-separated-value (CSV) + files on disk. There is no backing store that needs to be created + or initialized for such a virtual table (since the CSV files already + exist on disk) so the xCreate and xConnect methods will be identical + for that module. + + + Another example is a virtual table that implements a full-text index. + The xCreate method must create and initialize data structures to hold + the dictionary and posting lists for that index. The xConnect method, + on the other hand, only has to locate and use an existing dictionary + and posting lists that were created by a prior xCreate call. + + + The xConnect method must return SQLITE_OK if it is successful + in creating the new virtual table, or SQLITE_ERROR if it is not + successful. If not successful, the sqlite3_vtab structure must not be + allocated. An error message may optionally be returned in *pzErr if + unsuccessful. + Space to hold the error message string must be allocated using + an SQLite memory allocation function like + sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will + attempt to free the space using sqlite3_free() after the error has + been reported up to the application. + + + The xConnect method is required for every virtual table implementation, + though the xCreate and xConnect pointers of the sqlite3_module object + may point to the same function if the virtual table does not need to + initialize backing store. + + + + The native database connection handle. + + + The original native pointer value that was provided to the + sqlite3_create_module(), sqlite3_create_module_v2() or + sqlite3_create_disposable_module() functions. + + + The number of arguments from the CREATE VIRTUAL TABLE statement. + + + The array of string arguments from the CREATE VIRTUAL TABLE + statement. + + + Upon success, this parameter must be modified to point to the newly + created native sqlite3_vtab derived structure. + + + Upon failure, this parameter must be modified to point to the error + message, with the underlying memory having been obtained from the + sqlite3_malloc() function. + + + A standard SQLite return code. + + + + + + SQLite uses the xBestIndex method of a virtual table module to determine + the best way to access the virtual table. + The xBestIndex method has a prototype like this: + + + int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); + + + The SQLite core communicates with the xBestIndex method by filling + in certain fields of the sqlite3_index_info structure and passing a + pointer to that structure into xBestIndex as the second parameter. + The xBestIndex method fills out other fields of this structure which + forms the reply. The sqlite3_index_info structure looks like this: + + + struct sqlite3_index_info { + /* Inputs */ + const int nConstraint; /* Number of entries in aConstraint */ + const struct sqlite3_index_constraint { + int iColumn; /* Column constrained. -1 for ROWID */ + unsigned char op; /* Constraint operator */ + unsigned char usable; /* True if this constraint is usable */ + int iTermOffset; /* Used internally - xBestIndex should ignore */ + } *const aConstraint; /* Table of WHERE clause constraints */ + const int nOrderBy; /* Number of terms in the ORDER BY clause */ + const struct sqlite3_index_orderby { + int iColumn; /* Column number */ + unsigned char desc; /* True for DESC. False for ASC. */ + } *const aOrderBy; /* The ORDER BY clause */ + /* Outputs */ + struct sqlite3_index_constraint_usage { + int argvIndex; /* if >0, constraint is part of argv to xFilter */ + unsigned char omit; /* Do not code a test for this constraint */ + } *const aConstraintUsage; + int idxNum; /* Number used to identify the index */ + char *idxStr; /* String, possibly obtained from sqlite3_malloc */ + int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ + int orderByConsumed; /* True if output is already ordered */ + double estimatedCost; /* Estimated cost of using this index */ + ]]>/* Fields below are only available in SQLite 3.8.2 and later */]]> + sqlite3_int64 estimatedRows; /* Estimated number of rows returned */ + ]]>/* Fields below are only available in SQLite 3.9.0 and later */]]> + int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */ + ]]>/* Fields below are only available in SQLite 3.10.0 and later */]]> + sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */ + }; + + + Note the warnings on the "estimatedRows", "idxFlags", and colUsed fields. + These fields were added with SQLite versions 3.8.2, 3.9.0, and 3.10.0, respectively. + Any extension that reads or writes these fields must first check that the + version of the SQLite library in use is greater than or equal to appropriate + version - perhaps comparing the value returned from sqlite3_libversion_number() + against constants 3008002, 3009000, and/or 3010000. The result of attempting + to access these fields in an sqlite3_index_info structure created by an + older version of SQLite are undefined. + + + In addition, there are some defined constants: + + + #define SQLITE_INDEX_CONSTRAINT_EQ 2 + #define SQLITE_INDEX_CONSTRAINT_GT 4 + #define SQLITE_INDEX_CONSTRAINT_LE 8 + #define SQLITE_INDEX_CONSTRAINT_LT 16 + #define SQLITE_INDEX_CONSTRAINT_GE 32 + #define SQLITE_INDEX_CONSTRAINT_MATCH 64 + #define SQLITE_INDEX_CONSTRAINT_LIKE 65 /* 3.10.0 and later */ + #define SQLITE_INDEX_CONSTRAINT_GLOB 66 /* 3.10.0 and later */ + #define SQLITE_INDEX_CONSTRAINT_REGEXP 67 /* 3.10.0 and later */ + #define SQLITE_INDEX_CONSTRAINT_NE 68 /* 3.21.0 and later */ + #define SQLITE_INDEX_CONSTRAINT_ISNOT 69 /* 3.21.0 and later */ + #define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70 /* 3.21.0 and later */ + #define SQLITE_INDEX_CONSTRAINT_ISNULL 71 /* 3.21.0 and later */ + #define SQLITE_INDEX_CONSTRAINT_IS 72 /* 3.21.0 and later */ + #define SQLITE_INDEX_CONSTRAINT_FUNCTION 150 /* 3.25.0 and later */ + #define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */ + + + The SQLite core calls the xBestIndex method when it is compiling a query + that involves a virtual table. In other words, SQLite calls this method + when it is running sqlite3_prepare() or the equivalent. + By calling this method, the + SQLite core is saying to the virtual table that it needs to access + some subset of the rows in the virtual table and it wants to know the + most efficient way to do that access. The xBestIndex method replies + with information that the SQLite core can then use to conduct an + efficient search of the virtual table. + + + While compiling a single SQL query, the SQLite core might call + xBestIndex multiple times with different settings in sqlite3_index_info. + The SQLite core will then select the combination that appears to + give the best performance. + + + Before calling this method, the SQLite core initializes an instance + of the sqlite3_index_info structure with information about the + query that it is currently trying to process. This information + derives mainly from the WHERE clause and ORDER BY or GROUP BY clauses + of the query, but also from any ON or USING clauses if the query is a + join. The information that the SQLite core provides to the xBestIndex + method is held in the part of the structure that is marked as "Inputs". + The "Outputs" section is initialized to zero. + + + The information in the sqlite3_index_info structure is ephemeral + and may be overwritten or deallocated as soon as the xBestIndex method + returns. If the xBestIndex method needs to remember any part of the + sqlite3_index_info structure, it should make a copy. Care must be + take to store the copy in a place where it will be deallocated, such + as in the idxStr field with needToFreeIdxStr set to 1. + + + Note that xBestIndex will always be called before xFilter, since + the idxNum and idxStr outputs from xBestIndex are required inputs to + xFilter. However, there is no guarantee that xFilter will be called + following a successful xBestIndex. + + + The xBestIndex method is required for every virtual table implementation. + + + The main thing that the SQLite core is trying to communicate to + the virtual table is the constraints that are available to limit + the number of rows that need to be searched. The aConstraint[] array + contains one entry for each constraint. There will be exactly + nConstraint entries in that array. + + + Each constraint will usually correspond to a term in the WHERE clause + or in a USING or ON clause that is of the form + + + column OP EXPR + + + Where "column" is a column in the virtual table, OP is an operator + like "=" or "<", and EXPR is an arbitrary expression. So, for example, + if the WHERE clause contained a term like this: + + + a = 5 + + + Then one of the constraints would be on the "a" column with + operator "=" and an expression of "5". Constraints need not have a + literal representation of the WHERE clause. The query optimizer might + make transformations to the + WHERE clause in order to extract as many constraints + as it can. So, for example, if the WHERE clause contained something + like this: + + + x BETWEEN 10 AND 100 AND 999>y + + + The query optimizer might translate this into three separate constraints: + + + x >= 10 + x <= 100 + y < 999 + + + For each such constraint, the aConstraint[].iColumn field indicates which + column appears on the left-hand side of the constraint. + The first column of the virtual table is column 0. + The rowid of the virtual table is column -1. + The aConstraint[].op field indicates which operator is used. + The SQLITE_INDEX_CONSTRAINT_* constants map integer constants + into operator values. + Columns occur in the order they were defined by the call to + sqlite3_declare_vtab() in the xCreate or xConnect method. + Hidden columns are counted when determining the column index. + + + If the xFindFunction() method for the virtual table is defined, and + if xFindFunction() sometimes returns SQLITE_INDEX_CONSTRAINT_FUNCTION or + larger, then the constraints might also be of the form: + + + FUNCTION( column, EXPR) + + + In this case the aConstraint[].op value is the same as the value + returned by xFindFunction() for FUNCTION. + + + The aConstraint[] array contains information about all constraints + that apply to the virtual table. But some of the constraints might + not be usable because of the way tables are ordered in a join. + The xBestIndex method must therefore only consider constraints + that have an aConstraint[].usable flag which is true. + + + In addition to WHERE clause constraints, the SQLite core also + tells the xBestIndex method about the ORDER BY clause. + (In an aggregate query, the SQLite core might put in GROUP BY clause + information in place of the ORDER BY clause information, but this fact + should not make any difference to the xBestIndex method.) + If all terms of the ORDER BY clause are columns in the virtual table, + then nOrderBy will be the number of terms in the ORDER BY clause + and the aOrderBy[] array will identify the column for each term + in the order by clause and whether or not that column is ASC or DESC. + + + In SQLite version 3.10.0 (2016-01-06) and later, + the colUsed field is available + to indicate which fields of the virtual table are actually used by the + statement being prepared. If the lowest bit of colUsed is set, that + means that the first column is used. The second lowest bit corresponds + to the second column. And so forth. If the most significant bit of + colUsed is set, that means that one or more columns other than the + first 63 columns are used. If column usage information is needed by the + xFilter method, then the required bits must be encoded into either + the idxNum or idxStr output fields. + + + Given all of the information above, the job of the xBestIndex + method it to figure out the best way to search the virtual table. + + + The xBestIndex method fills the idxNum and idxStr fields with + information that communicates an indexing strategy to the xFilter + method. The information in idxNum and idxStr is arbitrary as far + as the SQLite core is concerned. The SQLite core just copies the + information through to the xFilter method. Any desired meaning can + be assigned to idxNum and idxStr as long as xBestIndex and xFilter + agree on what that meaning is. + + + The idxStr value may be a string obtained from an SQLite + memory allocation function such as sqlite3_mprintf(). + If this is the case, then the needToFreeIdxStr flag must be set to + true so that the SQLite core will know to call sqlite3_free() on + that string when it has finished with it, and thus avoid a memory leak. + The idxStr value may also be a static constant string, in which case + the needToFreeIdxStr boolean should remain false. + + + If the virtual table will output rows in the order specified by + the ORDER BY clause, then the orderByConsumed flag may be set to + true. If the output is not automatically in the correct order + then orderByConsumed must be left in its default false setting. + This will indicate to the SQLite core that it will need to do a + separate sorting pass over the data after it comes out of the virtual table. + + + The estimatedCost field should be set to the estimated number + of disk access operations required to execute this query against + the virtual table. The SQLite core will often call xBestIndex + multiple times with different constraints, obtain multiple cost + estimates, then choose the query plan that gives the lowest estimate. + The SQLite core initializes estimatedCost to a very large value + prior to invoking xBestIndex, so if xBestIndex determines that the + current combination of parameters is undesirable, it can leave the + estimatedCost field unchanged to discourage its use. + + + If the current version of SQLite is 3.8.2 or greater, the estimatedRows + field may be set to an estimate of the number of rows returned by the + proposed query plan. If this value is not explicitly set, the default + estimate of 25 rows is used. + + + If the current version of SQLite is 3.9.0 or greater, the idxFlags field + may be set to SQLITE_INDEX_SCAN_UNIQUE to indicate that the virtual table + will return only zero or one rows given the input constraints. Additional + bits of the idxFlags field might be understood in later versions of SQLite. + + + The aConstraintUsage[] array contains one element for each of + the nConstraint constraints in the inputs section of the + sqlite3_index_info structure. + The aConstraintUsage[] array is used by xBestIndex to tell the + core how it is using the constraints. + + + The xBestIndex method may set aConstraintUsage[].argvIndex + entries to values greater than zero. + Exactly one entry should be set to 1, another to 2, another to 3, + and so forth up to as many or as few as the xBestIndex method wants. + The EXPR of the corresponding constraints will then be passed + in as the argv[] parameters to xFilter. + + + For example, if the aConstraint[3].argvIndex is set to 1, then + when xFilter is called, the argv[0] passed to xFilter will have + the EXPR value of the aConstraint[3] constraint. + + + By default, the SQLite core double checks all constraints on + each row of the virtual table that it receives. If such a check + is redundant, the xBestFilter method can suppress that double-check by + setting aConstraintUsage[].omit. + + + The xBestIndex method should return SQLITE_OK on success. If any + kind of fatal error occurs, an appropriate error code (ex: SQLITE_NOMEM) + should be returned instead. + + + If xBestIndex returns SQLITE_CONSTRAINT, that does not indicate an + error. Rather, SQLITE_CONSTRAINT indicates that the particular combination + of input parameters specified should not be used in the query plan. + The SQLITE_CONSTRAINT return is useful for table-valued functions that + have required parameters. If the aConstraint[].usable field is false + for one of the required parameter, then the xBestIndex method should + return SQLITE_CONSTRAINT. + + + The following example will better illustrate the use of SQLITE_CONSTRAINT + as a return value from xBestIndex: + + + SELECT * FROM realtab, tablevaluedfunc(realtab.x); + + + Assuming that the first hidden column of "tablevaluedfunc" is "param1", + the query above is semantically equivalent to this: + + + SELECT * FROM realtab, tablevaluedfunc + WHERE tablevaluedfunc.param1 = realtab.x; + + + The query planner must decide between many possible implementations + of this query, but two plans in particular are of note: + + ]]> + ]]>Scan all + rows of realtab and for each row, find rows in tablevaluedfunc where + param1 is equal to realtab.x + ]]>]]>Scan all rows of tablevalued func and for each row find rows + in realtab where x is equal to tablevaluedfunc.param1. + ]]>]]> + + The xBestIndex method will be invoked once for each of the potential + plans above. For plan 1, the aConstraint[].usable flag for for the + SQLITE_CONSTRAINT_EQ constraint on the param1 column will be true because + the right-hand side value for the "param1 = ?" constraint will be known, + since it is determined by the outer realtab loop. + But for plan 2, the aConstraint[].usable flag for "param1 = ?" will be false + because the right-hand side value is determined by an inner loop and is thus + an unknown quantity. Because param1 is a required input to the table-valued + functions, the xBestIndex method should return SQLITE_CONSTRAINT when presented + with plan 2, indicating that a required input is missing. This forces the + query planner to select plan 1. + + + + The native pointer to the sqlite3_vtab derived structure. + + + The native pointer to the sqlite3_index_info structure. + + + A standard SQLite return code. + + + + + + int (*xDisconnect)(sqlite3_vtab *pVTab); + + + This method releases a connection to a virtual table. + Only the sqlite3_vtab object is destroyed. + The virtual table is not destroyed and any backing store + associated with the virtual table persists. + + This method undoes the work of xConnect. + + This method is a destructor for a connection to the virtual table. + Contrast this method with xDestroy. The xDestroy is a destructor + for the entire virtual table. + + + The xDisconnect method is required for every virtual table implementation, + though it is acceptable for the xDisconnect and xDestroy methods to be + the same function if that makes sense for the particular virtual table. + + + + The native pointer to the sqlite3_vtab derived structure. + + + A standard SQLite return code. + + + + + + int (*xDestroy)(sqlite3_vtab *pVTab); + + + This method releases a connection to a virtual table, just like + the xDisconnect method, and it also destroys the underlying + table implementation. This method undoes the work of xCreate. + + + The xDisconnect method is called whenever a database connection + that uses a virtual table is closed. The xDestroy method is only + called when a DROP TABLE statement is executed against the virtual table. + + + The xDestroy method is required for every virtual table implementation, + though it is acceptable for the xDisconnect and xDestroy methods to be + the same function if that makes sense for the particular virtual table. + + + + The native pointer to the sqlite3_vtab derived structure. + + + A standard SQLite return code. + + + + + + int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); + + + The xOpen method creates a new cursor used for accessing (read and/or + writing) a virtual table. A successful invocation of this method + will allocate the memory for the sqlite3_vtab_cursor (or a subclass), + initialize the new object, and make *ppCursor point to the new object. + The successful call then returns SQLITE_OK. + + + For every successful call to this method, the SQLite core will + later invoke the xClose method to destroy + the allocated cursor. + + + The xOpen method need not initialize the pVtab field of the + sqlite3_vtab_cursor structure. The SQLite core will take care + of that chore automatically. + + + A virtual table implementation must be able to support an arbitrary + number of simultaneously open cursors. + + + When initially opened, the cursor is in an undefined state. + The SQLite core will invoke the xFilter method + on the cursor prior to any attempt to position or read from the cursor. + + + The xOpen method is required for every virtual table implementation. + + + + The native pointer to the sqlite3_vtab derived structure. + + + Upon success, this parameter must be modified to point to the newly + created native sqlite3_vtab_cursor derived structure. + + + A standard SQLite return code. + + + + + + int (*xClose)(sqlite3_vtab_cursor*); + + + The xClose method closes a cursor previously opened by + xOpen. + The SQLite core will always call xClose once for each cursor opened + using xOpen. + + + This method must release all resources allocated by the + corresponding xOpen call. The routine will not be called again even if it + returns an error. The SQLite core will not use the + sqlite3_vtab_cursor again after it has been closed. + + + The xClose method is required for every virtual table implementation. + + + + The native pointer to the sqlite3_vtab_cursor derived structure. + + + A standard SQLite return code. + + + + + + int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, + int argc, sqlite3_value **argv); + + + This method begins a search of a virtual table. + The first argument is a cursor opened by xOpen. + The next two arguments define a particular search index previously + chosen by xBestIndex. The specific meanings of idxNum and idxStr + are unimportant as long as xFilter and xBestIndex agree on what + that meaning is. + + + The xBestIndex function may have requested the values of + certain expressions using the aConstraintUsage[].argvIndex values + of the sqlite3_index_info structure. + Those values are passed to xFilter using the argc and argv parameters. + + + If the virtual table contains one or more rows that match the + search criteria, then the cursor must be left point at the first row. + Subsequent calls to xEof must return false (zero). + If there are no rows match, then the cursor must be left in a state + that will cause the xEof to return true (non-zero). + The SQLite engine will use + the xColumn and xRowid methods to access that row content. + The xNext method will be used to advance to the next row. + + + This method must return SQLITE_OK if successful, or an sqlite + error code if an error occurs. + + + The xFilter method is required for every virtual table implementation. + + + + The native pointer to the sqlite3_vtab_cursor derived structure. + + + Number used to help identify the selected index. + + + The native pointer to the UTF-8 encoded string containing the + string used to help identify the selected index. + + + The number of native pointers to sqlite3_value structures specified + in . + + + An array of native pointers to sqlite3_value structures containing + filtering criteria for the selected index. + + + A standard SQLite return code. + + + + + + int (*xNext)(sqlite3_vtab_cursor*); + + + The xNext method advances a virtual table cursor + to the next row of a result set initiated by xFilter. + If the cursor is already pointing at the last row when this + routine is called, then the cursor no longer points to valid + data and a subsequent call to the xEof method must return true (non-zero). + If the cursor is successfully advanced to another row of content, then + subsequent calls to xEof must return false (zero). + + + This method must return SQLITE_OK if successful, or an sqlite + error code if an error occurs. + + + The xNext method is required for every virtual table implementation. + + + + The native pointer to the sqlite3_vtab_cursor derived structure. + + + A standard SQLite return code. + + + + + + int (*xEof)(sqlite3_vtab_cursor*); + + + The xEof method must return false (zero) if the specified cursor + currently points to a valid row of data, or true (non-zero) otherwise. + This method is called by the SQL engine immediately after each + xFilter and xNext invocation. + + + The xEof method is required for every virtual table implementation. + + + + The native pointer to the sqlite3_vtab_cursor derived structure. + + + Non-zero if no more rows are available; zero otherwise. + + + + + + int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int N); + + + The SQLite core invokes this method in order to find the value for + the N-th column of the current row. N is zero-based so the first column + is numbered 0. + The xColumn method may return its result back to SQLite using one of the + following interface: + + + ]]> + ]]> sqlite3_result_blob() + ]]>]]> sqlite3_result_double() + ]]>]]> sqlite3_result_int() + ]]>]]> sqlite3_result_int64() + ]]>]]> sqlite3_result_null() + ]]>]]> sqlite3_result_text() + ]]>]]> sqlite3_result_text16() + ]]>]]> sqlite3_result_text16le() + ]]>]]> sqlite3_result_text16be() + ]]>]]> sqlite3_result_zeroblob() + ]]>]]> + + + If the xColumn method implementation calls none of the functions above, + then the value of the column defaults to an SQL NULL. + + + To raise an error, the xColumn method should use one of the result_text() + methods to set the error message text, then return an appropriate + error code. The xColumn method must return SQLITE_OK on success. + + + The xColumn method is required for every virtual table implementation. + + + + The native pointer to the sqlite3_vtab_cursor derived structure. + + + The native pointer to the sqlite3_context structure to be used + for returning the specified column value to the SQLite core + library. + + + The zero-based index corresponding to the column containing the + value to be returned. + + + A standard SQLite return code. + + + + + + int (*xRowid)(sqlite3_vtab_cursor *pCur, sqlite_int64 *pRowid); + + + A successful invocation of this method will cause *pRowid to be + filled with the rowid of row that the + virtual table cursor pCur is currently pointing at. + This method returns SQLITE_OK on success. + It returns an appropriate error code on failure. + + + The xRowid method is required for every virtual table implementation. + + + + The native pointer to the sqlite3_vtab_cursor derived structure. + + + Upon success, this parameter must be modified to contain the unique + integer row identifier for the current row for the specified cursor. + + + A standard SQLite return code. + + + + + + int (*xUpdate)( + sqlite3_vtab *pVTab, + int argc, + sqlite3_value **argv, + sqlite_int64 *pRowid + ); + + + All changes to a virtual table are made using the xUpdate method. + This one method can be used to insert, delete, or update. + + + The argc parameter specifies the number of entries in the argv array. + The value of argc will be 1 for a pure delete operation or N+2 for an insert + or replace or update where N is the number of columns in the table. + In the previous sentence, N includes any hidden columns. + + + Every argv entry will have a non-NULL value in C but may contain the + SQL value NULL. In other words, it is always true that + ]]>argv[i]!=0]]> for ]]>i]]> between 0 and ]]>argc-1]]>. + However, it might be the case that + ]]>sqlite3_value_type(argv[i])==SQLITE_NULL]]>. + + + The argv[0] parameter is the rowid of a row in the virtual table + to be deleted. If argv[0] is an SQL NULL, then no deletion occurs. + + + The argv[1] parameter is the rowid of a new row to be inserted + into the virtual table. If argv[1] is an SQL NULL, then the implementation + must choose a rowid for the newly inserted row. Subsequent argv[] + entries contain values of the columns of the virtual table, in the + order that the columns were declared. The number of columns will + match the table declaration that the xConnect or xCreate method made + using the sqlite3_declare_vtab() call. All hidden columns are included. + + + When doing an insert without a rowid (argc>1, argv[1] is an SQL NULL), + on a virtual table that uses ROWID (but not on a WITHOUT ROWID virtual table), + the implementation must set *pRowid to the rowid of the newly inserted row; + this will become the value returned by the sqlite3_last_insert_rowid() + function. Setting this value in all the other cases is a harmless no-op; + the SQLite engine ignores the *pRowid return value if argc==1 or + argv[1] is not an SQL NULL. + + + Each call to xUpdate will fall into one of cases shown below. + Not that references to ]]>argv[i]]]> mean the SQL value + held within the argv[i] object, not the argv[i] + object itself. + + + ]]> + ]]>]]>argc = 1 ]]> argv[0] ≠ NULL]]> + ]]>]]> + DELETE: The single row with rowid or PRIMARY KEY equal to argv[0] is deleted. + No insert occurs. + ]]>]]>]]>argc > 1 ]]> argv[0] = NULL]]> + ]]>]]> + INSERT: A new row is inserted with column values taken from + argv[2] and following. In a rowid virtual table, if argv[1] is an SQL NULL, + then a new unique rowid is generated automatically. The argv[1] will be NULL + for a WITHOUT ROWID virtual table, in which case the implementation should + take the PRIMARY KEY value from the appropriate column in argv[2] and following. + ]]>]]>]]>argc > 1 ]]> argv[0] ≠ NULL ]]> argv[0] = argv[1]]]> + ]]>]]> + UPDATE: + The row with rowid or PRIMARY KEY argv[0] is updated with new values + in argv[2] and following parameters. + ]]>]]>]]>argc > 1 ]]> argv[0] ≠ NULL ]]> argv[0] ≠ argv[1]]]> + ]]>]]> + UPDATE with rowid or PRIMARY KEY change: + The row with rowid or PRIMARY KEY argv[0] is updated with + the rowid or PRIMARY KEY in argv[1] + and new values in argv[2] and following parameters. This will occur + when an SQL statement updates a rowid, as in the statement: + + UPDATE table SET rowid=rowid+1 WHERE ...; + + ]]>]]> + + + The xUpdate method must return SQLITE_OK if and only if it is + successful. If a failure occurs, the xUpdate must return an appropriate + error code. On a failure, the pVTab->zErrMsg element may optionally + be replaced with error message text stored in memory allocated from SQLite + using functions such as sqlite3_mprintf() or sqlite3_malloc(). + + + If the xUpdate method violates some constraint of the virtual table + (including, but not limited to, attempting to store a value of the wrong + datatype, attempting to store a value that is too + large or too small, or attempting to change a read-only value) then the + xUpdate must fail with an appropriate error code. + + + If the xUpdate method is performing an UPDATE, then + sqlite3_value_nochange(X) can be used to discover which columns + of the virtual table were actually modified by the UPDATE + statement. The sqlite3_value_nochange(X) interface returns + true for columns that do not change. + On every UPDATE, SQLite will first invoke + xColumn separately for each unchanging column in the table to + obtain the value for that column. The xColumn method can + check to see if the column is unchanged at the SQL level + by invoking sqlite3_vtab_nochange(). If xColumn sees that + the column is not being modified, it should return without setting + a result using one of the sqlite3_result_xxxxx() + interfaces. Only in that case sqlite3_value_nochange() will be + true within the xUpdate method. If xColumn does + invoke one or more sqlite3_result_xxxxx() + interfaces, then SQLite understands that as a change in the value + of the column and the sqlite3_value_nochange() call for that + column within xUpdate will return false. + + + There might be one or more sqlite3_vtab_cursor objects open and in use + on the virtual table instance and perhaps even on the row of the virtual + table when the xUpdate method is invoked. The implementation of + xUpdate must be prepared for attempts to delete or modify rows of the table + out from other existing cursors. If the virtual table cannot accommodate + such changes, the xUpdate method must return an error code. + + + The xUpdate method is optional. + If the xUpdate pointer in the sqlite3_module for a virtual table + is a NULL pointer, then the virtual table is read-only. + + + + The native pointer to the sqlite3_vtab derived structure. + + + The number of new or modified column values contained in + . + + + The array of native pointers to sqlite3_value structures containing + the new or modified column values, if any. + + + Upon success, this parameter must be modified to contain the unique + integer row identifier for the row that was inserted, if any. + + + A standard SQLite return code. + + + + + + int (*xBegin)(sqlite3_vtab *pVTab); + + + This method begins a transaction on a virtual table. + This is method is optional. The xBegin pointer of sqlite3_module + may be NULL. + + + This method is always followed by one call to either the + xCommit or xRollback method. Virtual table transactions do + not nest, so the xBegin method will not be invoked more than once + on a single virtual table + without an intervening call to either xCommit or xRollback. + Multiple calls to other methods can and likely will occur in between + the xBegin and the corresponding xCommit or xRollback. + + + + The native pointer to the sqlite3_vtab derived structure. + + + A standard SQLite return code. + + + + + + int (*xSync)(sqlite3_vtab *pVTab); + + + This method signals the start of a two-phase commit on a virtual + table. + This is method is optional. The xSync pointer of sqlite3_module + may be NULL. + + + This method is only invoked after call to the xBegin method and + prior to an xCommit or xRollback. In order to implement two-phase + commit, the xSync method on all virtual tables is invoked prior to + invoking the xCommit method on any virtual table. If any of the + xSync methods fail, the entire transaction is rolled back. + + + + The native pointer to the sqlite3_vtab derived structure. + + + A standard SQLite return code. + + + + + + int (*xCommit)(sqlite3_vtab *pVTab); + + + This method causes a virtual table transaction to commit. + This is method is optional. The xCommit pointer of sqlite3_module + may be NULL. + + + A call to this method always follows a prior call to xBegin and + xSync. + + + + The native pointer to the sqlite3_vtab derived structure. + + + A standard SQLite return code. + + + + + + int (*xRollback)(sqlite3_vtab *pVTab); + + + This method causes a virtual table transaction to rollback. + This is method is optional. The xRollback pointer of sqlite3_module + may be NULL. + + + A call to this method always follows a prior call to xBegin. + + + + The native pointer to the sqlite3_vtab derived structure. + + + A standard SQLite return code. + + + + + + int (*xFindFunction)( + sqlite3_vtab *pVtab, + int nArg, + const char *zName, + void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), + void **ppArg + ); + + + This method is called during sqlite3_prepare() to give the virtual + table implementation an opportunity to overload functions. + This method may be set to NULL in which case no overloading occurs. + + + When a function uses a column from a virtual table as its first + argument, this method is called to see if the virtual table would + like to overload the function. The first three parameters are inputs: + the virtual table, the number of arguments to the function, and the + name of the function. If no overloading is desired, this method + returns 0. To overload the function, this method writes the new + function implementation into *pxFunc and writes user data into *ppArg + and returns either 1 or a number between + SQLITE_INDEX_CONSTRAINT_FUNCTION and 255. + + + Historically, the return value from xFindFunction() was either zero + or one. Zero means that the function is not overloaded and one means that + it is overload. The ability to return values of + SQLITE_INDEX_CONSTRAINT_FUNCTION or greater was added in + version 3.25.0 (2018-09-15). If xFindFunction returns + SQLITE_INDEX_CONSTRAINT_FUNCTION or greater, than means that the function + takes two arguments and the function + can be used as a boolean in the WHERE clause of a query and that + the virtual table is able to exploit that function to speed up the query + result. When xFindFunction returns SQLITE_INDEX_CONSTRAINT_FUNCTION or + larger, the value returned becomes the sqlite3_index_info.aConstraint.op + value for one of the constraints passed into xBestIndex() and the second + argument becomes the value corresponding to that constraint that is passed + to xFilter(). This enables the + xBestIndex()/xFilter implementations to use the function to speed + its search. + + + The technique of having xFindFunction() return values of + SQLITE_INDEX_CONSTRAINT_FUNCTION was initially used in the implementation + of the Geopoly module. The xFindFunction() method of that module returns + SQLITE_INDEX_CONSTRAINT_FUNCTION for the geopoly_overlap() SQL function + and it returns + SQLITE_INDEX_CONSTRAINT_FUNCTION+1 for the geopoly_within() SQL function. + This permits search optimizations for queries such as: + + + SELECT * FROM geopolytab WHERE geopoly_overlap(_shape, $query_polygon); + + + Note that infix functions (LIKE, GLOB, REGEXP, and MATCH) reverse + the order of their arguments. So "like(A,B)" is equivalent to "B like A". + For the form "B like A" the B term is considered the first argument + to the function. But for "like(A,B)" the A term is considered the + first argument. + + + The function pointer returned by this routine must be valid for + the lifetime of the sqlite3_vtab object given in the first parameter. + + + + The native pointer to the sqlite3_vtab derived structure. + + + The number of arguments to the function being sought. + + + The name of the function being sought. + + + Upon success, this parameter must be modified to contain the + delegate responsible for implementing the specified function. + + + Upon success, this parameter must be modified to contain the + native user-data pointer associated with + . + + + Non-zero if the specified function was found; zero otherwise. + + + + + + int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); + + + This method provides notification that the virtual table implementation + that the virtual table will be given a new name. + If this method returns SQLITE_OK then SQLite renames the table. + If this method returns an error code then the renaming is prevented. + + + The xRename method is optional. If omitted, then the virtual + table may not be renamed using the ALTER TABLE RENAME command. + + + The PRAGMA legacy_alter_table setting is enabled prior to invoking this + method, and the value for legacy_alter_table is restored after this + method finishes. This is necessary for the correct operation of virtual + tables that make use of shadow tables where the shadow tables must be + renamed to match the new virtual table name. If the legacy_alter_format is + off, then the xConnect method will be invoked for the virtual table every + time the xRename method tries to change the name of the shadow table. + + + + The native pointer to the sqlite3_vtab derived structure. + + + The native pointer to the UTF-8 encoded string containing the new + name for the virtual table. + + + A standard SQLite return code. + + + + + + int (*xSavepoint)(sqlite3_vtab *pVtab, int); + int (*xRelease)(sqlite3_vtab *pVtab, int); + int (*xRollbackTo)(sqlite3_vtab *pVtab, int); + + + These methods provide the virtual table implementation an opportunity to + implement nested transactions. They are always optional and will only be + called in SQLite version 3.7.7 (2011-06-23) and later. + + + When xSavepoint(X,N) is invoked, that is a signal to the virtual table X + that it should save its current state as savepoint N. + A subsequent call + to xRollbackTo(X,R) means that the state of the virtual table should return + to what it was when xSavepoint(X,R) was last called. + The call + to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the + invalided savepoints will be rolled back or released without first + being reinitialized by a call to xSavepoint(). + A call to xRelease(X,M) invalidates all savepoints where N>=M. + + + None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever + be called except in between calls to xBegin() and + either xCommit() or xRollback(). + + + + The native pointer to the sqlite3_vtab derived structure. + + + This is an integer identifier under which the the current state of + the virtual table should be saved. + + + A standard SQLite return code. + + + + + + int (*xSavepoint)(sqlite3_vtab *pVtab, int); + int (*xRelease)(sqlite3_vtab *pVtab, int); + int (*xRollbackTo)(sqlite3_vtab *pVtab, int); + + + These methods provide the virtual table implementation an opportunity to + implement nested transactions. They are always optional and will only be + called in SQLite version 3.7.7 (2011-06-23) and later. + + + When xSavepoint(X,N) is invoked, that is a signal to the virtual table X + that it should save its current state as savepoint N. + A subsequent call + to xRollbackTo(X,R) means that the state of the virtual table should return + to what it was when xSavepoint(X,R) was last called. + The call + to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the + invalided savepoints will be rolled back or released without first + being reinitialized by a call to xSavepoint(). + A call to xRelease(X,M) invalidates all savepoints where N>=M. + + + None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever + be called except in between calls to xBegin() and + either xCommit() or xRollback(). + + + + The native pointer to the sqlite3_vtab derived structure. + + + This is an integer used to indicate that any saved states with an + identifier greater than or equal to this should be deleted by the + virtual table. + + + A standard SQLite return code. + + + + + + int (*xSavepoint)(sqlite3_vtab *pVtab, int); + int (*xRelease)(sqlite3_vtab *pVtab, int); + int (*xRollbackTo)(sqlite3_vtab *pVtab, int); + + + These methods provide the virtual table implementation an opportunity to + implement nested transactions. They are always optional and will only be + called in SQLite version 3.7.7 (2011-06-23) and later. + + + When xSavepoint(X,N) is invoked, that is a signal to the virtual table X + that it should save its current state as savepoint N. + A subsequent call + to xRollbackTo(X,R) means that the state of the virtual table should return + to what it was when xSavepoint(X,R) was last called. + The call + to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the + invalided savepoints will be rolled back or released without first + being reinitialized by a call to xSavepoint(). + A call to xRelease(X,M) invalidates all savepoints where N>=M. + + + None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever + be called except in between calls to xBegin() and + either xCommit() or xRollback(). + + + + The native pointer to the sqlite3_vtab derived structure. + + + This is an integer identifier used to specify a specific saved + state for the virtual table for it to restore itself back to, which + should also have the effect of deleting all saved states with an + integer identifier greater than this one. + + + A standard SQLite return code. + + This class represents a context from the SQLite core library that can be passed to the sqlite3_result_*() and associated functions. - - - This interface represents a native handle provided by the SQLite core - library. - - - - - The native handle value. - - The native context handle. @@ -7811,6 +13431,12 @@ The native context handle to use. + + + Returns the underlying SQLite native handle associated with this + object instance. + + Sets the context result to NULL. @@ -7818,59 +13444,59 @@ - Sets the context result to the specified + Sets the context result to the specified value. - The value to use. + The value to use. - Sets the context result to the specified + Sets the context result to the specified value. - The value to use. + The value to use. - Sets the context result to the specified + Sets the context result to the specified value. - The value to use. + The value to use. - Sets the context result to the specified + Sets the context result to the specified value. - The value to use. This value will be + The value to use. This value will be converted to the UTF-8 encoding prior to being used. - Sets the context result to the specified + Sets the context result to the specified value containing an error message. - The value containing the error message text. + The value containing the error message text. This value will be converted to the UTF-8 encoding prior to being used. - Sets the context result to the specified + Sets the context result to the specified value. - The value to use. + The value to use. @@ -7885,11 +13511,11 @@ - Sets the context result to the specified array + Sets the context result to the specified array value. - The array value to use. + The array value to use. @@ -7902,18 +13528,12 @@ - Sets the context result to the specified . + Sets the context result to the specified . - The to use. + The to use. - - - Returns the underlying SQLite native handle associated with this - object instance. - - This class represents a value from the SQLite core library that can be @@ -7940,10 +13560,23 @@ access to it from this object instance. + + + Converts a native pointer to a native sqlite3_value structure into + a managed object instance. + + + The native pointer to a native sqlite3_value structure to convert. + + + The managed object instance or null upon + failure. + + Converts a logical array of native pointers to native sqlite3_value - structures into a managed array of + structures into a managed array of object instances. @@ -7955,10 +13588,31 @@ structures to convert. - The managed array of object instances or + The managed array of object instances or null upon failure. + + + Returns the underlying SQLite native handle associated with this + object instance. + + + + + Returns non-zero if the native SQLite value has been successfully + persisted as a managed value within this object instance (i.e. the + property may then be read successfully). + + + + + If the managed value for this object instance is available (i.e. it + has been previously persisted via the ) method, + that value is returned; otherwise, an exception is thrown. The + returned value may be null. + + Gets and returns the type affinity associated with this value. @@ -7979,48 +13633,59 @@ - Gets and returns the associated with this + Gets and returns the associated with this value. - The associated with this value. + The associated with this value. - Gets and returns the associated with + Gets and returns the associated with this value. - The associated with this value. + The associated with this value. - Gets and returns the associated with this + Gets and returns the associated with this value. - The associated with this value. + The associated with this value. - Gets and returns the associated with this + Gets and returns the associated with this value. - The associated with this value. The value is + The associated with this value. The value is converted from the UTF-8 encoding prior to being returned. - Gets and returns the array associated with this + Gets and returns the array associated with this value. - The array associated with this value. + The array associated with this value. + + + + + Gets and returns an instance associated with + this value. + + + The associated with this value. If the type + affinity of the object is unknown or cannot be determined, a null + value will be returned. @@ -8035,27 +13700,6 @@ Non-zero if the native value was persisted successfully. - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - Returns non-zero if the native SQLite value has been successfully - persisted as a managed value within this object instance (i.e. the - property may then be read successfully). - - - - - If the managed value for this object instance is available (i.e. it - has been previously persisted via the ) method, - that value is returned; otherwise, an exception is thrown. The - returned value may be null. - - These are the allowed values for the operators that are part of a @@ -8093,6 +13737,63 @@ This value represents the MATCH operator. + + + This value represents the LIKE operator. + + + + + This value represents the GLOB operator. + + + + + This value represents the REGEXP operator. + + + + + This value represents the inequality operator. + + + + + This value represents the IS NOT operator. + + + + + This value represents the IS NOT NULL operator. + + + + + This value represents the IS NULL operator. + + + + + This value represents the IS operator. + + + + + These are the allowed values for the index flags from the + method. + + + + + No special handling. This is the default. + + + + + This value indicates that the scan of the index will visit at + most one row. + + This class represents the native sqlite3_index_constraint structure @@ -8117,13 +13818,13 @@ Column on left-hand side of constraint. - Constraint operator (). + Constraint operator (). True if this constraint is usable. - Used internally - + Used internally - should ignore. @@ -8134,7 +13835,7 @@ - Constraint operator (). + Constraint operator (). @@ -8144,7 +13845,7 @@ - Used internally - + Used internally - should ignore. @@ -8191,6 +13892,11 @@ structure from the SQLite core library. + + + Constructs a default instance of this class. + + Constructs an instance of this class using the specified native @@ -8225,7 +13931,7 @@ This class represents the various inputs provided by the SQLite core - library to the method. + library to the method. @@ -8233,30 +13939,30 @@ Constructs an instance of this class. - The number of instances to + The number of instances to pre-allocate space for. - The number of instances to + The number of instances to pre-allocate space for. - An array of object instances, + An array of object instances, each containing information supplied by the SQLite core library. - An array of object instances, + An array of object instances, each containing information supplied by the SQLite core library. This class represents the various outputs provided to the SQLite core - library by the method. + library by the method. @@ -8264,7 +13970,7 @@ Constructs an instance of this class. - The number of instances + The number of instances to pre-allocate space for. @@ -8274,13 +13980,33 @@ the available version of the SQLite core library. - Non-zero if the property is supported + Non-zero if the property is supported by the SQLite core library. + + + Determines if the native flags field can be used, based on the + available version of the SQLite core library. + + + Non-zero if the property is supported by + the SQLite core library. + + + + + Determines if the native flags field can be used, based on the + available version of the SQLite core library. + + + Non-zero if the property is supported by + the SQLite core library. + + - An array of object + An array of object instances, each containing information to be supplied to the SQLite core library. @@ -8288,14 +14014,14 @@ Number used to help identify the selected index. This value will - later be provided to the + later be provided to the method. String used to help identify the selected index. This value will - later be provided to the + later be provided to the method. @@ -8320,12 +14046,45 @@ Estimated number of rows returned. Using a null value here indicates that a default estimated rows value should be used. + This property has no effect if the SQLite core library is not at + least version 3.8.2. + + + + + The flags that should be used with this index. Using a null value + here indicates that a default flags value should be used. This + property has no effect if the SQLite core library is not at least + version 3.9.0. + + + + + + Indicates which columns of the virtual table may be required by the + current scan. Virtual table columns are numbered from zero in the + order in which they appear within the CREATE TABLE statement passed + to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62), + the corresponding bit is set within the bit mask if the column may + be required by SQLite. If the table has at least 64 columns and + any column to the right of the first 63 is required, then bit 63 of + colUsed is also set. In other words, column iCol may be required + if the expression + + + (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) + + + evaluates to non-zero. Using a null value here indicates that a + default flags value should be used. This property has no effect if + the SQLite core library is not at least version 3.10.0. + This class represents the various inputs and outputs used with the - method. + method. @@ -8333,55 +14092,122 @@ Constructs an instance of this class. - The number of (and - ) instances to + The number of (and + ) instances to pre-allocate space for. - The number of instances to + The number of instances to pre-allocate space for. - + + + Attempts to determine the structure sizes needed to create and + populate a native + + structure. + + + The size of the native + + structure is stored here. + + + The size of the native + + structure is stored here. + + + The size of the native + + structure is stored here. + + + The size of the native + + structure is stored here. + + + + + Attempts to allocate and initialize a native + + structure. + + + The number of instances to + pre-allocate space for. + + + The number of instances to + pre-allocate space for. + + + The newly allocated native + structure + -OR- if it could not be fully allocated. + + + + + Frees all the memory associated with a native + + structure. + + + The native pointer to the native sqlite3_index_info structure to + free. + + + Converts a native pointer to a native sqlite3_index_info structure - into a new object instance. + into a new object instance. The native pointer to the native sqlite3_index_info structure to convert. + + Non-zero to include fields from the outputs portion of the native + structure; otherwise, the "output" fields will not be read. + Upon success, this parameter will be modified to contain the newly - created object instance. + created object instance. - + Populates the outputs of a pre-allocated native sqlite3_index_info - structure using an existing object + structure using an existing object instance. - The existing object instance containing + The existing object instance containing the output data to use. The native pointer to the pre-allocated native sqlite3_index_info structure. + + Non-zero to include fields from the inputs portion of the native + structure; otherwise, the "input" fields will not be written. + - The object instance containing - the inputs to the + The object instance containing + the inputs to the method. - The object instance containing - the outputs from the + The object instance containing + the outputs from the method. @@ -8395,24 +14221,24 @@ The index within the array of strings provided to the - and - methods containing the + and + methods containing the name of the module implementing this virtual table. The index within the array of strings provided to the - and - methods containing the + and + methods containing the name of the database containing this virtual table. The index within the array of strings provided to the - and - methods containing the + and + methods containing the name of the virtual table. @@ -8422,68 +14248,15 @@ The original array of strings provided to the - and - methods. + and + methods. - - - This method should normally be used by the - method in order to - perform index selection based on the constraints provided by the - SQLite core library. - - - The object instance containing all the - data for the inputs and outputs relating to index selection. - - - Non-zero upon success. - - - - - Attempts to record the renaming of the virtual table associated - with this object instance. - - - The new name for the virtual table. - - - Non-zero upon success. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being called - from the finalizer. - - - - - Finalizes this object instance. - - The original array of strings provided to the - and - methods. + and + methods. @@ -8503,17 +14276,70 @@ - The object instance containing all the + The object instance containing all the data for the inputs and outputs relating to the most recent index selection. + + + This method should normally be used by the + method in order to + perform index selection based on the constraints provided by the + SQLite core library. + + + The object instance containing all the + data for the inputs and outputs relating to index selection. + + + Non-zero upon success. + + + + + Attempts to record the renaming of the virtual table associated + with this object instance. + + + The new name for the virtual table. + + + Non-zero upon success. + + Returns the underlying SQLite native handle associated with this object instance. + + + Disposes of this object instance. + + + + + Throws an if this object + instance has been disposed. + + + + + Disposes of this object instance. + + + Non-zero if this method is being called from the + method. Zero if this method is being called + from the finalizer. + + + + + Finalizes this object instance. + + This class represents a managed virtual table cursor implementation. @@ -8537,7 +14363,7 @@ Constructs an instance of this class. - The object instance associated + The object instance associated with this object instance. @@ -8546,25 +14372,50 @@ Constructs an instance of this class. + + + The object instance associated + with this object instance. + + + + + Number used to help identify the selected index. This value will + be set via the method. + + + + + String used to help identify the selected index. This value will + be set via the method. + + + + + The values used to filter the rows returned via this cursor object + instance. This value will be set via the + method. + + - Attempts to persist the specified object + Attempts to persist the specified object instances in order to make them available after the - method returns. + method returns. - The array of object instances to be + The array of object instances to be persisted. - The number of object instances that were + The number of object instances that were successfully persisted. This method should normally be used by the - method in order to + method in order to perform filtering of the result rows and/or to record the filtering criteria provided by the SQLite core library. @@ -8593,6 +14444,12 @@ next row. + + + Returns the underlying SQLite native handle associated with this + object instance. + + Disposes of this object instance. @@ -8600,7 +14457,7 @@ - Throws an if this object + Throws an if this object instance has been disposed. @@ -8610,7 +14467,7 @@ Non-zero if this method is being called from the - method. Zero if this method is being called + method. Zero if this method is being called from the finalizer. @@ -8619,1142 +14476,16 @@ Finalizes this object instance. - + - The object instance associated - with this object instance. - - - - - Number used to help identify the selected index. This value will - be set via the method. - - - - - String used to help identify the selected index. This value will - be set via the method. - - - - - The values used to filter the rows returned via this cursor object - instance. This value will be set via the - method. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - This interface represents a virtual table implementation written in - native code. - - - - - - This method is called to create a new instance of a virtual table - in response to a CREATE VIRTUAL TABLE statement. The db parameter - is a pointer to the SQLite database connection that is executing - the CREATE VIRTUAL TABLE statement. The pAux argument is the copy - of the client data pointer that was the fourth argument to the - sqlite3_create_module() or sqlite3_create_module_v2() call that - registered the virtual table module. The argv parameter is an - array of argc pointers to null terminated strings. The first - string, argv[0], is the name of the module being invoked. The - module name is the name provided as the second argument to - sqlite3_create_module() and as the argument to the USING clause of - the CREATE VIRTUAL TABLE statement that is running. The second, - argv[1], is the name of the database in which the new virtual table - is being created. The database name is "main" for the primary - database, or "temp" for TEMP database, or the name given at the - end of the ATTACH statement for attached databases. The third - element of the array, argv[2], is the name of the new virtual - table, as specified following the TABLE keyword in the CREATE - VIRTUAL TABLE statement. If present, the fourth and subsequent - strings in the argv[] array report the arguments to the module name - in the CREATE VIRTUAL TABLE statement. - - - The job of this method is to construct the new virtual table object - (an sqlite3_vtab object) and return a pointer to it in *ppVTab. - - - As part of the task of creating a new sqlite3_vtab structure, this - method must invoke sqlite3_declare_vtab() to tell the SQLite core - about the columns and datatypes in the virtual table. The - sqlite3_declare_vtab() API has the following prototype: - - - - int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable) - - - - The first argument to sqlite3_declare_vtab() must be the same - database connection pointer as the first parameter to this method. - The second argument to sqlite3_declare_vtab() must a - zero-terminated UTF-8 string that contains a well-formed CREATE - TABLE statement that defines the columns in the virtual table and - their data types. The name of the table in this CREATE TABLE - statement is ignored, as are all constraints. Only the column names - and datatypes matter. The CREATE TABLE statement string need not to - be held in persistent memory. The string can be deallocated and/or - reused as soon as the sqlite3_declare_vtab() routine returns. - - - - The native database connection handle. - - - The original native pointer value that was provided to the - sqlite3_create_module(), sqlite3_create_module_v2() or - sqlite3_create_disposable_module() functions. - - - The number of arguments from the CREATE VIRTUAL TABLE statement. - - - The array of string arguments from the CREATE VIRTUAL TABLE - statement. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab derived structure. - - - Upon failure, this parameter must be modified to point to the error - message, with the underlying memory having been obtained from the - sqlite3_malloc() function. - - - A standard SQLite return code. - - - - - - The xConnect method is very similar to xCreate. It has the same - parameters and constructs a new sqlite3_vtab structure just like - xCreate. And it must also call sqlite3_declare_vtab() like xCreate. - - - The difference is that xConnect is called to establish a new - connection to an existing virtual table whereas xCreate is called - to create a new virtual table from scratch. - - - The xCreate and xConnect methods are only different when the - virtual table has some kind of backing store that must be - initialized the first time the virtual table is created. The - xCreate method creates and initializes the backing store. The - xConnect method just connects to an existing backing store. - - - As an example, consider a virtual table implementation that - provides read-only access to existing comma-separated-value (CSV) - files on disk. There is no backing store that needs to be created - or initialized for such a virtual table (since the CSV files - already exist on disk) so the xCreate and xConnect methods will be - identical for that module. - - - Another example is a virtual table that implements a full-text - index. The xCreate method must create and initialize data - structures to hold the dictionary and posting lists for that index. - The xConnect method, on the other hand, only has to locate and use - an existing dictionary and posting lists that were created by a - prior xCreate call. - - - The xConnect method must return SQLITE_OK if it is successful in - creating the new virtual table, or SQLITE_ERROR if it is not - successful. If not successful, the sqlite3_vtab structure must not - be allocated. An error message may optionally be returned in *pzErr - if unsuccessful. Space to hold the error message string must be - allocated using an SQLite memory allocation function like - sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will - attempt to free the space using sqlite3_free() after the error has - been reported up to the application. - - - The xConnect method is required for every virtual table - implementation, though the xCreate and xConnect pointers of the - sqlite3_module object may point to the same function the virtual - table does not need to initialize backing store. - - - - The native database connection handle. - - - The original native pointer value that was provided to the - sqlite3_create_module(), sqlite3_create_module_v2() or - sqlite3_create_disposable_module() functions. - - - The number of arguments from the CREATE VIRTUAL TABLE statement. - - - The array of string arguments from the CREATE VIRTUAL TABLE - statement. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab derived structure. - - - Upon failure, this parameter must be modified to point to the error - message, with the underlying memory having been obtained from the - sqlite3_malloc() function. - - - A standard SQLite return code. - - - - - - SQLite uses the xBestIndex method of a virtual table module to - determine the best way to access the virtual table. The xBestIndex - method has a prototype like this: - - - int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); - - - The SQLite core communicates with the xBestIndex method by filling - in certain fields of the sqlite3_index_info structure and passing a - pointer to that structure into xBestIndex as the second parameter. - The xBestIndex method fills out other fields of this structure - which forms the reply. The sqlite3_index_info structure looks like - this: - - - struct sqlite3_index_info { - /* Inputs */ - const int nConstraint; /* Number of entries in aConstraint */ - const struct sqlite3_index_constraint { - int iColumn; /* Column on left-hand side of - * constraint */ - unsigned char op; /* Constraint operator */ - unsigned char usable; /* True if this constraint is usable */ - int iTermOffset; /* Used internally - xBestIndex should - * ignore */ - } *const aConstraint; /* Table of WHERE clause constraints */ - const int nOrderBy; /* Number of terms in the ORDER BY - * clause */ - const struct sqlite3_index_orderby { - int iColumn; /* Column number */ - unsigned char desc; /* True for DESC. False for ASC. */ - } *const aOrderBy; /* The ORDER BY clause */ - /* Outputs */ - struct sqlite3_index_constraint_usage { - int argvIndex; /* if greater than zero, constraint is - * part of argv to xFilter */ - unsigned char omit; /* Do not code a test for this - * constraint */ - } *const aConstraintUsage; - int idxNum; /* Number used to identify the index */ - char *idxStr; /* String, possibly obtained from - * sqlite3_malloc() */ - int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if - * true */ - int orderByConsumed; /* True if output is already ordered */ - double estimatedCost; /* Estimated cost of using this index */ - }; - - - In addition, there are some defined constants: - - - #define SQLITE_INDEX_CONSTRAINT_EQ 2 - #define SQLITE_INDEX_CONSTRAINT_GT 4 - #define SQLITE_INDEX_CONSTRAINT_LE 8 - #define SQLITE_INDEX_CONSTRAINT_LT 16 - #define SQLITE_INDEX_CONSTRAINT_GE 32 - #define SQLITE_INDEX_CONSTRAINT_MATCH 64 - - - The SQLite core calls the xBestIndex method when it is compiling a - query that involves a virtual table. In other words, SQLite calls - this method when it is running sqlite3_prepare() or the equivalent. - By calling this method, the SQLite core is saying to the virtual - table that it needs to access some subset of the rows in the - virtual table and it wants to know the most efficient way to do - that access. The xBestIndex method replies with information that - the SQLite core can then use to conduct an efficient search of the - virtual table. - - - While compiling a single SQL query, the SQLite core might call - xBestIndex multiple times with different settings in - sqlite3_index_info. The SQLite core will then select the - combination that appears to give the best performance. - - - Before calling this method, the SQLite core initializes an instance - of the sqlite3_index_info structure with information about the - query that it is currently trying to process. This information - derives mainly from the WHERE clause and ORDER BY or GROUP BY - clauses of the query, but also from any ON or USING clauses if the - query is a join. The information that the SQLite core provides to - the xBestIndex method is held in the part of the structure that is - marked as "Inputs". The "Outputs" section is initialized to zero. - - - The information in the sqlite3_index_info structure is ephemeral - and may be overwritten or deallocated as soon as the xBestIndex - method returns. If the xBestIndex method needs to remember any part - of the sqlite3_index_info structure, it should make a copy. Care - must be take to store the copy in a place where it will be - deallocated, such as in the idxStr field with needToFreeIdxStr set - to 1. - - - Note that xBestIndex will always be called before xFilter, since - the idxNum and idxStr outputs from xBestIndex are required inputs - to xFilter. However, there is no guarantee that xFilter will be - called following a successful xBestIndex. - - - The xBestIndex method is required for every virtual table - implementation. - - - 2.3.1 Inputs - - - The main thing that the SQLite core is trying to communicate to the - virtual table is the constraints that are available to limit the - number of rows that need to be searched. The aConstraint[] array - contains one entry for each constraint. There will be exactly - nConstraint entries in that array. - - - Each constraint will correspond to a term in the WHERE clause or in - a USING or ON clause that is of the form - - - column OP EXPR - - - Where "column" is a column in the virtual table, OP is an operator - like "=" or "<", and EXPR is an arbitrary expression. So, for - example, if the WHERE clause contained a term like this: - - - a = 5 - - - Then one of the constraints would be on the "a" column with - operator "=" and an expression of "5". Constraints need not have a - literal representation of the WHERE clause. The query optimizer - might make transformations to the WHERE clause in order to extract - as many constraints as it can. So, for example, if the WHERE clause - contained something like this: - - - x BETWEEN 10 AND 100 AND 999>y - - - The query optimizer might translate this into three separate - constraints: - - - x >= 10 - x <= 100 - y < 999 - - - For each constraint, the aConstraint[].iColumn field indicates - which column appears on the left-hand side of the constraint. The - first column of the virtual table is column 0. The rowid of the - virtual table is column -1. The aConstraint[].op field indicates - which operator is used. The SQLITE_INDEX_CONSTRAINT_* constants map - integer constants into operator values. Columns occur in the order - they were defined by the call to sqlite3_declare_vtab() in the - xCreate or xConnect method. Hidden columns are counted when - determining the column index. - - - The aConstraint[] array contains information about all constraints - that apply to the virtual table. But some of the constraints might - not be usable because of the way tables are ordered in a join. The - xBestIndex method must therefore only consider constraints that - have an aConstraint[].usable flag which is true. - - - In addition to WHERE clause constraints, the SQLite core also tells - the xBestIndex method about the ORDER BY clause. (In an aggregate - query, the SQLite core might put in GROUP BY clause information in - place of the ORDER BY clause information, but this fact should not - make any difference to the xBestIndex method.) If all terms of the - ORDER BY clause are columns in the virtual table, then nOrderBy - will be the number of terms in the ORDER BY clause and the - aOrderBy[] array will identify the column for each term in the - order by clause and whether or not that column is ASC or DESC. - - - 2.3.2 Outputs - - - Given all of the information above, the job of the xBestIndex - method it to figure out the best way to search the virtual table. - - - The xBestIndex method fills the idxNum and idxStr fields with - information that communicates an indexing strategy to the xFilter - method. The information in idxNum and idxStr is arbitrary as far as - the SQLite core is concerned. The SQLite core just copies the - information through to the xFilter method. Any desired meaning can - be assigned to idxNum and idxStr as long as xBestIndex and xFilter - agree on what that meaning is. - - - The idxStr value may be a string obtained from an SQLite memory - allocation function such as sqlite3_mprintf(). If this is the case, - then the needToFreeIdxStr flag must be set to true so that the - SQLite core will know to call sqlite3_free() on that string when it - has finished with it, and thus avoid a memory leak. - - - If the virtual table will output rows in the order specified by the - ORDER BY clause, then the orderByConsumed flag may be set to true. - If the output is not automatically in the correct order then - orderByConsumed must be left in its default false setting. This - will indicate to the SQLite core that it will need to do a separate - sorting pass over the data after it comes out of the virtual table. - - - The estimatedCost field should be set to the estimated number of - disk access operations required to execute this query against the - virtual table. The SQLite core will often call xBestIndex multiple - times with different constraints, obtain multiple cost estimates, - then choose the query plan that gives the lowest estimate. - - - The aConstraintUsage[] array contains one element for each of the - nConstraint constraints in the inputs section of the - sqlite3_index_info structure. The aConstraintUsage[] array is used - by xBestIndex to tell the core how it is using the constraints. - - - The xBestIndex method may set aConstraintUsage[].argvIndex entries - to values greater than one. Exactly one entry should be set to 1, - another to 2, another to 3, and so forth up to as many or as few as - the xBestIndex method wants. The EXPR of the corresponding - constraints will then be passed in as the argv[] parameters to - xFilter. - - - For example, if the aConstraint[3].argvIndex is set to 1, then when - xFilter is called, the argv[0] passed to xFilter will have the EXPR - value of the aConstraint[3] constraint. - - - By default, the SQLite core double checks all constraints on each - row of the virtual table that it receives. If such a check is - redundant, the xBestFilter method can suppress that double-check by - setting aConstraintUsage[].omit. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The native pointer to the sqlite3_index_info structure. - - - A standard SQLite return code. - - - - - - This method releases a connection to a virtual table. Only the - sqlite3_vtab object is destroyed. The virtual table is not - destroyed and any backing store associated with the virtual table - persists. This method undoes the work of xConnect. - - - This method is a destructor for a connection to the virtual table. - Contrast this method with xDestroy. The xDestroy is a destructor - for the entire virtual table. - - - The xDisconnect method is required for every virtual table - implementation, though it is acceptable for the xDisconnect and - xDestroy methods to be the same function if that makes sense for - the particular virtual table. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - This method releases a connection to a virtual table, just like the - xDisconnect method, and it also destroys the underlying table - implementation. This method undoes the work of xCreate. - - - The xDisconnect method is called whenever a database connection - that uses a virtual table is closed. The xDestroy method is only - called when a DROP TABLE statement is executed against the virtual - table. - - - The xDestroy method is required for every virtual table - implementation, though it is acceptable for the xDisconnect and - xDestroy methods to be the same function if that makes sense for - the particular virtual table. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - The xOpen method creates a new cursor used for accessing (read - and/or writing) a virtual table. A successful invocation of this - method will allocate the memory for the sqlite3_vtab_cursor (or a - subclass), initialize the new object, and make *ppCursor point to - the new object. The successful call then returns SQLITE_OK. - - - For every successful call to this method, the SQLite core will - later invoke the xClose method to destroy the allocated cursor. - - - The xOpen method need not initialize the pVtab field of the - sqlite3_vtab_cursor structure. The SQLite core will take care of - that chore automatically. - - - A virtual table implementation must be able to support an arbitrary - number of simultaneously open cursors. - - - When initially opened, the cursor is in an undefined state. The - SQLite core will invoke the xFilter method on the cursor prior to - any attempt to position or read from the cursor. - - - The xOpen method is required for every virtual table - implementation. - - - - The native pointer to the sqlite3_vtab derived structure. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab_cursor derived structure. - - - A standard SQLite return code. - - - - - - The xClose method closes a cursor previously opened by xOpen. The - SQLite core will always call xClose once for each cursor opened - using xOpen. - - - This method must release all resources allocated by the - corresponding xOpen call. The routine will not be called again even - if it returns an error. The SQLite core will not use the - sqlite3_vtab_cursor again after it has been closed. - - - The xClose method is required for every virtual table - implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - A standard SQLite return code. - - - - - - This method begins a search of a virtual table. The first argument - is a cursor opened by xOpen. The next two argument define a - particular search index previously chosen by xBestIndex. The - specific meanings of idxNum and idxStr are unimportant as long as - xFilter and xBestIndex agree on what that meaning is. - - - The xBestIndex function may have requested the values of certain - expressions using the aConstraintUsage[].argvIndex values of the - sqlite3_index_info structure. Those values are passed to xFilter - using the argc and argv parameters. - - - If the virtual table contains one or more rows that match the - search criteria, then the cursor must be left point at the first - row. Subsequent calls to xEof must return false (zero). If there - are no rows match, then the cursor must be left in a state that - will cause the xEof to return true (non-zero). The SQLite engine - will use the xColumn and xRowid methods to access that row content. - The xNext method will be used to advance to the next row. - - - This method must return SQLITE_OK if successful, or an sqlite error - code if an error occurs. - - - The xFilter method is required for every virtual table - implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - Number used to help identify the selected index. - - - The native pointer to the UTF-8 encoded string containing the - string used to help identify the selected index. - - - The number of native pointers to sqlite3_value structures specified - in . - - - An array of native pointers to sqlite3_value structures containing - filtering criteria for the selected index. - - - A standard SQLite return code. - - - - - - The xNext method advances a virtual table cursor to the next row of - a result set initiated by xFilter. If the cursor is already - pointing at the last row when this routine is called, then the - cursor no longer points to valid data and a subsequent call to the - xEof method must return true (non-zero). If the cursor is - successfully advanced to another row of content, then subsequent - calls to xEof must return false (zero). - - - This method must return SQLITE_OK if successful, or an sqlite error - code if an error occurs. - - - The xNext method is required for every virtual table - implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - A standard SQLite return code. - - - - - - The xEof method must return false (zero) if the specified cursor - currently points to a valid row of data, or true (non-zero) - otherwise. This method is called by the SQL engine immediately - after each xFilter and xNext invocation. - - - The xEof method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - Non-zero if no more rows are available; zero otherwise. - - - - - - The SQLite core invokes this method in order to find the value for - the N-th column of the current row. N is zero-based so the first - column is numbered 0. The xColumn method may return its result back - to SQLite using one of the following interface: - - - sqlite3_result_blob() - sqlite3_result_double() - sqlite3_result_int() - sqlite3_result_int64() - sqlite3_result_null() - sqlite3_result_text() - sqlite3_result_text16() - sqlite3_result_text16le() - sqlite3_result_text16be() - sqlite3_result_zeroblob() - - - If the xColumn method implementation calls none of the functions - above, then the value of the column defaults to an SQL NULL. - - - To raise an error, the xColumn method should use one of the - result_text() methods to set the error message text, then return an - appropriate error code. The xColumn method must return SQLITE_OK on - success. - - - The xColumn method is required for every virtual table - implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - The native pointer to the sqlite3_context structure to be used - for returning the specified column value to the SQLite core + This interface represents a native handle provided by the SQLite core library. - - - The zero-based index corresponding to the column containing the - value to be returned. - - - A standard SQLite return code. - - - - - - A successful invocation of this method will cause *pRowid to be - filled with the rowid of row that the virtual table cursor pCur is - currently pointing at. This method returns SQLITE_OK on success. It - returns an appropriate error code on failure. - - - The xRowid method is required for every virtual table - implementation. - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the current row for the specified cursor. - - - A standard SQLite return code. - - + - - All changes to a virtual table are made using the xUpdate method. - This one method can be used to insert, delete, or update. - - - The argc parameter specifies the number of entries in the argv - array. The value of argc will be 1 for a pure delete operation or - N+2 for an insert or replace or update where N is the number of - columns in the table. In the previous sentence, N includes any - hidden columns. - - - Every argv entry will have a non-NULL value in C but may contain - the SQL value NULL. In other words, it is always true that - argv[i]!=0 for i between 0 and argc-1. However, it might be the - case that sqlite3_value_type(argv[i])==SQLITE_NULL. - - - The argv[0] parameter is the rowid of a row in the virtual table - to be deleted. If argv[0] is an SQL NULL, then no deletion occurs. - - - The argv[1] parameter is the rowid of a new row to be inserted into - the virtual table. If argv[1] is an SQL NULL, then the - implementation must choose a rowid for the newly inserted row. - Subsequent argv[] entries contain values of the columns of the - virtual table, in the order that the columns were declared. The - number of columns will match the table declaration that the - xConnect or xCreate method made using the sqlite3_declare_vtab() - call. All hidden columns are included. - - - When doing an insert without a rowid (argc>1, argv[1] is an SQL - NULL), the implementation must set *pRowid to the rowid of the - newly inserted row; this will become the value returned by the - sqlite3_last_insert_rowid() function. Setting this value in all the - other cases is a harmless no-op; the SQLite engine ignores the - *pRowid return value if argc==1 or argv[1] is not an SQL NULL. - - - Each call to xUpdate will fall into one of cases shown below. Note - that references to argv[i] mean the SQL value held within the - argv[i] object, not the argv[i] object itself. - - - argc = 1 - - - The single row with rowid equal to argv[0] is deleted. No - insert occurs. - - - argc > 1 - argv[0] = NULL - - - A new row is inserted with a rowid argv[1] and column - values in argv[2] and following. If argv[1] is an SQL NULL, - the a new unique rowid is generated automatically. - - - argc > 1 - argv[0] ? NULL - argv[0] = argv[1] - - - The row with rowid argv[0] is updated with new values in - argv[2] and following parameters. - - - argc > 1 - argv[0] ? NULL - argv[0] ? argv[1] - - - The row with rowid argv[0] is updated with rowid argv[1] - and new values in argv[2] and following parameters. This - will occur when an SQL statement updates a rowid, as in - the statement: - - - UPDATE table SET rowid=rowid+1 WHERE ...; - - - The xUpdate method must return SQLITE_OK if and only if it is - successful. If a failure occurs, the xUpdate must return an - appropriate error code. On a failure, the pVTab->zErrMsg element - may optionally be replaced with error message text stored in memory - allocated from SQLite using functions such as sqlite3_mprintf() or - sqlite3_malloc(). - - - If the xUpdate method violates some constraint of the virtual table - (including, but not limited to, attempting to store a value of the - wrong datatype, attempting to store a value that is too large or - too small, or attempting to change a read-only value) then the - xUpdate must fail with an appropriate error code. - - - There might be one or more sqlite3_vtab_cursor objects open and in - use on the virtual table instance and perhaps even on the row of - the virtual table when the xUpdate method is invoked. The - implementation of xUpdate must be prepared for attempts to delete - or modify rows of the table out from other existing cursors. If the - virtual table cannot accommodate such changes, the xUpdate method - must return an error code. - - - The xUpdate method is optional. If the xUpdate pointer in the - sqlite3_module for a virtual table is a NULL pointer, then the - virtual table is read-only. - + The native handle value. - - The native pointer to the sqlite3_vtab derived structure. - - - The number of new or modified column values contained in - . - - - The array of native pointers to sqlite3_value structures containing - the new or modified column values, if any. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the row that was inserted, if any. - - - A standard SQLite return code. - - - - - - This method begins a transaction on a virtual table. This is method - is optional. The xBegin pointer of sqlite3_module may be NULL. - - - This method is always followed by one call to either the xCommit or - xRollback method. Virtual table transactions do not nest, so the - xBegin method will not be invoked more than once on a single - virtual table without an intervening call to either xCommit or - xRollback. Multiple calls to other methods can and likely will - occur in between the xBegin and the corresponding xCommit or - xRollback. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - This method signals the start of a two-phase commit on a virtual - table. This is method is optional. The xSync pointer of - sqlite3_module may be NULL. - - - This method is only invoked after call to the xBegin method and - prior to an xCommit or xRollback. In order to implement two-phase - commit, the xSync method on all virtual tables is invoked prior to - invoking the xCommit method on any virtual table. If any of the - xSync methods fail, the entire transaction is rolled back. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - This method causes a virtual table transaction to commit. This is - method is optional. The xCommit pointer of sqlite3_module may be - NULL. - - - A call to this method always follows a prior call to xBegin and - xSync. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - This method causes a virtual table transaction to rollback. This is - method is optional. The xRollback pointer of sqlite3_module may be - NULL. - - - A call to this method always follows a prior call to xBegin. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - This method provides notification that the virtual table - implementation that the virtual table will be given a new name. If - this method returns SQLITE_OK then SQLite renames the table. If - this method returns an error code then the renaming is prevented. - - - The xRename method is required for every virtual table - implementation. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The number of arguments to the function being sought. - - - The name of the function being sought. - - - Upon success, this parameter must be modified to contain the - delegate responsible for implementing the specified function. - - - Upon success, this parameter must be modified to contain the - native user-data pointer associated with - . - - - Non-zero if the specified function was found; zero otherwise. - - - - - - This method provides notification that the virtual table - implementation that the virtual table will be given a new name. If - this method returns SQLITE_OK then SQLite renames the table. If - this method returns an error code then the renaming is prevented. - - - The xRename method is required for every virtual table - implementation. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The native pointer to the UTF-8 encoded string containing the new - name for the virtual table. - - - A standard SQLite return code. - - - - - - These methods provide the virtual table implementation an - opportunity to implement nested transactions. They are always - optional and will only be called in SQLite version 3.7.7 and later. - - - When xSavepoint(X,N) is invoked, that is a signal to the virtual - table X that it should save its current state as savepoint N. A - subsequent call to xRollbackTo(X,R) means that the state of the - virtual table should return to what it was when xSavepoint(X,R) was - last called. The call to xRollbackTo(X,R) will invalidate all - savepoints with N>R; none of the invalided savepoints will be - rolled back or released without first being reinitialized by a call - to xSavepoint(). A call to xRelease(X,M) invalidates all savepoints - where N>=M. - - - None of the xSavepoint(), xRelease(), or xRollbackTo() methods will - ever be called except in between calls to xBegin() and either - xCommit() or xRollback(). - - - - The native pointer to the sqlite3_vtab derived structure. - - - This is an integer identifier under which the the current state of - the virtual table should be saved. - - - A standard SQLite return code. - - - - - - These methods provide the virtual table implementation an - opportunity to implement nested transactions. They are always - optional and will only be called in SQLite version 3.7.7 and later. - - - When xSavepoint(X,N) is invoked, that is a signal to the virtual - table X that it should save its current state as savepoint N. A - subsequent call to xRollbackTo(X,R) means that the state of the - virtual table should return to what it was when xSavepoint(X,R) was - last called. The call to xRollbackTo(X,R) will invalidate all - savepoints with N>R; none of the invalided savepoints will be - rolled back or released without first being reinitialized by a call - to xSavepoint(). A call to xRelease(X,M) invalidates all savepoints - where N>=M. - - - None of the xSavepoint(), xRelease(), or xRollbackTo() methods will - ever be called except in between calls to xBegin() and either - xCommit() or xRollback(). - - - - The native pointer to the sqlite3_vtab derived structure. - - - This is an integer used to indicate that any saved states with an - identifier greater than or equal to this should be deleted by the - virtual table. - - - A standard SQLite return code. - - - - - - These methods provide the virtual table implementation an - opportunity to implement nested transactions. They are always - optional and will only be called in SQLite version 3.7.7 and later. - - - When xSavepoint(X,N) is invoked, that is a signal to the virtual - table X that it should save its current state as savepoint N. A - subsequent call to xRollbackTo(X,R) means that the state of the - virtual table should return to what it was when xSavepoint(X,R) was - last called. The call to xRollbackTo(X,R) will invalidate all - savepoints with N>R; none of the invalided savepoints will be - rolled back or released without first being reinitialized by a call - to xSavepoint(). A call to xRelease(X,M) invalidates all savepoints - where N>=M. - - - None of the xSavepoint(), xRelease(), or xRollbackTo() methods will - ever be called except in between calls to xBegin() and either - xCommit() or xRollback(). - - - - The native pointer to the sqlite3_vtab derived structure. - - - This is an integer identifier used to specify a specific saved - state for the virtual table for it to restore itself back to, which - should also have the effect of deleting all saved states with an - integer identifier greater than this one. - - - A standard SQLite return code. - @@ -9762,13 +14493,25 @@ managed code. + + + Returns non-zero if the schema for the virtual table has been + declared. + + + + + Returns the name of the module as it was registered with the SQLite + core library. + + This method is called in response to the - method. + method. - The object instance associated with + The object instance associated with the virtual table. @@ -9782,7 +14525,7 @@ Upon success, this parameter must be modified to contain the - object instance associated with + object instance associated with the virtual table. @@ -9796,10 +14539,10 @@ This method is called in response to the - method. + method. - The object instance associated with + The object instance associated with the virtual table. @@ -9813,7 +14556,7 @@ Upon success, this parameter must be modified to contain the - object instance associated with + object instance associated with the virtual table. @@ -9827,14 +14570,14 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. - The object instance containing all the + The object instance containing all the data for the inputs and outputs relating to index selection. @@ -9844,10 +14587,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -9857,10 +14600,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -9870,15 +14613,15 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. Upon success, this parameter must be modified to contain the - object instance associated + object instance associated with the newly opened virtual table cursor. @@ -9888,10 +14631,10 @@ This method is called in response to the - method. + method. - The object instance + The object instance associated with the previously opened virtual table cursor to be used. @@ -9902,10 +14645,10 @@ This method is called in response to the - method. + method. - The object instance + The object instance associated with the previously opened virtual table cursor to be used. @@ -9925,10 +14668,10 @@ This method is called in response to the - method. + method. - The object instance + The object instance associated with the previously opened virtual table cursor to be used. @@ -9939,10 +14682,10 @@ This method is called in response to the - method. + method. - The object instance + The object instance associated with the previously opened virtual table cursor to be used. @@ -9953,15 +14696,15 @@ This method is called in response to the - method. + method. - The object instance + The object instance associated with the previously opened virtual table cursor to be used. - The object instance to be used for + The object instance to be used for returning the specified column value to the SQLite core library. @@ -9975,10 +14718,10 @@ This method is called in response to the - method. + method. - The object instance + The object instance associated with the previously opened virtual table cursor to be used. @@ -9993,14 +14736,14 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. - The array of object instances containing + The array of object instances containing the new or modified column values, if any. @@ -10014,10 +14757,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -10027,10 +14770,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -10040,10 +14783,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -10053,10 +14796,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -10066,10 +14809,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -10080,13 +14823,13 @@ Upon success, this parameter must be modified to contain the - object instance responsible for + object instance responsible for implementing the specified function. Upon success, this parameter must be modified to contain the native user-data pointer associated with - . + . Non-zero if the specified function was found; zero otherwise. @@ -10095,10 +14838,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -10111,10 +14854,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -10128,10 +14871,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -10146,10 +14889,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -10162,47 +14905,126 @@ A standard SQLite return code. - - - Returns non-zero if the schema for the virtual table has been - declared. - - - - - Returns the name of the module as it was registered with the SQLite - core library. - - This class contains static methods that are used to allocate, manipulate, and free native memory provided by the SQLite core library. + + + Determines if the native sqlite3_msize() API can be used, based on + the available version of the SQLite core library. + + + Non-zero if the native sqlite3_msize() API is supported by the + SQLite core library. + + Allocates at least the specified number of bytes of native memory via the SQLite core library sqlite3_malloc() function and returns - the resulting native pointer. + the resulting native pointer. If the TRACK_MEMORY_BYTES option + was enabled at compile-time, adjusts the number of bytes currently + allocated by this class. The number of bytes to allocate. The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could + specified size -OR- if the memory could + not be allocated. + + + + + Allocates at least the specified number of bytes of native memory + via the SQLite core library sqlite3_malloc64() function and returns + the resulting native pointer. If the TRACK_MEMORY_BYTES option + was enabled at compile-time, adjusts the number of bytes currently + allocated by this class. + + + The number of bytes to allocate. + + + The native pointer that points to a block of memory of at least the + specified size -OR- if the memory could + not be allocated. + + + + + Allocates at least the specified number of bytes of native memory + via the SQLite core library sqlite3_malloc() function and returns + the resulting native pointer without adjusting the number of + allocated bytes currently tracked by this class. This is useful + when dealing with blocks of memory that will be freed directly by + the SQLite core library. + + + The number of bytes to allocate. + + + The native pointer that points to a block of memory of at least the + specified size -OR- if the memory could + not be allocated. + + + + + Allocates at least the specified number of bytes of native memory + via the SQLite core library sqlite3_malloc64() function and returns + the resulting native pointer without adjusting the number of + allocated bytes currently tracked by this class. This is useful + when dealing with blocks of memory that will be freed directly by + the SQLite core library. + + + The number of bytes to allocate. + + + The native pointer that points to a block of memory of at least the + specified size -OR- if the memory could not be allocated. - Gets and returns the actual size of the specified memory block that - was previously obtained from the method. + Gets and returns the actual size of the specified memory block + that was previously obtained from the , + , , or + methods or directly from the + SQLite core library. - The native pointer to the memory block previously obtained from the - method. + The native pointer to the memory block previously obtained from + the , , + , or + methods or directly from the + SQLite core library. + + + The actual size, in bytes, of the memory block specified via the + native pointer. + + + + + Gets and returns the actual size of the specified memory block + that was previously obtained from the , + , , or + methods or directly from the + SQLite core library. + + + The native pointer to the memory block previously obtained from + the , , + , or + methods or directly from the + SQLite core library. The actual size, in bytes, of the memory block specified via the @@ -10212,11 +15034,25 @@ Frees a memory block previously obtained from the - method. + or methods. If + the TRACK_MEMORY_BYTES option was enabled at compile-time, adjusts + the number of bytes currently allocated by this class. The native pointer to the memory block previously obtained from the - method. + or methods. + + + + + Frees a memory block previously obtained from the SQLite core + library without adjusting the number of allocated bytes currently + tracked by this class. This is useful when dealing with blocks of + memory that were not allocated using this class. + + + The native pointer to the memory block previously obtained from the + SQLite core library. @@ -10233,7 +15069,7 @@ - This is the object instance used to handle + This is the object instance used to handle conversions from/to UTF-8. @@ -10317,7 +15153,65 @@ The native NUL-terminated UTF-8 string pointer or - upon failure. + upon failure. + + + + + Converts the specified managed string into a native NUL-terminated + UTF-8 string pointer using memory obtained from the SQLite core + library. + + + The managed string to convert. + + + Non-zero to obtain memory from the SQLite core library without + adjusting the number of allocated bytes currently being tracked + by the class. + + + The native NUL-terminated UTF-8 string pointer or + upon failure. + + + + + Converts the specified managed string into a native NUL-terminated + UTF-8 string pointer using memory obtained from the SQLite core + library. + + + The managed string to convert. + + + The length of the native string, in bytes. + + + The native NUL-terminated UTF-8 string pointer or + upon failure. + + + + + Converts the specified managed string into a native NUL-terminated + UTF-8 string pointer using memory obtained from the SQLite core + library. + + + The managed string to convert. + + + Non-zero to obtain memory from the SQLite core library without + adjusting the number of allocated bytes currently being tracked + by the class. + + + The length of the native string, in bytes. + + + The native NUL-terminated UTF-8 string pointer or + upon failure. @@ -10337,7 +15231,7 @@ The array of managed strings or null upon failure. - + Converts an array of managed strings into an array of native NUL-terminated UTF-8 string pointers. @@ -10345,6 +15239,11 @@ The array of managed strings to convert. + + Non-zero to obtain memory from the SQLite core library without + adjusting the number of allocated bytes currently being tracked + by the class. + The array of native NUL-terminated UTF-8 string pointers or null upon failure. @@ -10384,6 +15283,21 @@ The native pointer to a logical byte array or null upon failure. + + + Converts a managed byte array into a native pointer to a logical + array of bytes. + + + The managed byte array to convert. + + + The length, in bytes, of the converted logical array of bytes. + + + The native pointer to a logical byte array or null upon failure. + + This class contains static methods that are used to perform several @@ -10392,20 +15306,20 @@ - Returns a new object instance based on the - specified object instance and an integer + Returns a new object instance based on the + specified object instance and an integer offset. - The object instance representing the base + The object instance representing the base memory location. The integer offset from the base memory location that the new - object instance should point to. + object instance should point to. - The new object instance. + The new object instance. @@ -10443,121 +15357,138 @@ - Reads a value from the specified memory + Reads a value from the specified memory location. - The object instance representing the base + The object instance representing the base memory location. The integer offset from the base memory location where the - value to be read is located. + value to be read is located. - The value at the specified memory location. + The value at the specified memory location. + + + + + Reads a value from the specified memory + location. + + + The object instance representing the base + memory location. + + + The integer offset from the base memory location where the + value to be read is located. + + + The value at the specified memory location. - Reads a value from the specified memory + Reads a value from the specified memory location. - The object instance representing the base + The object instance representing the base memory location. The integer offset from the base memory location where the - to be read is located. + to be read is located. - The value at the specified memory location. + The value at the specified memory location. - Reads an value from the specified memory + Reads an value from the specified memory location. - The object instance representing the base + The object instance representing the base memory location. The integer offset from the base memory location where the - value to be read is located. + value to be read is located. - The value at the specified memory location. + The value at the specified memory location. - Writes an value to the specified memory + Writes an value to the specified memory location. - The object instance representing the base + The object instance representing the base memory location. The integer offset from the base memory location where the - value to be written is located. + value to be written is located. - The value to write. + The value to write. - Writes an value to the specified memory + Writes an value to the specified memory location. - The object instance representing the base + The object instance representing the base memory location. The integer offset from the base memory location where the - value to be written is located. + value to be written is located. - The value to write. + The value to write. - Writes a value to the specified memory + Writes a value to the specified memory location. - The object instance representing the base + The object instance representing the base memory location. The integer offset from the base memory location where the - value to be written is located. + value to be written is located. - The value to write. + The value to write. - Writes a value to the specified memory + Writes a value to the specified memory location. - The object instance representing the base + The object instance representing the base memory location. The integer offset from the base memory location where the - value to be written is located. + value to be written is located. - The value to write. + The value to write. @@ -10583,6 +15514,437 @@ user-defined virtual table module classes implemented in managed code. + + + This class implements the + interface by forwarding those method calls to the + object instance it contains. If the + contained object instance is null, all + the methods simply generate an + error. + + + + + This is the value that is always used for the "logErrors" + parameter to the various static error handling methods provided + by the class. + + + + + This is the value that is always used for the "logExceptions" + parameter to the various static error handling methods provided + by the class. + + + + + This is the error message text used when the contained + object instance is not available + for any reason. + + + + + The object instance used to provide + an implementation of the + interface. + + + + + Constructs an instance of this class. + + + The object instance used to provide + an implementation of the + interface. + + + + + Sets the table error message to one that indicates the native + module implementation is not available. + + + The native pointer to the sqlite3_vtab derived structure. + + + The value of . + + + + + Sets the table error message to one that indicates the native + module implementation is not available. + + + The native pointer to the sqlite3_vtab_cursor derived + structure. + + + The value of . + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + Disposes of this object instance. + + + + + Throws an if this object + instance has been disposed. + + + + + Disposes of this object instance. + + + Non-zero if this method is being called from the + method. Zero if this method is being + called from the finalizer. + + + + + Finalizes this object instance. + + The default version of the native sqlite3_module structure in use. @@ -10668,43 +16030,43 @@ Creates and returns the native sqlite_module structure using the - configured (or default) + configured (or default) interface implementation. The native sqlite_module structure using the configured (or - default) interface + default) interface implementation. Creates and returns the native sqlite_module structure using the - specified interface + specified interface implementation. - The interface implementation to + The interface implementation to use. The native sqlite_module structure using the specified - interface implementation. + interface implementation. Creates a copy of the specified - object instance, + object instance, using default implementations for the contained delegates when necessary. - The object + The object instance to copy. - The new object + The new object instance. @@ -10713,8 +16075,8 @@ Calls one of the virtual table initialization methods. - Non-zero to call the - method; otherwise, the + Non-zero to call the + method; otherwise, the method will be called. @@ -10750,9 +16112,9 @@ Calls one of the virtual table finalization methods. - Non-zero to call the + Non-zero to call the method; otherwise, the - method will be + method will be called. @@ -10769,18 +16131,18 @@ existing error message, if any. - The object instance to be used. + The object instance to be used. The native pointer to the sqlite3_vtab derived structure. Non-zero if this error message should also be logged using the - class. + class. Non-zero if caught exceptions should be logged using the - class. + class. The error message. @@ -10796,19 +16158,19 @@ existing error message, if any. - The object instance to be used. + The object instance to be used. - The object instance used to + The object instance used to lookup the native pointer to the sqlite3_vtab derived structure. Non-zero if this error message should also be logged using the - class. + class. Non-zero if caught exceptions should be logged using the - class. + class. The error message. @@ -10824,7 +16186,7 @@ existing error message, if any. - The object instance to be used. + The object instance to be used. The native pointer to the sqlite3_vtab_cursor derived structure @@ -10833,11 +16195,11 @@ Non-zero if this error message should also be logged using the - class. + class. Non-zero if caught exceptions should be logged using the - class. + class. The error message. @@ -10853,19 +16215,19 @@ existing error message, if any. - The object instance to be used. + The object instance to be used. - The object instance used to + The object instance used to lookup the native pointer to the sqlite3_vtab derived structure. Non-zero if this error message should also be logged using the - class. + class. Non-zero if caught exceptions should be logged using the - class. + class. The error message. @@ -10876,30 +16238,30 @@ - Gets and returns the interface + Gets and returns the interface implementation to be used when creating the native sqlite3_module structure. Derived classes may override this method to supply an - alternate implementation for the + alternate implementation for the interface. - The interface implementation to + The interface implementation to be used when populating the native sqlite3_module structure. If the returned value is null, the private methods provided by the - class and relating to the - interface will be used to + class and relating to the + interface will be used to create the necessary delegates. - Creates and returns the + Creates and returns the interface implementation corresponding to the current - object instance. + object instance. - The interface implementation - corresponding to the current object + The interface implementation + corresponding to the current object instance. @@ -10955,7 +16317,7 @@ derived structure. - The object instance to be used. + The object instance to be used. The native pointer to the sqlite3_vtab_cursor derived structure @@ -10964,7 +16326,7 @@ The native pointer to the sqlite3_vtab derived structure -OR- - if it cannot be determined. + if it cannot be determined. @@ -10980,12 +16342,12 @@ The native pointer to the sqlite3_vtab derived structure -OR- - if it cannot be determined. + if it cannot be determined. - Looks up and returns the object + Looks up and returns the object instance based on the native pointer to the sqlite3_vtab derived structure. @@ -10993,7 +16355,7 @@ The native pointer to the sqlite3_vtab derived structure. - The object instance or null if + The object instance or null if the corresponding one cannot be found. @@ -11001,20 +16363,20 @@ Allocates and returns a native pointer to a sqlite3_vtab derived structure and creates an association between it and the specified - object instance. + object instance. - The object instance to be used + The object instance to be used when creating the association. The native pointer to a sqlite3_vtab derived structure or - if the method fails for any reason. + if the method fails for any reason. - Looks up and returns the + Looks up and returns the object instance based on the native pointer to the sqlite3_vtab_cursor derived structure. @@ -11025,7 +16387,7 @@ The native pointer to the sqlite3_vtab_cursor derived structure. - The object instance or null + The object instance or null if the corresponding one cannot be found. @@ -11033,23 +16395,23 @@ Allocates and returns a native pointer to a sqlite3_vtab_cursor derived structure and creates an association between it and the - specified object instance. + specified object instance. - The object instance to be + The object instance to be used when creating the association. The native pointer to a sqlite3_vtab_cursor derived structure or - if the method fails for any reason. + if the method fails for any reason. Deterimines the key that should be used to identify and store the - object instance for the virtual table + object instance for the virtual table (i.e. to be returned via the - method). + method). The number of arguments to the virtual table function. @@ -11058,7 +16420,7 @@ The name of the virtual table function. - The object instance associated with + The object instance associated with this virtual table function. @@ -11073,7 +16435,7 @@ specified database connection. - The object instance to use when + The object instance to use when declaring the schema of the virtual table. This parameter may not be null. @@ -11094,12 +16456,12 @@ Calls the native SQLite core library in order to declare a virtual table function in response to a call into the - - or virtual table + + or virtual table methods. - The object instance to use when + The object instance to use when declaring the schema of the virtual table. @@ -11116,6 +16478,24 @@ A standard SQLite return code. + + + Returns or sets a boolean value indicating whether virtual table + errors should be logged using the class. + + + + + Returns or sets a boolean value indicating whether exceptions + caught in the + method, + the method, + the method, + the method, + and the method should be logged using the + class. + + Arranges for the specified error message to be placed into the @@ -11139,7 +16519,7 @@ existing error message, if any. - The object instance used to + The object instance used to lookup the native pointer to the sqlite3_vtab derived structure. @@ -11156,7 +16536,7 @@ existing error message, if any. - The object instance used to + The object instance used to lookup the native pointer to the sqlite3_vtab derived structure. @@ -11168,11 +16548,11 @@ - Modifies the specified object instance + Modifies the specified object instance to contain the specified estimated cost. - The object instance to modify. + The object instance to modify. The estimated cost value to use. Using a null value means that the @@ -11184,11 +16564,11 @@ - Modifies the specified object instance + Modifies the specified object instance to contain the default estimated cost. - The object instance to modify. + The object instance to modify. Non-zero upon success. @@ -11196,11 +16576,11 @@ - Modifies the specified object instance + Modifies the specified object instance to contain the specified estimated rows. - The object instance to modify. + The object instance to modify. The estimated rows value to use. Using a null value means that the @@ -11212,355 +16592,411 @@ - Modifies the specified object instance + Modifies the specified object instance to contain the default estimated rows. - The object instance to modify. + The object instance to modify. Non-zero upon success. - + - See the method. + Modifies the specified object instance + to contain the specified flags. - - See the method. + + The object instance to modify. - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. + + The index flags value to use. Using a null value means that the + default value provided by the SQLite core library should be used. - See the method. + Non-zero upon success. + + + + + Modifies the specified object instance + to contain the default index flags. + + + The object instance to modify. + + + Non-zero upon success. + + + + + Returns or sets a boolean value indicating whether virtual table + errors should be logged using the class. + + + + + Returns or sets a boolean value indicating whether exceptions + caught in the + method, + method, and the + method should be logged using the + class. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. + + + Returns non-zero if the schema for the virtual table has been + declared. + + + + + Returns the name of the module as it was registered with the SQLite + core library. + + This method is called in response to the - method. + method. - The object instance associated with + The object instance associated with the virtual table. @@ -11574,7 +17010,7 @@ Upon success, this parameter must be modified to contain the - object instance associated with + object instance associated with the virtual table. @@ -11588,10 +17024,10 @@ This method is called in response to the - method. + method. - The object instance associated with + The object instance associated with the virtual table. @@ -11605,7 +17041,7 @@ Upon success, this parameter must be modified to contain the - object instance associated with + object instance associated with the virtual table. @@ -11619,14 +17055,14 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. - The object instance containing all the + The object instance containing all the data for the inputs and outputs relating to index selection. @@ -11636,10 +17072,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -11649,10 +17085,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -11662,15 +17098,15 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. Upon success, this parameter must be modified to contain the - object instance associated + object instance associated with the newly opened virtual table cursor. @@ -11680,10 +17116,10 @@ This method is called in response to the - method. + method. - The object instance + The object instance associated with the previously opened virtual table cursor to be used. @@ -11694,10 +17130,10 @@ This method is called in response to the - method. + method. - The object instance + The object instance associated with the previously opened virtual table cursor to be used. @@ -11717,10 +17153,10 @@ This method is called in response to the - method. + method. - The object instance + The object instance associated with the previously opened virtual table cursor to be used. @@ -11731,10 +17167,10 @@ This method is called in response to the - method. + method. - The object instance + The object instance associated with the previously opened virtual table cursor to be used. @@ -11745,15 +17181,15 @@ This method is called in response to the - method. + method. - The object instance + The object instance associated with the previously opened virtual table cursor to be used. - The object instance to be used for + The object instance to be used for returning the specified column value to the SQLite core library. @@ -11767,10 +17203,10 @@ This method is called in response to the - method. + method. - The object instance + The object instance associated with the previously opened virtual table cursor to be used. @@ -11785,14 +17221,14 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. - The array of object instances containing + The array of object instances containing the new or modified column values, if any. @@ -11806,10 +17242,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -11819,10 +17255,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -11832,10 +17268,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -11845,10 +17281,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -11858,10 +17294,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -11872,13 +17308,13 @@ Upon success, this parameter must be modified to contain the - object instance responsible for + object instance responsible for implementing the specified function. Upon success, this parameter must be modified to contain the native user-data pointer associated with - . + . Non-zero if the specified function was found; zero otherwise. @@ -11887,10 +17323,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -11903,10 +17339,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -11920,10 +17356,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -11938,10 +17374,10 @@ This method is called in response to the - method. + method. - The object instance associated + The object instance associated with this virtual table. @@ -11961,7 +17397,7 @@ - Throws an if this object + Throws an if this object instance has been disposed. @@ -11971,7 +17407,7 @@ Non-zero if this method is being called from the - method. Zero if this method is being + method. Zero if this method is being called from the finalizer. @@ -11980,501 +17416,159 @@ Finalizes this object instance. - + - Returns or sets a boolean value indicating whether virtual table - errors should be logged using the class. + This class contains some virtual methods that may be useful for other + virtual table classes. It specifically does NOT implement any of the + interface methods. - + - Returns or sets a boolean value indicating whether exceptions - caught in the - method, - the method, - the method, - the method, - and the method should be logged using the - class. + The CREATE TABLE statement used to declare the schema for the + virtual table. - + - Returns or sets a boolean value indicating whether virtual table - errors should be logged using the class. + Non-zero if different object instances with the same value should + generate different row identifiers, where applicable. This has no + effect on the .NET Compact Framework. - - - Returns or sets a boolean value indicating whether exceptions - caught in the - method, - method, and the - method should be logged using the - class. - - - - - Returns non-zero if the schema for the virtual table has been - declared. - - - - - Returns the name of the module as it was registered with the SQLite - core library. - - - - - This class implements the - interface by forwarding those method calls to the - object instance it contains. If the - contained object instance is null, all - the methods simply generate an - error. - - - - - This is the value that is always used for the "logErrors" - parameter to the various static error handling methods provided - by the class. - - - - - This is the value that is always used for the "logExceptions" - parameter to the various static error handling methods provided - by the class. - - - - - This is the error message text used when the contained - object instance is not available - for any reason. - - - - - The object instance used to provide - an implementation of the - interface. - - - + Constructs an instance of this class. - - The object instance used to provide - an implementation of the - interface. + + The name of the module. This parameter cannot be null. - + - Sets the table error message to one that indicates the native - module implementation is not available. + Constructs an instance of this class. - - The native pointer to the sqlite3_vtab derived structure. + + The name of the module. This parameter cannot be null. + + Non-zero if different object instances with the same value should + generate different row identifiers, where applicable. This + parameter has no effect on the .NET Compact Framework. + + + + + Determines the SQL statement used to declare the virtual table. + This method should be overridden in derived classes if they require + a custom virtual table schema. + - The value of . + The SQL statement used to declare the virtual table -OR- null if it + cannot be determined. - + - Sets the table error message to one that indicates the native - module implementation is not available. + Sets the table error message to one that indicates the virtual + table cursor is of the wrong type. - - The native pointer to the sqlite3_vtab_cursor derived - structure. + + The object instance. + + + The that the virtual table cursor should be. - The value of . + The value of . - + - See the method. + Determines the string to return as the column value for the object + instance value. - - See the method. + + The object instance + associated with the previously opened virtual table cursor to be + used. - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. + + The object instance to return a string representation for. - See the method. + The string representation of the specified object instance or null + upon failure. - + - See the method. + Constructs an unique row identifier from two + values. The first value + must contain the row sequence number for the current row and the + second value must contain the hash code of the key column value + for the current row. - - See the method. + + The integer row sequence number for the current row. - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. + + The hash code of the key column value for the current row. - See the method. + The unique row identifier or zero upon failure. - + - See the method. + Determines the unique row identifier for the current row. - - See the method. + + The object instance + associated with the previously opened virtual table cursor to be + used. - - See the method. + + The object instance to return a unique row identifier for. - See the method. + The unique row identifier or zero upon failure. - + - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Disposes of this object instance. - - - - - Throws an if this object + Throws an if this object instance has been disposed. - + Disposes of this object instance. Non-zero if this method is being called from the - method. Zero if this method is being - called from the finalizer. + method. Zero if this method is + being called from the finalizer. - - - Finalizes this object instance. - - This class represents a virtual table cursor to be used with the - class. It is not sealed and may + class. It is not sealed and may be used as the base class for any user-defined virtual table cursor - class that wraps an object instance. + class that wraps an object instance. - The instance provided when this cursor + The instance provided when this cursor was created. This value will be non-zero if false has been returned from the - method. + method. @@ -12482,65 +17576,37 @@ Constructs an instance of this class. - The object instance associated + The object instance associated with this object instance. - The instance to expose as a virtual + The instance to expose as a virtual table cursor. Advances to the next row of the virtual table cursor using the - method of the - object instance. + method of the + object instance. Non-zero if the current row is valid; zero otherwise. If zero is returned, no further rows are available. - - - Resets the virtual table cursor position, also invalidating the - current row, using the method of - the object instance. - - - - - Closes the virtual table cursor. This method must not throw any - exceptions. - - - - - Throws an if the virtual - table cursor has been closed. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - Returns the value for the current row of the virtual table cursor - using the property of the - object instance. + using the property of the + object instance. + + + + + Resets the virtual table cursor position, also invalidating the + current row, using the method of + the object instance. @@ -12554,13 +17620,41 @@ Returns non-zero if the virtual table cursor is open. + + + Closes the virtual table cursor. This method must not throw any + exceptions. + + + + + Throws an if the virtual + table cursor has been closed. + + + + + Throws an if this object + instance has been disposed. + + + + + Disposes of this object instance. + + + Non-zero if this method is being called from the + method. Zero if this method is + being called from the finalizer. + + This class implements a virtual table module that exposes an - object instance as a read-only virtual + object instance as a read-only virtual table. It is not sealed and may be used as the base class for any user-defined virtual table class that wraps an - object instance. The following short + object instance. The following short example shows it being used to treat an array of strings as a table data source: @@ -12602,456 +17696,9 @@ - - - This class implements a virtual table module that does nothing by - providing "empty" implementations for all of the - interface methods. The result - codes returned by these "empty" method implementations may be - controlled on a per-method basis by using and/or overriding the - , - , - , - , and - methods from within derived classes. - - - - - This field is used to store the - values to return, on a per-method basis, for all methods that are - part of the interface. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - - - Determines the default value to be - returned by methods of the - interface that lack an overridden implementation in all classes - derived from the class. - - - The value that should be returned - by all interface methods unless - a more specific result code has been set for that interface method. - - - - - Converts a value into a boolean - return value for use with the - method. - - - The value to convert. - - - The value. - - - - - Converts a value into a boolean - return value for use with the - method. - - - The value to convert. - - - The value. - - - - - Determines the value that should be - returned by the specified - interface method if it lack an overridden implementation. If no - specific value is available (or set) - for the specified method, the value - returned by the method will be - returned instead. - - - The name of the method. Currently, this method must be part of - the interface. - - - The value that should be returned - by the interface method. - - - - - Sets the value that should be - returned by the specified - interface method if it lack an overridden implementation. - - - The name of the method. Currently, this method must be part of - the interface. - - - The value that should be returned - by the interface method. - - - Non-zero upon success. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - The CREATE TABLE statement used to declare the schema for the - virtual table. - - - The instance containing the backing data + The instance containing the backing data for the virtual table. @@ -13070,7 +17717,7 @@ The name of the module. This parameter cannot be null. - The instance to expose as a virtual + The instance to expose as a virtual table. This parameter cannot be null. @@ -13082,7 +17729,7 @@ The name of the module. This parameter cannot be null. - The instance to expose as a virtual + The instance to expose as a virtual table. This parameter cannot be null. @@ -13091,307 +17738,232 @@ parameter has no effect on the .NET Compact Framework. - - - Determines the SQL statement used to declare the virtual table. - This method should be overridden in derived classes if they require - a custom virtual table schema. - - - The SQL statement used to declare the virtual table -OR- null if it - cannot be determined. - - - - - Sets the table error message to one that indicates the virtual - table cursor is of the wrong type. - - - The object instance. - - - The value of . - - Sets the table error message to one that indicates the virtual table cursor has no current row. - The object instance. + The object instance. - The value of . - - - - - Determines the string to return as the column value for the object - instance value. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to return a string representation for. - - - The string representation of the specified object instance or null - upon failure. - - - - - Constructs an unique row identifier from two - values. The first value - must contain the row sequence number for the current row and the - second value must contain the hash code of the enumerator value - for the current row. - - - The integer row sequence number for the current row. - - - The hash code of the enumerator value for the current row. - - - The unique row identifier or zero upon failure. - - - - - Determines the unique row identifier for the current row. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to return a unique row identifier for. - - - The unique row identifier or zero upon failure. + The value of . - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - Throws an if this object + Throws an if this object instance has been disposed. @@ -13401,21 +17973,21 @@ Non-zero if this method is being called from the - method. Zero if this method is + method. Zero if this method is being called from the finalizer. This class represents a virtual table cursor to be used with the - class. It is not sealed and may + class. It is not sealed and may be used as the base class for any user-defined virtual table cursor - class that wraps an object instance. + class that wraps an object instance. - The instance provided when this + The instance provided when this cursor was created. @@ -13424,14 +17996,21 @@ Constructs an instance of this class. - The object instance associated + The object instance associated with this object instance. - The instance to expose as a virtual + The instance to expose as a virtual table cursor. + + + Returns the value for the current row of the virtual table cursor + using the property of the + object instance. + + Closes the virtual table cursor. This method must not throw any @@ -13440,7 +18019,7 @@ - Throws an if this object + Throws an if this object instance has been disposed. @@ -13450,29 +18029,22 @@ Non-zero if this method is being called from the - method. Zero if this method is + method. Zero if this method is being called from the finalizer. - - - Returns the value for the current row of the virtual table cursor - using the property of the - object instance. - - This class implements a virtual table module that exposes an - object instance as a read-only virtual + object instance as a read-only virtual table. It is not sealed and may be used as the base class for any user-defined virtual table class that wraps an - object instance. + object instance. - The instance containing the backing + The instance containing the backing data for the virtual table. @@ -13484,44 +18056,44 @@ The name of the module. This parameter cannot be null. - The instance to expose as a virtual + The instance to expose as a virtual table. This parameter cannot be null. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - See the method. + See the method. - Throws an if this object + Throws an if this object instance has been disposed. @@ -13531,9 +18103,2951 @@ Non-zero if this method is being called from the - method. Zero if this method is + method. Zero if this method is being called from the finalizer. + + + This class implements a virtual table module that does nothing by + providing "empty" implementations for all of the + interface methods. The result + codes returned by these "empty" method implementations may be + controlled on a per-method basis by using and/or overriding the + , + , + , + , and + methods from within derived classes. + + + + + This field is used to store the + values to return, on a per-method basis, for all methods that are + part of the interface. + + + + + Constructs an instance of this class. + + + The name of the module. This parameter cannot be null. + + + + + Determines the default value to be + returned by methods of the + interface that lack an overridden implementation in all classes + derived from the class. + + + The value that should be returned + by all interface methods unless + a more specific result code has been set for that interface method. + + + + + Converts a value into a boolean + return value for use with the + method. + + + The value to convert. + + + The value. + + + + + Converts a value into a boolean + return value for use with the + method. + + + The value to convert. + + + The value. + + + + + Determines the value that should be + returned by the specified + interface method if it lack an overridden implementation. If no + specific value is available (or set) + for the specified method, the value + returned by the method will be + returned instead. + + + The name of the method. Currently, this method must be part of + the interface. + + + The value that should be returned + by the interface method. + + + + + Sets the value that should be + returned by the specified + interface method if it lack an overridden implementation. + + + The name of the method. Currently, this method must be part of + the interface. + + + The value that should be returned + by the interface method. + + + Non-zero upon success. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + See the method. + + + See the method. + + + See the method. + + + See the method. + + + + + Throws an if this object + instance has been disposed. + + + + + Disposes of this object instance. + + + Non-zero if this method is being called from the + method. Zero if this method is + being called from the finalizer. + + + + + This enumerated type represents a type of conflict seen when apply + changes from a change set or patch set. + + + + + This value is seen when processing a DELETE or UPDATE change if a + row with the required PRIMARY KEY fields is present in the + database, but one or more other (non primary-key) fields modified + by the update do not contain the expected "before" values. + + + + + This value is seen when processing a DELETE or UPDATE change if a + row with the required PRIMARY KEY fields is not present in the + database. There is no conflicting row in this case. + + The results of invoking the + + method are undefined. + + + + + This value is seen when processing an INSERT change if the + operation would result in duplicate primary key values. + The conflicting row in this case is the database row with the + matching primary key. + + + + + If a non-foreign key constraint violation occurs while applying a + change (i.e. a UNIQUE, CHECK or NOT NULL constraint), the conflict + callback will see this value. + + There is no conflicting row in this case. The results of invoking + the + method are undefined. + + + + + If foreign key handling is enabled, and applying a changes leaves + the database in a state containing foreign key violations, this + value will be seen exactly once before the changes are committed. + If the conflict handler + , the changes, + including those that caused the foreign key constraint violation, + are committed. Or, if it returns + , the changes are + rolled back. + + No current or conflicting row information is provided. The only + method it is possible to call on the supplied + object is + . + + + + + This enumerated type represents the result of a user-defined conflict + resolution callback. + + + + + If a conflict callback returns this value no special action is + taken. The change that caused the conflict is not applied. The + application of changes continues with the next change. + + + + + This value may only be returned from a conflict callback if the + type of conflict was + or . If this is + not the case, any changes applied so far are rolled back and the + call to + + will raise a with an error code of + . + + If this value is returned for a + conflict, then the + conflicting row is either updated or deleted, depending on the type + of change. + + If this value is returned for a + conflict, then + the conflicting row is removed from the database and a second + attempt to apply the change is made. If this second attempt fails, + the original row is restored to the database before continuing. + + + + + If this value is returned, any changes applied so far are rolled + back and the call to + + will raise a with an error code of + . + + + + + This enumerated type represents possible flags that may be passed + to the appropriate overloads of various change set creation methods. + + + + + No special handling. + + + + + Invert the change set while iterating through it. + This is equivalent to inverting a change set using + before + applying it. It is an error to specify this flag + with a patch set. + + + + + This callback is invoked when a determination must be made about + whether changes to a specific table should be tracked -OR- applied. + It will not be called for tables that are already attached to a + . + + + The optional application-defined context data that was originally + passed to the or + + methods. This value may be null. + + + The name of the table. + + + Non-zero if changes to the table should be considered; otherwise, + zero. Throwing an exception from this callback will result in + undefined behavior. + + + + + This callback is invoked when there is a conflict while apply changes + to a database. + + + The optional application-defined context data that was originally + passed to the + + method. This value may be null. + + + The type of this conflict. + + + The object associated with + this conflict. This value may not be null; however, only properties + that are applicable to the conflict type will be available. Further + information on this is available within the descriptions of the + available values. + + + A value that indicates the + action to be taken in order to resolve the conflict. Throwing an + exception from this callback will result in undefined behavior. + + + + + This interface contains methods used to manipulate a set of changes for + a database. + + + + + This method "inverts" the set of changes within this instance. + Applying an inverted set of changes to a database reverses the + effects of applying the uninverted changes. Specifically: + ]]>]]> + Each DELETE change is changed to an INSERT, and + ]]>]]> + Each INSERT change is changed to a DELETE, and + ]]>]]> + For each UPDATE change, the old.* and new.* values are exchanged. + ]]>]]> + This method does not change the order in which changes appear + within the set of changes. It merely reverses the sense of each + individual change. + + + The new instance that represents + the resulting set of changes -OR- null if it is not available. + + + + + This method combines the specified set of changes with the ones + contained in this instance. + + + The changes to be combined with those in this instance. + + + The new instance that represents + the resulting set of changes -OR- null if it is not available. + + + + + Attempts to apply the set of changes in this instance to the + associated database. + + + The delegate that will need + to handle any conflicting changes that may arise. + + + The optional application-defined context data. This value may be + null. + + + + + Attempts to apply the set of changes in this instance to the + associated database. + + + The delegate that will need + to handle any conflicting changes that may arise. + + + The optional delegate + that can be used to filter the list of tables impacted by the set + of changes. + + + The optional application-defined context data. This value may be + null. + + + + + This interface contains methods used to manipulate multiple sets of + changes for a database. + + + + + Attempts to add a change set (or patch set) to this change group + instance. The underlying data must be contained entirely within + the byte array. + + + The raw byte data for the specified change set (or patch set). + + + + + Attempts to add a change set (or patch set) to this change group + instance. The underlying data will be read from the specified + . + + + The instance containing the raw change set + (or patch set) data to read. + + + + + Attempts to create and return, via , the + combined set of changes represented by this change group instance. + + + Upon success, this will contain the raw byte data for all the + changes in this change group instance. + + + + + Attempts to create and write, via , the + combined set of changes represented by this change group instance. + + + Upon success, the raw byte data for all the changes in this change + group instance will be written to this . + + + + + This interface contains properties and methods used to fetch metadata + about one change within a set of changes for a database. + + + + + The name of the table the change was made to. + + + + + The number of columns impacted by this change. This value can be + used to determine the highest valid column index that may be used + with the , , + and methods of this interface. It + will be this value minus one. + + + + + This will contain the value + , + , or + , corresponding to + the overall type of change this item represents. + + + + + Non-zero if this change is considered to be indirect (i.e. as + though they were made via a trigger or foreign key action). + + + + + This array contains a for each column in + the table associated with this change. The element will be zero + if the column is not part of the primary key; otherwise, it will + be non-zero. + + + + + This method may only be called from within a + delegate when the conflict + type is . It + returns the total number of known foreign key violations in the + destination database. + + + + + Queries and returns the original value of a given column for this + change. This method may only be called when the + has a value of + or + . + + + The index for the column. This value must be between zero and one + less than the total number of columns for this table. + + + The original value of a given column for this change. + + + + + Queries and returns the updated value of a given column for this + change. This method may only be called when the + has a value of + or + . + + + The index for the column. This value must be between zero and one + less than the total number of columns for this table. + + + The updated value of a given column for this change. + + + + + Queries and returns the conflicting value of a given column for + this change. This method may only be called from within a + delegate when the conflict + type is or + . + + + The index for the column. This value must be between zero and one + less than the total number of columns for this table. + + + The conflicting value of a given column for this change. + + + + + This interface contains methods to query and manipulate the state of a + change tracking session for a database. + + + + + Determines if this session is currently tracking changes to its + associated database. + + + Non-zero if changes to the associated database are being trakced; + otherwise, zero. + + + + + Enables tracking of changes to the associated database. + + + + + Disables tracking of changes to the associated database. + + + + + Determines if this session is currently set to mark changes as + indirect (i.e. as though they were made via a trigger or foreign + key action). + + + Non-zero if changes to the associated database are being marked as + indirect; otherwise, zero. + + + + + Sets the indirect flag for this session. Subsequent changes will + be marked as indirect until this flag is changed again. + + + + + Clears the indirect flag for this session. Subsequent changes will + be marked as direct until this flag is changed again. + + + + + Determines if there are any tracked changes currently within the + data for this session. + + + Non-zero if there are no changes within the data for this session; + otherwise, zero. + + + + + Upon success, causes changes to the specified table(s) to start + being tracked. Any tables impacted by calls to this method will + not cause the callback + to be invoked. + + + The name of the table to be tracked -OR- null to track all + applicable tables within this database. + + + + + This method is used to set the table filter for this instance. + + + The table filter callback -OR- null to clear any existing table + filter callback. + + + The optional application-defined context data. This value may be + null. + + + + + Attempts to create and return, via , the + combined set of changes represented by this session instance. + + + Upon success, this will contain the raw byte data for all the + changes in this session instance. + + + + + Attempts to create and write, via , the + combined set of changes represented by this session instance. + + + Upon success, the raw byte data for all the changes in this session + instance will be written to this . + + + + + Attempts to create and return, via , the + combined set of changes represented by this session instance as a + patch set. + + + Upon success, this will contain the raw byte data for all the + changes in this session instance. + + + + + Attempts to create and write, via , the + combined set of changes represented by this session instance as a + patch set. + + + Upon success, the raw byte data for all the changes in this session + instance will be written to this . + + + + + This method loads the differences between two tables [with the same + name, set of columns, and primary key definition] into this session + instance. + + + The name of the database containing the table with the original + data (i.e. it will need updating in order to be identical to the + one within the database associated with this session instance). + + + The name of the table. + + + + + This class contains some static helper methods for use within this + subsystem. + + + + + This method checks the byte array specified by the caller to make + sure it will be usable. + + + A byte array provided by the caller into one of the public methods + for the classes that belong to this subsystem. This value cannot + be null or represent an empty array; otherwise, an appropriate + exception will be thrown. + + + + + This class is used to hold the native connection handle associated with + a open until this subsystem is totally + done with it. This class is for internal use by this subsystem only. + + + + + The SQL statement used when creating the native statement handle. + There are no special requirements for this other than counting as + an "open statement handle". + + + + + The format of the error message used when reporting, during object + disposal, that the statement handle is still open (i.e. because + this situation is considered a fairly serious programming error). + + + + + The wrapped native connection handle associated with this lock. + + + + + The flags associated with the connection represented by the + value. + + + + + The native statement handle for this lock. The garbage collector + cannot cause this statement to be finalized; therefore, it will + serve to hold the associated native connection open until it is + freed manually using the method. + + + + + Constructs a new instance of this class using the specified wrapped + native connection handle and associated flags. + + + The wrapped native connection handle to be associated with this + lock. + + + The flags associated with the connection represented by the + value. + + + Non-zero if the method should be called prior + to returning from this constructor. + + + + + Queries and returns the wrapped native connection handle for this + instance. + + + The wrapped native connection handle for this instance -OR- null + if it is unavailable. + + + + + Queries and returns the flags associated with the connection for + this instance. + + + The value. There is no return + value reserved to indicate an error. + + + + + Queries and returns the native connection handle for this instance. + + + The native connection handle for this instance. If this value is + unavailable or invalid an exception will be thrown. + + + + + This method attempts to "lock" the associated native connection + handle by preparing a SQL statement that will not be finalized + until the method is called (i.e. and which + cannot be done by the garbage collector). If the statement is + already prepared, nothing is done. If the statement cannot be + prepared for any reason, an exception will be thrown. + + + + + This method attempts to "unlock" the associated native connection + handle by finalizing the previously prepared statement. If the + statement is already finalized, nothing is done. If the statement + cannot be finalized for any reason, an exception will be thrown. + + + + + Disposes of this object instance. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + Finalizes this object instance. + + + + + This class manages the native change set iterator. It is used as the + base class for the and + classes. It knows how to + advance the native iterator handle as well as finalize it. + + + + + The native change set (a.k.a. iterator) handle. + + + + + Non-zero if this instance owns the native iterator handle in the + field. In that case, this instance will + finalize the native iterator handle upon being disposed or + finalized. + + + + + Constructs a new instance of this class using the specified native + iterator handle. + + + The native iterator handle to use. + + + Non-zero if this instance is to take ownership of the native + iterator handle specified by . + + + + + Throws an exception if the native iterator handle is invalid. + + + + + Used to query the native iterator handle. This method is only used + by the class. + + + The native iterator handle -OR- if it + is not available. + + + + + Attempts to advance the native iterator handle to its next item. + + + Non-zero if the native iterator handle was advanced and contains + more data; otherwise, zero. If the underlying native API returns + an unexpected value then an exception will be thrown. + + + + + Attempts to create an instance of this class that is associated + with the specified native iterator handle. Ownership of the + native iterator handle is NOT transferred to the new instance of + this class. + + + The native iterator handle to use. + + + The new instance of this class. No return value is reserved to + indicate an error; however, if the native iterator handle is not + valid, any subsequent attempt to make use of it via the returned + instance of this class may throw exceptions. + + + + + Disposes of this object instance. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + Finalizes this object instance. + + + + + This class manages the native change set iterator for a set of changes + contained entirely in memory. + + + + + The native memory buffer allocated to contain the set of changes + associated with this instance. This will always be freed when this + instance is disposed or finalized. + + + + + Constructs an instance of this class using the specified native + memory buffer and native iterator handle. + + + The native memory buffer to use. + + + The native iterator handle to use. + + + Non-zero if this instance is to take ownership of the native + iterator handle specified by . + + + + + Attempts to create an instance of this class using the specified + raw byte data. + + + The raw byte data containing the set of changes for this native + iterator. + + + The new instance of this class -OR- null if it cannot be created. + + + + + Attempts to create an instance of this class using the specified + raw byte data. + + + The raw byte data containing the set of changes for this native + iterator. + + + The flags used to create the change set iterator. + + + The new instance of this class -OR- null if it cannot be created. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + This class manages the native change set iterator for a set of changes + backed by a instance. + + + + + The instance that is managing + the underlying used as the backing store for + the set of changes associated with this native change set iterator. + + + + + Constructs an instance of this class using the specified native + iterator handle and . + + + The instance to use. + + + The native iterator handle to use. + + + Non-zero if this instance is to take ownership of the native + iterator handle specified by . + + + + + Attempts to create an instance of this class using the specified + . + + + The where the raw byte data for the set of + changes may be read. + + + The flags associated with the parent connection. + + + The new instance of this class -OR- null if it cannot be created. + + + + + Attempts to create an instance of this class using the specified + . + + + The where the raw byte data for the set of + changes may be read. + + + The flags associated with the parent connection. + + + The flags used to create the change set iterator. + + + The new instance of this class -OR- null if it cannot be created. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + This class is used to act as a bridge between a + instance and the delegates used with the native streaming API. + + + + + The managed stream instance used to in order to service the native + delegates for both input and output. + + + + + The flags associated with the connection. + + + + + The delegate used to provide input to the native streaming API. + It will be null -OR- point to the method. + + + + + The delegate used to provide output to the native streaming API. + It will be null -OR- point to the method. + + + + + Constructs a new instance of this class using the specified managed + stream and connection flags. + + + The managed stream instance to be used in order to service the + native delegates for both input and output. + + + The flags associated with the parent connection. + + + + + Queries and returns the flags associated with the connection for + this instance. + + + The value. There is no return + value reserved to indicate an error. + + + + + Returns a delegate that wraps the method, + creating it first if necessary. + + + A delegate that refers to the method. + + + + + Returns a delegate that wraps the method, + creating it first if necessary. + + + A delegate that refers to the method. + + + + + This method attempts to read bytes from + the managed stream, writing them to the + buffer. + + + Optional extra context information. Currently, this will always + have a value of . + + + A preallocated native buffer to receive the requested input bytes. + It must be at least bytes in size. + + + Upon entry, the number of bytes to read. Upon exit, the number of + bytes actually read. This value may be zero upon exit. + + + The value upon success -OR- an + appropriate error code upon failure. + + + + + This method attempts to write bytes to + the managed stream, reading them from the + buffer. + + + Optional extra context information. Currently, this will always + have a value of . + + + A preallocated native buffer containing the requested output + bytes. It must be at least bytes in + size. + + + The number of bytes to write. + + + The value upon success -OR- an + appropriate error code upon failure. + + + + + Disposes of this object instance. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + Finalizes this object instance. + + + + + This class manages a collection of + instances. When used, it takes responsibility for creating, returning, + and disposing of its instances. + + + + + The managed collection of + instances, keyed by their associated + instance. + + + + + The flags associated with the connection. + + + + + Constructs a new instance of this class using the specified + connection flags. + + + The flags associated with the parent connection. + + + + + Makes sure the collection of + is created. + + + + + Makes sure the collection of + is disposed. + + + + + Attempts to return a instance + suitable for the specified . + + + The instance. If this value is null, a null + value will be returned. + + + A instance. Typically, these + are always freshly created; however, this method is designed to + return the existing instance + associated with the specified stream, should one exist. + + + + + Disposes of this object instance. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + Finalizes this object instance. + + + + + This class represents a group of change sets (or patch sets). + + + + + The instance associated + with this change group. + + + + + The flags associated with the connection. + + + + + The native handle for this change group. This will be deleted when + this instance is disposed or finalized. + + + + + Constructs a new instance of this class using the specified + connection flags. + + + The flags associated with the parent connection. + + + + + Throws an exception if the native change group handle is invalid. + + + + + Makes sure the native change group handle is valid, creating it if + necessary. + + + + + Makes sure the instance + is available, creating it if necessary. + + + + + Attempts to return a instance + suitable for the specified . + + + The instance. If this value is null, a null + value will be returned. + + + A instance. Typically, these + are always freshly created; however, this method is designed to + return the existing instance + associated with the specified stream, should one exist. + + + + + Attempts to add a change set (or patch set) to this change group + instance. The underlying data must be contained entirely within + the byte array. + + + The raw byte data for the specified change set (or patch set). + + + + + Attempts to add a change set (or patch set) to this change group + instance. The underlying data will be read from the specified + . + + + The instance containing the raw change set + (or patch set) data to read. + + + + + Attempts to create and return, via , the + combined set of changes represented by this change group instance. + + + Upon success, this will contain the raw byte data for all the + changes in this change group instance. + + + + + Attempts to create and write, via , the + combined set of changes represented by this change group instance. + + + Upon success, the raw byte data for all the changes in this change + group instance will be written to this . + + + + + Disposes of this object instance. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + Finalizes this object instance. + + + + + This class represents the change tracking session associated with a + database. + + + + + The instance associated + with this session. + + + + + The name of the database (e.g. "main") for this session. + + + + + The native handle for this session. This will be deleted when + this instance is disposed or finalized. + + + + + The delegate used to provide table filtering to the native API. + It will be null -OR- point to the method. + + + + + The managed callback used to filter tables for this session. Set + via the method. + + + + + The optional application-defined context data that was passed to + the method. This value may be null. + + + + + Constructs a new instance of this class using the specified wrapped + native connection handle and associated flags. + + + The wrapped native connection handle to be associated with this + session. + + + The flags associated with the connection represented by the + value. + + + The name of the database (e.g. "main") for this session. + + + + + Throws an exception if the native session handle is invalid. + + + + + Makes sure the native session handle is valid, creating it if + necessary. + + + + + This method sets up the internal table filtering associated state + of this instance. + + + The table filter callback -OR- null to clear any existing table + filter callback. + + + The optional application-defined context data. This value may be + null. + + + The native + delegate -OR- null to clear any existing table filter. + + + + + Makes sure the instance + is available, creating it if necessary. + + + + + Attempts to return a instance + suitable for the specified . + + + The instance. If this value is null, a null + value will be returned. + + + A instance. Typically, these + are always freshly created; however, this method is designed to + return the existing instance + associated with the specified stream, should one exist. + + + + + This method is called when determining if a table needs to be + included in the tracked changes for the associated database. + + + Optional extra context information. Currently, this will always + have a value of . + + + The native pointer to the name of the table. + + + Non-zero if changes to the specified table should be considered; + otherwise, zero. + + + + + Determines if this session is currently tracking changes to its + associated database. + + + Non-zero if changes to the associated database are being trakced; + otherwise, zero. + + + + + Enables tracking of changes to the associated database. + + + + + Disables tracking of changes to the associated database. + + + + + Determines if this session is currently set to mark changes as + indirect (i.e. as though they were made via a trigger or foreign + key action). + + + Non-zero if changes to the associated database are being marked as + indirect; otherwise, zero. + + + + + Sets the indirect flag for this session. Subsequent changes will + be marked as indirect until this flag is changed again. + + + + + Clears the indirect flag for this session. Subsequent changes will + be marked as direct until this flag is changed again. + + + + + Determines if there are any tracked changes currently within the + data for this session. + + + Non-zero if there are no changes within the data for this session; + otherwise, zero. + + + + + Upon success, causes changes to the specified table(s) to start + being tracked. Any tables impacted by calls to this method will + not cause the callback + to be invoked. + + + The name of the table to be tracked -OR- null to track all + applicable tables within this database. + + + + + This method is used to set the table filter for this instance. + + + The table filter callback -OR- null to clear any existing table + filter callback. + + + The optional application-defined context data. This value may be + null. + + + + + Attempts to create and return, via , the + set of changes represented by this session instance. + + + Upon success, this will contain the raw byte data for all the + changes in this session instance. + + + + + Attempts to create and write, via , the + set of changes represented by this session instance. + + + Upon success, the raw byte data for all the changes in this session + instance will be written to this . + + + + + Attempts to create and return, via , the + set of changes represented by this session instance as a patch set. + + + Upon success, this will contain the raw byte data for all the + changes in this session instance. + + + + + Attempts to create and write, via , the + set of changes represented by this session instance as a patch set. + + + Upon success, the raw byte data for all the changes in this session + instance will be written to this . + + + + + This method loads the differences between two tables [with the same + name, set of columns, and primary key definition] into this session + instance. + + + The name of the database containing the table with the original + data (i.e. it will need updating in order to be identical to the + one within the database associated with this session instance). + + + The name of the table. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + This class represents the abstract concept of a set of changes. It + acts as the base class for the + and classes. It derives from + the class, which is used to hold + the underlying native connection handle open until the instances of + this class are disposed or finalized. It also provides the ability + to construct wrapped native delegates of the + and + types. + + + + + Constructs an instance of this class using the specified wrapped + native connection handle. + + + The wrapped native connection handle to be associated with this + change set. + + + The flags associated with the connection represented by the + value. + + + + + Creates and returns a concrete implementation of the + interface. + + + The native iterator handle to use. + + + An instance of the + interface, which can be used to fetch metadata associated with + the current item in this set of changes. + + + + + Attempts to create a + native delegate + that invokes the specified + delegate. + + + The to invoke when the + native delegate + is called. If this value is null then null is returned. + + + The optional application-defined context data. This value may be + null. + + + The created + native delegate -OR- null if it cannot be created. + + + + + Attempts to create a + native delegate + that invokes the specified + delegate. + + + The to invoke when the + native delegate + is called. If this value is null then null is returned. + + + The optional application-defined context data. This value may be + null. + + + The created + native delegate -OR- null if it cannot be created. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + This class represents a set of changes contained entirely in memory. + + + + + The raw byte data for this set of changes. Since this data must + be marshalled to a native memory buffer before being used, there + must be enough memory available to store at least two times the + amount of data contained within it. + + + + + The flags used to create the change set iterator. + + + + + Constructs an instance of this class using the specified raw byte + data and wrapped native connection handle. + + + The raw byte data for the specified change set (or patch set). + + + The wrapped native connection handle to be associated with this + set of changes. + + + The flags associated with the connection represented by the + value. + + + + + Constructs an instance of this class using the specified raw byte + data and wrapped native connection handle. + + + The raw byte data for the specified change set (or patch set). + + + The wrapped native connection handle to be associated with this + set of changes. + + + The flags associated with the connection represented by the + value. + + + The flags used to create the change set iterator. + + + + + This method "inverts" the set of changes within this instance. + Applying an inverted set of changes to a database reverses the + effects of applying the uninverted changes. Specifically: + ]]>]]> + Each DELETE change is changed to an INSERT, and + ]]>]]> + Each INSERT change is changed to a DELETE, and + ]]>]]> + For each UPDATE change, the old.* and new.* values are exchanged. + ]]>]]> + This method does not change the order in which changes appear + within the set of changes. It merely reverses the sense of each + individual change. + + + The new instance that represents + the resulting set of changes. + + + + + This method combines the specified set of changes with the ones + contained in this instance. + + + The changes to be combined with those in this instance. + + + The new instance that represents + the resulting set of changes. + + + + + Attempts to apply the set of changes in this instance to the + associated database. + + + The delegate that will need + to handle any conflicting changes that may arise. + + + The optional application-defined context data. This value may be + null. + + + + + Attempts to apply the set of changes in this instance to the + associated database. + + + The delegate that will need + to handle any conflicting changes that may arise. + + + The optional delegate + that can be used to filter the list of tables impacted by the set + of changes. + + + The optional application-defined context data. This value may be + null. + + + + + Creates an capable of iterating over the + items within this set of changes. + + + The new + instance. + + + + + Creates an capable of iterating over the + items within this set of changes. + + + The new instance. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + This class represents a set of changes that are backed by a + instance. + + + + + The instance that is managing + the underlying input used as the backing + store for the set of changes associated with this instance. + + + + + The instance that is managing + the underlying output used as the backing + store for the set of changes generated by the + or methods. + + + + + The instance used as the backing store for + the set of changes associated with this instance. + + + + + The instance used as the backing store for + the set of changes generated by the or + methods. + + + + + The flags used to create the change set iterator. + + + + + Constructs an instance of this class using the specified streams + and wrapped native connection handle. + + + The where the raw byte data for the set of + changes may be read. + + + The where the raw byte data for resulting + sets of changes may be written. + + + The wrapped native connection handle to be associated with this + set of changes. + + + The flags associated with the connection represented by the + value. + + + + + Constructs an instance of this class using the specified streams + and wrapped native connection handle. + + + The where the raw byte data for the set of + changes may be read. + + + The where the raw byte data for resulting + sets of changes may be written. + + + The wrapped native connection handle to be associated with this + set of changes. + + + The flags associated with the connection represented by the + value. + + + The flags used to create the change set iterator. + + + + + Throws an exception if the input stream or its associated stream + adapter are invalid. + + + + + Throws an exception if the output stream or its associated stream + adapter are invalid. + + + + + This method "inverts" the set of changes within this instance. + Applying an inverted set of changes to a database reverses the + effects of applying the uninverted changes. Specifically: + ]]>]]> + Each DELETE change is changed to an INSERT, and + ]]>]]> + Each INSERT change is changed to a DELETE, and + ]]>]]> + For each UPDATE change, the old.* and new.* values are exchanged. + ]]>]]> + This method does not change the order in which changes appear + within the set of changes. It merely reverses the sense of each + individual change. + + + Since the resulting set of changes is written to the output stream, + this method always returns null. + + + + + This method combines the specified set of changes with the ones + contained in this instance. + + + The changes to be combined with those in this instance. + + + Since the resulting set of changes is written to the output stream, + this method always returns null. + + + + + Attempts to apply the set of changes in this instance to the + associated database. + + + The delegate that will need + to handle any conflicting changes that may arise. + + + The optional application-defined context data. This value may be + null. + + + + + Attempts to apply the set of changes in this instance to the + associated database. + + + The delegate that will need + to handle any conflicting changes that may arise. + + + The optional delegate + that can be used to filter the list of tables impacted by the set + of changes. + + + The optional application-defined context data. This value may be + null. + + + + + Creates an capable of iterating over the + items within this set of changes. + + + The new + instance. + + + + + Creates an capable of iterating over the + items within this set of changes. + + + The new instance. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + This class represents an that is capable of + enumerating over a set of changes. It serves as the base class for the + and + classes. It manages and + owns an instance of the class. + + + + + This managed change set iterator is managed and owned by this + class. It will be disposed when this class is disposed. + + + + + Constructs an instance of this class using the specified managed + change set iterator. + + + The managed iterator instance to use. + + + + + Throws an exception if the managed iterator instance is invalid. + + + + + Sets the managed iterator instance to a new value. + + + The new managed iterator instance to use. + + + + + Disposes of the managed iterator instance and sets its value to + null. + + + + + Disposes of the existing managed iterator instance and then sets it + to a new value. + + + The new managed iterator instance to use. + + + + + Returns the current change within the set of changes, represented + by a instance. + + + + + Returns the current change within the set of changes, represented + by a instance. + + + + + Attempts to advance to the next item in the set of changes. + + + Non-zero if more items are available; otherwise, zero. + + + + + Throws because not all the + derived classes are able to support reset functionality. + + + + + Disposes of this object instance. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + Finalizes this object instance. + + + + + This class represents an that is capable of + enumerating over a set of changes contained entirely in memory. + + + + + The raw byte data for this set of changes. Since this data must + be marshalled to a native memory buffer before being used, there + must be enough memory available to store at least two times the + amount of data contained within it. + + + + + The flags used to create the change set iterator. + + + + + Constructs an instance of this class using the specified raw byte + data. + + + The raw byte data containing the set of changes for this + enumerator. + + + + + Constructs an instance of this class using the specified raw byte + data. + + + The raw byte data containing the set of changes for this + enumerator. + + + The flags used to create the change set iterator. + + + + + Resets the enumerator to its initial position. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + This class represents an that is capable of + enumerating over a set of changes backed by a + instance. + + + + + Constructs an instance of this class using the specified stream. + + + The where the raw byte data for the set of + changes may be read. + + + The flags associated with the parent connection. + + + + + Constructs an instance of this class using the specified stream. + + + The where the raw byte data for the set of + changes may be read. + + + The flags associated with the parent connection. + + + The flags used to create the change set iterator. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + This interface implements properties and methods used to fetch metadata + about one change within a set of changes for a database. + + + + + The instance to use. This + will NOT be owned by this class and will not be disposed upon this + class being disposed or finalized. + + + + + Constructs an instance of this class using the specified iterator + instance. + + + The managed iterator instance to use. + + + + + Throws an exception if the managed iterator instance is invalid. + + + + + Populates the underlying data for the , + , , and + properties, using the appropriate native + API. + + + + + Populates the underlying data for the + property using the appropriate + native API. + + + + + Populates the underlying data for the + property using the + appropriate native API. + + + + + Backing field for the property. This value + will be null if this field has not yet been populated via the + underlying native API. + + + + + The name of the table the change was made to. + + + + + Backing field for the property. This + value will be null if this field has not yet been populated via the + underlying native API. + + + + + The number of columns impacted by this change. This value can be + used to determine the highest valid column index that may be used + with the , , + and methods of this interface. It + will be this value minus one. + + + + + Backing field for the property. This + value will be null if this field has not yet been populated via the + underlying native API. + + + + + This will contain the value + , + , or + , corresponding to + the overall type of change this item represents. + + + + + Backing field for the property. This value + will be null if this field has not yet been populated via the + underlying native API. + + + + + Non-zero if this change is considered to be indirect (i.e. as + though they were made via a trigger or foreign key action). + + + + + Backing field for the property. + This value will be null if this field has not yet been populated + via the underlying native API. + + + + + This array contains a for each column in + the table associated with this change. The element will be zero + if the column is not part of the primary key; otherwise, it will + be non-zero. + + + + + Backing field for the + property. This value will be null if this field has not yet been + populated via the underlying native API. + + + + + This method may only be called from within a + delegate when the conflict + type is . It + returns the total number of known foreign key violations in the + destination database. + + + + + Queries and returns the original value of a given column for this + change. This method may only be called when the + has a value of + or + . + + + The index for the column. This value must be between zero and one + less than the total number of columns for this table. + + + The original value of a given column for this change. + + + + + Queries and returns the updated value of a given column for this + change. This method may only be called when the + has a value of + or + . + + + The index for the column. This value must be between zero and one + less than the total number of columns for this table. + + + The updated value of a given column for this change. + + + + + Queries and returns the conflicting value of a given column for + this change. This method may only be called from within a + delegate when the conflict + type is or + . + + + The index for the column. This value must be between zero and one + less than the total number of columns for this table. + + + The conflicting value of a given column for this change. + + + + + Disposes of this object instance. + + + + + Non-zero if this object instance has been disposed. + + + + + Throws an exception if this object instance has been disposed. + + + + + Disposes or finalizes this object instance. + + + Non-zero if this object is being disposed; otherwise, this object + is being finalized. + + + + + Finalizes this object instance. + + diff --git a/src/Libraries/Sqlite/libsqlite3.0.dylib b/src/Libraries/Sqlite/libsqlite3.0.dylib index 364b585e7..0c477bda1 100644 Binary files a/src/Libraries/Sqlite/libsqlite3.0.dylib and b/src/Libraries/Sqlite/libsqlite3.0.dylib differ diff --git a/src/Libraries/Sqlite/sqlite3.dll b/src/Libraries/Sqlite/sqlite3.dll index a65d21493..71a7eb91a 100644 Binary files a/src/Libraries/Sqlite/sqlite3.dll and b/src/Libraries/Sqlite/sqlite3.dll differ