tools

Documentation

Index

• Constants
• Variables
• func GetAuth(cmd *cobra.Command, envFlagApiKey, envFlagJwt string) (authToken string, authType client.AuthType)
• func ReadAPIKey(cmd *cobra.Command, envFlagName string) string
• func ReadAPIToken(cmd *cobra.Command, envFlagName string) string
• func StoreStatsE(cmd *cobra.Command, args []string) error
• type FileInfo
• type KeyStats
• type StoreStats
• type ValueStats

Constants

const MAX_LIST_DISPLAY_COUNT = 6

Variables

var Cmd = &cobra.Command{Use: "tools", Short: "Developer tools related to substreams"}

var ErrEmptyStore = errors.New("store is empty")

var Example = func(in string) string {
	return string(cli.Example(in))
}

var ExamplePrefixed = func(prefix, in string) string {
	return string(cli.ExamplePrefixed(prefix, in))
}

Functions

func GetAuth

func GetAuth(cmd *cobra.Command, envFlagApiKey, envFlagJwt string) (authToken string, authType client.AuthType)

func ReadAPIKey

func ReadAPIKey(cmd *cobra.Command, envFlagName string) string

func ReadAPIToken

func ReadAPIToken(cmd *cobra.Command, envFlagName string) string

func StoreStatsE

func StoreStatsE(cmd *cobra.Command, args []string) error

Types

type FileInfo

type FileInfo struct {
	FileName       string       `json:"name"`
	FileSize       int64        `json:"size_bytes"`
	FileSizeGrowth float64      `json:"size_growth"`
	FileBlockRange *block.Range `json:"block_range"`
}

type KeyStats

type KeyStats struct {
	TotalSize   uint64  `json:"total_size_bytes"`
	LargestSize uint64  `json:"largest_size_bytes"`
	AverageSize float64 `json:"average_size_bytes"`
	StdDevSize  float64 `json:"std_dev_size_bytes"`

	Largest string `json:"largest"`
}

type StoreStats

type StoreStats struct {
	Name         string `json:"module_name"`
	ModuleHash   string `json:"module_hash"`
	InitialBlock uint64 `json:"module_initial_block"`
	ValueType    string `json:"module_value_type"`
	UpdatePolicy string `json:"module_update_policy"`

	KeysCount uint64 `json:"count"`

	FileInfo   *FileInfo   `json:"file_info,omitempty"`
	KeyStats   *KeyStats   `json:"keys,inline,omitempty"`
	ValueStats *ValueStats `json:"values,inline,omitempty"`
}

type ValueStats

type ValueStats struct {
	TotalSize   uint64  `json:"total_size_bytes"`
	LargestSize uint64  `json:"largest_size_bytes"`
	AverageSize float64 `json:"average_size_bytes"`
	StdDevSize  float64 `json:"std_dev_size_bytes"`

	Largest string `json:"largest_value_key"`
}