==================
Creating Adapters
==================

This guide outlines the minimum structure for a SQLSpec adapter and links to the
example adapter skeleton.

Example
=======

.. literalinclude:: /examples/contributing/new_adapter.py
   :language: python
   :caption: ``adapter skeleton``
   :start-after: # start-example
   :end-before: # end-example
   :dedent: 4
   :no-upgrade:

Adapter Checklist
=================

- ``config.py`` with a typed config class.
- ``driver.py`` implementing sync or async driver APIs.
- Optional ``type_converter.py`` and ``_types.py`` for DB-specific types.
- ``__init__.py`` exports the public surface.

See Also
========

- :doc:`/reference/driver` for required driver methods.
- :doc:`/reference/adapters` for config naming conventions.