Scroll to navigation

Catmandu::Config(3pm) User Contributed Perl Documentation Catmandu::Config(3pm)

NAME

Catmandu::Config - Configuration settings of Catmandu

CONFIG

Catmandu configuration options can be stored in files in the root directory of your programming project. The file can be YAML, JSON or Perl and is called "catmandu.yml", "catmandu.json" or "catmandu.pl". In this file you can set the default Catmandu stores and exporters to be used. Here is an example of a "catmandu.yml" file:

    store:
      default:
        package: ElasticSearch
        options:
          index_name: myrepository
    exporter:
      default:
        package: YAML

Split config

For large configs it's more convenient to split the config into several files. You can do so by having multiple config files starting with catmandu*.

    catmandu.general.yml
    catmandu.db.yml
    ...

Split config files are processed and merged by Config::Onion.

Deeply nested config structures

Config files can indicate a path under which their keys will be nested. This makes your configuration more readable by keeping indentation to a minimum.

A config file containing

    _prefix:
        foo:
            bar:
    baz: 1

will be loaded as

    foo:
      bar:
        baz: 1

See Config::Onion for more information on how this works.

2023-03-03 perl v5.36.0