Default
=======

The OpenAPI :samp:`default` directive is interpreted by OpenAlchemy as a
default value for the column linked to the property.

.. seealso::

    :ref:`default`
      OpenAlchemy documentation for the default value.

    `SQLAlchemy Scalar Default <https://docs.sqlalchemy.org/en/13/core/defaults.html#scalar-defaults>`_
      Documentation for the SQLAlchemy scalar default.

The following example defines a default value for the :samp:`name` property of
:samp:`Employee`:

.. literalinclude:: ../../../examples/default/example-spec.yml
    :language: yaml
    :linenos:

The following file uses OpenAlchemy to generate the SQLAlchemy models:

.. literalinclude:: ../../../examples/default/models.py
    :language: python
    :linenos:

The SQLAlchemy models generated by OpenAlchemy are equivalent to the following
traditional models file:

.. literalinclude:: ../../../examples/default/models_traditional.py
    :language: python
    :linenos:

OpenAlchemy will generate the following typed models:

.. literalinclude:: ../../../examples/default/models_auto.py
    :language: python
    :linenos:

.. seealso::
    :ref:`getting-started`