@itwin/core-bentley 4.0.0-dev.48 → 4.0.0-dev.51

package/lib/esm/BeSQLite.d.ts

@@ -1,173 +1,173 @@
-/** @packageDocumentation
- * @module BeSQLite
- */
-/** Whether to open a database readonly or writeable.
- * @public
- */
-export declare enum OpenMode {
-    Readonly = 1,
-    ReadWrite = 2
-}
-/** Values, stored in changesets, that indicate what operation was performed on the database.
- * @public
- */
-export declare enum DbOpcode {
-    /** A row was deleted. */
-    Delete = 9,
-    /** A new row was inserted. */
-    Insert = 18,
-    /** Some columns of an existing row were updated. */
-    Update = 23
-}
-/** Values for return codes from BeSQLite functions. Consult SQLite documentation for further explanations.
- * @public
- */
-export declare enum DbResult {
-    /** Success */
-    BE_SQLITE_OK = 0,
-    /** SQL error or missing database */
-    BE_SQLITE_ERROR = 1,
-    /** Internal logic error */
-    BE_SQLITE_INTERNAL = 2,
-    /** Access permission denied */
-    BE_SQLITE_PERM = 3,
-    /** Callback routine requested an abort */
-    BE_SQLITE_ABORT = 4,
-    /** The database file is locked */
-    BE_SQLITE_BUSY = 5,
-    /** A table in the database is locked */
-    BE_SQLITE_LOCKED = 6,
-    /** A malloc() failed */
-    BE_SQLITE_NOMEM = 7,
-    /** Attempt to write a readonly database */
-    BE_SQLITE_READONLY = 8,
-    /** Operation terminated by interrupt */
-    BE_SQLITE_INTERRUPT = 9,
-    /** Some kind of disk I/O error occurred */
-    BE_SQLITE_IOERR = 10,
-    /** The database disk image is malformed */
-    BE_SQLITE_CORRUPT = 11,
-    /** NOT USED. Table or record not found */
-    BE_SQLITE_NOTFOUND = 12,
-    /** Insertion failed because database is full or write operation failed because disk is full */
-    BE_SQLITE_FULL = 13,
-    /** Unable to open the database file */
-    BE_SQLITE_CANTOPEN = 14,
-    /** Database lock protocol error */
-    BE_SQLITE_PROTOCOL = 15,
-    /** Database is empty */
-    BE_SQLITE_EMPTY = 16,
-    /** The database schema changed */
-    BE_SQLITE_SCHEMA = 17,
-    /** String or BLOB exceeds size limit */
-    BE_SQLITE_TOOBIG = 18,
-    /** Abort due to constraint violation. See extended error values. */
-    BE_SQLITE_CONSTRAINT_BASE = 19,
-    /** Data type mismatch */
-    BE_SQLITE_MISMATCH = 20,
-    /** Library used incorrectly */
-    BE_SQLITE_MISUSE = 21,
-    /** Uses OS features not supported on host */
-    BE_SQLITE_NOLFS = 22,
-    /** Authorization denied */
-    BE_SQLITE_AUTH = 23,
-    /** Auxiliary database format error */
-    BE_SQLITE_FORMAT = 24,
-    /** 2nd parameter to Bind out of range */
-    BE_SQLITE_RANGE = 25,
-    /** File opened that is not a database file */
-    BE_SQLITE_NOTADB = 26,
-    /** Step() has another row ready */
-    BE_SQLITE_ROW = 100,
-    /** Step() has finished executing */
-    BE_SQLITE_DONE = 101,
-    BE_SQLITE_IOERR_READ = 266,
-    BE_SQLITE_IOERR_SHORT_READ = 522,
-    BE_SQLITE_IOERR_WRITE = 778,
-    BE_SQLITE_IOERR_FSYNC = 1034,
-    BE_SQLITE_IOERR_DIR_FSYNC = 1290,
-    BE_SQLITE_IOERR_TRUNCATE = 1546,
-    BE_SQLITE_IOERR_FSTAT = 1802,
-    BE_SQLITE_IOERR_UNLOCK = 2058,
-    BE_SQLITE_IOERR_RDLOCK = 2314,
-    BE_SQLITE_IOERR_DELETE = 2570,
-    BE_SQLITE_IOERR_BLOCKED = 2826,
-    BE_SQLITE_IOERR_NOMEM = 3082,
-    BE_SQLITE_IOERR_ACCESS = 3338,
-    BE_SQLITE_IOERR_CHECKRESERVEDLOCK = 3594,
-    BE_SQLITE_IOERR_LOCK = 3850,
-    BE_SQLITE_IOERR_CLOSE = 4106,
-    BE_SQLITE_IOERR_DIR_CLOSE = 4362,
-    BE_SQLITE_IOERR_SHMOPEN = 4618,
-    BE_SQLITE_IOERR_SHMSIZE = 4874,
-    BE_SQLITE_IOERR_SHMLOCK = 5130,
-    BE_SQLITE_IOERR_SHMMAP = 5386,
-    BE_SQLITE_IOERR_SEEK = 5642,
-    BE_SQLITE_IOERR_DELETE_NOENT = 5898,
-    /** attempt to create a new file when a file by that name already exists */
-    BE_SQLITE_ERROR_FileExists = 16777226,
-    /** attempt to open a BeSQLite::Db that is already in use somewhere. */
-    BE_SQLITE_ERROR_AlreadyOpen = 33554442,
-    /** attempt to open a BeSQLite::Db that doesn't have a property table. */
-    BE_SQLITE_ERROR_NoPropertyTable = 50331658,
-    /** the database name is not a file. */
-    BE_SQLITE_ERROR_FileNotFound = 67108874,
-    /** there is no transaction active and the database was opened with AllowImplicitTransactions=false */
-    BE_SQLITE_ERROR_NoTxnActive = 83886090,
-    /** wrong BeSQLite profile version */
-    BE_SQLITE_ERROR_BadDbProfile = 100663306,
-    /** Profile of file could not be determined. */
-    BE_SQLITE_ERROR_InvalidProfileVersion = 117440522,
-    /** Upgrade of profile of file failed. */
-    BE_SQLITE_ERROR_ProfileUpgradeFailed = 134217738,
-    /** Profile of file is too old. Therefore file can only be opened read-only. */
-    BE_SQLITE_ERROR_ProfileTooOldForReadWrite = 150994954,
-    /** Profile of file is too old. Therefore file cannot be opened. */
-    BE_SQLITE_ERROR_ProfileTooOld = 167772170,
-    /** Profile of file is too new for read-write access. Therefore file can only be opened read-only. */
-    BE_SQLITE_ERROR_ProfileTooNewForReadWrite = 184549386,
-    /** Profile of file is too new. Therefore file cannot be opened. */
-    BE_SQLITE_ERROR_ProfileTooNew = 201326602,
-    /** attempt to commit with active changetrack */
-    BE_SQLITE_ERROR_ChangeTrackError = 218103818,
-    /** invalid version of the revision file is being imported */
-    BE_SQLITE_ERROR_InvalidChangeSetVersion = 234881034,
-    /** The schemas found in the database need to be upgraded */
-    BE_SQLITE_ERROR_SchemaUpgradeRequired = 251658250,
-    /** The schemas found in the database are too new, and the application needs to be upgraded. */
-    BE_SQLITE_ERROR_SchemaTooNew = 268435466,
-    /** The schemas found in the database are too old, and the DgnDb needs to be upgraded. */
-    BE_SQLITE_ERROR_SchemaTooOld = 285212682,
-    /** Error acquiring a lock on the schemas before upgrade. */
-    BE_SQLITE_ERROR_SchemaLockFailed = 301989898,
-    /** Error upgrading the schemas in the database. */
-    BE_SQLITE_ERROR_SchemaUpgradeFailed = 318767114,
-    /** Error importing the schemas into the database. */
-    BE_SQLITE_ERROR_SchemaImportFailed = 335544330,
-    /** Error acquiring locks or codes */
-    BE_SQLITE_ERROR_CouldNotAcquireLocksOrCodes = 352321546,
-    /** Recommended that the schemas found in the database be upgraded */
-    BE_SQLITE_ERROR_SchemaUpgradeRecommended = 369098762,
-    /** schema update require data transform */
-    BE_SQLITE_ERROR_DataTransformRequired = 385875978,
-    BE_SQLITE_LOCKED_SHAREDCACHE = 262,
-    BE_SQLITE_BUSY_RECOVERY = 261,
-    BE_SQLITE_CANTOPEN_NOTEMPDIR = 270,
-    BE_SQLITE_CANTOPEN_ISDIR = 526,
-    BE_SQLITE_CANTOPEN_FULLPATH = 782,
-    BE_SQLITE_CORRUPT_VTAB = 267,
-    BE_SQLITE_READONLY_RECOVERY = 264,
-    BE_SQLITE_READONLY_CANTLOCK = 520,
-    BE_SQLITE_READONLY_ROLLBACK = 776,
-    BE_SQLITE_ABORT_ROLLBACK = 516,
-    BE_SQLITE_CONSTRAINT_CHECK = 275,
-    BE_SQLITE_CONSTRAINT_COMMITHOOK = 531,
-    BE_SQLITE_CONSTRAINT_FOREIGNKEY = 787,
-    BE_SQLITE_CONSTRAINT_FUNCTION = 1043,
-    BE_SQLITE_CONSTRAINT_NOTNULL = 1299,
-    BE_SQLITE_CONSTRAINT_PRIMARYKEY = 1555,
-    BE_SQLITE_CONSTRAINT_TRIGGER = 1811,
-    BE_SQLITE_CONSTRAINT_UNIQUE = 2067,
-    BE_SQLITE_CONSTRAINT_VTAB = 2323
-}
+/** @packageDocumentation
+ * @module BeSQLite
+ */
+/** Whether to open a database readonly or writeable.
+ * @public
+ */
+export declare enum OpenMode {
+    Readonly = 1,
+    ReadWrite = 2
+}
+/** Values, stored in changesets, that indicate what operation was performed on the database.
+ * @public
+ */
+export declare enum DbOpcode {
+    /** A row was deleted. */
+    Delete = 9,
+    /** A new row was inserted. */
+    Insert = 18,
+    /** Some columns of an existing row were updated. */
+    Update = 23
+}
+/** Values for return codes from BeSQLite functions. Consult SQLite documentation for further explanations.
+ * @public
+ */
+export declare enum DbResult {
+    /** Success */
+    BE_SQLITE_OK = 0,
+    /** SQL error or missing database */
+    BE_SQLITE_ERROR = 1,
+    /** Internal logic error */
+    BE_SQLITE_INTERNAL = 2,
+    /** Access permission denied */
+    BE_SQLITE_PERM = 3,
+    /** Callback routine requested an abort */
+    BE_SQLITE_ABORT = 4,
+    /** The database file is locked */
+    BE_SQLITE_BUSY = 5,
+    /** A table in the database is locked */
+    BE_SQLITE_LOCKED = 6,
+    /** A malloc() failed */
+    BE_SQLITE_NOMEM = 7,
+    /** Attempt to write a readonly database */
+    BE_SQLITE_READONLY = 8,
+    /** Operation terminated by interrupt */
+    BE_SQLITE_INTERRUPT = 9,
+    /** Some kind of disk I/O error occurred */
+    BE_SQLITE_IOERR = 10,
+    /** The database disk image is malformed */
+    BE_SQLITE_CORRUPT = 11,
+    /** NOT USED. Table or record not found */
+    BE_SQLITE_NOTFOUND = 12,
+    /** Insertion failed because database is full or write operation failed because disk is full */
+    BE_SQLITE_FULL = 13,
+    /** Unable to open the database file */
+    BE_SQLITE_CANTOPEN = 14,
+    /** Database lock protocol error */
+    BE_SQLITE_PROTOCOL = 15,
+    /** Database is empty */
+    BE_SQLITE_EMPTY = 16,
+    /** The database schema changed */
+    BE_SQLITE_SCHEMA = 17,
+    /** String or BLOB exceeds size limit */
+    BE_SQLITE_TOOBIG = 18,
+    /** Abort due to constraint violation. See extended error values. */
+    BE_SQLITE_CONSTRAINT_BASE = 19,
+    /** Data type mismatch */
+    BE_SQLITE_MISMATCH = 20,
+    /** Library used incorrectly */
+    BE_SQLITE_MISUSE = 21,
+    /** Uses OS features not supported on host */
+    BE_SQLITE_NOLFS = 22,
+    /** Authorization denied */
+    BE_SQLITE_AUTH = 23,
+    /** Auxiliary database format error */
+    BE_SQLITE_FORMAT = 24,
+    /** 2nd parameter to Bind out of range */
+    BE_SQLITE_RANGE = 25,
+    /** File opened that is not a database file */
+    BE_SQLITE_NOTADB = 26,
+    /** Step() has another row ready */
+    BE_SQLITE_ROW = 100,
+    /** Step() has finished executing */
+    BE_SQLITE_DONE = 101,
+    BE_SQLITE_IOERR_READ = 266,
+    BE_SQLITE_IOERR_SHORT_READ = 522,
+    BE_SQLITE_IOERR_WRITE = 778,
+    BE_SQLITE_IOERR_FSYNC = 1034,
+    BE_SQLITE_IOERR_DIR_FSYNC = 1290,
+    BE_SQLITE_IOERR_TRUNCATE = 1546,
+    BE_SQLITE_IOERR_FSTAT = 1802,
+    BE_SQLITE_IOERR_UNLOCK = 2058,
+    BE_SQLITE_IOERR_RDLOCK = 2314,
+    BE_SQLITE_IOERR_DELETE = 2570,
+    BE_SQLITE_IOERR_BLOCKED = 2826,
+    BE_SQLITE_IOERR_NOMEM = 3082,
+    BE_SQLITE_IOERR_ACCESS = 3338,
+    BE_SQLITE_IOERR_CHECKRESERVEDLOCK = 3594,
+    BE_SQLITE_IOERR_LOCK = 3850,
+    BE_SQLITE_IOERR_CLOSE = 4106,
+    BE_SQLITE_IOERR_DIR_CLOSE = 4362,
+    BE_SQLITE_IOERR_SHMOPEN = 4618,
+    BE_SQLITE_IOERR_SHMSIZE = 4874,
+    BE_SQLITE_IOERR_SHMLOCK = 5130,
+    BE_SQLITE_IOERR_SHMMAP = 5386,
+    BE_SQLITE_IOERR_SEEK = 5642,
+    BE_SQLITE_IOERR_DELETE_NOENT = 5898,
+    /** attempt to create a new file when a file by that name already exists */
+    BE_SQLITE_ERROR_FileExists = 16777226,
+    /** attempt to open a BeSQLite::Db that is already in use somewhere. */
+    BE_SQLITE_ERROR_AlreadyOpen = 33554442,
+    /** attempt to open a BeSQLite::Db that doesn't have a property table. */
+    BE_SQLITE_ERROR_NoPropertyTable = 50331658,
+    /** the database name is not a file. */
+    BE_SQLITE_ERROR_FileNotFound = 67108874,
+    /** there is no transaction active and the database was opened with AllowImplicitTransactions=false */
+    BE_SQLITE_ERROR_NoTxnActive = 83886090,
+    /** wrong BeSQLite profile version */
+    BE_SQLITE_ERROR_BadDbProfile = 100663306,
+    /** Profile of file could not be determined. */
+    BE_SQLITE_ERROR_InvalidProfileVersion = 117440522,
+    /** Upgrade of profile of file failed. */
+    BE_SQLITE_ERROR_ProfileUpgradeFailed = 134217738,
+    /** Profile of file is too old. Therefore file can only be opened read-only. */
+    BE_SQLITE_ERROR_ProfileTooOldForReadWrite = 150994954,
+    /** Profile of file is too old. Therefore file cannot be opened. */
+    BE_SQLITE_ERROR_ProfileTooOld = 167772170,
+    /** Profile of file is too new for read-write access. Therefore file can only be opened read-only. */
+    BE_SQLITE_ERROR_ProfileTooNewForReadWrite = 184549386,
+    /** Profile of file is too new. Therefore file cannot be opened. */
+    BE_SQLITE_ERROR_ProfileTooNew = 201326602,
+    /** attempt to commit with active changetrack */
+    BE_SQLITE_ERROR_ChangeTrackError = 218103818,
+    /** invalid version of the revision file is being imported */
+    BE_SQLITE_ERROR_InvalidChangeSetVersion = 234881034,
+    /** The schemas found in the database need to be upgraded */
+    BE_SQLITE_ERROR_SchemaUpgradeRequired = 251658250,
+    /** The schemas found in the database are too new, and the application needs to be upgraded. */
+    BE_SQLITE_ERROR_SchemaTooNew = 268435466,
+    /** The schemas found in the database are too old, and the DgnDb needs to be upgraded. */
+    BE_SQLITE_ERROR_SchemaTooOld = 285212682,
+    /** Error acquiring a lock on the schemas before upgrade. */
+    BE_SQLITE_ERROR_SchemaLockFailed = 301989898,
+    /** Error upgrading the schemas in the database. */
+    BE_SQLITE_ERROR_SchemaUpgradeFailed = 318767114,
+    /** Error importing the schemas into the database. */
+    BE_SQLITE_ERROR_SchemaImportFailed = 335544330,
+    /** Error acquiring locks or codes */
+    BE_SQLITE_ERROR_CouldNotAcquireLocksOrCodes = 352321546,
+    /** Recommended that the schemas found in the database be upgraded */
+    BE_SQLITE_ERROR_SchemaUpgradeRecommended = 369098762,
+    /** schema update require data transform */
+    BE_SQLITE_ERROR_DataTransformRequired = 385875978,
+    BE_SQLITE_LOCKED_SHAREDCACHE = 262,
+    BE_SQLITE_BUSY_RECOVERY = 261,
+    BE_SQLITE_CANTOPEN_NOTEMPDIR = 270,
+    BE_SQLITE_CANTOPEN_ISDIR = 526,
+    BE_SQLITE_CANTOPEN_FULLPATH = 782,
+    BE_SQLITE_CORRUPT_VTAB = 267,
+    BE_SQLITE_READONLY_RECOVERY = 264,
+    BE_SQLITE_READONLY_CANTLOCK = 520,
+    BE_SQLITE_READONLY_ROLLBACK = 776,
+    BE_SQLITE_ABORT_ROLLBACK = 516,
+    BE_SQLITE_CONSTRAINT_CHECK = 275,
+    BE_SQLITE_CONSTRAINT_COMMITHOOK = 531,
+    BE_SQLITE_CONSTRAINT_FOREIGNKEY = 787,
+    BE_SQLITE_CONSTRAINT_FUNCTION = 1043,
+    BE_SQLITE_CONSTRAINT_NOTNULL = 1299,
+    BE_SQLITE_CONSTRAINT_PRIMARYKEY = 1555,
+    BE_SQLITE_CONSTRAINT_TRIGGER = 1811,
+    BE_SQLITE_CONSTRAINT_UNIQUE = 2067,
+    BE_SQLITE_CONSTRAINT_VTAB = 2323
+}
 //# sourceMappingURL=BeSQLite.d.ts.map