version

Documentation

Overview

Package version provides information about FerretDB version and build configuration.

Extra 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 builds of FerretDB:

ferretdb_dev - enables development build (see below; implied by builds with race detector)

Development builds

Development builds of FerretDB behave differently in a few aspects:

• they are significantly slower;
• some values that are normally randomized are fixed or less randomized to make debugging easier;
• 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

• Constants
• Variables
• type Info
  • func Get() *Info

Constants

const (
	// DocumentDB is a version of DocumentDB this version of FerretDB is compatible with.
	DocumentDB = "0.107.0 gitref: HEAD sha:e63835403d buildId:0"

	// DocumentDBURL points to the release page of the DocumentDB version above.
	DocumentDBURL = "https://github.com/FerretDB/documentdb/releases/tag/v0.107.0-ferretdb-2.7.0"
)

Variables

var DocumentDBSafeToUpdate = []string{
	"0.102.0 gitref: HEAD sha:80462f5 buildId:0",
	"0.103.0 gitref: HEAD sha:7514232 buildId:0",
	"0.104.0 gitref: HEAD sha:2045d0e buildId:0",
	"0.105.0 gitref: HEAD sha:8453d93b buildId:0",
	"0.106.0 gitref: HEAD sha:beb9d25d98 buildId:0",
}

DocumentDBSafeToUpdate represents versions of DocumentDB that FerretDB can update.

var PostgreSQLTest string

PostgreSQLTest is a version of PostgreSQL used by tests.

Types

type Info

type Info struct {
	Version          string
	Commit           string
	Branch           string
	Dirty            bool
	Package          string
	DevBuild         bool
	BuildEnvironment map[string]string

	// 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 [4]int32
}

Info provides details about the current build.

func Get

func Get() *Info

Get returns current build's info.

It returns a shared instance without any synchronization. If caller needs to modify the instance, it should make sure there is no concurrent accesses.