Documentation ¶
Index ¶
- Variables
- type Client
- func (c *Client) Close() error
- func (c *Client) Delete(ctx context.Context, keyHash authdb.KeyHash) error
- func (c *Client) Get(ctx context.Context, keyHash authdb.KeyHash) (record *authdb.Record, err error)
- func (c *Client) GetFullRecord(ctx context.Context, keyHash authdb.KeyHash) (*authdb.FullRecord, error)
- func (c *Client) HealthCheck(ctx context.Context) error
- func (c *Client) Invalidate(ctx context.Context, keyHash authdb.KeyHash, reason string) error
- func (c *Client) Put(ctx context.Context, keyHash authdb.KeyHash, record *authdb.Record) (err error)
- func (c *Client) Run(ctx context.Context) error
- func (c *Client) Unpublish(ctx context.Context, keyHash authdb.KeyHash) error
- type Config
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // Error is a class for badgerauth admin client errors. Error = errs.Class("badgerauth admin client") )
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client allows for performing administrative actions on a badgerauth database.
func (*Client) Get ¶
func (c *Client) Get(ctx context.Context, keyHash authdb.KeyHash) (record *authdb.Record, err error)
Get retrieves the record. It returns (nil, nil) if the key does not exist. If the record is invalid, the error contains why.
func (*Client) GetFullRecord ¶
func (c *Client) GetFullRecord(ctx context.Context, keyHash authdb.KeyHash) (*authdb.FullRecord, error)
GetFullRecord retrieves a record with invalidation information from the first configured node address.
func (*Client) HealthCheck ¶
HealthCheck ensures all configured nodes can be contacted and returns an error otherwise.
func (*Client) Invalidate ¶
Invalidate invalidates a record on all configured node addresses.
func (*Client) Put ¶
func (c *Client) Put(ctx context.Context, keyHash authdb.KeyHash, record *authdb.Record) (err error)
Put stores the record in all configured nodes.
type Config ¶
type Config struct { NodeAddresses []string `user:"true" help:"comma delimited list of node addresses"` CertsDir string `user:"true" help:"directory for certificates for authentication"` // InsecureDisableTLS allows disabling tls for testing. InsecureDisableTLS bool `internal:"true"` }
Config contains configuration options for a badgerauth admin client.
Click to show internal directories.
Click to hide internal directories.