config

package

v0.2.0 Latest Latest Go to latest Published: May 13, 2024 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/gnames/bhlnames

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func RootDir ¶ added in v0.2.0

func RootDir() string

RootDir returns the default root directory for BHLnames data.

Types ¶

type Config ¶

type Config struct {

	// BHLDumpURL specifies the source for Biodiversity Heritage Library dump
	// files.
	BHLDumpURL string

	// BHLNamesURL specifies the source for BHLindex data (name occurrences and
	// verifications).
	BHLNamesURL string

	// CoLDataURL specifies the source for Catalogue of Life data in Darwin Core
	// Archive format.
	CoLDataURL string

	// DbDatabase is the name of the PostgreSQL database for BHLnames data.
	DbDatabase string

	// DbHost is the hostname or IP address of the PostgreSQL server.
	DbHost string

	// DbUser is the PostgreSQL username with write permissions to the database.
	DbUser string

	// DbPass is the password for `DBUser`.
	DbPass string

	// JobsNum controls the concurrency level for finding references
	// containing specified names.
	JobsNum int

	// PortREST specifies the port number for the BHLnames RESTful service.
	PortREST int

	// RootDir is the base directory for all BHLnames downloaded and extracted
	// files.
	RootDir string

	// DownloadBHLFile is the full path where the downloaded BHL dump
	// (compressed) is stored.
	DownloadBHLFile string

	// DownloadCoLFile is the full path where the downloaded CoL DwCA file is
	// stored.
	DownloadCoLFile string

	// ExtractDir is the directory where BHLnames extracts the contents of the
	// compressed files.
	ExtractDir string

	// DownloadNamesFile is the full path where the downloaded BHLindex Data file
	// is stored.
	DownloadNamesFile string

	// WithCoLDataTrim indicates whether the CoL nomenclatural tables should be
	// cleared and repopulated with fresh CoL data or import will continue from
	// where it was paused.
	WithCoLDataTrim bool

	// WithRebuild determines if BHL or CoL data needs to be re-downloaded and
	// processed. If true, deletes any locally cached data.
	WithRebuild bool
}