Ksqlite Kotlin API/ksqlite.kapi.database/FileControl

FileControl

interface FileControl(source)

Exposes the file control APIs.

Functions

getDataVersion

abstract fun getDataVersion(database: String? = null): Int

Returns the data version used to detect changes to a database file.

getMmapSize

abstract fun getMmapSize(database: String? = null): Long?

Returns the maximum number of bytes that will be used for memory-mapped I/O. If the option is not supported by the VFS, then null is returned.

getSizeLimit

abstract fun getSizeLimit(database: String? = null): Long?

Returns the upper bound on the size of the in-memory database, on database. If the option is not supported by the VFS, then null is returned.

getSystemError

abstract fun getSystemError(database: String? = null): Int?

Returns the platform specific error code, on database. If the option is not supported by the VFS, then null is returned.

getTempFileName

abstract fun getTempFileName(database: String? = null): String?

Returns a generated temporary file name. If the option is not supported by the VFS, then null is returned.

getVfsName

abstract fun getVfsName(database: String? = null): String?

Returns the names of all VFS shims and the final bottom-level VFS. If the option is not supported by the VFS, then null is returned.

hasMoved

abstract fun hasMoved(database: String? = null): Boolean?

Returns whether the file has been renamed, moved, or deleted since it was first opened. If the option is not supported by the VFS, then null is returned.

isPersistWal

abstract fun isPersistWal(database: String? = null): Boolean?

Returns whether the persistent WAL mode is enabled. If the option is not supported by the VFS, then null is returned.

isPowerSafeOverwrite

abstract fun isPowerSafeOverwrite(database: String? = null): Boolean?

Returns whether the zero-damage mode is enabled. If the option is not supported by the VFS, then null is returned.

reserveBytes

abstract fun reserveBytes(bytes: Int, database: String?)

resetCache

abstract fun resetCache(database: String? = null)

Purges the content of the in-memory page cache.

setChunkSize

abstract fun setChunkSize(size: Int, database: String? = null)

Sets the size of a chunk the VFS should split the database file in. Does nothing is the VFS does not support the option.

setLockTimeout

abstract fun setLockTimeout(millis: Int, database: String? = null)

Sets the duration, in milliseconds, before failing when attempting to obtain a file lock using the xLock or xShmLock methods of the VFS. Does nothing is the VFS does not support the option.

setMmapSize

abstract fun setMmapSize(size: Long, database: String? = null)

Sets the maximum number of bytes that will be used for memory-mapped I/O. Does nothing is the VFS does not support the option.

setOverwrite

abstract fun setOverwrite(value: Long, database: String?)

Indicates that the entire database file will be overwritten by the current transaction. Does nothing is the VFS does not support the option.

setPersistWal

abstract fun setPersistWal(enabled: Boolean, database: String? = null)

Enables or disables the persistent WAL mode. Does nothing is the VFS does not support the option.

setPowerSafeOverwrite

abstract fun setPowerSafeOverwrite(enabled: Boolean, database: String? = null)

Enables or disables the zero-damage mode. Does nothing is the VFS does not support the option.

setSizeHint

abstract fun setSizeHint(size: Long, database: String? = null)

Gives the VFS layer a hint of how large the database file will grow to be during the current transaction, on database. Does nothing is the VFS does not support the option.

setSizeLimit

abstract fun setSizeLimit(limit: Long, database: String? = null)

Sets the upper bound on the size of the in-memory database, on database. Does nothing is the VFS does not support the option.