Ksqlite Kotlin API/ksqlite.kapi/SQLite/Companion

Companion

Provides access to SQLite APIs that do not require SQLite initialization.

Properties

open override val caseIndependentComparator: Comparator<String>

Comparator that compare the contents of two buffers containing UTF-8 strings in a case-independent fashion, using the same definition of "case independence" that SQLite uses internally when comparing identifiers.

compileOptions

open override val compileOptions: List<String>

Returns the options that were defined at compile-time. The SQLITE_ prefix is omitted for each option.

isThreadSafe

open override val isThreadSafe: Boolean

Whether SQLite was compiled with mutexing code omitted due to the SQLITE_THREADSAFE compile-time option being set to 0.

keywordCount

open override val keywordCount: Int

Number of distinct keywords understood by SQLite.

sourceId

open override val sourceId: String

Identifier of the check-in of SQLite within its configuration management system.

version

open override val version: String

SQLite version.

versionNumber

open override val versionNumber: Int

SQLite version number.

Functions

createCaseIndependentComparator

open override fun createCaseIndependentComparator(maxBytes: Int): Comparator<String>

Returns a comparator that compare the contents of two buffers containing UTF-8 strings in a case-independent fashion, using the same definition of "case independence" that SQLite uses internally when comparing identifiers.

getKeyword

open override fun getKeyword(index: Int): String

Returns the keyword at given index.

initialize

fun initialize(configure: ConfigurationScope.() -> Unit? = null): SQLite

Initializes SQLite and returns an SQLite instance used to initiate connections. SQLite global options can be configured by supplying a value to configure.

isCompleteSqlStatement

open override fun isCompleteSqlStatement(sql: String): Boolean

Returns true if this seems to form a complete SQL statement. If additional input is needed before sending tbe text into SQLite for parsing, then false is returned.

isKeyword

open override fun isKeyword(word: String): Boolean

Returns whether word is a keyword.

log

open override fun log(errorCode: Int, message: String)

Logs content using SQLite logging interface.

matchGlob

open override fun matchGlob(pattern: String, input: String): Boolean

Returns true if and only if input matches the GLOB pattern.

matchLike

open override fun matchLike(pattern: String, input: String, escape: Char): Boolean

Returns true if and only if input matches the LIKE pattern with escape character.