client

package
v0.31.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 4, 2021 License: BSD-3-Clause Imports: 17 Imported by: 1

Documentation

Index

Constants

View Source
const (
	// DefaultPort zqd port to connect with.
	DefaultPort      = 9867
	DefaultUserAgent = "zqd-client-golang"
)

Variables

View Source
var (
	// ErrPoolNotFound is returned when the specified pool does not exist.
	ErrPoolNotFound = errors.New("pool not found")
	// ErrPoolExists is returned when the specified the pool already exists.
	ErrPoolExists = errors.New("pool exists")
	// ErrBranchNotFound is returned when the specified branch does not exist.
	ErrBranchNotFound = errors.New("branch not found")
	// ErrBranchExists is returned when the specified the branch already exists.
	ErrBranchExists = errors.New("branch exists")
)

Functions

This section is empty.

Types

type Connection

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

func NewConnection

func NewConnection() *Connection

NewConnection creates a new connection with the given useragent string and a base URL set up to talk to http://localhost:defaultport

func NewConnectionTo

func NewConnectionTo(hostURL string) *Connection

NewConnectionTo creates a new connection with the given useragent string and a base URL derived from the hostURL argument.

func (*Connection) AuthIdentity

func (c *Connection) AuthIdentity(ctx context.Context) (*Response, error)

func (*Connection) AuthMethod

func (c *Connection) AuthMethod(ctx context.Context) (*Response, error)

func (*Connection) BranchGet

func (c *Connection) BranchGet(ctx context.Context, poolID ksuid.KSUID, branchName string) (*Response, error)

func (*Connection) BranchPost

func (c *Connection) BranchPost(ctx context.Context, poolID ksuid.KSUID, payload api.BranchPostRequest) (*Response, error)

func (*Connection) ClientHostURL

func (c *Connection) ClientHostURL() string

ClientHostURL allows us to print the host in log messages and internal error messages

func (*Connection) Delete

func (c *Connection) Delete(ctx context.Context, poolID ksuid.KSUID, branchName string, ids []ksuid.KSUID, message api.CommitMessage) (*Response, error)

func (*Connection) Do

func (c *Connection) Do(ctx context.Context, method, url string, body interface{}) (*resty.Response, error)

func (*Connection) IndexPost

func (c *Connection) IndexPost(ctx context.Context, id ksuid.KSUID, post api.IndexPostRequest) error

func (*Connection) Load

func (c *Connection) Load(ctx context.Context, poolID ksuid.KSUID, branchName string, r io.Reader, message api.CommitMessage) (*Response, error)

func (*Connection) MergeBranch

func (c *Connection) MergeBranch(ctx context.Context, poolID ksuid.KSUID, childBranch, parentBranch string, message api.CommitMessage) (*Response, error)

func (*Connection) Ping

func (c *Connection) Ping(ctx context.Context) (time.Duration, error)

Ping checks to see if the server and measure the time it takes to get back the response.

func (*Connection) PoolPost

func (c *Connection) PoolPost(ctx context.Context, payload api.PoolPostRequest) (*Response, error)

func (*Connection) PoolPut

func (c *Connection) PoolPut(ctx context.Context, id ksuid.KSUID, req api.PoolPutRequest) error

func (*Connection) PoolRemove

func (c *Connection) PoolRemove(ctx context.Context, id ksuid.KSUID) error

func (*Connection) PoolStats

func (c *Connection) PoolStats(ctx context.Context, id ksuid.KSUID) (*Response, error)

func (*Connection) Query

func (c *Connection) Query(ctx context.Context, head *lakeparse.Commitish, src string, filenames ...string) (*Response, error)

func (*Connection) Request

func (c *Connection) Request(ctx context.Context) *resty.Request

func (*Connection) Revert

func (c *Connection) Revert(ctx context.Context, poolID ksuid.KSUID, branchName string, commitID ksuid.KSUID, message api.CommitMessage) (*Response, error)

func (*Connection) SetAuthToken

func (c *Connection) SetAuthToken(token string)

func (*Connection) SetTimeout

func (c *Connection) SetTimeout(to time.Duration)

SetTimeout sets the underlying http request timeout to the given duration

func (*Connection) SetURL

func (c *Connection) SetURL(u string)

func (*Connection) SetUserAgent

func (c *Connection) SetUserAgent(useragent string)

func (*Connection) URL

func (c *Connection) URL() string

func (*Connection) Version

func (c *Connection) Version(ctx context.Context) (string, error)

Version retrieves the version string from the service.

type ErrorResponse

type ErrorResponse struct {
	*resty.Response
	Err error
}

func (*ErrorResponse) Error

func (e *ErrorResponse) Error() string

func (*ErrorResponse) Unwrap

func (e *ErrorResponse) Unwrap() error

type Response

type Response struct {
	Body        io.ReadCloser
	ContentType string
	StatusCode  int
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL