.. title:: SQLSpec

.. meta::
   :description: A type-safe SQL query mapper designed for minimal abstraction between Python and SQL
   :keywords: SQL, Python, database, query mapper, type-safe

.. container:: title-with-logo

    .. raw:: html

        <h1 class="brand-text" aria-label="SQLSpec - Type-safe SQL query mapper">SQLSpec</h1>

**A type-safe SQL query mapper designed for minimal abstraction between Python and SQL.**

SQLSpec is **NOT an ORM**. It is a flexible connectivity layer that provides a consistent, modern interface for executing SQL queries across multiple database systems. It empowers you to write raw, efficient SQL while benefiting from type safety, automatic parameter handling, and a powerful, optional query builder.

.. grid:: 1 1 2 2
    :padding: 0
    :gutter: 2

    .. grid-item-card:: :octicon:`rocket` Get Started
      :link: getting_started/index
      :link-type: doc

      Install SQLSpec and run your first query in 5 minutes.

    .. grid-item-card:: :octicon:`book` Usage Guides
      :link: usage/index
      :link-type: doc

      In-depth guides on configuration, drivers, the query builder, and more.

    .. grid-item-card:: :octicon:`package` API Reference
      :link: reference/index
      :link-type: doc

      The complete, auto-generated API documentation for the ``sqlspec`` library.

    .. grid-item-card:: :octicon:`play` Playground
      :link: playground
      :link-type: doc

      Run SQLSpec in your browser with an interactive SQL playground.

.. toctree::
    :hidden:
    :titlesonly:
    :caption: Documentation

    getting_started/index
    usage/index
    reference/index
    playground

.. toctree::
    :hidden:
    :titlesonly:
    :caption: Developers

    contributing/index
    Code of Conduct <https://github.com/litestar-org/.github?tab=coc-ov-file#readme>
    Security <https://github.com/litestar-org/.github?tab=coc-ov-file#security-ov-file>