sbtree

Documentation

Overview

Package sbtree provides data structures used by HTML templates to build the web pages for the Syncbase debug viewer. To minimize mixing of code and presentation, all the data for use in the templates is in a form that is convenient for accessing and iterating over, i.e struct fields, no-arg methods, slices, or maps. In some cases this required mirroring data structures in the public Syncbase API to avoid having the templates deal with context objects, or to avoid the templates needing extra variables to handle indirection.

Index

• type CollectionTree
  • func AssembleCollectionTree(ctx *context.T, ...) *CollectionTree
• type SyncbaseTree
  • func AssembleSyncbaseTree(ctx *context.T, server string, service syncbase.Service, dbIds []wire.Id) *SyncbaseTree

Types

type CollectionTree

type CollectionTree struct {
	Service    syncbase.Service
	Database   syncbase.Database
	Collection syncbase.Collection
	RowCount   int
	TotKeySize uint64
	KeysPage   keysPage
}

CollectionTree has all the data for the collection page of the Syncbase debug viewer.

func AssembleCollectionTree

func AssembleCollectionTree(
	ctx *context.T, server, dbBlessing, dbName, collBlessing, collName, firstKey string, keysPerPage int,
) *CollectionTree

AssembleCollectionTree returns information describing the given Syncbase collection, including a "page" of keys starting at the given first key.

type SyncbaseTree

type SyncbaseTree struct {
	Service syncbase.Service
	Dbs     []dbTree
}

SyncbaseTree has all the data for the main page of the Syncbase debug viewer.

func AssembleSyncbaseTree

func AssembleSyncbaseTree(
	ctx *context.T, server string, service syncbase.Service, dbIds []wire.Id,
) *SyncbaseTree

AssembleSyncbaseTree returns information describing the Syncbase server running on the given server. Errors are included in the tree, so they can be displayed in the HTML.