Repository Name and Contact

You should set an unique name for the repository and an administrative email address for contacting the repository owner. Those are shown along some technical information when the Identify verb is requested.

# Default settings
repositoryName: 'OAI-PMH 2.0 Data Provider'
adminEmail: 'admin@example.org'

Database Connection

This has to be a valid data source name (DSN) URI. The scheme is used to specify a driver, the user and password in the URI encode user and password for the connection, followed by the host and port parts. The path after the authority part represents the name of the database (the leading slash is removed so add an extra slash to specify an absolute file path for SQLite). Any optional query parameters are used as additional connection parameters.

Since the scheme determines the database driver it also specifies if the PDO abstraction (mariadb , mssql , mysql , oracle , postgresql , sqlite ) or native drivers (ibm-db2 , mysqli , oci8 , pgsql , sqlite3 , sqlsrv ) should be used to handle the connection. Make sure the corresponding PHP extension is installed.

The placeholder %BASEDIR% may be used to represent the application's base directory.

Additional connection parameters are database-specific. A list of available options can be found in the Doctrine DBAL documentation.

# Default setting
database: 'sqlite3:///%BASEDIR%/data/sqlite3.db'

# More examples
database: 'mssql://user:secret@127.0.0.1/oaipmh'
database: 'mysql://user@localhost/oai?charset=utf8mb4'
database: 'pgsql://oaipmh:password@localhost:5432/oai_data_provider'
database: 'sqlite:////opt/oaipmh/database.db'

Metadata Formats

The default format is oai_dc which is also required by the OAI-PMH specification, but technically you can provide any XML based data formats you want. Just add another entry with the metadata prefix as key and namespace/schema URIs as array values or replace the default entry (although not recommended).

You do not have to provide every record in each metadata format, but if you have the same record in multiple formats it is highly recommended to use the same identifier for all versions of the record.

# Default setting
metadataPrefix: {
  oai_dc: {
    namespace: 'http://www.openarchives.org/OAI/2.0/oai_dc/',
    schema: 'https://www.openarchives.org/OAI/2.0/oai_dc.xsd'
  }
}

Deletion Policy

This states if and how the repository keeps track of deleted records. You can delete records by importing empty records with the same identifier and metadata prefix or by using the command ./bin/cli oai:delete:record . Depending on the deleted records policy those records will be either marked as deleted or completely removed from the database.

Valid options are:

no - The repository does not provide any information about deletions and deleted records are completely removed from the database.

persistent - The repository provides consistent information about deletions and placeholders for deleted records are kept in the database.

transient - The repository may provide information about deletions. This is handled exactly the same as persistent , but you are allowed to manually prune deleted records from the database (see below).

# Default setting
deletedRecords: 'transient'

Harvesting Settings

For larger result sets resumption tokens are provided repeatedly which allow requesting more batches of records until the set is complete. Here you can configure how many records each batch should contain and how long a resumption token should be considered valid.

Valid options for records per batch are any number between 1 and 100 .

The expiration time for resumption tokens can be between 300 and 86400 seconds (i. e. from 5 minutes to 24 hours).

# Default settings
maxRecords: 50
tokenValid: 1800 # 30 minutes