Configuration Reference
=======================

datafaker is configured using a YAML file, which is passed to several commands with the ``--config-file`` option.
Throughout the docs, we will refer to this file as ``config.yaml`` but it can be called anything (the exception being that there will be a naming conflict if you have a vocabulary table called ``config``).

You can generate an example configuration file, based on your source database and filled with only default values (therefore you can safely delete any parts of the generated configuration file you don't need) like this:

.. code-block:: shell

   datafaker generate-config

Below, we see the schema for the configuration file.
Note that our config file format includes a section of SmartNoise SQL metadata, which is explained more fully `here <https://docs.smartnoise.org/sql/metadata.html#yaml-format>`_.

.. raw:: html
   :file: _static/config_schema.html