Inheritance diagram for nix::LocalStoreConfig:

Public Member Functions
const std::string	name () override
std::string	doc () override
Public Member Functions inherited from nix::LocalFSStoreConfig
	StoreConfig ()=delete
Public Member Functions inherited from nix::StoreConfig
virtual std::optional< ExperimentalFeature >	experimentalFeature () const
	Config (StringMap initials={})
Public Member Functions inherited from nix::Config
	Config (StringMap initials={})
bool	set (const std::string &name, const std::string &value, const ApplyConfigOptions &options={}) override
void	addSetting (AbstractSetting *setting)
void	getSettings (std::map< std::string, SettingInfo > &res, bool overriddenOnly=false) override
void	resetOverridden () override
JSON	toJSON () override
void	convertToArgs (Args &args, const std::string &category) override
Public Member Functions inherited from nix::AbstractConfig
void	applyConfig (const std::string &contents, const ApplyConfigOptions &options={})
void	warnUnknownSettings ()
void	reapplyUnknownSettings ()

Public Attributes
Setting< bool >	requireSigs
Setting< bool >	readOnly
Public Attributes inherited from nix::LocalFSStoreConfig
const PathsSetting< std::optional< Path > >	rootDir
const PathsSetting< Path >	stateDir
const PathsSetting< Path >	logDir
const PathsSetting< Path >	realStoreDir
Public Attributes inherited from nix::StoreConfig
const PathsSetting< Path >	storeDir_
const Path	storeDir = storeDir_
const Setting< int >	pathInfoCacheSize
const Setting< bool >	isTrusted
Setting< int >	priority
Setting< bool >	wantMassQuery
Setting< StringSet >	systemFeatures

Additional Inherited Members
Public Types inherited from nix::StoreConfig
typedef std::map< std::string, std::string >	Params
Public Types inherited from nix::Config
using	Settings = std::map<std::string, SettingData>
Static Public Member Functions inherited from nix::StoreConfig
static StringSet	getDefaultSystemFeatures ()
Protected Member Functions inherited from nix::AbstractConfig
	AbstractConfig (StringMap initials={})
Protected Attributes inherited from nix::AbstractConfig
StringMap	unknownSettings

Member Function Documentation

◆ doc()

std::string nix::LocalStoreConfig::doc ( )

overridevirtual

Documentation for this type of store.

Reimplemented from nix::StoreConfig.

◆ name()

const std::string nix::LocalStoreConfig::name ( )

inlineoverridevirtual

The name of this type of store.

Implements nix::StoreConfig.

Member Data Documentation

◆ readOnly

Setting<bool> nix::LocalStoreConfig::readOnly

Initial value:

{this,
        false,
        "read-only",
        R"(
          Allow this store to be opened when its [database](@docroot@/glossary.md#gloss-nix-database) is on a read-only filesystem.
 
          Normally Lix will attempt to open the store database in read-write mode, even for querying (when write access is not needed), causing it to fail if the database is on a read-only filesystem.
 
          Enable read-only mode to disable locking and open the SQLite database with the [`immutable` parameter](https://www.sqlite.org/c3ref/open.html) set.
 
          > **Warning**
          > Do not use this unless the filesystem is read-only.
          >
          > Using it when the filesystem is writable can cause incorrect query results or corruption errors if the database is changed by another process.
          > While the filesystem the database resides on might appear to be read-only, consider whether another user or system might have write access to it.
        )"}

◆ requireSigs

Setting<bool> nix::LocalStoreConfig::requireSigs

Initial value:

{this,
        settings.requireSigs,
        "require-sigs",
        "Whether store paths copied into this store should have a trusted signature."}

The documentation for this struct was generated from the following files:

lix/libstore/local-store.hh
lix/libstore/local-store.cc

Public Member Functions