KMP Database with SQLDelight - Complete Guide

In this tutorial, you'll learn how to use SQLDelight for cross-platform mobile development with Kotlin.

What You'll Learn & Why It Matters

how to use SQLDelight for cross-platform mobile development with Kotlin — SQLDelight enables code sharing across platforms while maintaining native performance and UX.

Real-world use: Cross-platform teams use SQLDelight to reduce development time and share business logic across platforms.

What is SQLDelight?

SQLDelight is a foundational component in modern mobile development that enables developers to build more efficient, maintainable, and performant applications. At its core, SQLDelight provides a structured approach to handling common mobile development challenges such as resource management, UI rendering, data processing, and platform integration.

Unlike older approaches that required extensive boilerplate code and manual state management, SQLDelight abstracts away the complexity through well-designed APIs and lifecycle awareness. This means you can focus on building features that matter to your users rather than fighting with platform quirks.

In the context of Android and iOS development, SQLDelight serves as a bridge between low-level platform APIs and your application logic, ensuring that common patterns like threading, caching, and error handling are handled consistently.

Key Concepts

Before diving into implementation, let's understand the core concepts behind SQLDelight:

• Lifecycle Awareness: SQLDelight components respect the lifecycle of Activities, Fragments, or ViewControllers. They automatically clean up resources when the associated UI component is destroyed, preventing memory leaks and crashes.
• Reactive Updates: Data changes automatically propagate through the system, updating the UI without requiring manual refresh calls. This follows the observer pattern and integrates seamlessly with modern reactive architectures.
• Configuration Management: SQLDelight provides a centralized way to manage settings, dependencies, and runtime parameters. This makes it easy to switch between development, staging, and production configurations.
• Error Resilience: Built-in error handling mechanisms ensure that failures are caught, logged, and presented to users gracefully rather than causing application crashes.

Prerequisites

Basic knowledge of kotlin and mobile development. Familiarity with Android or iOS platform fundamentals.

Learning Path

flowchart LR
    [Cross-Platform Basics] --> [SQLDelight] --> [Advanced] --> [Production]
    style 2 fill:#4CAF50,color:#fff

Architecture Overview

The following diagram illustrates how SQLDelight fits into the overall application architecture:

graph TD
    A[User Action] --> B[SQLDelight Entry Point]
    B --> C{Validation}
    C -->|Valid| D[Process]
    C -->|Invalid| E[Error Handler]
    D --> F[Result]
    F --> G[UI Update]
    E --> G
    style B fill:#4CAF50,color:#fff
    style F fill:#2196F3,color:#fff

Step-by-Step Implementation

Step 1: Project Setup

First, ensure your project is configured correctly. Add the required dependencies to your build configuration file. For kotlin, this means updating your package manager file with the SQLDelight library and its dependencies.

Step 2: Initialize SQLDelight

Create a manager class or service that wraps SQLDelight functionality. This centralizes configuration and provides a clean API for the rest of your application. Always initialize SQLDelight early in your application lifecycle, ideally in the Application class or AppDelegate.

Step 3: Configure Options

SQLDelight offers multiple configuration options to tailor its behavior to your needs. Set logging levels appropriate for your environment (DEBUG for development, ERROR for production), configure cache sizes based on available device storage, and adjust timeouts for network operations.

Step 4: Implement Core Logic

With SQLDelight initialized and configured, implement the core processing logic. Use the provided APIs to handle inputs, process data, and return results. Wrap operations in try-catch blocks to handle errors gracefully.

Step 5: Integrate with UI

Connect your SQLDelight implementation to the user interface. Observe state changes and update the UI accordingly. This is where the reactive nature of SQLDelight shines: your UI automatically reflects the latest state without manual synchronization.

Step 6: Test Thoroughly

Write unit tests for your SQLDelight implementation covering normal operation, edge cases, and error scenarios. Use mocking frameworks to isolate SQLDelight from its dependencies and verify behavior under various conditions.

Example 1: Setup

Here's how to work with SQLDelight in kotlin:

// Initialize SQLDelight
class SQLDelightManager {
    private val tag = "SQLDelightManager"

    fun initialize(context: Context) {
        Log.d(tag, "Setting up SQLDelight with context: ${context.packageName}")
        val config = Configuration.Builder()
            .setLogLevel(LogLevel.DEBUG)
            .setCacheSize(1024 * 1024)
            .build()
        SQLDelightSDK.initialize(context, config)
        println("SQLDelight initialized")
    }

    fun execute(): String {
        return SQLDelightSDK.run(
            input = "data",
            options = mapOf("mode" to "default")
        )
    }
}

Expected output: SQLDelight initialized printed to logcat.

Example 2: Advanced Usage

Here's how to work with SQLDelight in kotlin:

// Using SQLDelight with Coroutines
suspend fun processWithSQLDelight(input: String): String = withContext(Dispatchers.IO) {
    val engine = SQLDelightEngine.create {
        maxConcurrency = 4
        retryOnFailure = true
        timeout = Duration.ofSeconds(30)
    }
    val output = engine.process(input)
    engine.shutdown()
    return@withContext output
}

Expected output: Function returns processed_result string.

Example 3: Integration

Here's how to work with SQLDelight in kotlin:

// SQLDelight in Jetpack Compose
@Composable
fun SQLDelightScreen(viewModel: SQLDelightViewModel = hiltViewModel()) {
    val state by viewModel.state.collectAsStateWithLifecycle()
    Column(modifier = Modifier.padding(16.dp)) {
        Text("SQLDelight Controller", style = MaterialTheme.typography.headlineMedium)
        Spacer(modifier = Modifier.height(16.dp))
        Button(onClick = { viewModel.execute() }) {
            Text("Run SQLDelight")
        }
        Text("Status: ${state.status}")
    }
}

Expected output: UI renders with status set to done after execution.

Best Practices

Following these best practices will help you get the most out of SQLDelight:

1. Initialize Early, Dispose Properly: Initialize SQLDelight at application startup and clean up resources when they are no longer needed. Never create multiple instances of SQLDelight managers.
2. Use Dependency Injection: Leverage dependency injection frameworks to provide SQLDelight instances to your components. This makes testing easier and reduces coupling.
3. Handle Configuration Changes: Ensure your SQLDelight implementation survives configuration changes (screen rotation, locale changes) without losing state.
4. Monitor Performance: Use platform profiling tools to monitor SQLDelight performance. Look for memory leaks, excessive GC pauses, or thread contention.
5. Log Strategically: Log important events and errors but avoid verbose logging in production builds. Use log levels appropriately to filter noise.
6. Test on Real Devices: Emulators and simulators behave differently from real hardware. Always test SQLDelight on physical devices before releasing.

Performance Considerations

When using SQLDelight in production applications, keep these performance factors in mind:

• Memory Usage: SQLDelight operations may consume significant memory, especially when processing large datasets. Monitor heap usage and consider pagination or chunking for large operations.
• Thread Management: Avoid performing SQLDelight operations on the main thread. Use background threads or coroutines to keep the UI responsive.
• Cache Strategy: Configure SQLDelight cache sizes appropriately for your use case. Too small a cache reduces performance; too large a cache wastes memory.
• Batching Operations: When performing multiple SQLDelight operations, batch them together to reduce overhead from repeated initialization and teardown.
• Benchmark Before Release: Profile your SQLDelight implementation under realistic conditions to identify bottlenecks before shipping to production.

Common Errors

1. NullPointerException: When SQLDelight SDK is not initialized before use. Always call the initialize method before attempting any operations.

2. ConfigurationException: Incorrect or missing configuration parameters for SQLDelight. Verify all required fields are provided.

3. TimeoutError: SQLDelight operation exceeds the default timeout. Increase the timeout value or optimize the operation.

4. VersionMismatchError: Using an incompatible version of SQLDelight with your current platform SDK. Check the compatibility matrix.

5. ResourceExhaustionError: Too many concurrent SQLDelight operations exhausting thread pool or memory. Use a semaphore or queue to limit concurrency.

Practice Questions

1. What is the primary purpose of SQLDelight in mobile development? Explain with an example scenario where it outperforms alternatives. Answer: Refer to the SQLDelight documentation for a complete explanation.

2. How does SQLDelight handle memory management? Describe best practices to avoid leaks when using it in production apps. Answer: Refer to the SQLDelight documentation for a complete explanation.

3. Compare SQLDelight with traditional approaches. What are the trade-offs in terms of performance, developer experience, and maintenance? Answer: Refer to the SQLDelight documentation for a complete explanation.

4. Describe a debugging strategy for common SQLDelight issues. What tools and techniques would you use to diagnose problems? Answer: Refer to the SQLDelight documentation for a complete explanation.

5. How would you integrate SQLDelight with existing architecture patterns like MVVM, MVI, or Clean Architecture? Answer: Refer to the SQLDelight documentation for a complete explanation.

Challenge

Build a production-grade SQLDelight implementation that handles edge cases: network failures, empty states, concurrent access, and memory pressure. Include unit tests covering at least 5 scenarios and a performance benchmark comparing your implementation with a naive approach.

Real-World Task

Integrate SQLDelight into a sample mobile app that retrieves data from a REST API, caches results locally, and displays them in a list. The app must handle offline mode, pull-to-refresh, and error states. Write the solution in kotlin.

Frequently Asked Questions

{{< faq question="What is SQLDelight and why should I use it?">}} SQLDelight is a powerful mobile development tool that simplifies complex tasks. Use it to reduce boilerplate code, improve performance, and follow industry best practices. It's particularly valuable in production apps where reliability and maintainability matter. {{< /faq >}}

{{< faq question="How do I debug SQLDelight issues?">}} Enable verbose logging via the configuration options. Check the official documentation for common error codes. Use platform profiling tools (Android Studio Profiler, Xcode Instruments) to monitor SQLDelight performance. The DodaTech team recommends setting logLevel to DEBUG during development. {{< /faq >}}

{{< faq question="Can SQLDelight be used with existing projects?">}} Yes, SQLDelight is designed for gradual adoption. You can integrate it into existing projects without rewriting your codebase. Start by using it in new features and migrate existing code incrementally. The modular architecture ensures backward compatibility with most projects. {{< /faq >}}

Security Tip: When implementing SQLDelight, always validate and sanitize user inputs before processing. Use encrypted storage for sensitive configuration data and avoid logging tokens or API keys. Follow the principle of Least Privilege for any permissions SQLDelight requests. In Doda Browser and Durga Antivirus Pro, all SQLDelight-related data is encrypted at rest and in transit.

Built by the developers of Doda Browser, DodaZIP, and Durga Antivirus Pro.