Configuration file

This extension requires a configuration file in YAML format. By default the extension is looking for a seeder.yaml file in your projects root directory. This path can be overwritten when running the CLI command.

<project-root>/seeder.yaml

data:
  loader: yaml
  options:
    type: 'folder'
    path: 'data/database/'

fal:
  storages:
    - identifier: default
      storagePath: fileadmin/

ordering:
  fe_users:
    after: [ "fe_groups" ]
  tt_content:
    after: [ "sys_category" ]

operations:
  envFileGenerator:
    envFiles:
      pids:
        path: pids.env
        values:
          PID_404: "{pages:404:uid}"

Name	Type	Required
data	DataLoader	true
fal	object	true
fal.storages	array	true
ordering	array	true
operations	object	true

data

Type: DataLoader
Required: true

Configuration for how the static data should be loaded. See DataLoader options

fal

Type: object
Required: true

FAL configuration. By now only the key storages is supported.

fal.storages

Type: array
Required: true

Configuration for FAL resource storages that should be created. See FAL storage options for more details.

Note

The first storage configured is marked as default storage.

ordering

Type: array
Required: true

An array of database tables for setting the ordering of record processing. Any table can be used as a key and might have two properties: before and after. Both keys are arrays themself and contain database table names.

fe_users:
  after: [ "fe_groups" ]
tt_content:
  after: [ "sys_category" ]

Note

The tables pages and sys_file are by default configured to the processed before the tt_content table.

operations

Type: object
Required: true

There can be additional operations before and after the seeding. See operations page.

DataLoader options

Name	Type	Required
loader	string	true
options	array	true
options.type	string	true
options.path	string	true

loader

Type: string
Required: true

Name of the registered data loader. Available loaders provided by this extension: yaml. Additional loaders can be registered using dependency injection.

options

Type: array
Required: true

An array of options given to the data loader.

type: 'folder'
path: 'data/database/'

options.type

Type: string
Required: true

Either folder or file.

Using folder value, the loader will iterate through all subdirectories and load *.yaml files.

Using file value, the riles needs to provide all data for seeding (imports can be used).

Note

Only for yaml data loader.

options.path

Type: string
Required: true

Relative path to the yaml file or folder, based on the type configuration.

Note

Only for yaml data loader.

FAL storage options

Name	Type	Required
identifier	string	true
storagePath	string	true
baseUri	string

identifier

Type: string
Required: true

Unique identifier for this storage. Is used to assign files to this storage.

storagePath

Type: string
Required: true

Relative or absolute path for the storage. Is used as basePath in storage configuration. When starting with a /, that path is considered to be absolute.

baseUri

Type: string

Set the bashUri configuration for this storage.