Slick

Reactive Functional Relational Mapping for Scala

API Documentation (scaladoc)

• Slick Core (slick)
• TestKit (slick-testkit)
• Code Generator (slick-codegen)
• Direct Embedding (slick-direct) (Deprecated)
• Slick Extensions (slick-extensions)

User Manual

• Introduction
  • What is Slick?
  • Functional Relational Mapping
  • Reactive Applications
  • Plain SQL Support
  • License
  • Next Steps
• Supported Databases
• Getting Started
  • Adding Slick to Your Project
  • Quick Introduction
    • Database Configuration
    • Schema
    • Populating the Database
    • Querying
• Database Configuration
  • Using Typesafe Config
  • Using a JDBC URL
  • Using a DataSource
  • Using a JNDI Name
  • Database thread pool
  • Connection pools
  • DatabaseConfig
• Database I/O Actions
  • Executing Database I/O Actions
    • Materialized
    • Streaming
    • Transactions and Pinned Sessions
  • JDBC Interoperability
• Schemas
  • Table Rows
  • Table Query
  • Mapped Tables
  • Constraints
  • Data Definition Language
• Queries
  • Expressions
  • Sorting and Filtering
  • Joining and Zipping
    • Applicative joins
    • Monadic joins
    • Zip joins
  • Unions
  • Aggregation
  • Querying
  • Deleting
  • Inserting
  • Updating
  • Compiled Queries
• Schema Code Generation
  • Overview
  • Standalone use
  • Integrated into sbt
  • Generated Code
  • Customization
• User-Defined Features
  • Scalar Database Functions
  • Other Database Functions And Stored Procedures
  • Using Custom Scalar Types in Queries
  • Using Custom Record Types in Queries
    • Polymorphic Types (e.g. Custom Tuple Types or HLists)
    • Monomorphic Case Classes
    • Combining Mapped Types
• Plain SQL Queries
  • Scaffolding
  • String Interpolation
  • Result Sets
  • Splicing Literal Values
  • Type-Checked SQL Statements
• Coming from ORM to Slick
  • Introduction
  • Configuration
  • Mapping configuration.
  • Navigating the object graph
    • Using plain old method calls
    • Query languages
  • Query granularity
  • Read caching
  • Writes (and caching)
  • Relationships
    • Modifying relationships
  • Inheritance
  • Code-generation
• Coming from SQL to Slick
  • Schema
  • Queries in comparison
    • JDBC Query
    • Slick Plain SQL queries
    • Slick type-safe, composable queries
  • Main obstacle: Semantic API differences
  • Scala-to-SQL compilation during runtime
  • Limitations
    • Missing query operators
    • Non-optimal SQL code
  • SQL vs. Slick examples
    • SELECT *
    • SELECT
    • WHERE
    • ORDER BY
    • Aggregations (max, etc.)
    • GROUP BY
    • HAVING
    • Implicit inner joins
    • Explicit inner joins
    • Outer joins (left/right/full)
    • Subquery
    • Scalar value subquery / custom function
    • insert
    • update
    • delete
    • CASE
• Upgrade Guides
  • Compatibility Policy
  • Upgrade from 2.1 to 3.0
    • Package Structure
    • Database I/O Actions
    • Join Operators
    • first
    • Column Type
    • Closing Databases
    • Metadata API and Code Generator
    • Inserting from Queries and Expressions
    • Default String Types
    • JdbcDriver
  • Upgrade from 2.0 to 2.1
    • Query type parameters
    • .list and .first
    • .where
    • .isNull and .isNotNull
    • Static Plain SQL Queries
    • Slick code generator / Slick model
  • Upgrade from 1.0 to 2.0
    • Code Generation
    • Table Descriptions
    • Mapped Tables
    • Profile Hierarchy
    • Inserting
    • Pre-compiled Updates
    • Database and Session Handling
    • Dynamically and Statically Scoped Sessions
    • Mapped Column Types
• Slick Extensions

Appendix

• Direct Embedding (Deprecated)
  • Dependencies
  • Imports
  • Row class and schema
  • Query
  • Execution
  • Alternative direct embedding bound to a driver and session
  • Features
• Slick TestKit
  • Scaffolding
  • Driver
  • Test Harness
  • Database Configuration
  • Testing