Ksqlite Kotlin API/ksqlite.kapi.backup/Backup

Backup

interface Backup : AutoCloseable(source)

Exposes the Online Backup API.

Unless documented otherwise, every member throws IllegalStateException once this backup is closed.

Types

Companion

object Companion

Provides methods to initializes a Backup.

Properties

pageCount

abstract val pageCount: Int

Returns the total number of pages in the source database as of the most recent call to step.

remaining

abstract val remaining: Int

Returns the number of pages still to be backed up as of the most recent call to step.

Functions

abstract override fun close()

Releases all resources associated with this backup. Calling this again on an already closed backup has no effect.

step

abstract fun step(count: Int)

Copies up to count pages between the source and destination databases. A negative count copies all remaining pages in this single call. Use remaining to check whether the backup is complete.