pbclient

package module

Go to main page

Versions in this module

v1

v1.0.0

May 2, 2026

Changes in this version

+ func PrepareRequest(req *http.Request, hasBody bool, opts ...DoOption)

+ type DoOption func(*doConfig)

+ func WithAuthStaleStatuses(codes ...int) DoOption

+ func WithContentType(ct string) DoOption

+ func WithHeader(k, v string) DoOption

v0

v0.0.4

Apr 25, 2026

v0.0.3

Dec 20, 2025

Changes in this version

+ type AuthenticatedClient interface

+ Do func(ctx context.Context, method, path string, body io.Reader) (*http.Response, error)

type Client

+ AuthenticateSuperuser func(creds Credentials) (AuthenticatedClient, error)

+ AuthenticateUser func(creds Credentials) (AuthenticatedClient, error)

+ type Consumer struct

+ func NewConsumer[T any](client AuthenticatedClient, collection string, opts ConsumerOptions) (*Consumer[T], error)

+ func (c *Consumer[T]) Close() error

+ func (c *Consumer[T]) Errors() <-chan error

+ func (c *Consumer[T]) Messages() <-chan Message[T]

+ func (c *Consumer[T]) Start(ctx context.Context) error

+ type ConsumerOptions struct

+ BatchSize int

+ BufferSize int

+ ConsumerGroup string

+ ErrorBufferSize int

+ Filter string

+ OffsetCollection string

+ OffsetProvider OffsetProvider

+ PollInterval time.Duration

+ type Credentials struct

+ Email string

+ Password string

+ type IDOffsetProvider struct

+ func (i *IDOffsetProvider) BuildFilter(lastOffset string, userFilter string) string

+ func (i *IDOffsetProvider) ExtractOffset(record map[string]any) (string, error)

+ func (i *IDOffsetProvider) InitialOffset() string

+ func (i *IDOffsetProvider) SortField() string

+ type Message struct

+ Data T

+ func (m *Message[T]) Commit(ctx context.Context) error

+ type OffsetProvider interface

+ BuildFilter func(lastOffset string, userFilter string) string

+ ExtractOffset func(record map[string]any) (string, error)

+ InitialOffset func() string

+ SortField func() string

+ func NewIDOffsetProvider() OffsetProvider

+ func NewTimestampOffsetProvider() OffsetProvider

+ type TimestampOffsetProvider struct

+ func (t *TimestampOffsetProvider) BuildFilter(lastOffset string, userFilter string) string

+ func (t *TimestampOffsetProvider) ExtractOffset(record map[string]any) (string, error)

+ func (t *TimestampOffsetProvider) InitialOffset() string

+ func (t *TimestampOffsetProvider) SortField() string

+ type TypedKVStore struct

+ func NewTypedKVStore[T any](client AuthenticatedClient, collection string, appName string) TypedKVStore[T]

+ func (s TypedKVStore[T]) Delete(ctx context.Context, key string) error

+ func (s TypedKVStore[T]) Exists(ctx context.Context, key string) (bool, error)

+ func (s TypedKVStore[T]) Get(ctx context.Context, key string) (T, error)

+ func (s TypedKVStore[T]) List(ctx context.Context, prefix string) ([]string, error)

+ func (s TypedKVStore[T]) Set(ctx context.Context, key string, value T) error

v0.0.2

Nov 21, 2025

Changes in this version

type Client

+ func (c *Client) Do(ctx context.Context, method, path string, body io.Reader) (*http.Response, error)

type ClientOption

+ func WithAuthToken(token string, expires time.Time) ClientOption

v0.0.1

Nov 20, 2025

Changes in this version

+ var ErrBadRequest = errors.New("bad request")

+ var ErrConflict = errors.New("conflict")

+ var ErrForbidden = errors.New("forbidden")

+ var ErrNotFound = errors.New("not found")

+ var ErrRateLimited = errors.New("rate limited")

+ var ErrServer = errors.New("server error")

+ var ErrUnauthorized = errors.New("unauthorized")

+ var ErrValidation = errors.New("validation failed")

+ func And(filters ...string) string

+ func Eq(field, value string) string

+ func Gt(field, value string) string

+ func Gte(field, value string) string

+ func Lt(field, value string) string

+ func Lte(field, value string) string

+ func Neq(field, value string) string

+ func Or(filters ...string) string

+ type Client struct

+ func NewClient(baseURL, adminEmail, adminPassword string, opts ...ClientOption) (*Client, error)

+ type ClientOption func(*Client)

+ func WithHTTPClient(client *http.Client) ClientOption

+ func WithLogger(logger *slog.Logger) ClientOption

+ func WithRetry(maxRetries int, backoff time.Duration) ClientOption

+ func WithTimeout(timeout time.Duration) ClientOption

+ type HTTPError struct

+ Message string

+ Status int

+ func (e *HTTPError) Error() string

+ type KVStore struct

+ func NewKVStore(client *Client, collection string) *KVStore

+ func (s *KVStore) Delete(ctx context.Context, key string) error

+ func (s *KVStore) Exists(ctx context.Context, key string) (bool, error)

+ func (s *KVStore) Get(ctx context.Context, key string, dest interface{}) error

+ func (s *KVStore) List(ctx context.Context, prefix string) ([]string, error)

+ func (s *KVStore) Set(ctx context.Context, key string, value interface{}) error

+ type ListOptions struct

+ Fields []string

+ Filter string

+ Page int

+ PerPage int

+ Sort string

+ type ListResult struct

+ Items []T

+ Page int

+ PerPage int

+ TotalItems int

+ TotalPages int

+ type Repository struct

+ func NewRepository[T any](client *Client, collection string) *Repository[T]

+ func (r *Repository[T]) Create(ctx context.Context, record T) (*T, error)

+ func (r *Repository[T]) Delete(ctx context.Context, id string) error

+ func (r *Repository[T]) Get(ctx context.Context, id string) (*T, error)

+ func (r *Repository[T]) List(ctx context.Context, opts ListOptions) (*ListResult[T], error)

+ func (r *Repository[T]) Update(ctx context.Context, id string, record T) (*T, error)

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