admin

Documentation

Overview

Package admin provides the client for the admin service.

Index

• type AuthInterceptor
  • func NewAuthInterceptor(token string) *AuthInterceptor
  • func (i *AuthInterceptor) SetToken(token string)
  • func (i *AuthInterceptor) WrapStreamingClient(next connect.StreamingClientFunc) connect.StreamingClientFunc
  • func (i *AuthInterceptor) WrapStreamingHandler(next connect.StreamingHandlerFunc) connect.StreamingHandlerFunc
  • func (i *AuthInterceptor) WrapUnary(next connect.UnaryFunc) connect.UnaryFunc
• type Client
  • func Dial(rpcAddr string, opts ...Option) (*Client, error)
  • func New(opts ...Option) (*Client, error)
  • func (c *Client) ChangePassword(ctx context.Context, username, password, newPassword string) error
  • func (c *Client) Close()
  • func (c *Client) CreateProject(ctx context.Context, name string) (*types.Project, error)
  • func (c *Client) DeleteAccount(ctx context.Context, username, password string) error
  • func (c *Client) Dial(rpcAddr string) error
  • func (c *Client) GetProject(ctx context.Context, name string) (*types.Project, error)
  • func (c *Client) GetServerVersion(ctx context.Context) (*types.VersionDetail, error)
  • func (c *Client) ListChangeSummaries(ctx context.Context, projectName string, key key.Key, previousSeq int64, ...) ([]*types.ChangeSummary, error)
  • func (c *Client) ListDocuments(ctx context.Context, projectName string, previousID string, pageSize int32, ...) ([]*types.DocumentSummary, error)
  • func (c *Client) ListProjects(ctx context.Context) ([]*types.Project, error)
  • func (c *Client) LogIn(ctx context.Context, username, password string) (string, error)
  • func (c *Client) RemoveDocument(ctx context.Context, projectName string, documentKey string, force bool) error
  • func (c *Client) SignUp(ctx context.Context, username, password string) (*types.User, error)
  • func (c *Client) UpdateProject(ctx context.Context, id string, fields *types.UpdatableProjectFields) (*types.Project, error)
• type Option
  • func WithInsecure(isInsecure bool) Option
  • func WithLogger(logger *zap.Logger) Option
  • func WithToken(token string) Option
• type Options

Types

type AuthInterceptor

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

AuthInterceptor is an interceptor for authentication.

func NewAuthInterceptor

func NewAuthInterceptor(token string) *AuthInterceptor

NewAuthInterceptor creates a new instance of AuthInterceptor.

func (*AuthInterceptor) SetToken

func (i *AuthInterceptor) SetToken(token string)

SetToken sets the token of the client.

func (*AuthInterceptor) WrapStreamingClient

func (i *AuthInterceptor) WrapStreamingClient(next connect.StreamingClientFunc) connect.StreamingClientFunc

WrapStreamingClient creates a stream client interceptor for authorization.

func (*AuthInterceptor) WrapStreamingHandler

func (i *AuthInterceptor) WrapStreamingHandler(next connect.StreamingHandlerFunc) connect.StreamingHandlerFunc

WrapStreamingHandler creates a stream server interceptor for authorization.

func (*AuthInterceptor) WrapUnary

func (i *AuthInterceptor) WrapUnary(next connect.UnaryFunc) connect.UnaryFunc

WrapUnary creates a unary server interceptor for authorization.

type Client

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

Client is a client for admin service.

func Dial

func Dial(rpcAddr string, opts ...Option) (*Client, error)

Dial creates an instance of Client and dials to the admin service.

func New

func New(opts ...Option) (*Client, error)

New creates an instance of Client.

func (*Client) ChangePassword

func (c *Client) ChangePassword(ctx context.Context, username, password, newPassword string) error

ChangePassword changes the user's password.

func (*Client) Close

func (c *Client) Close()

Close closes the connection to the admin service.

func (*Client) CreateProject

func (c *Client) CreateProject(ctx context.Context, name string) (*types.Project, error)

CreateProject creates a new project.

func (*Client) DeleteAccount

func (c *Client) DeleteAccount(ctx context.Context, username, password string) error

DeleteAccount deletes the user's account.

func (*Client) Dial

func (c *Client) Dial(rpcAddr string) error

Dial dials to the admin service.

func (*Client) GetProject

func (c *Client) GetProject(ctx context.Context, name string) (*types.Project, error)

GetProject gets the project by name.

func (*Client) GetServerVersion

func (c *Client) GetServerVersion(ctx context.Context) (*types.VersionDetail, error)

GetServerVersion gets the server version.

func (*Client) ListChangeSummaries

func (c *Client) ListChangeSummaries(
	ctx context.Context,
	projectName string,
	key key.Key,
	previousSeq int64,
	pageSize int32,
	isForward bool,
) ([]*types.ChangeSummary, error)

ListChangeSummaries returns the change summaries of the given document.

func (*Client) ListDocuments

func (c *Client) ListDocuments(
	ctx context.Context,
	projectName string,
	previousID string,
	pageSize int32,
	isForward bool,
	includeSnapshot bool,
) ([]*types.DocumentSummary, error)

ListDocuments lists documents.

func (*Client) ListProjects

func (c *Client) ListProjects(ctx context.Context) ([]*types.Project, error)

ListProjects lists all projects.

func (*Client) LogIn

func (c *Client) LogIn(
	ctx context.Context,
	username,
	password string,
) (string, error)

LogIn logs in a user.

func (*Client) RemoveDocument

func (c *Client) RemoveDocument(
	ctx context.Context,
	projectName string,
	documentKey string,
	force bool,
) error

RemoveDocument removes a document of the given key.

func (*Client) SignUp

func (c *Client) SignUp(
	ctx context.Context,
	username,
	password string,
) (*types.User, error)

SignUp signs up a new user.

func (*Client) UpdateProject

func (c *Client) UpdateProject(
	ctx context.Context,
	id string,
	fields *types.UpdatableProjectFields,
) (*types.Project, error)

UpdateProject updates an existing project.

type Option

type Option func(*Options)

Option configures Options.

func WithInsecure

func WithInsecure(isInsecure bool) Option

WithInsecure configures insecure option of the client.

func WithLogger

func WithLogger(logger *zap.Logger) Option

WithLogger configures the Logger of the client.

func WithToken

func WithToken(token string) Option

WithToken configures the token of the client.

type Options

type Options struct {
	// Token is the token of the user.
	Token string

	// Logger is the Logger of the client.
	Logger *zap.Logger

	// IsInsecure is whether to disable the TLS connection of the client.
	IsInsecure bool
}

Options configures how we set up the client.