immuc

Documentation

Index

• func Init(opts *Options) (*immuc, error)
• func PadRight(str, pad string, length int) string
• func PrintHealth(res *schema.DatabaseHealthResponse) string
• func PrintKV(entry *schema.Entry, verified, valueOnly bool) string
• func PrintServerInfo(resp *schema.ServerInfoResponse) string
• func PrintSetItem(set []byte, referencedkey []byte, score float64, txhdr *schema.TxHeader, ...) string
• func PrintState(root *schema.ImmutableState) string
• func PrintTx(tx *schema.Tx, verified bool) string
• type Client
• type Options
  • func OptionsFromEnv() *Options
  • func (o *Options) GetImmudbClientOptions() *client.Options
  • func (o *Options) GetRevisionSeparator() string
  • func (o *Options) GetValueOnly() bool
  • func (o *Options) WithImmudbClientOptions(opts *client.Options) *Options
  • func (o *Options) WithRevisionSeparator(revisionSeparator string) *Options
  • func (o *Options) WithValueOnly(valueOnly bool) *Options

Functions

func Init

func Init(opts *Options) (*immuc, error)

Init ...

func PadRight

func PadRight(str, pad string, length int) string

PadRight ...

func PrintHealth

func PrintHealth(res *schema.DatabaseHealthResponse) string

func PrintKV

func PrintKV(
	entry *schema.Entry,
	verified, valueOnly bool,
) string

PrintKV ...

func PrintServerInfo

func PrintServerInfo(resp *schema.ServerInfoResponse) string

func PrintSetItem

func PrintSetItem(set []byte, referencedkey []byte, score float64, txhdr *schema.TxHeader, verified bool) string

PrintSetItem ...

func PrintState

func PrintState(root *schema.ImmutableState) string

PrintState ...

func PrintTx

func PrintTx(tx *schema.Tx, verified bool) string

PrintTx ...

Types

type Client

type Client interface {
	Connect(args []string) error
	Disconnect(args []string) error
	Execute(f func(immuClient client.ImmuClient) (interface{}, error)) (interface{}, error)
	ServerInfo(args []string) (string, error)
	HealthCheck(args []string) (string, error)
	DatabaseHealth(args []string) (string, error)
	CurrentState(args []string) (string, error)
	GetTxByID(args []string) (string, error)
	VerifiedGetTxByID(args []string) (string, error)
	Get(args []string) (string, error)
	VerifiedGet(args []string) (string, error)
	Login(args []string) (string, error)
	Logout(args []string) (string, error)
	History(args []string) (string, error)
	SetReference(args []string) (string, error)
	VerifiedSetReference(args []string) (string, error)
	ZScan(args []string) (string, error)
	Scan(args []string) (string, error)
	Count(args []string) (string, error)
	Set(args []string) (string, error)
	Restore(args []string) (string, error)
	VerifiedSet(args []string) (string, error)
	DeleteKey(args []string) (string, error)
	ZAdd(args []string) (string, error)
	VerifiedZAdd(args []string) (string, error)
	CreateDatabase(args []string) (string, error)
	DatabaseList(args []string) (string, error)
	UseDatabase(args []string) (string, error)
	UserCreate(args []string) (string, error)
	SetActiveUser(args []string, active bool) (string, error)
	SetUserPermission(args []string) (string, error)
	UserList(args []string) (string, error)
	ChangeUserPassword(args []string) (string, error)
	ValueOnly() bool     // TODO: ?
	SetValueOnly(v bool) // TODO: ?
	SQLExec(args []string) (string, error)
	SQLQuery(args []string) (string, error)
	ListTables() (string, error)
	DescribeTable(args []string) (string, error)

	WithFileTokenService(tkns tokenservice.TokenService) Client
}

Client ...

type Options

type Options struct {
	// contains filtered or unexported fields
}

func OptionsFromEnv

func OptionsFromEnv() *Options

func (*Options) GetImmudbClientOptions

func (o *Options) GetImmudbClientOptions() *client.Options

func (*Options) GetRevisionSeparator

func (o *Options) GetRevisionSeparator() string

func (*Options) GetValueOnly

func (o *Options) GetValueOnly() bool

func (*Options) WithImmudbClientOptions

func (o *Options) WithImmudbClientOptions(opts *client.Options) *Options

func (*Options) WithRevisionSeparator

func (o *Options) WithRevisionSeparator(revisionSeparator string) *Options

func (*Options) WithValueOnly

func (o *Options) WithValueOnly(valueOnly bool) *Options