c934f45bfc
We are not using this method and most probably we won't need to list objects with all statuses at once. Removing for now. Change-Id: I7aa0468c5f635ee2fb1fe51db382595c6343dd9c
121 lines
3.3 KiB
Go
121 lines
3.3 KiB
Go
// Copyright (C) 2020 Storj Labs, Inc.
|
|
// See LICENSE for copying information.
|
|
|
|
package metabase
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"storj.io/common/storj"
|
|
"storj.io/common/uuid"
|
|
)
|
|
|
|
// ObjectEntry contains information about an item in a bucket.
|
|
type ObjectEntry struct {
|
|
IsPrefix bool
|
|
|
|
ObjectKey ObjectKey
|
|
Version Version
|
|
StreamID uuid.UUID
|
|
|
|
CreatedAt time.Time
|
|
ExpiresAt *time.Time
|
|
|
|
Status ObjectStatus
|
|
SegmentCount int32
|
|
|
|
EncryptedMetadataNonce []byte
|
|
EncryptedMetadata []byte
|
|
EncryptedMetadataEncryptedKey []byte
|
|
|
|
TotalPlainSize int64
|
|
TotalEncryptedSize int64
|
|
FixedSegmentSize int32
|
|
|
|
Encryption storj.EncryptionParameters
|
|
}
|
|
|
|
// ObjectsIterator iterates over a sequence of ObjectEntry items.
|
|
type ObjectsIterator interface {
|
|
Next(ctx context.Context, item *ObjectEntry) bool
|
|
}
|
|
|
|
// IterateCursor is a cursor used during iteration through objects.
|
|
//
|
|
// The cursor is exclusive.
|
|
type IterateCursor struct {
|
|
Key ObjectKey
|
|
Version Version
|
|
}
|
|
|
|
// StreamIDCursor is a cursor used during iteration through streamIDs of a pending object.
|
|
type StreamIDCursor struct {
|
|
StreamID uuid.UUID
|
|
}
|
|
|
|
// IteratePendingObjectsByKey contains arguments necessary for listing pending objects by ObjectKey.
|
|
type IteratePendingObjectsByKey struct {
|
|
ObjectLocation
|
|
BatchSize int
|
|
Cursor StreamIDCursor
|
|
}
|
|
|
|
// IterateObjectsWithStatus contains arguments necessary for listing objects in a bucket.
|
|
type IterateObjectsWithStatus struct {
|
|
ProjectID uuid.UUID
|
|
BucketName string
|
|
Recursive bool
|
|
BatchSize int
|
|
Prefix ObjectKey
|
|
Cursor IterateCursor
|
|
Status ObjectStatus
|
|
IncludeCustomMetadata bool
|
|
IncludeSystemMetadata bool
|
|
}
|
|
|
|
// IterateObjectsAllVersionsWithStatus iterates through all versions of all objects with specified status.
|
|
func (db *DB) IterateObjectsAllVersionsWithStatus(ctx context.Context, opts IterateObjectsWithStatus, fn func(context.Context, ObjectsIterator) error) (err error) {
|
|
defer mon.Task()(&ctx)(&err)
|
|
if err = opts.Verify(); err != nil {
|
|
return err
|
|
}
|
|
return iterateAllVersionsWithStatus(ctx, db, opts, fn)
|
|
}
|
|
|
|
// Verify verifies get object request fields.
|
|
func (opts *IterateObjectsWithStatus) Verify() error {
|
|
switch {
|
|
case opts.ProjectID.IsZero():
|
|
return ErrInvalidRequest.New("ProjectID missing")
|
|
case opts.BucketName == "":
|
|
return ErrInvalidRequest.New("BucketName missing")
|
|
case opts.BatchSize < 0:
|
|
return ErrInvalidRequest.New("BatchSize is negative")
|
|
case !(opts.Status == Pending || opts.Status == Committed):
|
|
return ErrInvalidRequest.New("Status %v is not supported", opts.Status)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// IteratePendingObjectsByKey iterates through all streams of pending objects with the same ObjectKey.
|
|
func (db *DB) IteratePendingObjectsByKey(ctx context.Context, opts IteratePendingObjectsByKey, fn func(context.Context, ObjectsIterator) error) (err error) {
|
|
defer mon.Task()(&ctx)(&err)
|
|
|
|
if err := opts.Verify(); err != nil {
|
|
return err
|
|
}
|
|
return iteratePendingObjectsByKey(ctx, db, opts, fn)
|
|
}
|
|
|
|
// Verify verifies get object request fields.
|
|
func (opts *IteratePendingObjectsByKey) Verify() error {
|
|
if err := opts.ObjectLocation.Verify(); err != nil {
|
|
return err
|
|
}
|
|
if opts.BatchSize < 0 {
|
|
return ErrInvalidRequest.New("BatchSize is negative")
|
|
}
|
|
return nil
|
|
}
|