Class ServerConfig

optimade/server/config.py:168–599

This class stores server config parameters in a way that can be easily extended for new config file types.

class ServerConfig(BaseSettings):
    """This class stores server config parameters in a way that
    can be easily extended for new config file types.
    """

    model_config = SettingsConfigDict(
        env_prefix="optimade_",
        extra="allow",
        env_file_encoding="utf-8",
        case_sensitive=False,
        validate_assignment=True,
    )

    debug: Annotated[
        bool,
        Field(
            description="Turns on Debug Mode for the OPTIMADE Server implementation",
        ),
    ] = False

    insert_test_data: Annotated[
        bool,
        Field(
            description=(
                "Insert test data into each collection on server initialisation. If true, "
                "the configured backend will be populated with test data on server start. "
                "Should be disabled for production usage."
            ),
        ),
    ] = True

    insert_from_jsonl: Annotated[
        Path | None,
        Field(
            description=(
                "The absolute path to an OPTIMADE JSONL file to use to initialize the database. "
                "A unique index will be created over the ID to avoid duplication over multiple runs."
            )
        ),
    ] = None

    exit_after_insert: Annotated[
        bool, Field(description="Exit the API after inserting data")
    ] = False

    create_default_index: Annotated[
        bool,
        Field(
            description=(
                "Whether to create a set of default indices "
                "for supporting databases after inserting JSONL data."
            )
        ),
    ] = False

    gzip: Annotated[
        GZipConfig,
        Field(description="Configuration options for GZip compression."),