SQLDelight

https://sqldelight.github.io/sqldelight/latest
Admin
SQLDelight is a SQL compiler that generates typesafe Kotlin APIs from your SQL statements with...
Tokens:214,592
Snippets:2,227
Trust Score:9.7
Update:10 hours ago
Show doc for...
Tokens:
Raw
### setup

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/sqlite-3-24/app.cash.sqldelight.dialects.sqlite_3_24/-sqlite-dialect/index.html

Performs setup operations for the dialect.

```APIDOC
## setup()

### Description
Performs setup operations for the dialect.

### Method
function

### Signature
`open override fun setup()`
```

--------------------------------

### Migration file hierarchy example

Source: https://sqldelight.github.io/sqldelight/latest/jvm_h2/

Example directory structure showing migration files v1__backend.sqm and v2__backend.sqm under src/main/sqldelight.

```plaintext
src
`-- main
    `-- sqldelight
        |-- v1__backend.sqm
        `-- v2__backend.sqm
```

--------------------------------

### setup

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/sqlite-3-18/app.cash.sqldelight.dialects.sqlite_3_18/-sqlite-dialect/index.html

Sets up the SQLite dialect.

```APIDOC
## setup()

### Description
Sets up the SQLite dialect.

### Method
setup

### Signature
open override fun setup()

```

--------------------------------

### Example SQL schema and query for expandSelectStar

Source: https://sqldelight.github.io/sqldelight/latest/android_sqlite/gradle/

Example .sq file content showing a CREATE TABLE and a getAll query with SELECT *. When expandSelectStar is true, the query is rewritten to explicitly list columns.

```sql
CREATE TABLE hockey_player (
  id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
  name TEXT NOT NULL,
  number INTEGER NOT NULL
);

getAll:
SELECT * FROM hockey_player;
```

--------------------------------

### SqlDelightModule.setup

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-compiler/dialect/app.cash.sqldelight.dialect.api/-sql-delight-module/index.html

Open function that performs setup operations for the module. It is part of the SqlDelightModule interface and can be overridden by implementations.

```APIDOC
## setup()

### Description
Performs setup operations for the SqlDelightModule. This function is open and can be overridden by implementations.

### Method
Function

### Signature
`open fun setup()`

### Parameters
None

### Returns
Unit
```

--------------------------------

### Keyset-based query example with beginInclusive and endExclusive

Source: https://sqldelight.github.io/sqldelight/latest/2.x/extensions/androidx-paging3/app.cash.sqldelight.paging3/-query-paging-source.html

Example SQL query returned by queryProvider for keyset paging. It selects values between beginInclusive and endExclusive, handling null endExclusive.

```SQL
SELECT value FROM numbers
WHERE value >= :beginInclusive AND (value < :endExclusive OR :endExclusive IS NULL)
ORDER BY value ASC;
```

--------------------------------

### Example migration file 1.sqm

Source: https://sqldelight.github.io/sqldelight/latest/android_sqlite/migrations/

SQL statements to migrate from version 1 to version 2. These are run by the Database.Schema.migrate() method.

```sql
ALTER TABLE hockeyPlayer ADD COLUMN draft_year INTEGER;
ALTER TABLE hockeyPlayer ADD COLUMN draft_order INTEGER;
```

--------------------------------

### Gradle Kotlin DSL snapshot setup

Source: https://sqldelight.github.io/sqldelight/latest/

Configures the SQLDelight plugin from the Central Portal Snapshots repository in settings.gradle.kts and build.gradle.kts. Use 'SNAPSHOT-VERSION' as the plugin version.

```Kotlin
// settings.gradle.kts
pluginManagement {
    repositories {
        gradlePluginPortal()
        maven(url = "https://central.sonatype.com/repository/maven-snapshots")
    }
}

// build.gradle.kts
plugins {
    id("app.cash.sqldelight") version "SNAPSHOT-VERSION"
}

repositories {
    maven(url = "https://central.sonatype.com/repository/maven-snapshots")
}
```

--------------------------------

### Gradle Groovy DSL snapshot setup

Source: https://sqldelight.github.io/sqldelight/latest/

Configures the SQLDelight plugin from the Central Portal Snapshots repository in settings.gradle and build.gradle. Use 'SNAPSHOT-VERSION' as the plugin version.

```Groovy
// settings.gradle
pluginManagement {
    repositories {
        gradlePluginPortal()
        maven { url "https://central.sonatype.com/repository/maven-snapshots" }
    }
}

// build.gradle
plugins {
    id "app.cash.sqldelight" version "SNAPSHOT-VERSION"
}

repositories {
    maven { url "https://central.sonatype.com/repository/maven-snapshots" }
}
```

--------------------------------

### Example 'begin_transaction' action message

Source: https://sqldelight.github.io/sqldelight/latest/js_sqlite/custom_worker/

Message sent to the worker to begin a transaction. Contains 'id' and 'action' properties.

```json
{
  "id": 2,
  "action": "begin_transaction"
}
```

--------------------------------

### Example response with query results

Source: https://sqldelight.github.io/sqldelight/latest/js_sqlite/custom_worker/

Response to an 'exec' message containing a result set. The 'results' property is an array of rows, each row an array of column values.

```json
{
  "id": 5,
  "results": [
    ["value", "this is the content of column_b"],
    ["value", "this is a different row"]
  ]
}
```

--------------------------------

### Example 'exec' action message

Source: https://sqldelight.github.io/sqldelight/latest/js_sqlite/custom_worker/

Message sent to the worker to execute a SQL statement. Contains 'id', 'action', 'sql', and 'params' properties.

```json
{
  "id": 5,
  "action": "exec",
  "sql": "SELECT column_a, column_b FROM some_table WHERE column_a = ?;",
  "params": ["value"]
}
```

--------------------------------

### Use generated typesafe queries

Source: https://sqldelight.github.io/sqldelight/latest/android_sqlite/

Instantiate the Database and use the generated PlayerQueries object to execute typesafe functions. The example shows selecting all players, inserting a player, and inserting a full player object.

```kotlin
fun doDatabaseThings(driver: SqlDriver) {
  val database = Database(driver)
  val playerQueries: PlayerQueries = database.playerQueries

  println(playerQueries.selectAll().executeAsList()) 
  // [HockeyPlayer(15, "Ryan Getzlaf")]

  playerQueries.insert(player_number = 10, full_name = "Corey Perry")
  println(playerQueries.selectAll().executeAsList()) 
  // [HockeyPlayer(15, "Ryan Getzlaf"), HockeyPlayer(10, "Corey Perry")]

  val player = HockeyPlayer(10, "Ronald McDonald")
  playerQueries.insertFullPlayerObject(player)
}
```

--------------------------------

### Replace AfterVersionWithDriver with AfterVersion

Source: https://sqldelight.github.io/sqldelight/latest/upgrading-2.0/

The AfterVersionWithDriver type was removed; use AfterVersion which now always includes the driver. The migrateWithCallbacks function was removed; use migrate with callbacks. The example shows the migration from AfterVersionWithDriver to AfterVersion.

```kotlin
Database.Schema.migrateWithCallbacks(
  driver = driver,
  oldVersion = 1,
  newVersion = Database.Schema.version,
-  AfterVersionWithDriver(3) { driver ->
-    driver.execute(null, "INSERT INTO test (value) VALUES('hello')", 0)
-  }
+  AfterVersion(3) { driver ->
+    driver.execute(null, "INSERT INTO test (value) VALUES('hello')", 0)
+  }
)
```

--------------------------------

### Keyset page boundaries query using SQLite window functions

Source: https://sqldelight.github.io/sqldelight/latest/2.x/extensions/androidx-paging3/app.cash.sqldelight.paging3/-query-paging-source.html

Example query for pageBoundariesProvider to generate page boundaries using SQLite window functions. Requires SQLite 3.25.0 or later, so consuming apps likely need minSdk 30 or bundle a SQLite module.

```SQL
SELECT value
FROM (
  SELECT
    value,
    CASE
      WHEN ((row_number() OVER(ORDER BY value ASC) - 1) % :limit) = 0 THEN 1
      WHEN value = :anchor THEN 1
      ELSE 0
    END page_boundary
  FROM numbers
  ORDER BY value ASC
)
WHERE page_boundary = 1;
```

--------------------------------

### Offset-based query example with LIMIT and OFFSET

Source: https://sqldelight.github.io/sqldelight/latest/2.x/extensions/androidx-paging3/app.cash.sqldelight.paging3/-query-paging-source.html

Example SQL query returned by queryProvider for offset-based paging. It selects values from the 'numbers' table with a LIMIT of 10 and OFFSET of 100.

```SQL
SELECT value FROM numbers
LIMIT 10
OFFSET 100;
```

--------------------------------

### get

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-compiler/app.cash.sqldelight.core.lang/-sql-delight-language/index.html

Returns the current KeyFMap value.

```APIDOC
## get

### Description
Returns the current KeyFMap value.

### Function Signature
fun get(): KeyFMap?

### Returns
- **KeyFMap?** - The current value.
```

--------------------------------

### getStartOffsetInParent

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/mysql/app.cash.sqldelight.dialects.mysql.grammar.psi.impl/-my-sql-assignment-impl/index.html

Returns the start offset of this element in its parent.

```APIDOC
## getStartOffsetInParent

### Description
Returns the start offset of this element in its parent.

### Method
open fun getStartOffsetInParent(): Int

### Returns
- **Int** - The start offset.
```

--------------------------------

### Migration file directory structure

Source: https://sqldelight.github.io/sqldelight/latest/android_sqlite/migrations/

Shows the expected layout of the sqldelight folder with .sq files and a migrations subdirectory containing .sqm files.

```text
src
└─ main
   └─ sqdelight
      ├─ com/example/hockey
      |  ├─ Team.sq
      |  └─ Player.sq
      └─ migrations
         ├─ 1.sqm
         └─ 2.sqm
```

--------------------------------

### getInstance

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-compiler/app.cash.sqldelight.core/-sql-delight-project-service/-companion/index.html

Returns a SqlDelightProjectService instance for the given project.

```APIDOC
## getInstance

### Description
Returns a SqlDelightProjectService instance for the given project.

### Method
Function

### Signature
fun getInstance(project: Project): SqlDelightProjectService

### Parameters
- **project** (Project) - Required - The project for which to get the service.

### Returns
- **SqlDelightProjectService** - The service instance.
```

--------------------------------

### Define SQL schema in Player.sq

Source: https://sqldelight.github.io/sqldelight/latest/android_sqlite/

Create a .sq file under src/main/sqldelight with SQL statements to define tables, indexes, and default content. The first statement typically creates a table.

```sql
CREATE TABLE hockeyPlayer (
  player_number INTEGER PRIMARY KEY NOT NULL,
  full_name TEXT NOT NULL
);

CREATE INDEX hockeyPlayer_full_name ON hockeyPlayer(full_name);

INSERT INTO hockeyPlayer (player_number, full_name)
VALUES (15, 'Ryan Getzlaf');
```

--------------------------------

### transactionWithResult

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-suspending-transacter/index.html

Starts a Transaction and runs the provided suspend bodyWithReturn within that transaction, returning the result of the body.

```APIDOC
## [SUSPEND] transactionWithResult

### Description
Starts a Transaction and runs bodyWithReturn in that transaction, returning the result.

### Method
Suspend function

### Signature
```kotlin
abstract suspend fun <R> transactionWithResult(noEnclosing: Boolean = false, bodyWithReturn: suspend SuspendingTransactionWithReturn<R>.() -> R): R
```

### Parameters
- **noEnclosing** (Boolean) - Optional - If true, the transaction will not be enclosed within an existing transaction.
- **bodyWithReturn** (suspend SuspendingTransactionWithReturn<R>.() -> R) - Required - The suspend lambda that returns a value of type R.

### Response
Returns the result of type R from the transaction body.
```

--------------------------------

### SQL query with nullable equality

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-gradle-plugin/app.cash.sqldelight.gradle/-sql-delight-database/treat-null-as-unknown-for-equality.html

Example SQL query that triggers the null check generation when the rvalue is nullable.

```sql
SELECT *
FROM test_table
WHERE foo = ?
```

--------------------------------

### onCreate

Source: https://sqldelight.github.io/sqldelight/latest/2.x/drivers/android-driver/app.cash.sqldelight.driver.android/-android-sqlite-driver/-callback/index.html

Called when the database is created for the first time.

```APIDOC
## onCreate

### Description
Called when the database is created for the first time.

### Method
open override fun onCreate(db: SupportSQLiteDatabase)

### Parameters
- **db** (SupportSQLiteDatabase) - Required - The database being created.

```

--------------------------------

### newTransaction()

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight.db/-sql-driver/new-transaction.html

Starts a new Transacter.Transaction on the database. The behavior may vary depending on the implementation's connection/threading patterns.

```APIDOC
## newTransaction()

### Description
Starts a new Transacter.Transaction on the database. It's up to the implementor how this method behaves for different connection/threading patterns.

### Method
newTransaction

### Signature
abstract fun newTransaction(): QueryResult<Transacter.Transaction>

### Returns
- **QueryResult<Transacter.Transaction>** - The result of starting a new transaction.
```

--------------------------------

### Example 'rollback_transaction' action message

Source: https://sqldelight.github.io/sqldelight/latest/js_sqlite/custom_worker/

Message sent to the worker to rollback the current transaction. Contains 'id' and 'action' properties.

```json
{
  "id": 8,
  "action": "rollback_transaction"
}
```

--------------------------------

### SqlDelightDatabase Constructor

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-gradle-plugin/app.cash.sqldelight.gradle/-sql-delight-database/index.html

Creates a new SqlDelightDatabase instance with the given project and name.

```APIDOC
## SqlDelightDatabase Constructor

### Description
Creates a new SqlDelightDatabase instance with the given project and name.

### Method
Constructor

### Parameters
- **project** (Project) - Required - The project associated with this database.
- **name** (String) - Required - The name of the database.

```

--------------------------------

### Example 'end_transaction' action message

Source: https://sqldelight.github.io/sqldelight/latest/js_sqlite/custom_worker/

Message sent to the worker to end the current transaction. Contains 'id' and 'action' properties.

```json
{
  "id": 3,
  "action": "end_transaction"
}
```

--------------------------------

### getInstance(project: Project): SqlDelightProjectService

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-compiler/app.cash.sqldelight.core/-sql-delight-project-service/-companion/get-instance.html

Returns a SqlDelightProjectService instance for the given Project. This function is used to obtain the project service.

```APIDOC
## getInstance(project: Project): SqlDelightProjectService

### Description
Returns a SqlDelightProjectService instance for the given Project.

### Function Signature
```kotlin
fun getInstance(project: Project): SqlDelightProjectService
```

### Parameters
- **project** (Project) - Required - The project for which to get the service.

### Returns
- **SqlDelightProjectService** - The service instance for the project.

```

--------------------------------

### onConfigure

Source: https://sqldelight.github.io/sqldelight/latest/2.x/drivers/android-driver/app.cash.sqldelight.driver.android/-android-sqlite-driver/-callback/index.html

Called when the database is configured.

```APIDOC
## onConfigure

### Description
Called when the database is configured.

### Method
open fun onConfigure(db: SupportSQLiteDatabase)

### Parameters
- **db** (SupportSQLiteDatabase) - Required - The database being configured.

```

--------------------------------

### visitDateDataType

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/postgresql/app.cash.sqldelight.dialects.postgresql.grammar.psi/-postgre-sql-visitor/visit-date-data-type.html

Open function that visits a PostgreSqlDateDataType instance. The source provides no further details on parameters, return values, or usage examples.

```APIDOC
## visitDateDataType

### Description
Open function that visits a PostgreSqlDateDataType instance.

### Signature
```kotlin
open fun visitDateDataType(@NotNull o: @NotNull PostgreSqlDateDataType)
```

### Parameters
- **o** (PostgreSqlDateDataType) - Required - The PostgreSqlDateDataType to visit.

```

--------------------------------

### SqliteMigrationStrategy()

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/sqlite-3-18/app.cash.sqldelight.dialects.sqlite_3_18/-sqlite-migration-strategy/index.html

Creates a new instance of SqliteMigrationStrategy.

```APIDOC
## SqliteMigrationStrategy()

### Description
Creates a new instance of SqliteMigrationStrategy.

### Constructor
SqliteMigrationStrategy()

```

--------------------------------

### fromFile

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqlite-migrations/app.cash.sqlite.migrations/-catalog-database/-companion/index.html

Creates a CatalogDatabase instance from a file path with the given init statements.

```APIDOC
## fromFile

### Description
Creates a CatalogDatabase instance from a file path with the given init statements.

### Function Signature
fun fromFile(path: String, initStatements: List<CatalogDatabase.InitStatement>): CatalogDatabase

### Parameters
- **path** (String) - Required - The file path to the database.
- **initStatements** (List<CatalogDatabase.InitStatement>) - Required - The list of init statements to apply.

### Returns
- **CatalogDatabase** - The created database instance.
```

--------------------------------

### transactionWithResult

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-transacter-impl/transaction-with-result.html

Starts a Transaction and runs bodyWithReturn in that transaction. Throws IllegalStateException if noEnclosing is true and there is already an active Transaction on this thread.

```APIDOC
## transactionWithResult

### Description
Starts a Transaction and runs bodyWithReturn in that transaction.

### Method
Function

### Signature
```kotlin
open override fun <R> transactionWithResult(noEnclosing: Boolean = false, bodyWithReturn: TransactionWithReturn<R>.() -> R): R
```

### Parameters
- **noEnclosing** (Boolean) - Optional - If true, ensures no enclosing transaction exists.
- **bodyWithReturn** (TransactionWithReturn<R>.() -> R) - Required - The body to run within the transaction.

### Throws
- **IllegalStateException** - if noEnclosing is true and there is already an active Transaction on this thread.

```

--------------------------------

### transactionWithResult

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-suspending-transacter/transaction-with-result.html

Starts a Transaction and runs bodyWithReturn in that transaction. Throws IllegalStateException if noEnclosing is true and there is already an active Transaction on this thread.

```APIDOC
## transactionWithResult

### Description
Starts a Transaction and runs bodyWithReturn in that transaction.

### Signature
abstract suspend fun <R> transactionWithResult(noEnclosing: Boolean = false, bodyWithReturn: suspend SuspendingTransactionWithReturn<R>.() -> R): R

### Parameters
- **noEnclosing** (Boolean) - Optional - Default: false. If true, throws IllegalStateException if there is already an active Transaction on this thread.
- **bodyWithReturn** (suspend SuspendingTransactionWithReturn<R>.() -> R) - Required - The body to run within the transaction, with access to a SuspendingTransactionWithReturn receiver.

### Throws
- **IllegalStateException** - if noEnclosing is true and there is already an active Transaction on this thread.

```

--------------------------------

### AfterVersion Constructor

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight.db/-after-version/

Creates an AfterVersion instance with the target version and the migration block to execute.

```APIDOC
## AfterVersion Constructor

### Description
Creates an AfterVersion instance that holds a migration block to be executed after migrating to the specified version.

### Constructor
`AfterVersion(afterVersion: Long, block: (SqlDriver) -> Unit)`

### Parameters
- **afterVersion** (Long) - Required - The version after which the block should be executed.
- **block** ((SqlDriver) -> Unit) - Required - The block of code to execute during migration.

```

--------------------------------

### transactionWithResult

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-suspending-transacter-impl/transaction-with-result.html

Starts a transaction and runs bodyWithReturn in that transaction. Throws IllegalStateException if noEnclosing is true and there is already an active Transaction on this thread.

```APIDOC
## transactionWithResult

### Description
Starts a Transaction and runs bodyWithReturn in that transaction.

### Signature
open suspend override fun <R> transactionWithResult(noEnclosing: Boolean = false, bodyWithReturn: suspend SuspendingTransactionWithReturn<R>.() -> R): R

### Parameters
- **noEnclosing** (Boolean) - Optional - If true, ensures no enclosing transaction is active.
- **bodyWithReturn** (suspend SuspendingTransactionWithReturn<R>.() -> R) - Required - The body to run within the transaction.

### Return Value
- **R** - The result of the transaction body.

### Throws
- **IllegalStateException** - if noEnclosing is true and there is already an active Transaction on this thread.
```

--------------------------------

### accept(visitor: PsiElementVisitor)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/postgresql/app.cash.sqldelight.dialects.postgresql.grammar.psi.impl/-postgre-sql-policy-name-impl/accept.html

Accepts a PsiElementVisitor instance.

```APIDOC
## accept(visitor: PsiElementVisitor)

### Description
Accepts a PsiElementVisitor instance.

### Method
accept

### Parameters
- **visitor** (PsiElementVisitor) - Required - The visitor to accept.

```

--------------------------------

### Set dialect (Kotlin DSL)

Source: https://sqldelight.github.io/sqldelight/latest/android_sqlite/gradle/

Set the SQL dialect using a Gradle dependency. Example uses SQLite 3.24 dialect.

```kotlin
dialect("app.cash.sqldelight:sqlite-3-24-dialect:2.4.0")
```

--------------------------------

### SqlSchema.create

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight.db/-sql-schema/index.html

Creates the database schema from scratch using the provided driver. Assumes no existing database state.

```APIDOC
## create

### Description
Use driver to create the schema from scratch. Assumes no existing database state.

### Method
create

### Parameters
- **driver** (SqlDriver) - Required - The driver to use for creating the schema.

### Returns
T - The result of the creation operation, indicating success or failure based on the type parameter.
```

--------------------------------

### Configure migration output directory and format

Source: https://sqldelight.github.io/sqldelight/latest/jvm_h2/migrations/

Configures the SQLDelight Gradle plugin to output migration files as valid SQL. Sets migrationOutputDirectory to build/resources/main/migrations and migrationOutputFileFormat to .sql (the default). This creates a new task generateMainDatabaseMigrations.

```groovy
sqldelight {
  databases {
    Database {
      migrationOutputDirectory = layout.buildDirectory.dir("resources/main/migrations")
      migrationOutputFileFormat = ".sql" // Defaults to .sql
  }
}
```

--------------------------------

### transaction

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-suspending-transacter/transaction.html

Starts a Transaction and runs the provided body in that transaction. Throws IllegalStateException if noEnclosing is true and there is already an active Transaction on this thread.

```APIDOC
## transaction

### Description
Starts a Transaction and runs body in that transaction.

### Method
abstract suspend fun transaction(noEnclosing: Boolean = false, body: suspend SuspendingTransactionWithoutReturn.() -> Unit)

### Parameters
- **noEnclosing** (Boolean) - Optional - Default: false. If true, throws IllegalStateException if there is already an active Transaction on this thread.
- **body** (suspend SuspendingTransactionWithoutReturn.() -> Unit) - Required - The body to run in the transaction.

### Throws
- **IllegalStateException** - if noEnclosing is true and there is already an active Transaction on this thread.
```

--------------------------------

### accept(visitor: SqliteVisitor)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/sqlite-3-18/app.cash.sqldelight.dialects.sqlite_3_18.grammar.psi.impl/-sqlite-bind-parameter-impl/accept.html

Accepts a SqliteVisitor instance to traverse the SQLite AST.

```APIDOC
## accept(visitor: SqliteVisitor)

### Description
Accepts a SqliteVisitor instance to traverse the SQLite AST.

### Method
accept

### Parameters
- **visitor** (SqliteVisitor) - Required - The visitor to accept.

```

--------------------------------

### AfterVersion Constructor

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight.db/-after-version/index.html

Creates an AfterVersion instance with the target version and the block of code to execute after migration.

```APIDOC
## AfterVersion Constructor

### Description
Creates an AfterVersion instance that holds a migration block to be executed after the database has migrated to the specified version.

### Constructor
`AfterVersion(afterVersion: Long, block: (SqlDriver) -> Unit)`

### Parameters
- **afterVersion** (Long) - Required - The version after which the block should be executed.
- **block** ((SqlDriver) -> Unit) - Required - The block of code to execute during migration.

```

--------------------------------

### Pass dispatcher to coroutines extension

Source: https://sqldelight.github.io/sqldelight/latest/upgrading-2.0/

The coroutines extension API now requires a dispatcher to be explicitly passed. The example shows adding '.mapToList(Dispatchers.IO)' to the flow.

```kotlin
val players: Flow<List<HockeyPlayer>> =
  playerQueries.selectAll()
    .asFlow()
+   .mapToList(Dispatchers.IO)
```

--------------------------------

### getInstance(module: Module): SqlDelightFileIndex

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-compiler/app.cash.sqldelight.core/-sql-delight-file-index/-companion/get-instance.html

Returns a SqlDelightFileIndex instance for the given module. This is a function that users can call directly.

```APIDOC
## getInstance(module: Module): SqlDelightFileIndex

### Description
Returns a SqlDelightFileIndex for the provided module.

### Function Signature
```kotlin
fun getInstance(module: Module): SqlDelightFileIndex
```

### Parameters
- **module** (Module) - Required - The module for which to get the file index.

### Return Value
- **SqlDelightFileIndex** - The file index for the given module.
```

--------------------------------

### Rename SqlDriver.Schema to SqlSchema

Source: https://sqldelight.github.io/sqldelight/latest/upgrading-2.0/

The Schema type is no longer nested inside SqlDriver and is now called SqlSchema. The example shows the type change from SqlDriver.Schema to SqlSchema.

```kotlin
-val schema: SqlDriver.Schema
+val schema: SqlSchema
```

--------------------------------

### fromFile

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqlite-migrations/app.cash.sqlite.migrations/-catalog-database/-companion/from-file.html

Creates a CatalogDatabase from the given file path and initialization statements.

```APIDOC
## fromFile

### Description
Creates a CatalogDatabase from the given file path and initialization statements.

### Function Signature
fun fromFile(path: String, initStatements: List<CatalogDatabase.InitStatement>): CatalogDatabase

### Parameters
- **path** (String) - The file path to the database.
- **initStatements** (List<CatalogDatabase.InitStatement>) - List of initialization statements.

### Returns
- **CatalogDatabase** - The created database instance.
```

--------------------------------

### transaction

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-transacter/index.html

Starts a Transaction and runs the provided body within that transaction. The noEnclosing parameter controls whether the transaction can be nested within an existing transaction.

```APIDOC
## transaction

### Description
Starts a Transaction and runs body in that transaction.

### Method
abstract fun transaction(noEnclosing: Boolean = false, body: TransactionWithoutReturn.() -> Unit)

### Parameters
- **noEnclosing** (Boolean) - Optional - If true, the transaction will not be enclosed within an existing transaction.
- **body** (TransactionWithoutReturn.() -> Unit) - Required - The body to execute within the transaction.

```

--------------------------------

### accept(visitor: SqliteVisitor)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/sqlite-3-24/app.cash.sqldelight.dialects.sqlite_3_24.grammar.psi.impl/-sqlite-upsert-clause-impl/accept.html

Accepts a SqliteVisitor instance to traverse the SQLite dialect elements.

```APIDOC
## accept(visitor: SqliteVisitor)

### Description
Accepts a SqliteVisitor instance to traverse the SQLite dialect elements.

### Method
accept

### Parameters
- **visitor** (SqliteVisitor) - Required - The visitor to accept.

```

--------------------------------

### sourceFolders(file: SqlDelightFile, includeDependencies: Boolean = true): Collection<PsiDirectory>

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-compiler/app.cash.sqldelight.core/-sql-delight-file-index/source-folders.html

Returns the source roots of SQLDelight files for the given SqlDelightFile. The includeDependencies parameter controls whether dependency source roots are included.

```APIDOC
## sourceFolders(file: SqlDelightFile, includeDependencies: Boolean = true): Collection<PsiDirectory>

### Description
Returns the source roots of SQLDelight files for the given SqlDelightFile. The includeDependencies parameter controls whether dependency source roots are included.

### Method
Function call

### Parameters
- **file** (SqlDelightFile) - Required - The file for which to find source roots.
- **includeDependencies** (Boolean) - Optional - Whether to include dependency source roots. Defaults to true.

### Return
Collection<PsiDirectory> - The source roots of SQLDelight files for the given file.
```

--------------------------------

### Example response for non-result-set SQL

Source: https://sqldelight.github.io/sqldelight/latest/js_sqlite/custom_worker/

Response for a SQL statement that does not return a result set. The 'results' property contains a single row/column with the number of affected rows.

```json
{
  "id": 10,
  "results": [ [1] ]
}
```

--------------------------------

### Kotlin DSL Gradle configuration for SQLDelight with HSQL dialect

Source: https://sqldelight.github.io/sqldelight/latest/jvm_h2/

Apply the SQLDelight Gradle plugin version 2.4.0 and register a database named 'Database' with the HSQL dialect. The package name is set to 'com.example'. This configuration is for the Kotlin DSL.

```kotlin
plugins {
  id("app.cash.sqldelight") version "2.4.0"
}

repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    register("Database") {
      packageName.set("com.example")
      dialect("app.cash.sqldelight:hsql-dialect:2.4.0")
    }
  }
}
```

--------------------------------

### Groovy DSL Gradle configuration for SQLDelight with HSQL dialect

Source: https://sqldelight.github.io/sqldelight/latest/jvm_h2/

Apply the SQLDelight Gradle plugin version 2.4.0 and register a database named 'Database' with the HSQL dialect. The package name is set to 'com.example'. This configuration is for the Groovy DSL.

```groovy
plugins {
  id "app.cash.sqldelight" version "2.4.0"
}

repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    register("Database") { // This will be the name of the generated database class.
      packageName = "com.example"
      dialect "app.cash.sqldelight:hsql-dialect:2.4.0"
    }
  }
}
```

--------------------------------

### forSourceFiles(action: (SqlFileBase) -> Unit)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-gradle-plugin/app.cash.sqldelight.core/-sql-delight-environment/for-source-files.html

Invokes the given action for each source file, providing the file as a SqlFileBase instance.

```APIDOC
## forSourceFiles(action: (SqlFileBase) -> Unit)

### Description
Invokes the given action for each source file, providing the file as a SqlFileBase instance.

### Method
Function

### Signature
```kotlin
@JvmName(name = "forSqlFileBases")
fun forSourceFiles(action: (SqlFileBase) -> Unit)
```

### Parameters
- **action** (function) - Required - A lambda that receives a SqlFileBase and performs operations on it.

```

--------------------------------

### Roll back a transactionWithResult with a return value

Source: https://sqldelight.github.io/sqldelight/latest/android_sqlite/transactions/

When using `transactionWithResult`, `rollback` requires a value to return. The example returns 0 on rollback and the number of players otherwise.

```kotlin
val numberInserted: Int = database.playerQueries.transactionWithResult {
  players.forEach { player ->
    if (player.number == 0) rollback(0)
    database.playerQueries.insert(
      player_number = player.number,
      full_name = player.fullName
    )
  }
  players.size
}
```

--------------------------------

### transaction

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-suspending-transacter/index.html

Starts a Transaction and runs the provided suspend body within that transaction. The noEnclosing parameter controls whether the transaction can be nested within an existing transaction.

```APIDOC
## [SUSPEND] transaction

### Description
Starts a Transaction and runs body in that transaction.

### Method
Suspend function

### Signature
```kotlin
abstract suspend fun transaction(noEnclosing: Boolean = false, body: suspend SuspendingTransactionWithoutReturn.() -> Unit)
```

### Parameters
- **noEnclosing** (Boolean) - Optional - If true, the transaction will not be enclosed within an existing transaction.
- **body** (suspend SuspendingTransactionWithoutReturn.() -> Unit) - Required - The suspend lambda to execute within the transaction.

### Response
No return value.
```

--------------------------------

### NativeSqliteDriver actual implementation for native

Source: https://sqldelight.github.io/sqldelight/latest/js_sqlite/multiplatform/

Provides the actual implementation for native platforms using NativeSqliteDriver with a synchronous schema and a database file named 'test.db'.

```kotlin
actual suspend fun provideDbDriver(
  schema: SqlSchema<QueryResult.AsyncValue<Unit>>
): SqlDriver {
  return NativeSqliteDriver(schema.synchronous(), "test.db")
}
```

--------------------------------

### generateSqlDelightFiles

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-gradle-plugin/app.cash.sqldelight.core/-sql-delight-environment/generate-sql-delight-files.html

Runs the SQLDelight compiler and returns the error or success status.

```APIDOC
## generateSqlDelightFiles

### Description
Runs the SQLDelight compiler and returns the error or success status.

### Function Signature
fun generateSqlDelightFiles(logger: (String) -> Unit): SqlDelightEnvironment.CompilationStatus

### Parameters
- **logger** ((String) -> Unit) - Required - A callback function that receives log messages as strings.

### Return Value
- **SqlDelightEnvironment.CompilationStatus** - The compilation status, indicating success or error.

```

--------------------------------

### Override sqlite-jdbc version for Android API 23

Source: https://sqldelight.github.io/sqldelight/latest/android_sqlite/testing/

Overrides the sqlite-jdbc version to match Android's minSdkVersion. Example uses API 23 with SQLite 3.8.10.2.

```groovy
dependencies {
  testImplementation('org.xerial:sqlite-jdbc') {
    // Override the version of sqlite used by sqlite-driver to match Android API 23
    version { strictly('3.8.10.2') }
  }
}
```

--------------------------------

### accept(visitor: SqliteVisitor)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/sqlite-3-18/app.cash.sqldelight.dialects.sqlite_3_18.grammar.psi.impl/-sqlite-real-data-type-impl/accept.html

Accepts a SqliteVisitor instance. This method is part of the visitor pattern and allows traversal of the SQLite dialect's AST nodes.

```APIDOC
## accept(visitor: SqliteVisitor)

### Description
Accepts a SqliteVisitor instance. This method is part of the visitor pattern and allows traversal of the SQLite dialect's AST nodes.

### Method
accept

### Parameters
- **visitor** (SqliteVisitor) - Required - The visitor to accept.

```

--------------------------------

### Grammar rule referencing external rules

Source: https://sqldelight.github.io/sqldelight/latest/contributing/

Shows how to reference ANSI SQL rules by surrounding them with {}. The rule definition should start as an exact copy of the ANSI SQL rule.

```BNF
my_rule ::= internal_rule {external_rule} {
  override = true
}
internal_rule ::= SOME_TOKEN
```

--------------------------------

### transactionWithResult(noEnclosing: Boolean = false, bodyWithReturn: TransactionWithReturn<R>.() -> R): R

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-transacter-impl/index.html

Starts a Transaction and runs the provided bodyWithReturn within that transaction, returning the result of the body.

```APIDOC
## transactionWithResult(noEnclosing: Boolean = false, bodyWithReturn: TransactionWithReturn<R>.() -> R): R

### Description
Starts a Transaction and runs bodyWithReturn in that transaction.

### Parameters
- **noEnclosing** (Boolean) - Optional - If true, the transaction will not be enclosed in an existing transaction.
- **bodyWithReturn** (TransactionWithReturn<R>.() -> R) - Required - The code to execute within the transaction, returning a value of type R.

### Returns
- **R** - The result of the transaction body.

```

--------------------------------

### Declare a database with the databases container (Groovy DSL)

Source: https://sqldelight.github.io/sqldelight/latest/android_sqlite/gradle/

Groovy DSL equivalent for creating a database named 'MyDatabase' using the `databases` container.

```groovy
sqldelight {
  databases {
    MyDatabase {
      // Database configuration here.
    }
  }
}
```

--------------------------------

### Mixin class implementation

Source: https://sqldelight.github.io/sqldelight/latest/contributing/

The mixin class must implement the original ANSI SQL type and the SQL-PSI base class SqlCompositeElementImpl. This example shows how to add error annotations.

```Kotlin
class MyRule(
  node: ASTNode
) : SqlCompositeElementImpl(node),
    SqlMyRule {
  fun annotate(annotationHolder: SqlAnnotationHolder) {
    if (internal_rule.text == "bad_text") {
      annotationHolder.createErrorAnnotation("Invalid text value", internal_rule)
    }
  }
}
```

--------------------------------

### Enable verifyMigrations (Groovy DSL)

Source: https://sqldelight.github.io/sqldelight/latest/android_sqlite/gradle/

Groovy DSL equivalent for enabling migration verification.

```groovy
verifyMigrations = true
```

--------------------------------

### SQLite schema for hockey_player table

Source: https://sqldelight.github.io/sqldelight/latest/

Example SQL schema that SQLDelight takes as input to generate typesafe code. Defines a hockey_player table with id, name, and number columns.

```SQL
CREATE TABLE hockey_player (
  id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
  name TEXT NOT NULL,
  number INTEGER NOT NULL
);
```

--------------------------------

### accept(visitor: SqliteVisitor)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/sqlite-3-18/app.cash.sqldelight.dialects.sqlite_3_18.grammar.psi.impl/-sqlite-text-data-type-impl/accept.html

Accepts a SqliteVisitor to traverse the SQLite syntax tree. This is part of the visitor pattern for the SQLite dialect.

```APIDOC
## accept(visitor: SqliteVisitor)

### Description
Accepts a SqliteVisitor to traverse the SQLite syntax tree. This is part of the visitor pattern for the SQLite dialect.

### Method
accept

### Parameters
- **visitor** (SqliteVisitor) - Required - The visitor to accept.

### Return Type
void (open fun)

```

--------------------------------

### transactionWithResult(noEnclosing: Boolean = false, bodyWithReturn: suspend SuspendingTransactionWithReturn<R>.() -> R): R

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-suspending-transacter-impl/index.html

Starts a transaction and runs the provided bodyWithReturn within that transaction, returning the result of the body.

```APIDOC
## transactionWithResult(noEnclosing: Boolean = false, bodyWithReturn: suspend SuspendingTransactionWithReturn<R>.() -> R): R

### Description
Starts a Transaction and runs bodyWithReturn in that transaction.

### Method
open suspend override fun <R> transactionWithResult

### Parameters
- **noEnclosing** (Boolean) - Optional - If true, the transaction will not be enclosed in an existing transaction. Default is false.
- **bodyWithReturn** (suspend SuspendingTransactionWithReturn<R>.() -> R) - Required - The suspending lambda that returns a value of type R.

### Returns
- **R** - The result of the bodyWithReturn lambda.

```

--------------------------------

### SqlDelightEnvironment constructor

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-gradle-plugin/app.cash.sqldelight.core/-sql-delight-environment/-sql-delight-environment.html

Creates a SqlDelightEnvironment instance with the specified properties, compilation unit, migration verification flag, dialect, module name, and optional codegen excluded columns.

```APIDOC
## SqlDelightEnvironment constructor

### Description
Initializes a new SqlDelightEnvironment with the given database options, compilation unit, migration verification flag, dialect, module name, and codegen excluded columns.

### Method
Constructor

### Parameters
- **properties** (SqlDelightDatabaseOptions) - Required - Database options for the environment.
- **compilationUnit** (SqlDelightCompilationUnit) - Required - The compilation unit containing source and dependency folders.
- **verifyMigrations** (Boolean) - Required - Whether to verify migrations.
- **dialect** (SqlDelightDialect) - Required - The SQL dialect to use.
- **moduleName** (String) - Required - The name of the module.
- **codegenExcludedColumns** (Set<String>) - Optional - Columns to exclude from code generation. Defaults to properties.codegenExcludedColumns.
- **sourceFolders** (List<File>) - Optional - Source folders from the compilation unit that exist and are not dependencies. Defaults to filtered source folders.
- **dependencyFolders** (List<File>) - Optional - Dependency folders from the compilation unit that exist and are dependencies. Defaults to filtered dependency folders.

### Response
No return value (constructor).
```

--------------------------------

### Configure database with managed properties (Groovy DSL)

Source: https://sqldelight.github.io/sqldelight/latest/upgrading-2.0/

Use the new DomainObjectCollection wrapper and assign packageName directly in the Groovy Gradle DSL.

```groovy
sqldelight {
  databases { // (1)!
    Database {
      packageName = "com.example"
    }
  }
}
```

--------------------------------

### transaction(noEnclosing: Boolean = false, body: TransactionWithoutReturn.() -> Unit)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-transacter-impl/index.html

Starts a Transaction and runs the provided body within that transaction. The noEnclosing parameter controls whether an enclosing transaction is allowed.

```APIDOC
## transaction(noEnclosing: Boolean = false, body: TransactionWithoutReturn.() -> Unit)

### Description
Starts a Transaction and runs body in that transaction.

### Parameters
- **noEnclosing** (Boolean) - Optional - If true, the transaction will not be enclosed in an existing transaction.
- **body** (TransactionWithoutReturn.() -> Unit) - Required - The code to execute within the transaction.

```

--------------------------------

### accept(visitor: PsiElementVisitor)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/sqlite-3-24/app.cash.sqldelight.dialects.sqlite_3_24.grammar.psi.impl/-sqlite-upsert-clause-impl/accept.html

Accepts a PsiElementVisitor instance to traverse the SQLite dialect elements.

```APIDOC
## accept(visitor: PsiElementVisitor)

### Description
Accepts a PsiElementVisitor instance to traverse the SQLite dialect elements.

### Method
accept

### Parameters
- **visitor** (PsiElementVisitor) - Required - The visitor to accept.

```

--------------------------------

### transaction(noEnclosing: Boolean = false, body: TransactionWithoutReturn.() -> Unit)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-transacter-impl/transaction.html

Starts a Transaction and runs the provided body in that transaction. Throws IllegalStateException if noEnclosing is true and there is already an active Transaction on this thread.

```APIDOC
## transaction(noEnclosing: Boolean = false, body: TransactionWithoutReturn.() -> Unit)

### Description
Starts a Transaction and runs the provided body in that transaction.

### Method
Function call

### Signature
```kotlin
open override fun transaction(noEnclosing: Boolean = false, body: TransactionWithoutReturn.() -> Unit)
```

### Parameters
- **noEnclosing** (Boolean) - Optional - If true, throws an exception if there is already an active transaction on this thread.
- **body** (TransactionWithoutReturn.() -> Unit) - Required - The code to execute within the transaction.

### Throws
- **IllegalStateException** - If noEnclosing is true and there is already an active Transaction on this thread.

```

--------------------------------

### Access QueryResult.value from driver methods

Source: https://sqldelight.github.io/sqldelight/latest/upgrading-2.0/

Driver methods like executeQuery now return a QueryResult object. Use QueryResult.value to access the returned value. The example shows adding '.value' to the executeQuery call.

```kotlin
-driver.executeQuery(null, "PRAGMA user_version", { /*...*/ })
+driver.executeQuery(null, "PRAGMA user_version", { /*...*/ }).value
```

--------------------------------

### AnsiSqlMigrationSquasher constructor

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-gradle-plugin/app.cash.sqldelight.gradle.squash/-ansi-sql-migration-squasher/index.html

Creates an AnsiSqlMigrationSquasher instance with a function to create new SQL files.

```APIDOC
## AnsiSqlMigrationSquasher constructor

### Description
Creates an AnsiSqlMigrationSquasher instance with a function to create new SQL files.

### Method
constructor

### Parameters
- **createNewSqlFile** ((String) -> SqlFileBase) - Required - Function that creates a new SqlFileBase from a string.

### Example
```kotlin
val squasher = AnsiSqlMigrationSquasher { fileName -> SqlFile(fileName) }
```
```

--------------------------------

### Callback constructor

Source: https://sqldelight.github.io/sqldelight/latest/2.x/drivers/android-driver/app.cash.sqldelight.driver.android/-android-sqlite-driver/-callback/index.html

Creates a Callback instance with the given SQLDelight schema and AfterVersion callbacks.

```APIDOC
## Callback constructor

### Description
Creates a Callback instance with the given SQLDelight schema and AfterVersion callbacks.

### Method
constructor

### Signature
constructor(schema: SqlSchema<QueryResult.Value<Unit>>, vararg callbacks: AfterVersion)

### Parameters
- **schema** (SqlSchema<QueryResult.Value<Unit>>) - Required - The SQLDelight schema.
- **callbacks** (AfterVersion) - Required - One or more AfterVersion callbacks.

```

--------------------------------

### Import primitive type in .sq file

Source: https://sqldelight.github.io/sqldelight/latest/upgrading-2.0/

Primitive types must now be imported into .sq and .sqm files. The example shows adding 'import kotlin.Boolean;' before using 'AS Boolean' in a table definition.

```sql
+import kotlin.Boolean;

CREATE TABLE HockeyPlayer (
  name TEXT NOT NULL,
  good INTEGER AS Boolean
);
```

--------------------------------

### accept(visitor: PsiElementVisitor)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/sqlite-3-37/app.cash.sqldelight.dialects.sqlite_3_37.grammar.psi.impl/-sqlite-overrides-impl/accept.html

Accepts a PsiElementVisitor to traverse the element tree. This is part of the visitor pattern implementation.

```APIDOC
## accept(visitor: PsiElementVisitor)

### Description
Accepts a PsiElementVisitor to traverse the element tree. This is part of the visitor pattern implementation.

### Method
accept

### Parameters
- **visitor** (PsiElementVisitor) - Required - The visitor to accept.

```

--------------------------------

### transaction(noEnclosing: Boolean = false, body: TransactionWithoutReturn.() -> Unit)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-transacter/transaction.html

Starts a Transaction and runs the provided body within that transaction. Throws IllegalStateException if noEnclosing is true and there is already an active Transaction on this thread.

```APIDOC
## transaction(noEnclosing: Boolean = false, body: TransactionWithoutReturn.() -> Unit)

### Description
Starts a Transaction and runs the provided body within that transaction.

### Method
Function call (abstract fun)

### Signature
```kotlin
abstract fun transaction(noEnclosing: Boolean = false, body: TransactionWithoutReturn.() -> Unit)
```

### Parameters
- **noEnclosing** (Boolean) - Optional - Default: false. If true, throws an exception if there is already an active transaction on this thread.
- **body** (TransactionWithoutReturn.() -> Unit) - Required - The code to execute within the transaction.

### Throws
- **IllegalStateException** - If noEnclosing is true and there is already an active Transaction on this thread.

```

--------------------------------

### accept(visitor: SqliteVisitor)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/sqlite-3-18/app.cash.sqldelight.dialects.sqlite_3_18.grammar.psi.impl/-sqlite-blob-data-type-impl/accept.html

Accepts a SqliteVisitor instance to traverse the element.

```APIDOC
## accept(visitor: SqliteVisitor)

### Description
Accepts a SqliteVisitor instance to traverse the element.

### Method
accept

### Parameters
- **visitor** (SqliteVisitor) - Required - The visitor to accept.

```

--------------------------------

### transaction(noEnclosing: Boolean = false, body: suspend SuspendingTransactionWithoutReturn.() -> Unit)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/runtime/app.cash.sqldelight/-suspending-transacter-impl/index.html

Starts a transaction and runs the provided body within that transaction. The noEnclosing parameter controls whether an enclosing transaction is allowed.

```APIDOC
## transaction(noEnclosing: Boolean = false, body: suspend SuspendingTransactionWithoutReturn.() -> Unit)

### Description
Starts a Transaction and runs body in that transaction.

### Method
open suspend override fun transaction

### Parameters
- **noEnclosing** (Boolean) - Optional - If true, the transaction will not be enclosed in an existing transaction. Default is false.
- **body** (suspend SuspendingTransactionWithoutReturn.() -> Unit) - Required - The suspending lambda to execute within the transaction.

```

--------------------------------

### accept(PsiElementVisitor)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/dialects/mysql/app.cash.sqldelight.dialects.mysql.grammar.psi.impl/-my-sql-alter-table-drop-column-impl/accept.html

Accepts a PsiElementVisitor to traverse the MySQL grammar element.

```APIDOC
## accept(PsiElementVisitor)

### Description
Accepts a PsiElementVisitor to traverse the MySQL grammar element.

### Method
accept

### Parameters
- **visitor** (PsiElementVisitor) - Required - The visitor to accept.

```

--------------------------------

### QueryPagingSource (Offset/Int)

Source: https://sqldelight.github.io/sqldelight/latest/2.x/extensions/androidx-paging3/app.cash.sqldelight.paging3/

Creates a PagingSource that pages through results using SQL offset/limit based paging. The countQuery is required to calculate pages and page offsets. The initialOffset parameter specifies the starting offset.

```APIDOC
## QueryPagingSource (Offset/Int)

### Description
Creates a PagingSource that pages through results according to queries generated by queryProvider. Queries returned by queryProvider should expect to do SQL offset/limit based paging. For that reason, countQuery is required to calculate pages and page offsets. initialOffset initial offset to start paging from.

### Function Signature
```kotlin
@JvmName(name = "QueryPagingSourceInt")
@JvmOverloads
fun <RowType : Any> QueryPagingSource(
    countQuery: Query<Int>,
    transacter: TransacterBase,
    context: CoroutineContext,
    queryProvider: (limit: Int, offset: Int) -> Query<RowType>,
    initialOffset: Int = 0
): PagingSource<Int, RowType>
```

### Parameters
- **countQuery** (Query<Int>) - Required - A query that returns the total count of rows.
- **transacter** (TransacterBase) - Required - The transacter used to execute queries.
- **context** (CoroutineContext) - Required - The coroutine context for paging operations.
- **queryProvider** ((limit: Int, offset: Int) -> Query<RowType>) - Required - A function that provides a query to fetch rows for a page given a limit and offset.
- **initialOffset** (Int) - Optional - Initial offset to start paging from. Default is 0.

### Returns
- **PagingSource<Int, RowType>** - A PagingSource that pages through results using offset/limit paging.
```

--------------------------------

### outputDirectories()

Source: https://sqldelight.github.io/sqldelight/latest/2.x/sqldelight-compiler/app.cash.sqldelight.core/-sql-delight-file-index/output-directories.html

Abstract function that returns a list of all SQLDelight output directories.

```APIDOC
## outputDirectories()

### Description
Returns a list of all SQLDelight output directories.

### Method
outputDirectories

### Return
- **List<String>** - A list of all SQLDelight output directories.
```
Tokens:
Raw