Documentation
¶
Overview ¶
Package regclient defines a client for interacting with a registry server
Index ¶
- Variables
- type Client
- func (c Client) DeleteDataset(peername, dsname string, ds *dataset.Dataset, pubKey crypto.PubKey) error
- func (c Client) DeleteProfile(handle string, privKey crypto.PrivKey) error
- func (c *Client) DsyncFetch(ctx context.Context, path string, ng ipld.NodeGetter, bapi coreiface.BlockAPI) error
- func (c *Client) DsyncSend(ctx context.Context, ng ipld.NodeGetter, mfst *dag.Manifest) error
- func (c Client) GetDataset(peername, dsname, profileID, hash string) (*registry.Dataset, error)
- func (c Client) GetProfile(p *registry.Profile) error
- func (c Client) GetReputation(id string) (*registry.ReputationResponse, error)
- func (c Client) ListDatasets(limit, offset int) ([]*registry.Dataset, error)
- func (c Client) Pin(path string, privKey crypto.PrivKey, addrs []string) error
- func (c Client) PutDataset(peername, dsname string, ds *dataset.Dataset, pubKey crypto.PubKey) error
- func (c Client) PutProfile(handle string, privKey crypto.PrivKey) error
- func (c Client) Search(p *SearchParams) ([]*registry.Result, error)
- func (c Client) Status(path string) (s pinset.PinStatus, err error)
- func (c Client) Unpin(path string, privKey crypto.PrivKey) error
- type Config
- type SearchFilter
- type SearchParams
Constants ¶
This section is empty.
Variables ¶
var ( // ErrNoRegistry indicates that no registry has been specified // all client methods MUST return ErrNoRegistry for all method calls // when config.Registry.Location is an empty string ErrNoRegistry = errors.New("registry: no registry specified") // ErrNoConnection indicates no path to the registry can be found ErrNoConnection = errors.New("registry: no connection") // ErrNotRegistered indicates this client is not registered ErrNotRegistered = errors.New("registry: not registered") // HTTPClient is hoisted here in case you'd like to use a different client instance // by default we just use http.DefaultClient HTTPClient = http.DefaultClient )
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client wraps a registry configuration with methods for interacting with the configured registry
func (Client) DeleteDataset ¶
func (c Client) DeleteDataset(peername, dsname string, ds *dataset.Dataset, pubKey crypto.PubKey) error
DeleteDataset removes a dataset from the registry
func (Client) DeleteProfile ¶
DeleteProfile removes a profile from the registry
func (*Client) DsyncFetch ¶
func (c *Client) DsyncFetch(ctx context.Context, path string, ng ipld.NodeGetter, bapi coreiface.BlockAPI) error
DsyncFetch fetches an entire DAG designated by root path
func (Client) GetDataset ¶
GetDataset fetches a dataset from a registry
func (Client) GetProfile ¶
GetProfile fills in missing fields in p with registry data
func (Client) GetReputation ¶
func (c Client) GetReputation(id string) (*registry.ReputationResponse, error)
GetReputation gets the reputation of a profile using the ProfileID
func (Client) ListDatasets ¶
ListDatasets returns a list of the datasets in the registry, using limit and offset
func (Client) PutDataset ¶
func (c Client) PutDataset(peername, dsname string, ds *dataset.Dataset, pubKey crypto.PubKey) error
PutDataset adds a dataset to a registry
func (Client) PutProfile ¶
PutProfile adds a profile to the registry
func (Client) Search ¶
func (c Client) Search(p *SearchParams) ([]*registry.Result, error)
Search makes a registry search request
type Config ¶
type Config struct {
// Location is the URL base to call to
Location string
}
Config encapsulates options for working with a registry
type SearchFilter ¶
type SearchFilter struct {
// Type denotes the ype of search filter
Type string
// Relation indicates the relation between the key and value
// supported options include ["eq"|"neq"|"gt"|"gte"|"lt"|"lte"]
Relation string
// Key corresponds to the name of the index mapping that we wish to
// apply the filter to
Key string
// Value is the predicate of the subject-relation-predicate triple
// eg. [key=timestamp] [gte] [value=[today]]
Value interface{}
}
SearchFilter stores various types of filters that may be applied to a search
type SearchParams ¶
type SearchParams struct {
QueryString string
Filters []SearchFilter
Limit int
Offset int
}
SearchParams contains the parameters that are passed to a Client.Search method
Source Files