interface SQLiteVFS { mxPathname?: number; xAccess(pVfs,
zName,
flags,
pResOut): number | Promise<number>; xCheckReservedLock(pFile,
pResOut): number | Promise<number>; xClose(pFile): number | Promise<number>; xDelete(pVfs,
zName,
syncDir): number | Promise<number>; xDeviceCharacteristics(pFile): number | Promise<number>; xFileControl(pFile,
op,
pArg): number | Promise<number>; xFileSize(pFile,
pSize): number | Promise<number>; xFullPathname(pVfs,
zName,
nOut,
zOut): number | Promise<number>; xGetLastError(pVfs,
nBuf,
zBuf): number | Promise<number>; xLock(pFile,
lockType): number | Promise<number>; xOpen(pVfs,
zName,
pFile,
flags,
pOutFlags): number | Promise<number>; xRead(pFile,
pData,
iAmt,
iOffsetLo,
iOffsetHi): number | Promise<number>; xSectorSize(pFile): number | Promise<number>; xSync(pFile,
flags): number | Promise<number>; xTruncate(pFile,
sizeLo,
sizeHi): number | Promise<number>; xUnlock(pFile,
lockType): number | Promise<number>; xWrite(pFile,
pData,
iAmt,
iOffsetLo,
iOffsetHi): number | Promise<number>; } Properties
Optional mxPathname
mxPathname?: number
Methods
xAccess
- xAccess(pVfs, zName, flags, pResOut): number | Promise<number>
Parameters
pVfs: number
zName: number
flags: number
pResOut: number
Returns number | Promise<number>
xCheckReservedLock
- xCheckReservedLock(pFile, pResOut): number | Promise<number>
Parameters
pFile: number
pResOut: number
Returns number | Promise<number>
xClose
- xClose(pFile): number | Promise<number>
Returns number | Promise<number>
xDelete
- xDelete(pVfs, zName, syncDir): number | Promise<number>
Parameters
pVfs: number
zName: number
syncDir: number
Returns number | Promise<number>
xDeviceCharacteristics
- xDeviceCharacteristics(pFile): number | Promise<number>
Returns number | Promise<number>
xFileControl
- xFileControl(pFile, op, pArg): number | Promise<number>
Parameters
pFile: number
op: number
pArg: number
Returns number | Promise<number>
xFileSize
- xFileSize(pFile, pSize): number | Promise<number>
Parameters
pFile: number
pSize: number
Returns number | Promise<number>
xFullPathname
- xFullPathname(pVfs, zName, nOut, zOut): number | Promise<number>
Parameters
pVfs: number
zName: number
nOut: number
zOut: number
Returns number | Promise<number>
xGetLastError
- xGetLastError(pVfs, nBuf, zBuf): number | Promise<number>
Parameters
pVfs: number
nBuf: number
zBuf: number
Returns number | Promise<number>
xLock
- xLock(pFile, lockType): number | Promise<number>
Parameters
pFile: number
lockType: number
Returns number | Promise<number>
xOpen
- xOpen(pVfs, zName, pFile, flags, pOutFlags): number | Promise<number>
Parameters
pVfs: number
zName: number
pFile: number
flags: number
pOutFlags: number
Returns number | Promise<number>
xRead
- xRead(pFile, pData, iAmt, iOffsetLo, iOffsetHi): number | Promise<number>
Parameters
pFile: number
pData: number
iAmt: number
iOffsetLo: number
iOffsetHi: number
Returns number | Promise<number>
xSectorSize
- xSectorSize(pFile): number | Promise<number>
Returns number | Promise<number>
xSync
- xSync(pFile, flags): number | Promise<number>
Parameters
pFile: number
flags: number
Returns number | Promise<number>
xTruncate
- xTruncate(pFile, sizeLo, sizeHi): number | Promise<number>
Parameters
pFile: number
sizeLo: number
sizeHi: number
Returns number | Promise<number>
xUnlock
- xUnlock(pFile, lockType): number | Promise<number>
Parameters
pFile: number
lockType: number
Returns number | Promise<number>
xWrite
- xWrite(pFile, pData, iAmt, iOffsetLo, iOffsetHi): number | Promise<number>
Parameters
pFile: number
pData: number
iAmt: number
iOffsetLo: number
iOffsetHi: number
Returns number | Promise<number>
SQLite Virtual File System object
Objects with this interface can be passed to SQLiteAPI.vfs_register to define a new filesystem.
There are synchronous and asynchronous example VFS classes in the repository.
See