obs

package

v0.0.0-...-a1e58aa Latest Latest Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/thanos-io/objstore

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func NewTestBucket(t testing.TB, location string) (objstore.Bucket, func(), error)
func NewTestBucketFromConfig(t testing.TB, c Config, reuseBucket bool, location string) (objstore.Bucket, func(), error)
type Bucket
- func NewBucket(logger log.Logger, conf []byte) (*Bucket, error)
- func NewBucketWithConfig(logger log.Logger, config Config) (*Bucket, error)
type Config

Constants ¶

View Source

const (
	MinMultipartUploadSize int64 = 1024 * 1024 * 100
	PartSize               int64 = 1024 * 1024 * 100
)

View Source

const DirDelim = "/"

Variables ¶

View Source

var DefaultConfig = Config{
	HTTPConfig: exthttp.HTTPConfig{
		IdleConnTimeout:       model.Duration(90 * time.Second),
		ResponseHeaderTimeout: model.Duration(2 * time.Minute),
		TLSHandshakeTimeout:   model.Duration(10 * time.Second),
		ExpectContinueTimeout: model.Duration(1 * time.Second),
		MaxIdleConns:          100,
		MaxIdleConnsPerHost:   100,
		MaxConnsPerHost:       0,
	},
}

Functions ¶

func NewTestBucket ¶

func NewTestBucket(t testing.TB, location string) (objstore.Bucket, func(), error)

NewTestBucket creates test bkt client that before returning creates temporary bucket.

func NewTestBucketFromConfig ¶

func NewTestBucketFromConfig(t testing.TB, c Config, reuseBucket bool, location string) (objstore.Bucket, func(), error)

Types ¶

type Bucket ¶

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

func NewBucket ¶

func NewBucket(logger log.Logger, conf []byte) (*Bucket, error)

func NewBucketWithConfig ¶

func NewBucketWithConfig(logger log.Logger, config Config) (*Bucket, error)

func (*Bucket) Attributes ¶

func (b *Bucket) Attributes(ctx context.Context, name string) (objstore.ObjectAttributes, error)

Attributes returns information about the specified object.

func (*Bucket) Close ¶

func (b *Bucket) Close() error

func (*Bucket) Delete ¶

func (b *Bucket) Delete(ctx context.Context, name string) error

Delete removes the object with the given name.

func (*Bucket) Exists ¶

func (b *Bucket) Exists(ctx context.Context, name string) (bool, error)

Exists checks if the given object exists in the bucket.

func (*Bucket) Get ¶

func (b *Bucket) Get(ctx context.Context, name string) (io.ReadCloser, error)

Get returns a reader for the given object name.

func (*Bucket) GetRange ¶

func (b *Bucket) GetRange(ctx context.Context, name string, off, length int64) (io.ReadCloser, error)

GetRange returns a new range reader for the given object name and range.

func (*Bucket) IsAccessDeniedErr ¶

func (b *Bucket) IsAccessDeniedErr(_ error) bool

IsAccessDeniedErr returns true if access to object is denied.

func (*Bucket) IsObjNotFoundErr ¶

func (b *Bucket) IsObjNotFoundErr(err error) bool

IsObjNotFoundErr returns true if error means that object is not found. Relevant to Get operations.

func (*Bucket) Iter ¶

func (b *Bucket) Iter(ctx context.Context, dir string, f func(string) error, options ...objstore.IterOption) error

Iter calls f for each entry in the given directory (not recursive.)

func (*Bucket) Name ¶

func (b *Bucket) Name() string

Name returns the bucket name for the provider.

func (*Bucket) Upload ¶

func (b *Bucket) Upload(ctx context.Context, name string, r io.Reader) error

Upload the contents of the reader as an object into the bucket.

type Config ¶

type Config struct {
	Bucket     string             `yaml:"bucket"`
	Endpoint   string             `yaml:"endpoint"`
	AccessKey  string             `yaml:"access_key"`
	SecretKey  string             `yaml:"secret_key"`
	HTTPConfig exthttp.HTTPConfig `yaml:"http_config"`
}

Source Files ¶

View all Source files

obs.go

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