LanguageColours.ETSDatabase (LanguageColours v1.1.0) View Source

Database that stores the language colours in an ETS table. Get operations will directly read from the database, update operations will be serialized through the database process.

Please see the main module documentation for the available configuration options and how to set up the database.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Get an LanguageColours.ETSDatabase.Options.t/0 struct corresponding to the given database configuration.

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Specs

Link to this function

startup_options(db_config)

View Source

Specs

startup_options(map()) :: LanguageColours.ETSDatabase.Options.t()

Get an LanguageColours.ETSDatabase.Options.t/0 struct corresponding to the given database configuration.

This is a helper for forming the options struct for starting the database in a supervisor.

NOTE: When using this function, the :file option is required.