sftp

Documentation

Overview

Package sftp provides a SFTP implementation of the storage interface.

Index

• Constants
• func Get() storage.IStorage
• func Set(s storage.IStorage)
• type Config
• type Option
• type ResponseListKeys
• type SFTP
  • func New(ctx context.Context, addr string, cfg *Config, options ...Option) (*SFTP, error)
  • func (s *SFTP) Count(ctx context.Context, target string, prm *count.Count, ...) (int64, error)
  • func (s *SFTP) Create(ctx context.Context, id, target string, v any, prm *create.Create, ...) (string, error)
  • func (s *SFTP) Delete(ctx context.Context, id, target string, prm *delete.Delete, ...) error
  • func (s *SFTP) GetClient() any
  • func (s *SFTP) List(ctx context.Context, target string, v any, prm *list.List, ...) error
  • func (s *SFTP) Retrieve(ctx context.Context, id, target string, v any, prm *retrieve.Retrieve, ...) error
  • func (s *SFTP) Update(ctx context.Context, id, target string, v any, prm *update.Update, ...) error

Constants

const Name = "sftp"

Name of the storage.

Functions

func Get

func Get() storage.IStorage

Get returns a setup SFTP, or set it up.

func Set

func Set(s storage.IStorage)

Set sets the storage, primarily used for testing.

Types

type Config

type Config = ssh.ClientConfig

Config is the SFTP configuration.

type Option

type Option = sftp.ClientOption

Option is for the SFTP configuration.

type ResponseListKeys

type ResponseListKeys struct {
	Keys []string `json:"keys"`
}

ResponseListKeys is the response from the Redis list SCAN command.

type SFTP

type SFTP struct {
	*storage.Storage

	Client *sftp.Client `json:"-" validate:"required"`

	// Target allows to set a static target. If it is empty, the target will be
	// dynamic - the one set at the operation (count, create, delete, etc) time.
	// Depending on the storage, target is a collection, a table, a bucket, etc.
	// For ElasticSearch, for example it doesn't have a concept of a database -
	// the target then is the index. Due to different cases of ElasticSearch
	// usage, the target can be static or dynamic - defined at the index time,
	// for example: log-{YYYY}-{MM}. For Redis, it isn't used at all.
	Target string `json:"-" validate:"omitempty,gt=0"`
}

SFTP storage definition.

func New

func New(ctx context.Context, addr string, cfg *Config, options ...Option) (*SFTP, error)

New creates a new SFTP storage.

NOTE: addr format is: host:port.

func (*SFTP) Count

func (s *SFTP) Count(ctx context.Context, target string, prm *count.Count, options ...storage.Func[*count.Count]) (int64, error)

Count returns the number of items in the storage.

func (*SFTP) Create

func (s *SFTP) Create(ctx context.Context, id, target string, v any, prm *create.Create, options ...storage.Func[*create.Create]) (string, error)

Create data.

NOTE: Not all storages returns the ID, neither all storages requires `id` to be set. You are better off setting the ID yourself.

func (*SFTP) Delete

func (s *SFTP) Delete(ctx context.Context, id, target string, prm *delete.Delete, options ...storage.Func[*delete.Delete]) error

Delete removes data.

func (*SFTP) GetClient

func (s *SFTP) GetClient() any

GetClient returns the client.

func (*SFTP) List

func (s *SFTP) List(ctx context.Context, target string, v any, prm *list.List, opts ...storage.Func[*list.List]) error

List data.

WARN: In general, projections that include non-indexed fields or fields that are part of a covered index (i.e., an index that includes all the projected fields) are less likely to impact performance.

NOTE: It uses param.List.Search to query the data.

func (*SFTP) Retrieve

func (s *SFTP) Retrieve(ctx context.Context, id, target string, v any, prm *retrieve.Retrieve, options ...storage.Func[*retrieve.Retrieve]) error

Retrieve data.

func (*SFTP) Update

func (s *SFTP) Update(ctx context.Context, id, target string, v any, prm *update.Update, opts ...storage.Func[*update.Update]) error

Update data.