How to set up Skunk with a basic Scala application?

Start by adding Skunk dependencies to your build.sbt, then create a Session resource using Cats Effect's IO. You'll need to configure a PostgreSQL connection and manage resources functionally, as shown in the microsite examples.

Skunk vs Doobie: which one should I use for PostgreSQL?

Skunk is PostgreSQL-specific with deeper optimizations and type-safety, while Doobie supports multiple databases and has a larger ecosystem. Choose Skunk for pure FP and Postgres focus; Doobie for flexibility across databases.

Does Skunk support JSONB and other PostgreSQL advanced types?

Yes, Skunk natively supports PostgreSQL-specific data types like JSONB, arrays, and enums through its type-safe API, leveraging the binary protocol for efficient serialization and deserialization.

How to handle errors and retries with Skunk?

Errors are managed functionally using Cats Effect's error-handling mechanisms, such as IO monads and resources. You can implement retries with libraries like cats-retry, but Skunk doesn't provide built-in retry logic.

Can I use Skunk with non-Cats Effect frameworks like ZIO?

Skunk is tightly coupled with Cats Effect, so using it with ZIO requires interoperability layers like zio-interop-cats, which can add complexity and might not support all features seamlessly.

What's the performance overhead of Skunk compared to plain JDBC?

Skunk adds some overhead due to its functional abstractions and type-safety, but it optimizes with PostgreSQL's binary protocol to mitigate this. For simple queries, plain JDBC might be faster, but Skunk excels in safety and scalability.

skunk — Functional PostgreSQL Data Access

What is skunk?

Skunk is a data access library for Scala applications that connects to PostgreSQL databases. It provides a purely functional, type-safe API for executing SQL queries and commands, ensuring compile-time validation and preventing common runtime errors. The library is designed to integrate seamlessly with functional programming ecosystems like Cats Effect and FS2.

Target Audience

Scala developers building applications with PostgreSQL who prioritize type safety, functional programming principles, and maintainable database code. It's especially suited for teams using Cats Effect, FS2, or similar functional libraries.

Value Proposition

Developers choose Skunk for its strong type safety, pure functional design, and deep PostgreSQL integration. It eliminates many runtime database errors through compile-time checks and offers a composable, resource-safe API that aligns with modern functional Scala practices.

A data access library for Scala + Postgres.

Use Cases

Best For

Building type-safe database layers in Scala applications
Integrating PostgreSQL with Cats Effect-based systems
Handling large query results efficiently with streaming
Ensuring compile-time validation of SQL statements
Writing maintainable, purely functional database code
Leveraging PostgreSQL-specific features in a Scala context

Not Ideal For

Projects using databases other than PostgreSQL (e.g., MySQL, SQLite)
Teams not already using or familiar with Cats Effect and functional programming patterns
Rapid prototyping where ORM-style abstractions and automatic migrations are preferred over raw SQL

Pros & Cons

Pros

Compile-Time SQL Validation

Skunk validates SQL statements and result types at compile time, preventing runtime errors like type mismatches or missing columns, as highlighted in its type-safe SQL feature.

Functional Programming Integration

Built on Cats Effect and FS2, it ensures referential transparency and resource safety, making it ideal for purely functional Scala codebases that prioritize correctness.

PostgreSQL-Specific Optimizations

Leverages PostgreSQL's binary protocol and advanced data types for efficient communication and native feature support, optimizing performance for Postgres-specific use cases.

Efficient Streaming Support

Uses FS2 streams to handle large result sets without loading all data into memory, enabling scalable data processing for applications with high-volume queries.

Cons

PostgreSQL-Only Lock-In

Skunk is designed exclusively for PostgreSQL, so projects requiring multi-database support or future migration to other systems face significant rework or need additional libraries.

Functional Programming Overhead

Its reliance on Cats Effect and monadic patterns adds complexity for developers unfamiliar with functional Scala, increasing the onboarding time and potential for confusion.

Limited Documentation Depth

The README directs users to an external microsite for details, which can fragment learning resources and make initial setup and troubleshooting more cumbersome.

Frequently Asked Questions

What is skunk?

Target Audience

Value Proposition

Use Cases

Best For

Building type-safe database layers in Scala applications
Integrating PostgreSQL with Cats Effect-based systems
Handling large query results efficiently with streaming
Ensuring compile-time validation of SQL statements
Writing maintainable, purely functional database code
Leveraging PostgreSQL-specific features in a Scala context

Not Ideal For

Projects using databases other than PostgreSQL (e.g., MySQL, SQLite)
Teams not already using or familiar with Cats Effect and functional programming patterns
Rapid prototyping where ORM-style abstractions and automatic migrations are preferred over raw SQL

Pros & Cons

Pros

Compile-Time SQL Validation

Skunk validates SQL statements and result types at compile time, preventing runtime errors like type mismatches or missing columns, as highlighted in its type-safe SQL feature.

Functional Programming Integration

Built on Cats Effect and FS2, it ensures referential transparency and resource safety, making it ideal for purely functional Scala codebases that prioritize correctness.

PostgreSQL-Specific Optimizations

Leverages PostgreSQL's binary protocol and advanced data types for efficient communication and native feature support, optimizing performance for Postgres-specific use cases.

Efficient Streaming Support

Uses FS2 streams to handle large result sets without loading all data into memory, enabling scalable data processing for applications with high-volume queries.

Cons

PostgreSQL-Only Lock-In

Skunk is designed exclusively for PostgreSQL, so projects requiring multi-database support or future migration to other systems face significant rework or need additional libraries.

Functional Programming Overhead

Its reliance on Cats Effect and monadic patterns adds complexity for developers unfamiliar with functional Scala, increasing the onboarding time and potential for confusion.

Limited Documentation Depth

The README directs users to an external microsite for details, which can fragment learning resources and make initial setup and troubleshooting more cumbersome.

Frequently Asked Questions

skunk

What is skunk?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Found a gem we're missing?

skunk

What is skunk?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Found a gem we're missing?