build

Documentation

Index

• Constants
• Variables
• func IsRelease() bool
• func SeemsOfficial() bool
• func TestingOverrideTag(t string) func()
• func VersionPrefix() string
• type Info
  • func GetInfo() Info
  • func (*Info) Descriptor() ([]byte, []int)
  • func (b Info) GoTime() time.Time
  • func (m *Info) Marshal() (dAtA []byte, err error)
  • func (m *Info) MarshalTo(dAtA []byte) (int, error)
  • func (*Info) ProtoMessage()
  • func (m *Info) Reset()
  • func (b Info) Short() string
  • func (m *Info) Size() (n int)
  • func (m *Info) String() string
  • func (b Info) Timestamp() (int64, error)
  • func (m *Info) Unmarshal(dAtA []byte) error
  • func (m *Info) XXX_DiscardUnknown()
  • func (m *Info) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Info) XXX_Merge(src proto.Message)
  • func (m *Info) XXX_Size() int
  • func (m *Info) XXX_Unmarshal(b []byte) error

Constants

const TimeFormat = "2006/01/02 15:04:05"

TimeFormat is the reference format for build.Time. Make sure it stays in sync with the string passed to the linker in the root Makefile.

Variables

var (
	ErrInvalidLengthInfo = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowInfo   = fmt.Errorf("proto: integer overflow")
)

var (

	// Distribution is changed by the CCL init-time hook in non-APL builds.
	Distribution = "OSS"
)

Functions

func IsRelease

func IsRelease() bool

IsRelease returns true if the binary was produced by a "release" build.

func SeemsOfficial

func SeemsOfficial() bool

SeemsOfficial reports whether this binary is likely to have come from an official release channel.

func TestingOverrideTag

func TestingOverrideTag(t string) func()

TestingOverrideTag allows tests to override the build tag.

func VersionPrefix

func VersionPrefix() string

VersionPrefix returns the version prefix of the current build.

Types

type Info

type Info struct {
	GoVersion       string `protobuf:"bytes,1,opt,name=go_version,json=goVersion" json:"go_version"`
	Tag             string `protobuf:"bytes,2,opt,name=tag" json:"tag"`
	Time            string `protobuf:"bytes,3,opt,name=time" json:"time"`
	Revision        string `protobuf:"bytes,4,opt,name=revision" json:"revision"`
	CgoCompiler     string `protobuf:"bytes,5,opt,name=cgo_compiler,json=cgoCompiler" json:"cgo_compiler"`
	CgoTargetTriple string `protobuf:"bytes,10,opt,name=cgo_target_triple,json=cgoTargetTriple" json:"cgo_target_triple"`
	Platform        string `protobuf:"bytes,6,opt,name=platform" json:"platform"`
	Distribution    string `protobuf:"bytes,7,opt,name=distribution" json:"distribution"`
	Type            string `protobuf:"bytes,8,opt,name=type" json:"type"`
	Channel         string `protobuf:"bytes,9,opt,name=channel" json:"channel"`
	EnvChannel      string `protobuf:"bytes,11,opt,name=env_channel,json=envChannel" json:"env_channel"`
	// dependencies exists to allow tests that run against old clusters
	// to unmarshal JSON containing this field. The tag is unimportant,
	// but the field name must remain unchanged.
	//
	// alternatively, we could set jsonpb.Unmarshaler.AllowUnknownFields
	// to true in httputil.doJSONRequest, but that comes at the expense
	// of run-time type checking, which is nice to have.
	Dependencies *string `protobuf:"bytes,10000,opt,name=dependencies" json:"dependencies,omitempty"`
}

Info describes build information for this CockroachDB binary.

func GetInfo

func GetInfo() Info

GetInfo returns an Info struct populated with the build information.

func (*Info) Descriptor

func (*Info) Descriptor() ([]byte, []int)

func (Info) GoTime

func (b Info) GoTime() time.Time

GoTime parses the utcTime string and returns a time.Time.

func (*Info) Marshal

func (m *Info) Marshal() (dAtA []byte, err error)

func (*Info) MarshalTo

func (m *Info) MarshalTo(dAtA []byte) (int, error)

func (*Info) ProtoMessage

func (*Info) ProtoMessage()

func (*Info) Reset

func (m *Info) Reset()

func (Info) Short

func (b Info) Short() string

Short returns a pretty printed build and version summary.

func (*Info) Size

func (m *Info) Size() (n int)

func (*Info) String

func (m *Info) String() string

func (Info) Timestamp

func (b Info) Timestamp() (int64, error)

Timestamp parses the utcTime string and returns the number of seconds since epoch.

func (*Info) Unmarshal

func (m *Info) Unmarshal(dAtA []byte) error

func (*Info) XXX_DiscardUnknown

func (m *Info) XXX_DiscardUnknown()

func (*Info) XXX_Marshal

func (m *Info) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Info) XXX_Merge

func (m *Info) XXX_Merge(src proto.Message)

func (*Info) XXX_Size

func (m *Info) XXX_Size() int

func (*Info) XXX_Unmarshal

func (m *Info) XXX_Unmarshal(b []byte) error