version

Documentation

Overview

Package version provides information about FerretDB version and build configuration.

Required files

The following generated text files may be present in this (build/version) directory during building:

• version.txt (required) contains information about the FerretDB version in a format similar to `git describe` output: `v<major>.<minor>.<patch>`.
• commit.txt (optional) contains information about the source git commit.
• branch.txt (optional) contains information about the source git branch.
• package.txt (optional) contains package type (e.g. "deb", "rpm", "docker", etc).

Go build tags

The following Go build tags (also known as build constraints) affect all builds of FerretDB, including embedded usage:

ferretdb_debug     - enables debug build (see below; implied by ferretdb_testcover tag and builds with race detector)
ferretdb_testcover - enables test coverage instrumentation
ferretdb_tigris    - enables Tigris backend handler
ferretdb_hana      - enables Hana backend handler

Debug builds

Debug builds of FerretDB behave differently in a few aspects:

• Some internal errors cause crashes instead of being handled more gracefully.
• Stack traces are collected more liberally.
• Metrics are written to stderr on exit.
• The default logging level is set to debug.

Index

• type Info
  • func Get() *Info

Types

type Info

type Info struct {
	Version          string
	Commit           string
	Branch           string
	Dirty            bool
	Package          string // TODO https://github.com/FerretDB/FerretDB/issues/1805
	DebugBuild       bool
	BuildEnvironment *types.Document

	// MongoDBVersion is fake MongoDB version for clients that check major.minor to adjust their behavior.
	MongoDBVersion string

	// MongoDBVersionArray is MongoDBVersion, but as an array.
	MongoDBVersionArray *types.Array
}

Info provides details about the current build.

func Get

func Get() *Info

Get returns current build's info.