Documentation ¶
Overview ¶
Package metabase implements storing objects and segements.
Index ¶
- Constants
- Variables
- func EqualAliasPieces(xs, ys AliasPieces) bool
- func LessObjectKey(a, b ObjectKey) bool
- func LimitedAsOfSystemTime(impl dbutil.Implementation, now, baseline time.Time, maxInterval time.Duration) string
- func SpannerTestModule(ball *mud.Ball, spannerConnection string)
- type Adapter
- type AliasPiece
- type AliasPieces
- func (aliases AliasPieces) Bytes() ([]byte, error)
- func (aliases *AliasPieces) DecodeSpanner(val any) (err error)
- func (aliases AliasPieces) EncodeSpanner() (any, error)
- func (aliases *AliasPieces) Scan(src any) error
- func (aliases *AliasPieces) SetBytes(data []byte) error
- func (aliases AliasPieces) Value() (driver.Value, error)
- type BeginCopyObject
- type BeginCopyObjectResult
- type BeginMoveCopyResults
- type BeginMoveObject
- type BeginMoveObjectResult
- type BeginObjectExactVersion
- type BeginObjectNextVersion
- type BeginSegment
- type BucketEmpty
- type BucketLocation
- type BucketName
- type BucketPrefix
- type BucketTally
- type CockroachAdapter
- func (p *CockroachAdapter) CommitInlineSegment(ctx context.Context, opts CommitInlineSegment) (err error)
- func (p *CockroachAdapter) CommitPendingObjectSegment(ctx context.Context, opts CommitSegment, aliasPieces AliasPieces) (err error)
- func (c *CockroachAdapter) DeleteBucketObjects(ctx context.Context, opts DeleteBucketObjects) (deletedObjectCount, deletedSegmentCount int64, err error)
- func (c *CockroachAdapter) GetTableStats(ctx context.Context, opts GetTableStats) (result TableStats, err error)
- func (c *CockroachAdapter) IterateLoopSegments(ctx context.Context, aliasCache *NodeAliasCache, opts IterateLoopSegments, ...) (err error)
- func (c *CockroachAdapter) MigrateToLatest(ctx context.Context) error
- func (c *CockroachAdapter) Name() string
- func (c *CockroachAdapter) TestMigrateToLatest(ctx context.Context) error
- func (c *CockroachAdapter) UpdateTableStats(ctx context.Context) error
- type CollectBucketTallies
- type CommitInlineObject
- type CommitInlineSegment
- type CommitObject
- type CommitObjectWithSegments
- type CommitSegment
- type Config
- type DB
- func (db *DB) BeginCopyObject(ctx context.Context, opts BeginCopyObject) (_ BeginCopyObjectResult, err error)
- func (db *DB) BeginMoveObject(ctx context.Context, opts BeginMoveObject) (_ BeginMoveObjectResult, err error)
- func (db *DB) BeginObjectNextVersion(ctx context.Context, opts BeginObjectNextVersion) (object Object, err error)
- func (db *DB) BeginSegment(ctx context.Context, opts BeginSegment) (err error)
- func (db *DB) BucketEmpty(ctx context.Context, opts BucketEmpty) (empty bool, err error)
- func (db *DB) CheckVersion(ctx context.Context) error
- func (db *DB) ChooseAdapter(projectID uuid.UUID) Adapter
- func (db *DB) Close() error
- func (db *DB) CollectBucketTallies(ctx context.Context, opts CollectBucketTallies) (result []BucketTally, err error)
- func (db *DB) CommitInlineObject(ctx context.Context, opts CommitInlineObject) (object Object, err error)
- func (db *DB) CommitInlineSegment(ctx context.Context, opts CommitInlineSegment) (err error)
- func (db *DB) CommitObject(ctx context.Context, opts CommitObject) (object Object, err error)
- func (db *DB) CommitObjectWithSegments(ctx context.Context, opts CommitObjectWithSegments) (object Object, err error)
- func (db *DB) CommitSegment(ctx context.Context, opts CommitSegment) (err error)
- func (db *DB) DeleteBucketObjects(ctx context.Context, opts DeleteBucketObjects) (deletedObjectCount int64, err error)
- func (db *DB) DeleteExpiredObjects(ctx context.Context, opts DeleteExpiredObjects) (err error)
- func (db *DB) DeleteObjectExactVersion(ctx context.Context, opts DeleteObjectExactVersion) (result DeleteObjectResult, err error)
- func (db *DB) DeleteObjectLastCommitted(ctx context.Context, opts DeleteObjectLastCommitted) (result DeleteObjectResult, err error)
- func (db *DB) DeletePendingObject(ctx context.Context, opts DeletePendingObject) (result DeleteObjectResult, err error)
- func (db *DB) DeleteZombieObjects(ctx context.Context, opts DeleteZombieObjects) (err error)
- func (db *DB) DestroyTables(ctx context.Context) error
- func (db *DB) EnsureNodeAliases(ctx context.Context, opts EnsureNodeAliases) (err error)
- func (db *DB) FinishCopyObject(ctx context.Context, opts FinishCopyObject) (object Object, err error)
- func (db *DB) FinishMoveObject(ctx context.Context, opts FinishMoveObject) (err error)
- func (db *DB) GetLatestObjectLastSegment(ctx context.Context, opts GetLatestObjectLastSegment) (segment Segment, err error)
- func (db *DB) GetNodeAliasEntries(ctx context.Context, opts GetNodeAliasEntries) (entries []NodeAliasEntry, err error)
- func (db *DB) GetObjectExactVersion(ctx context.Context, opts GetObjectExactVersion) (_ Object, err error)
- func (db *DB) GetObjectExactVersionLegalHold(ctx context.Context, opts GetObjectExactVersionLegalHold) (enabled bool, err error)
- func (db *DB) GetObjectExactVersionRetention(ctx context.Context, opts GetObjectExactVersionRetention) (retention Retention, err error)
- func (db *DB) GetObjectLastCommitted(ctx context.Context, opts GetObjectLastCommitted) (_ Object, err error)
- func (db *DB) GetObjectLastCommittedLegalHold(ctx context.Context, opts GetObjectLastCommittedLegalHold) (enabled bool, err error)
- func (db *DB) GetObjectLastCommittedRetention(ctx context.Context, opts GetObjectLastCommittedRetention) (retention Retention, err error)
- func (db *DB) GetSegmentByPosition(ctx context.Context, opts GetSegmentByPosition) (segment Segment, err error)
- func (db *DB) GetStreamPieceCountByNodeID(ctx context.Context, opts GetStreamPieceCountByNodeID) (result map[storj.NodeID]int64, err error)
- func (db *DB) GetTableStats(ctx context.Context, opts GetTableStats) (result TableStats, err error)
- func (db *DB) Implementation() dbutil.Implementation
- func (db *DB) IterateLoopSegments(ctx context.Context, opts IterateLoopSegments, ...) (err error)
- func (db *DB) IterateObjectsAllVersionsWithStatus(ctx context.Context, opts IterateObjectsWithStatus, ...) (err error)
- func (db *DB) IterateObjectsAllVersionsWithStatusAscending(ctx context.Context, opts IterateObjectsWithStatus, ...) (err error)
- func (db *DB) IteratePendingObjectsByKey(ctx context.Context, opts IteratePendingObjectsByKey, ...) (err error)
- func (db *DB) LatestNodesAliasMap(ctx context.Context) (_ *NodeAliasMap, err error)
- func (db *DB) ListBucketsStreamIDs(ctx context.Context, opts ListBucketsStreamIDs) (ListBucketsStreamIDsResult, error)
- func (db *DB) ListNodeAliases(ctx context.Context) (_ []NodeAliasEntry, err error)
- func (db *DB) ListObjects(ctx context.Context, opts ListObjects) (result ListObjectsResult, err error)
- func (db *DB) ListObjectsWithIterator(ctx context.Context, opts ListObjects) (result ListObjectsResult, err error)
- func (db *DB) ListSegments(ctx context.Context, opts ListSegments) (result ListSegmentsResult, err error)
- func (db *DB) ListStreamPositions(ctx context.Context, opts ListStreamPositions) (result ListStreamPositionsResult, err error)
- func (db *DB) MigrateToLatest(ctx context.Context) error
- func (db *DB) Now(ctx context.Context) (time.Time, error)
- func (db *DB) Ping(ctx context.Context) error
- func (db *DB) PrecommitConstraint(ctx context.Context, opts PrecommitConstraint, ...) (result PrecommitConstraintResult, err error)
- func (db *DB) SetObjectExactVersionLegalHold(ctx context.Context, opts SetObjectExactVersionLegalHold) (err error)
- func (db *DB) SetObjectExactVersionRetention(ctx context.Context, opts SetObjectExactVersionRetention) (err error)
- func (db *DB) SetObjectLastCommittedLegalHold(ctx context.Context, opts SetObjectLastCommittedLegalHold) (err error)
- func (db *DB) SetObjectLastCommittedRetention(ctx context.Context, opts SetObjectLastCommittedRetention) (err error)
- func (db *DB) TestMigrateToLatest(ctx context.Context) error
- func (db *DB) TestingAllObjects(ctx context.Context) (objects []Object, err error)
- func (db *DB) TestingAllSegments(ctx context.Context) (segments []Segment, err error)
- func (db *DB) TestingBatchInsertObjects(ctx context.Context, objects []RawObject) (err error)
- func (db *DB) TestingBatchInsertSegments(ctx context.Context, segments []RawSegment) (err error)
- func (db *DB) TestingBeginObjectExactVersion(ctx context.Context, opts BeginObjectExactVersion) (committed Object, err error)
- func (db *DB) TestingDeleteAll(ctx context.Context) (err error)
- func (db *DB) TestingGetState(ctx context.Context) (_ *RawState, err error)
- func (db *DB) TestingSetCleanup(cleanup func() error)
- func (db *DB) TestingSetObjectVersion(ctx context.Context, object ObjectStream, randomVersion Version) (rowsAffected int64, err error)
- func (db *DB) TestingSetPlacementAllSegments(ctx context.Context, placement storj.PlacementConstraint) (err error)
- func (db *DB) UnderlyingTagSQL() tagsql.DB
- func (db *DB) UpdateObjectLastCommittedMetadata(ctx context.Context, opts UpdateObjectLastCommittedMetadata) (err error)
- func (db *DB) UpdateSegmentPieces(ctx context.Context, opts UpdateSegmentPieces) (err error)
- func (db *DB) UpdateTableStats(ctx context.Context) (err error)
- type DeleteBucketObjects
- type DeleteExpiredObjects
- type DeleteObjectExactVersion
- type DeleteObjectLastCommitted
- type DeleteObjectResult
- type DeletePendingObject
- type DeleteZombieObjects
- type EncryptedKeyAndNonce
- type EnsureNodeAliases
- type FinishCopyObject
- type FinishMoveObject
- type GetLatestObjectLastSegment
- type GetNodeAliasEntries
- type GetObjectExactVersion
- type GetObjectExactVersionLegalHold
- type GetObjectExactVersionRetention
- type GetObjectLastCommitted
- type GetObjectLastCommittedLegalHold
- type GetObjectLastCommittedRetention
- type GetSegmentByPosition
- type GetStreamPieceCountByNodeID
- type GetTableStats
- type IterateCursor
- type IterateLoopSegments
- type IterateObjectsWithStatus
- type IteratePendingObjectsByKey
- type ListBucketsStreamIDs
- type ListBucketsStreamIDsResult
- type ListObjects
- type ListObjectsCursor
- type ListObjectsResult
- type ListSegments
- type ListSegmentsResult
- type ListStreamPositions
- type ListStreamPositionsResult
- type ListVerifyBucketList
- type LoopSegmentEntry
- type LoopSegmentsIterator
- type NodeAlias
- type NodeAliasCache
- func (cache *NodeAliasCache) Aliases(ctx context.Context, nodes []storj.NodeID) ([]NodeAlias, error)
- func (cache *NodeAliasCache) ConvertAliasesToPieces(ctx context.Context, aliasPieces AliasPieces) (_ Pieces, err error)
- func (cache *NodeAliasCache) EnsureAliases(ctx context.Context, nodes []storj.NodeID) ([]NodeAlias, error)
- func (cache *NodeAliasCache) EnsurePiecesToAliases(ctx context.Context, pieces Pieces) (_ AliasPieces, err error)
- func (cache *NodeAliasCache) Latest(ctx context.Context) (_ *NodeAliasMap, err error)
- func (cache *NodeAliasCache) Nodes(ctx context.Context, aliases []NodeAlias) ([]storj.NodeID, error)
- type NodeAliasDB
- type NodeAliasEntry
- type NodeAliasMap
- func (m *NodeAliasMap) Alias(node storj.NodeID) (x NodeAlias, ok bool)
- func (m *NodeAliasMap) Aliases(nodes []storj.NodeID) (xs []NodeAlias, missing []storj.NodeID)
- func (m *NodeAliasMap) ContainsAll(nodeIDs []storj.NodeID, nodeAliases []NodeAlias) bool
- func (m *NodeAliasMap) Max() NodeAlias
- func (m *NodeAliasMap) Merge(other *NodeAliasMap)
- func (m *NodeAliasMap) Node(alias NodeAlias) (x storj.NodeID, ok bool)
- func (m *NodeAliasMap) Nodes(aliases []NodeAlias) (xs []storj.NodeID, missing []NodeAlias)
- func (m *NodeAliasMap) Size() int
- type Object
- type ObjectEntry
- type ObjectKey
- type ObjectLocation
- type ObjectLockDeleteOptions
- type ObjectStatus
- func (status *ObjectStatus) DecodeSpanner(val any) (err error)
- func (status ObjectStatus) EncodeSpanner() (any, error)
- func (status ObjectStatus) IsCommitted() bool
- func (status ObjectStatus) IsDeleteMarker() bool
- func (status ObjectStatus) IsUnversioned() bool
- func (status ObjectStatus) String() string
- type ObjectStream
- type ObjectsIterator
- type ObjectsIteratorCursor
- type PendingObjectEntry
- type PendingObjectStream
- type PendingObjectsIterator
- type Piece
- type Pieces
- func (p Pieces) Add(piecesToAdd Pieces) (Pieces, error)
- func (p Pieces) Equal(pieces Pieces) bool
- func (p Pieces) FindByNum(pieceNum int) (_ Piece, found bool)
- func (p Pieces) Len() int
- func (p Pieces) Less(i, j int) bool
- func (p Pieces) Remove(piecesToRemove Pieces) (Pieces, error)
- func (pieces *Pieces) Scan(value interface{}) error
- func (p Pieces) Swap(i, j int)
- func (p Pieces) Update(piecesToAdd, piecesToRemove Pieces) (Pieces, error)
- func (pieces Pieces) Value() (driver.Value, error)
- func (p Pieces) Verify() error
- type PostgresAdapter
- func (p *PostgresAdapter) BeginObjectNextVersion(ctx context.Context, opts BeginObjectNextVersion, object *Object) error
- func (p *PostgresAdapter) BucketEmpty(ctx context.Context, opts BucketEmpty) (empty bool, err error)
- func (p *PostgresAdapter) CheckVersion(ctx context.Context) error
- func (p *PostgresAdapter) CollectBucketTallies(ctx context.Context, opts CollectBucketTallies) (result []BucketTally, err error)
- func (p *PostgresAdapter) CommitInlineSegment(ctx context.Context, opts CommitInlineSegment) (err error)
- func (p *PostgresAdapter) CommitPendingObjectSegment(ctx context.Context, opts CommitSegment, aliasPieces AliasPieces) (err error)
- func (p *PostgresAdapter) DeleteBucketObjects(ctx context.Context, opts DeleteBucketObjects) (deletedObjectCount, deletedSegmentCount int64, err error)
- func (p *PostgresAdapter) DeleteInactiveObjectsAndSegments(ctx context.Context, objects []ObjectStream, opts DeleteZombieObjects) (objectsDeleted, segmentsDeleted int64, err error)
- func (p *PostgresAdapter) DeleteObjectExactVersion(ctx context.Context, opts DeleteObjectExactVersion) (DeleteObjectResult, error)
- func (p *PostgresAdapter) DeleteObjectLastCommittedPlain(ctx context.Context, opts DeleteObjectLastCommitted) (DeleteObjectResult, error)
- func (p *PostgresAdapter) DeleteObjectLastCommittedSuspended(ctx context.Context, opts DeleteObjectLastCommitted, ...) (result DeleteObjectResult, err error)
- func (p *PostgresAdapter) DeleteObjectLastCommittedVersioned(ctx context.Context, opts DeleteObjectLastCommitted, ...) (result DeleteObjectResult, err error)
- func (p *PostgresAdapter) DeleteObjectsAndSegments(ctx context.Context, objects []ObjectStream) (objectsDeleted, segmentsDeleted int64, err error)
- func (p *PostgresAdapter) DeletePendingObject(ctx context.Context, opts DeletePendingObject) (result DeleteObjectResult, err error)
- func (p *PostgresAdapter) EnsureNodeAliases(ctx context.Context, opts EnsureNodeAliases) (err error)
- func (p *PostgresAdapter) FindExpiredObjects(ctx context.Context, opts DeleteExpiredObjects, startAfter ObjectStream, ...) (expiredObjects []ObjectStream, err error)
- func (p *PostgresAdapter) FindZombieObjects(ctx context.Context, opts DeleteZombieObjects, startAfter ObjectStream, ...) (objects []ObjectStream, err error)
- func (p *PostgresAdapter) GetLatestObjectLastSegment(ctx context.Context, opts GetLatestObjectLastSegment) (segment Segment, aliasPieces AliasPieces, err error)
- func (p *PostgresAdapter) GetNodeAliasEntries(ctx context.Context, opts GetNodeAliasEntries) (_ []NodeAliasEntry, err error)
- func (p *PostgresAdapter) GetObjectExactVersion(ctx context.Context, opts GetObjectExactVersion) (_ Object, err error)
- func (p *PostgresAdapter) GetObjectExactVersionLegalHold(ctx context.Context, opts GetObjectExactVersionLegalHold) (_ bool, err error)
- func (p *PostgresAdapter) GetObjectExactVersionRetention(ctx context.Context, opts GetObjectExactVersionRetention) (_ Retention, err error)
- func (p *PostgresAdapter) GetObjectLastCommitted(ctx context.Context, opts GetObjectLastCommitted) (object Object, err error)
- func (p *PostgresAdapter) GetObjectLastCommittedLegalHold(ctx context.Context, opts GetObjectLastCommittedLegalHold) (_ bool, err error)
- func (p *PostgresAdapter) GetObjectLastCommittedRetention(ctx context.Context, opts GetObjectLastCommittedRetention) (_ Retention, err error)
- func (p *PostgresAdapter) GetSegmentByPosition(ctx context.Context, opts GetSegmentByPosition) (segment Segment, aliasPieces AliasPieces, err error)
- func (p *PostgresAdapter) GetSegmentPositionsAndKeys(ctx context.Context, streamID uuid.UUID) (keysNonces []EncryptedKeyAndNonce, err error)
- func (p *PostgresAdapter) GetStreamPieceCountByAlias(ctx context.Context, opts GetStreamPieceCountByNodeID) (result map[NodeAlias]int64, err error)
- func (p *PostgresAdapter) GetTableStats(ctx context.Context, opts GetTableStats) (result TableStats, err error)
- func (p *PostgresAdapter) Implementation() dbutil.Implementation
- func (p *PostgresAdapter) IterateLoopSegments(ctx context.Context, aliasCache *NodeAliasCache, opts IterateLoopSegments, ...) (err error)
- func (p *PostgresAdapter) ListBucketsStreamIDs(ctx context.Context, opts ListBucketsStreamIDs, bucketNamesBytes [][]byte, ...) (result ListBucketsStreamIDsResult, err error)
- func (p *PostgresAdapter) ListNodeAliases(ctx context.Context) (_ []NodeAliasEntry, err error)
- func (p *PostgresAdapter) ListObjects(ctx context.Context, opts ListObjects) (result ListObjectsResult, err error)
- func (p *PostgresAdapter) ListSegments(ctx context.Context, opts ListSegments, aliasCache *NodeAliasCache) (result ListSegmentsResult, err error)
- func (p *PostgresAdapter) ListStreamPositions(ctx context.Context, opts ListStreamPositions) (result ListStreamPositionsResult, err error)
- func (p *PostgresAdapter) MigrateToLatest(ctx context.Context) error
- func (p *PostgresAdapter) Name() string
- func (p *PostgresAdapter) Now(ctx context.Context) (time.Time, error)
- func (p *PostgresAdapter) PendingObjectExists(ctx context.Context, opts BeginSegment) (exists bool, err error)
- func (p *PostgresAdapter) Ping(ctx context.Context) error
- func (p *PostgresAdapter) PostgresMigration() *migrate.Migration
- func (p *PostgresAdapter) SetObjectExactVersionLegalHold(ctx context.Context, opts SetObjectExactVersionLegalHold) (err error)
- func (p *PostgresAdapter) SetObjectExactVersionRetention(ctx context.Context, opts SetObjectExactVersionRetention) (err error)
- func (p *PostgresAdapter) SetObjectLastCommittedLegalHold(ctx context.Context, opts SetObjectLastCommittedLegalHold) (err error)
- func (p *PostgresAdapter) SetObjectLastCommittedRetention(ctx context.Context, opts SetObjectLastCommittedRetention) (err error)
- func (p *PostgresAdapter) TestMigrateToLatest(ctx context.Context) error
- func (p *PostgresAdapter) TestingBatchInsertObjects(ctx context.Context, objects []RawObject) (err error)
- func (p *PostgresAdapter) TestingBatchInsertSegments(ctx context.Context, aliasCache *NodeAliasCache, segments []RawSegment) (err error)
- func (p *PostgresAdapter) TestingBeginObjectExactVersion(ctx context.Context, opts BeginObjectExactVersion, object *Object) error
- func (p *PostgresAdapter) TestingDeleteAll(ctx context.Context) (err error)
- func (p *PostgresAdapter) TestingGetAllObjects(ctx context.Context) (_ []RawObject, err error)
- func (p *PostgresAdapter) TestingGetAllSegments(ctx context.Context, aliasCache *NodeAliasCache) (_ []RawSegment, err error)
- func (p *PostgresAdapter) TestingSetObjectVersion(ctx context.Context, object ObjectStream, randomVersion Version) (rowsAffected int64, err error)
- func (p *PostgresAdapter) TestingSetPlacementAllSegments(ctx context.Context, placement storj.PlacementConstraint) (err error)
- func (p *PostgresAdapter) UnderlyingDB() tagsql.DB
- func (p *PostgresAdapter) UpdateObjectLastCommittedMetadata(ctx context.Context, opts UpdateObjectLastCommittedMetadata) (affected int64, err error)
- func (p *PostgresAdapter) UpdateSegmentPieces(ctx context.Context, opts UpdateSegmentPieces, ...) (resultPieces AliasPieces, err error)
- func (p *PostgresAdapter) UpdateTableStats(ctx context.Context) error
- func (p *PostgresAdapter) WithTx(ctx context.Context, f func(context.Context, TransactionAdapter) error) error
- type PrecommitConstraint
- type PrecommitConstraintResult
- type PrecommitConstraintWithNonPendingResult
- type PrecommitDeleteUnversionedWithNonPending
- type RawCopy
- type RawObject
- type RawSegment
- type RawState
- type Retention
- type Segment
- type SegmentIterator
- type SegmentKey
- type SegmentLocation
- type SegmentPosition
- func (pos *SegmentPosition) DecodeSpanner(val any) (err error)
- func (pos SegmentPosition) Encode() uint64
- func (pos SegmentPosition) EncodeSpanner() (any, error)
- func (pos SegmentPosition) Less(b SegmentPosition) bool
- func (params *SegmentPosition) Scan(value interface{}) error
- func (params SegmentPosition) Value() (driver.Value, error)
- type SegmentPositionInfo
- type SetObjectExactVersionLegalHold
- type SetObjectExactVersionRetention
- type SetObjectLastCommittedLegalHold
- type SetObjectLastCommittedRetention
- type SpannerAdapter
- func (s *SpannerAdapter) BeginObjectNextVersion(ctx context.Context, opts BeginObjectNextVersion, object *Object) error
- func (s *SpannerAdapter) BucketEmpty(ctx context.Context, opts BucketEmpty) (empty bool, err error)
- func (s *SpannerAdapter) CheckVersion(ctx context.Context) error
- func (s *SpannerAdapter) Close() error
- func (s *SpannerAdapter) CollectBucketTallies(ctx context.Context, opts CollectBucketTallies) (result []BucketTally, err error)
- func (s *SpannerAdapter) CommitInlineSegment(ctx context.Context, opts CommitInlineSegment) (err error)
- func (s *SpannerAdapter) CommitPendingObjectSegment(ctx context.Context, opts CommitSegment, aliasPieces AliasPieces) (err error)
- func (s *SpannerAdapter) DeleteBucketObjects(ctx context.Context, opts DeleteBucketObjects) (deletedObjectCount, deletedSegmentCount int64, err error)
- func (s *SpannerAdapter) DeleteInactiveObjectsAndSegments(ctx context.Context, objects []ObjectStream, opts DeleteZombieObjects) (objectsDeleted, segmentsDeleted int64, err error)
- func (s *SpannerAdapter) DeleteObjectExactVersion(ctx context.Context, opts DeleteObjectExactVersion) (DeleteObjectResult, error)
- func (s *SpannerAdapter) DeleteObjectLastCommittedPlain(ctx context.Context, opts DeleteObjectLastCommitted) (DeleteObjectResult, error)
- func (s *SpannerAdapter) DeleteObjectLastCommittedSuspended(ctx context.Context, opts DeleteObjectLastCommitted, ...) (result DeleteObjectResult, err error)
- func (s *SpannerAdapter) DeleteObjectLastCommittedVersioned(ctx context.Context, opts DeleteObjectLastCommitted, ...) (result DeleteObjectResult, err error)
- func (s *SpannerAdapter) DeleteObjectsAndSegments(ctx context.Context, objects []ObjectStream) (objectsDeleted, segmentsDeleted int64, err error)
- func (s *SpannerAdapter) DeletePendingObject(ctx context.Context, opts DeletePendingObject) (result DeleteObjectResult, err error)
- func (s *SpannerAdapter) EnsureNodeAliases(ctx context.Context, opts EnsureNodeAliases) (err error)
- func (s *SpannerAdapter) FindExpiredObjects(ctx context.Context, opts DeleteExpiredObjects, startAfter ObjectStream, ...) (expiredObjects []ObjectStream, err error)
- func (s *SpannerAdapter) FindZombieObjects(ctx context.Context, opts DeleteZombieObjects, startAfter ObjectStream, ...) (objects []ObjectStream, err error)
- func (s *SpannerAdapter) GetLatestObjectLastSegment(ctx context.Context, opts GetLatestObjectLastSegment) (segment Segment, aliasPieces AliasPieces, err error)
- func (s *SpannerAdapter) GetNodeAliasEntries(ctx context.Context, opts GetNodeAliasEntries) (_ []NodeAliasEntry, err error)
- func (s *SpannerAdapter) GetObjectExactVersion(ctx context.Context, opts GetObjectExactVersion) (object Object, err error)
- func (s *SpannerAdapter) GetObjectExactVersionLegalHold(ctx context.Context, opts GetObjectExactVersionLegalHold) (_ bool, err error)
- func (s *SpannerAdapter) GetObjectExactVersionRetention(ctx context.Context, opts GetObjectExactVersionRetention) (_ Retention, err error)
- func (s *SpannerAdapter) GetObjectLastCommitted(ctx context.Context, opts GetObjectLastCommitted) (object Object, err error)
- func (s *SpannerAdapter) GetObjectLastCommittedLegalHold(ctx context.Context, opts GetObjectLastCommittedLegalHold) (_ bool, err error)
- func (s *SpannerAdapter) GetObjectLastCommittedRetention(ctx context.Context, opts GetObjectLastCommittedRetention) (_ Retention, err error)
- func (s *SpannerAdapter) GetSegmentByPosition(ctx context.Context, opts GetSegmentByPosition) (segment Segment, aliasPieces AliasPieces, err error)
- func (s *SpannerAdapter) GetSegmentPositionsAndKeys(ctx context.Context, streamID uuid.UUID) (keysNonces []EncryptedKeyAndNonce, err error)
- func (s *SpannerAdapter) GetStreamPieceCountByAlias(ctx context.Context, opts GetStreamPieceCountByNodeID) (result map[NodeAlias]int64, err error)
- func (s *SpannerAdapter) GetTableStats(ctx context.Context, opts GetTableStats) (result TableStats, err error)
- func (s *SpannerAdapter) Implementation() dbutil.Implementation
- func (s *SpannerAdapter) IterateLoopSegments(ctx context.Context, aliasCache *NodeAliasCache, opts IterateLoopSegments, ...) (err error)
- func (s *SpannerAdapter) ListBucketsStreamIDs(ctx context.Context, opts ListBucketsStreamIDs, bucketNamesBytes [][]byte, ...) (result ListBucketsStreamIDsResult, err error)
- func (s *SpannerAdapter) ListNodeAliases(ctx context.Context) (aliases []NodeAliasEntry, err error)
- func (s *SpannerAdapter) ListObjects(ctx context.Context, opts ListObjects) (result ListObjectsResult, err error)
- func (s *SpannerAdapter) ListSegments(ctx context.Context, opts ListSegments, aliasCache *NodeAliasCache) (result ListSegmentsResult, err error)
- func (s *SpannerAdapter) ListStreamPositions(ctx context.Context, opts ListStreamPositions) (result ListStreamPositionsResult, err error)
- func (s *SpannerAdapter) MigrateToLatest(ctx context.Context) error
- func (s *SpannerAdapter) Name() string
- func (s *SpannerAdapter) Now(ctx context.Context) (time.Time, error)
- func (s *SpannerAdapter) PendingObjectExists(ctx context.Context, opts BeginSegment) (exists bool, err error)
- func (s *SpannerAdapter) Ping(ctx context.Context) error
- func (s *SpannerAdapter) SetObjectExactVersionLegalHold(ctx context.Context, opts SetObjectExactVersionLegalHold) (err error)
- func (s *SpannerAdapter) SetObjectExactVersionRetention(ctx context.Context, opts SetObjectExactVersionRetention) (err error)
- func (s *SpannerAdapter) SetObjectLastCommittedLegalHold(ctx context.Context, opts SetObjectLastCommittedLegalHold) (err error)
- func (s *SpannerAdapter) SetObjectLastCommittedRetention(ctx context.Context, opts SetObjectLastCommittedRetention) (err error)
- func (s *SpannerAdapter) SpannerMigration() *migrate.Migration
- func (s *SpannerAdapter) TestMigrateToLatest(ctx context.Context) error
- func (s *SpannerAdapter) TestingBatchInsertObjects(ctx context.Context, objects []RawObject) (err error)
- func (s *SpannerAdapter) TestingBatchInsertSegments(ctx context.Context, aliasCache *NodeAliasCache, segments []RawSegment) (err error)
- func (s *SpannerAdapter) TestingBeginObjectExactVersion(ctx context.Context, opts BeginObjectExactVersion, object *Object) error
- func (s *SpannerAdapter) TestingDeleteAll(ctx context.Context) (err error)
- func (s *SpannerAdapter) TestingGetAllObjects(ctx context.Context) (_ []RawObject, err error)
- func (s *SpannerAdapter) TestingGetAllSegments(ctx context.Context, aliasCache *NodeAliasCache) (segments []RawSegment, err error)
- func (s *SpannerAdapter) TestingSetObjectVersion(ctx context.Context, object ObjectStream, randomVersion Version) (rowsAffected int64, err error)
- func (s *SpannerAdapter) TestingSetPlacementAllSegments(ctx context.Context, placement storj.PlacementConstraint) (err error)
- func (s *SpannerAdapter) UnderlyingDB() *spanner.Client
- func (s *SpannerAdapter) UpdateObjectLastCommittedMetadata(ctx context.Context, opts UpdateObjectLastCommittedMetadata) (affected int64, err error)
- func (s *SpannerAdapter) UpdateSegmentPieces(ctx context.Context, opts UpdateSegmentPieces, ...) (resultPieces AliasPieces, err error)
- func (s *SpannerAdapter) UpdateTableStats(ctx context.Context) error
- func (s *SpannerAdapter) WithTx(ctx context.Context, f func(context.Context, TransactionAdapter) error) error
- type SpannerConfig
- type SpannerTestDatabase
- type StreamIDCursor
- type StreamRange
- type StreamVersionID
- type TableStats
- type TestingPrecommitDeleteMode
- type TransactionAdapter
- type UpdateObjectLastCommittedMetadata
- type UpdateSegmentPieces
- type Version
Constants ¶
const ( Delimiter = '/' LastSegmentName = "l" LastSegmentIndex = uint32(math.MaxUint32) )
Common constants for segment keys.
const ( // Pending means that the object is being uploaded or that the client failed during upload. // The failed upload may be continued in the future. Pending = ObjectStatus(1) // CommittedUnversioned means that the object is finished and should be visible for general listing. CommittedUnversioned = ObjectStatus(3) // CommittedVersioned means that the object is finished and should be visible for general listing. CommittedVersioned = ObjectStatus(4) // DeleteMarkerVersioned is inserted when an object is deleted in a versioning enabled bucket. DeleteMarkerVersioned = ObjectStatus(5) // DeleteMarkerUnversioned is inserted when an unversioned object is deleted in a versioning suspended bucket. DeleteMarkerUnversioned = ObjectStatus(6) // Prefix is an ephemeral status used during non-recursive listing. Prefix = ObjectStatus(7) )
const CopySegmentLimit = int64(10000)
CopySegmentLimit is the maximum number of segments that can be copied.
const DefaultVersion = Version(1)
DefaultVersion represents default version 1.
const DelimiterNext = "0"
DelimiterNext is the string that comes immediately after Delimiter="/".
const ListLimit = intLimitRange(1000)
ListLimit is the maximum number of items the client can request for listing.
const ListVerifyLimit = intLimitRange(100000)
ListVerifyLimit is the maximum number of items the client can request for listing.
const MaxVersion = Version(math.MaxInt64 - 64)
MaxVersion represents maximum version. Version in DB is represented as INT8.
It uses `MaxInt64 - 64` to avoid issues with `-MaxVersion`.
const MoveSegmentLimit = int64(10000)
MoveSegmentLimit is the maximum number of segments that can be moved.
const NextVersion = Version(0)
NextVersion means that the version should be chosen automatically.
const PendingVersion = Version(0)
PendingVersion represents version that is used for pending objects (with UsePendingObjects).
const ValidatePlainSize = false
ValidatePlainSize determines whether we disable PlainSize validation for old uplinks.
Variables ¶
var ( // ErrObjectNotFound is used to indicate that the object does not exist. ErrObjectNotFound = errs.Class("object not found") // ErrInvalidRequest is used to indicate invalid requests. ErrInvalidRequest = errs.Class("metabase: invalid request") // ErrFailedPrecondition is used to indicate that some conditions in the request has failed. ErrFailedPrecondition = errs.Class("metabase: failed precondition") // ErrConflict is used to indicate conflict with the request. ErrConflict = errs.Class("metabase: conflict") )
var ( // Error is the default error for metabase. Error = errs.Class("metabase") // ErrObjectAlreadyExists is used to indicate that object already exists. ErrObjectAlreadyExists = errs.Class("object already exists") // ErrPendingObjectMissing is used to indicate a pending object is no longer accessible. ErrPendingObjectMissing = errs.Class("pending object missing") // ErrPermissionDenied general error for denying permission. ErrPermissionDenied = errs.Class("permission denied") // ErrMethodNotAllowed general error when operation is not allowed. ErrMethodNotAllowed = errs.Class("method not allowed") )
var ( // ErrValueChanged is returned when the current value of the key does not match the oldValue in UpdateSegmentPieces. ErrValueChanged = errs.Class("value changed") // ErrObjectExpiration is used when an object's expiration prevents an operation from succeeding. ErrObjectExpiration = errs.Class("object expiration") // ErrObjectStatus is used when an object's status prevents an operation from succeeding. ErrObjectStatus = errs.Class("object status") )
var ( // ErrObjectLock is used when an object's Object Lock configuration prevents // an operation from succeeding. ErrObjectLock = errs.Class("object lock") )
var ErrSegmentNotFound = errs.Class("segment not found")
ErrSegmentNotFound is an error class for non-existing segment.
var PrecommitDeleteModes = []TestingPrecommitDeleteMode{ DefaultUnversionedPrecommitMode, WithPrecheckSQLUnversionedPrecommitMode, WithVersionPrecheckUnversionedPrecommitMode, }
PrecommitDeleteModes is a list of all possible precommit delete modes.
Functions ¶
func EqualAliasPieces ¶
func EqualAliasPieces(xs, ys AliasPieces) bool
EqualAliasPieces compares whether xs and ys are equal.
func LessObjectKey ¶ added in v1.106.1
LessObjectKey returns whether a < b.
func LimitedAsOfSystemTime ¶ added in v1.106.1
func LimitedAsOfSystemTime(impl dbutil.Implementation, now, baseline time.Time, maxInterval time.Duration) string
LimitedAsOfSystemTime returns a SQL query clause for AS OF SYSTEM TIME.
func SpannerTestModule ¶ added in v1.103.2
SpannerTestModule adds all the required dependencies for Spanner migration and adapter.
Types ¶
type Adapter ¶ added in v1.102.2
type Adapter interface { Name() string Now(ctx context.Context) (time.Time, error) Ping(ctx context.Context) error MigrateToLatest(ctx context.Context) error CheckVersion(ctx context.Context) error Implementation() dbutil.Implementation BeginObjectNextVersion(context.Context, BeginObjectNextVersion, *Object) error GetObjectLastCommitted(ctx context.Context, opts GetObjectLastCommitted) (Object, error) IterateLoopSegments(ctx context.Context, aliasCache *NodeAliasCache, opts IterateLoopSegments, fn func(context.Context, LoopSegmentsIterator) error) error PendingObjectExists(ctx context.Context, opts BeginSegment) (exists bool, err error) CommitPendingObjectSegment(ctx context.Context, opts CommitSegment, aliasPieces AliasPieces) error CommitInlineSegment(ctx context.Context, opts CommitInlineSegment) error TestingBeginObjectExactVersion(ctx context.Context, opts BeginObjectExactVersion, object *Object) error GetObjectExactVersionRetention(ctx context.Context, opts GetObjectExactVersionRetention) (retention Retention, err error) GetObjectLastCommittedRetention(ctx context.Context, opts GetObjectLastCommittedRetention) (retention Retention, err error) SetObjectExactVersionRetention(ctx context.Context, opts SetObjectExactVersionRetention) error SetObjectLastCommittedRetention(ctx context.Context, opts SetObjectLastCommittedRetention) error GetObjectExactVersionLegalHold(ctx context.Context, opts GetObjectExactVersionLegalHold) (enabled bool, err error) GetObjectLastCommittedLegalHold(ctx context.Context, opts GetObjectLastCommittedLegalHold) (enabled bool, err error) SetObjectExactVersionLegalHold(ctx context.Context, opts SetObjectExactVersionLegalHold) error SetObjectLastCommittedLegalHold(ctx context.Context, opts SetObjectLastCommittedLegalHold) error GetTableStats(ctx context.Context, opts GetTableStats) (result TableStats, err error) UpdateTableStats(ctx context.Context) error BucketEmpty(ctx context.Context, opts BucketEmpty) (empty bool, err error) WithTx(ctx context.Context, f func(context.Context, TransactionAdapter) error) error CollectBucketTallies(ctx context.Context, opts CollectBucketTallies) (result []BucketTally, err error) GetSegmentByPosition(ctx context.Context, opts GetSegmentByPosition) (segment Segment, aliasPieces AliasPieces, err error) GetObjectExactVersion(ctx context.Context, opts GetObjectExactVersion) (_ Object, err error) GetSegmentPositionsAndKeys(ctx context.Context, streamID uuid.UUID) (keysNonces []EncryptedKeyAndNonce, err error) GetLatestObjectLastSegment(ctx context.Context, opts GetLatestObjectLastSegment) (segment Segment, aliasPieces AliasPieces, err error) ListObjects(ctx context.Context, opts ListObjects) (result ListObjectsResult, err error) ListSegments(ctx context.Context, opts ListSegments, aliasCache *NodeAliasCache) (result ListSegmentsResult, err error) ListStreamPositions(ctx context.Context, opts ListStreamPositions) (result ListStreamPositionsResult, err error) ListBucketsStreamIDs(ctx context.Context, opts ListBucketsStreamIDs, bucketNamesBytes [][]byte, projectIDs []uuid.UUID) (result ListBucketsStreamIDsResult, err error) UpdateSegmentPieces(ctx context.Context, opts UpdateSegmentPieces, oldPieces, newPieces AliasPieces) (resultPieces AliasPieces, err error) UpdateObjectLastCommittedMetadata(ctx context.Context, opts UpdateObjectLastCommittedMetadata) (affected int64, err error) DeleteObjectExactVersion(ctx context.Context, opts DeleteObjectExactVersion) (result DeleteObjectResult, err error) DeletePendingObject(ctx context.Context, opts DeletePendingObject) (result DeleteObjectResult, err error) DeleteObjectLastCommittedPlain(ctx context.Context, opts DeleteObjectLastCommitted) (result DeleteObjectResult, err error) DeleteObjectLastCommittedSuspended(ctx context.Context, opts DeleteObjectLastCommitted, deleterMarkerStreamID uuid.UUID) (result DeleteObjectResult, err error) DeleteObjectLastCommittedVersioned(ctx context.Context, opts DeleteObjectLastCommitted, deleterMarkerStreamID uuid.UUID) (result DeleteObjectResult, err error) FindExpiredObjects(ctx context.Context, opts DeleteExpiredObjects, startAfter ObjectStream, batchSize int) (expiredObjects []ObjectStream, err error) DeleteObjectsAndSegments(ctx context.Context, objects []ObjectStream) (objectsDeleted, segmentsDeleted int64, err error) FindZombieObjects(ctx context.Context, opts DeleteZombieObjects, startAfter ObjectStream, batchSize int) (objects []ObjectStream, err error) DeleteInactiveObjectsAndSegments(ctx context.Context, objects []ObjectStream, opts DeleteZombieObjects) (objectsDeleted, segmentsDeleted int64, err error) DeleteBucketObjects(ctx context.Context, opts DeleteBucketObjects) (deletedObjectCount, deletedSegmentCount int64, err error) EnsureNodeAliases(ctx context.Context, opts EnsureNodeAliases) error ListNodeAliases(ctx context.Context) (entries []NodeAliasEntry, err error) GetNodeAliasEntries(ctx context.Context, opts GetNodeAliasEntries) (entries []NodeAliasEntry, err error) GetStreamPieceCountByAlias(ctx context.Context, opts GetStreamPieceCountByNodeID) (result map[NodeAlias]int64, err error) TestingBatchInsertSegments(ctx context.Context, aliasCache *NodeAliasCache, segments []RawSegment) (err error) TestingGetAllObjects(ctx context.Context) (_ []RawObject, err error) TestingGetAllSegments(ctx context.Context, aliasCache *NodeAliasCache) (_ []RawSegment, err error) TestingDeleteAll(ctx context.Context) (err error) TestingBatchInsertObjects(ctx context.Context, objects []RawObject) (err error) TestingSetObjectVersion(ctx context.Context, object ObjectStream, randomVersion Version) (rowsAffected int64, err error) TestingSetPlacementAllSegments(ctx context.Context, placement storj.PlacementConstraint) (err error) // TestMigrateToLatest creates a database and applies all the migration for test purposes. TestMigrateToLatest(ctx context.Context) error // contains filtered or unexported methods }
Adapter is a low level extension point to use datasource related queries. TODO: we may need separated adapter for segments/objects/etc.
type AliasPiece ¶
AliasPiece is a piece with alias node ID.
type AliasPieces ¶
type AliasPieces []AliasPiece
AliasPieces is a slice of AliasPiece.
func (AliasPieces) Bytes ¶
func (aliases AliasPieces) Bytes() ([]byte, error)
Bytes compresses alias pieces to a slice of bytes.
func (*AliasPieces) DecodeSpanner ¶ added in v1.103.2
func (aliases *AliasPieces) DecodeSpanner(val any) (err error)
DecodeSpanner implements spanner.Decoder.
func (AliasPieces) EncodeSpanner ¶ added in v1.103.2
func (aliases AliasPieces) EncodeSpanner() (any, error)
EncodeSpanner implements spanner.Encoder.
func (*AliasPieces) Scan ¶
func (aliases *AliasPieces) Scan(src any) error
Scan implements the database/sql Scanner interface.
func (*AliasPieces) SetBytes ¶
func (aliases *AliasPieces) SetBytes(data []byte) error
SetBytes decompresses alias pieces from a slice of bytes.
type BeginCopyObject ¶ added in v1.50.1
type BeginCopyObject struct { ObjectLocation Version Version // VerifyLimits holds a callback by which the caller can interrupt the copy // if it turns out the copy would exceed a limit. VerifyLimits func(encryptedObjectSize int64, nSegments int64) error }
BeginCopyObject holds all data needed begin copy object method.
type BeginCopyObjectResult ¶ added in v1.50.1
type BeginCopyObjectResult BeginMoveCopyResults
BeginCopyObjectResult holds data needed to begin copy object.
type BeginMoveCopyResults ¶ added in v1.65.1
type BeginMoveCopyResults struct { StreamID uuid.UUID Version Version EncryptedMetadata []byte EncryptedMetadataKeyNonce []byte EncryptedMetadataKey []byte EncryptedKeysNonces []EncryptedKeyAndNonce EncryptionParameters storj.EncryptionParameters }
BeginMoveCopyResults holds all data needed to begin move and copy object methods.
type BeginMoveObject ¶ added in v1.39.4
type BeginMoveObject struct {
ObjectLocation
}
BeginMoveObject holds all data needed begin move object method.
type BeginMoveObjectResult ¶ added in v1.39.4
type BeginMoveObjectResult BeginMoveCopyResults
BeginMoveObjectResult holds data needed to begin move object.
type BeginObjectExactVersion ¶
type BeginObjectExactVersion struct { ObjectStream ExpiresAt *time.Time ZombieDeletionDeadline *time.Time EncryptedMetadata []byte // optional EncryptedMetadataNonce []byte // optional EncryptedMetadataEncryptedKey []byte // optional Encryption storj.EncryptionParameters Retention Retention // optional LegalHold bool // TestingBypassVerify makes the (*DB).TestingBeginObjectExactVersion method skip // validation of this struct's fields. This is useful for inserting intentionally // malformed or unexpected data into the database and testing that we handle it properly. TestingBypassVerify bool }
BeginObjectExactVersion contains arguments necessary for starting an object upload.
func (*BeginObjectExactVersion) Verify ¶ added in v1.43.1
func (opts *BeginObjectExactVersion) Verify() error
Verify verifies get object reqest fields.
type BeginObjectNextVersion ¶
type BeginObjectNextVersion struct { ObjectStream ExpiresAt *time.Time ZombieDeletionDeadline *time.Time EncryptedMetadata []byte // optional EncryptedMetadataNonce []byte // optional EncryptedMetadataEncryptedKey []byte // optional Encryption storj.EncryptionParameters Retention Retention // optional LegalHold bool }
BeginObjectNextVersion contains arguments necessary for starting an object upload.
func (*BeginObjectNextVersion) Verify ¶ added in v1.43.1
func (opts *BeginObjectNextVersion) Verify() error
Verify verifies get object request fields.
type BeginSegment ¶
type BeginSegment struct { ObjectStream Position SegmentPosition // TODO: unused field, can remove RootPieceID storj.PieceID Pieces Pieces ObjectExistsChecked bool }
BeginSegment contains options to verify, whether a new segment upload can be started.
type BucketEmpty ¶
type BucketEmpty struct { ProjectID uuid.UUID BucketName BucketName }
BucketEmpty contains arguments necessary for checking if bucket is empty.
type BucketLocation ¶
type BucketLocation struct { ProjectID uuid.UUID BucketName BucketName }
BucketLocation defines a bucket that belongs to a project.
func ParseBucketPrefix ¶
func ParseBucketPrefix(prefix BucketPrefix) (BucketLocation, error)
ParseBucketPrefix parses BucketPrefix.
func ParseCompactBucketPrefix ¶
func ParseCompactBucketPrefix(compactPrefix []byte) (BucketLocation, error)
ParseCompactBucketPrefix parses BucketPrefix.
func (BucketLocation) CompactPrefix ¶
func (loc BucketLocation) CompactPrefix() []byte
CompactPrefix converts bucket location into bucket prefix with compact project ID.
func (BucketLocation) Compare ¶ added in v1.107.1
func (loc BucketLocation) Compare(other BucketLocation) int
Compare compares this BucketLocation with another.
func (BucketLocation) Prefix ¶
func (loc BucketLocation) Prefix() BucketPrefix
Prefix converts bucket location into bucket prefix.
func (BucketLocation) Verify ¶
func (loc BucketLocation) Verify() error
Verify object location fields.
type BucketName ¶ added in v1.109.1
type BucketName string
BucketName is a plain-text string, however we should treat it as unsafe bytes to avoid issues with any encoding.
func (BucketName) Compare ¶ added in v1.109.1
func (b BucketName) Compare(x BucketName) int
Compare implements comparison for bucket names.
func (*BucketName) DecodeSpanner ¶ added in v1.109.1
func (b *BucketName) DecodeSpanner(value any) error
DecodeSpanner implements spanner.Decoder.
func (BucketName) EncodeSpanner ¶ added in v1.109.1
func (b BucketName) EncodeSpanner() (any, error)
EncodeSpanner implements spanner.Encoder.
func (*BucketName) Scan ¶ added in v1.109.1
func (b *BucketName) Scan(value interface{}) error
Scan extracts a BucketName from a database field.
func (BucketName) String ¶ added in v1.109.1
func (b BucketName) String() string
String implements stringer func.
type BucketTally ¶ added in v1.66.1
type BucketTally struct { BucketLocation ObjectCount int64 PendingObjectCount int64 TotalSegments int64 TotalBytes int64 MetadataSize int64 }
BucketTally contains information about aggregate data stored in a bucket.
type CockroachAdapter ¶ added in v1.102.2
type CockroachAdapter struct {
PostgresAdapter
}
CockroachAdapter uses Cockroach related SQL queries.
func (*CockroachAdapter) CommitInlineSegment ¶ added in v1.105.2
func (p *CockroachAdapter) CommitInlineSegment(ctx context.Context, opts CommitInlineSegment) (err error)
CommitInlineSegment commits inline segment to the database.
func (*CockroachAdapter) CommitPendingObjectSegment ¶ added in v1.104.1
func (p *CockroachAdapter) CommitPendingObjectSegment(ctx context.Context, opts CommitSegment, aliasPieces AliasPieces) (err error)
CommitPendingObjectSegment commits segment to the database.
func (*CockroachAdapter) DeleteBucketObjects ¶ added in v1.107.1
func (c *CockroachAdapter) DeleteBucketObjects(ctx context.Context, opts DeleteBucketObjects) (deletedObjectCount, deletedSegmentCount int64, err error)
DeleteBucketObjects deletes all objects in the specified bucket. Deletion performs in batches, so in case of error while processing, this method will return the number of objects deleted to the moment when an error occurs.
func (*CockroachAdapter) GetTableStats ¶ added in v1.104.1
func (c *CockroachAdapter) GetTableStats(ctx context.Context, opts GetTableStats) (result TableStats, err error)
GetTableStats implements Adapter.
func (*CockroachAdapter) IterateLoopSegments ¶ added in v1.114.5
func (c *CockroachAdapter) IterateLoopSegments(ctx context.Context, aliasCache *NodeAliasCache, opts IterateLoopSegments, fn func(context.Context, LoopSegmentsIterator) error) (err error)
IterateLoopSegments implements Adapter.
func (*CockroachAdapter) MigrateToLatest ¶ added in v1.112.2
func (c *CockroachAdapter) MigrateToLatest(ctx context.Context) error
MigrateToLatest migrates database to the latest version.
func (*CockroachAdapter) Name ¶ added in v1.106.1
func (c *CockroachAdapter) Name() string
Name returns the name of the adapter.
func (*CockroachAdapter) TestMigrateToLatest ¶ added in v1.110.1
func (c *CockroachAdapter) TestMigrateToLatest(ctx context.Context) error
TestMigrateToLatest creates a database and applies all the migration for test purposes.
func (*CockroachAdapter) UpdateTableStats ¶ added in v1.107.1
func (c *CockroachAdapter) UpdateTableStats(ctx context.Context) error
UpdateTableStats forces an update of table statistics. Probably useful mostly in test scenarios.
type CollectBucketTallies ¶ added in v1.66.1
type CollectBucketTallies struct { From BucketLocation To BucketLocation AsOfSystemTime time.Time AsOfSystemInterval time.Duration Now time.Time }
CollectBucketTallies contains arguments necessary for looping through objects in metabase.
func (*CollectBucketTallies) Verify ¶ added in v1.66.1
func (opts *CollectBucketTallies) Verify() error
Verify verifies CollectBucketTallies request fields.
type CommitInlineObject ¶ added in v1.106.1
type CommitInlineObject struct { ObjectStream CommitInlineSegment ExpiresAt *time.Time Encryption storj.EncryptionParameters EncryptedMetadata []byte // optional EncryptedMetadataNonce []byte // optional EncryptedMetadataEncryptedKey []byte // optional Retention Retention // optional LegalHold bool DisallowDelete bool // Versioned indicates whether an object is allowed to have multiple versions. Versioned bool }
CommitInlineObject contains arguments necessary for committing an inline object.
func (*CommitInlineObject) Verify ¶ added in v1.106.1
func (c *CommitInlineObject) Verify() error
Verify verifies reqest fields.
type CommitInlineSegment ¶
type CommitInlineSegment struct { ObjectStream Position SegmentPosition ExpiresAt *time.Time EncryptedKeyNonce []byte EncryptedKey []byte PlainOffset int64 // offset in the original data stream PlainSize int32 // size before encryption EncryptedETag []byte InlineData []byte }
CommitInlineSegment contains all necessary information about the segment.
func (CommitInlineSegment) Verify ¶ added in v1.106.1
func (opts CommitInlineSegment) Verify() error
Verify verifies commit inline segment reqest fields.
type CommitObject ¶
type CommitObject struct { ObjectStream Encryption storj.EncryptionParameters // this flag controls if we want to set metadata fields with CommitObject // it's possible to set metadata with BeginObject request so we need to // be explicit if we would like to set it with CommitObject which will // override any existing metadata. OverrideEncryptedMetadata bool EncryptedMetadata []byte // optional EncryptedMetadataNonce []byte // optional EncryptedMetadataEncryptedKey []byte // optional DisallowDelete bool // Versioned indicates whether an object is allowed to have multiple versions. Versioned bool }
CommitObject contains arguments necessary for committing an object.
func (*CommitObject) Verify ¶ added in v1.43.1
func (c *CommitObject) Verify() error
Verify verifies request fields.
type CommitObjectWithSegments ¶
type CommitObjectWithSegments struct { ObjectStream EncryptedMetadata []byte EncryptedMetadataNonce []byte EncryptedMetadataEncryptedKey []byte // TODO: this probably should use segment ranges rather than individual items Segments []SegmentPosition // DisallowDelete indicates whether the user is allowed to overwrite // the previous unversioned object. DisallowDelete bool // Versioned indicates whether an object is allowed to have multiple versions. Versioned bool }
CommitObjectWithSegments contains arguments necessary for committing an object.
TODO: not ready for production.
type CommitSegment ¶
type CommitSegment struct { ObjectStream Position SegmentPosition RootPieceID storj.PieceID ExpiresAt *time.Time EncryptedKeyNonce []byte EncryptedKey []byte PlainOffset int64 // offset in the original data stream PlainSize int32 // size before encryption EncryptedSize int32 // segment size after encryption EncryptedETag []byte Redundancy storj.RedundancyScheme Pieces Pieces Placement storj.PlacementConstraint }
CommitSegment contains all necessary information about the segment.
type Config ¶ added in v1.42.2
type Config struct { ApplicationName string MinPartSize memory.Size MaxNumberOfParts int // TODO remove this flag when server-side copy implementation will be finished ServerSideCopy bool ServerSideCopyDisabled bool UseListObjectsIterator bool NodeAliasCacheFullRefresh bool TestingUniqueUnversioned bool TestingPrecommitDeleteMode TestingPrecommitDeleteMode TestingSpannerProjects map[uuid.UUID]struct{} }
Config is a configuration struct for part validation.
type DB ¶
type DB struct {
// contains filtered or unexported fields
}
DB implements a database for storing objects and segments.
func (*DB) BeginCopyObject ¶ added in v1.50.1
func (db *DB) BeginCopyObject(ctx context.Context, opts BeginCopyObject) (_ BeginCopyObjectResult, err error)
BeginCopyObject collects all data needed to begin object copy procedure.
func (*DB) BeginMoveObject ¶ added in v1.39.4
func (db *DB) BeginMoveObject(ctx context.Context, opts BeginMoveObject) (_ BeginMoveObjectResult, err error)
BeginMoveObject collects all data needed to begin object move procedure.
func (*DB) BeginObjectNextVersion ¶
func (db *DB) BeginObjectNextVersion(ctx context.Context, opts BeginObjectNextVersion) (object Object, err error)
BeginObjectNextVersion adds a pending object to the database, with automatically assigned version.
func (*DB) BeginSegment ¶
func (db *DB) BeginSegment(ctx context.Context, opts BeginSegment) (err error)
BeginSegment verifies, whether a new segment upload can be started.
func (*DB) BucketEmpty ¶
BucketEmpty returns true if bucket does not contain objects (pending or committed). This method doesn't check bucket existence.
func (*DB) CheckVersion ¶
CheckVersion checks the database is the correct version.
func (*DB) ChooseAdapter ¶ added in v1.102.2
ChooseAdapter selects the right adapter based on configuration.
func (*DB) CollectBucketTallies ¶ added in v1.66.1
func (db *DB) CollectBucketTallies(ctx context.Context, opts CollectBucketTallies) (result []BucketTally, err error)
CollectBucketTallies collect limited bucket tallies from given bucket locations.
func (*DB) CommitInlineObject ¶ added in v1.106.1
func (db *DB) CommitInlineObject(ctx context.Context, opts CommitInlineObject) (object Object, err error)
CommitInlineObject adds full inline object to the database. If another committed object is under target location it will be deleted.
func (*DB) CommitInlineSegment ¶
func (db *DB) CommitInlineSegment(ctx context.Context, opts CommitInlineSegment) (err error)
CommitInlineSegment commits inline segment to the database.
func (*DB) CommitObject ¶
CommitObject adds a pending object to the database. If another committed object is under target location it will be deleted.
func (*DB) CommitObjectWithSegments ¶
func (db *DB) CommitObjectWithSegments(ctx context.Context, opts CommitObjectWithSegments) (object Object, err error)
CommitObjectWithSegments commits pending object to the database.
TODO: not ready for production.
func (*DB) CommitSegment ¶
func (db *DB) CommitSegment(ctx context.Context, opts CommitSegment) (err error)
CommitSegment commits segment to the database.
func (*DB) DeleteBucketObjects ¶
func (db *DB) DeleteBucketObjects(ctx context.Context, opts DeleteBucketObjects) (deletedObjectCount int64, err error)
DeleteBucketObjects deletes all objects in the specified bucket. Deletion performs in batches, so in case of error while processing, this method will return the number of objects deleted to the moment when an error occurs.
func (*DB) DeleteExpiredObjects ¶
func (db *DB) DeleteExpiredObjects(ctx context.Context, opts DeleteExpiredObjects) (err error)
DeleteExpiredObjects deletes all objects that expired before expiredBefore.
func (*DB) DeleteObjectExactVersion ¶
func (db *DB) DeleteObjectExactVersion(ctx context.Context, opts DeleteObjectExactVersion) (result DeleteObjectResult, err error)
DeleteObjectExactVersion deletes an exact object version.
func (*DB) DeleteObjectLastCommitted ¶ added in v1.63.1
func (db *DB) DeleteObjectLastCommitted( ctx context.Context, opts DeleteObjectLastCommitted, ) (result DeleteObjectResult, err error)
DeleteObjectLastCommitted deletes an object last committed version.
func (*DB) DeletePendingObject ¶
func (db *DB) DeletePendingObject(ctx context.Context, opts DeletePendingObject) (result DeleteObjectResult, err error)
DeletePendingObject deletes a pending object with specified version and streamID.
func (*DB) DeleteZombieObjects ¶ added in v1.30.1
func (db *DB) DeleteZombieObjects(ctx context.Context, opts DeleteZombieObjects) (err error)
DeleteZombieObjects deletes all objects that zombie deletion deadline passed. TODO will be removed when objects table will be free from pending objects.
func (*DB) DestroyTables ¶
DestroyTables deletes all tables.
TODO: remove this, only for bootstrapping.
func (*DB) EnsureNodeAliases ¶
func (db *DB) EnsureNodeAliases(ctx context.Context, opts EnsureNodeAliases) (err error)
EnsureNodeAliases ensures that the supplied node ID-s have a alias. It's safe to concurrently try and create node ID-s for the same NodeID.
func (*DB) FinishCopyObject ¶ added in v1.50.1
func (db *DB) FinishCopyObject(ctx context.Context, opts FinishCopyObject) (object Object, err error)
FinishCopyObject accepts new encryption keys for copied object and insert the corresponding new object ObjectKey and segments EncryptedKey. It returns the object at the destination location.
func (*DB) FinishMoveObject ¶ added in v1.40.3
func (db *DB) FinishMoveObject(ctx context.Context, opts FinishMoveObject) (err error)
FinishMoveObject accepts new encryption keys for moved object and updates the corresponding object ObjectKey and segments EncryptedKey.
func (*DB) GetLatestObjectLastSegment ¶
func (db *DB) GetLatestObjectLastSegment(ctx context.Context, opts GetLatestObjectLastSegment) (segment Segment, err error)
GetLatestObjectLastSegment returns an object last segment information.
func (*DB) GetNodeAliasEntries ¶ added in v1.108.1
func (db *DB) GetNodeAliasEntries(ctx context.Context, opts GetNodeAliasEntries) (entries []NodeAliasEntry, err error)
GetNodeAliasEntries fetches node aliases or ID-s for the specified nodes and aliases in random order.
func (*DB) GetObjectExactVersion ¶
func (db *DB) GetObjectExactVersion(ctx context.Context, opts GetObjectExactVersion) (_ Object, err error)
GetObjectExactVersion returns object information for exact version.
func (*DB) GetObjectExactVersionLegalHold ¶ added in v1.113.1
func (db *DB) GetObjectExactVersionLegalHold(ctx context.Context, opts GetObjectExactVersionLegalHold) (enabled bool, err error)
GetObjectExactVersionLegalHold returns the legal hold configuration of an exact version of an object.
func (*DB) GetObjectExactVersionRetention ¶ added in v1.110.1
func (db *DB) GetObjectExactVersionRetention(ctx context.Context, opts GetObjectExactVersionRetention) (retention Retention, err error)
GetObjectExactVersionRetention returns the retention configuration of an exact version of an object.
func (*DB) GetObjectLastCommitted ¶ added in v1.62.1
func (db *DB) GetObjectLastCommitted(ctx context.Context, opts GetObjectLastCommitted) (_ Object, err error)
GetObjectLastCommitted returns object information for last committed version.
func (*DB) GetObjectLastCommittedLegalHold ¶ added in v1.113.1
func (db *DB) GetObjectLastCommittedLegalHold(ctx context.Context, opts GetObjectLastCommittedLegalHold) (enabled bool, err error)
GetObjectLastCommittedLegalHold returns the legal hold configuration of the most recently committed version of an object.
func (*DB) GetObjectLastCommittedRetention ¶ added in v1.110.1
func (db *DB) GetObjectLastCommittedRetention(ctx context.Context, opts GetObjectLastCommittedRetention) (retention Retention, err error)
GetObjectLastCommittedRetention returns the retention configuration of the most recently committed version of an object.
func (*DB) GetSegmentByPosition ¶
func (db *DB) GetSegmentByPosition(ctx context.Context, opts GetSegmentByPosition) (segment Segment, err error)
GetSegmentByPosition returns information about segment on the specified position.
func (*DB) GetStreamPieceCountByNodeID ¶
func (db *DB) GetStreamPieceCountByNodeID(ctx context.Context, opts GetStreamPieceCountByNodeID) (result map[storj.NodeID]int64, err error)
GetStreamPieceCountByNodeID returns piece count by node id.
func (*DB) GetTableStats ¶ added in v1.32.2
func (db *DB) GetTableStats(ctx context.Context, opts GetTableStats) (result TableStats, err error)
GetTableStats gathers information about the metabase tables, currently only "segments" table.
func (*DB) Implementation ¶ added in v1.32.2
func (db *DB) Implementation() dbutil.Implementation
Implementation returns the implementation for the first db adapter. TODO: remove this.
func (*DB) IterateLoopSegments ¶ added in v1.31.1
func (db *DB) IterateLoopSegments(ctx context.Context, opts IterateLoopSegments, fn func(context.Context, LoopSegmentsIterator) error) (err error)
IterateLoopSegments iterates through all segments in metabase.
func (*DB) IterateObjectsAllVersionsWithStatus ¶
func (db *DB) IterateObjectsAllVersionsWithStatus(ctx context.Context, opts IterateObjectsWithStatus, fn func(context.Context, ObjectsIterator) error) (err error)
IterateObjectsAllVersionsWithStatus iterates through all versions of all objects with specified status.
func (*DB) IterateObjectsAllVersionsWithStatusAscending ¶ added in v1.96.4
func (db *DB) IterateObjectsAllVersionsWithStatusAscending(ctx context.Context, opts IterateObjectsWithStatus, fn func(context.Context, ObjectsIterator) error) (err error)
IterateObjectsAllVersionsWithStatusAscending iterates through all versions of all objects with specified status. Ordered from oldest to latest. TODO this method was copied (and renamed) from v1.95.1 as a workaround for issues with metabase.ListObject performance. It should be removed when problem with metabase.ListObject will be fixed.
func (*DB) IteratePendingObjectsByKey ¶
func (db *DB) IteratePendingObjectsByKey(ctx context.Context, opts IteratePendingObjectsByKey, fn func(context.Context, ObjectsIterator) error) (err error)
IteratePendingObjectsByKey iterates through all streams of pending objects with the same ObjectKey.
func (*DB) LatestNodesAliasMap ¶ added in v1.66.1
func (db *DB) LatestNodesAliasMap(ctx context.Context) (_ *NodeAliasMap, err error)
LatestNodesAliasMap returns the latest mapping between storj.NodeID and NodeAlias.
func (*DB) ListBucketsStreamIDs ¶ added in v1.70.1
func (db *DB) ListBucketsStreamIDs(ctx context.Context, opts ListBucketsStreamIDs) (ListBucketsStreamIDsResult, error)
ListBucketsStreamIDs lists the streamIDs of a list of buckets.
func (*DB) ListNodeAliases ¶
func (db *DB) ListNodeAliases(ctx context.Context) (_ []NodeAliasEntry, err error)
ListNodeAliases lists all node alias mappings.
func (*DB) ListObjects ¶ added in v1.65.1
func (db *DB) ListObjects(ctx context.Context, opts ListObjects) (result ListObjectsResult, err error)
ListObjects lists objects.
func (*DB) ListObjectsWithIterator ¶ added in v1.102.2
func (db *DB) ListObjectsWithIterator(ctx context.Context, opts ListObjects) (result ListObjectsResult, err error)
ListObjectsWithIterator lists objects.
func (*DB) ListSegments ¶
func (db *DB) ListSegments(ctx context.Context, opts ListSegments) (result ListSegmentsResult, err error)
ListSegments lists specified stream segments.
func (*DB) ListStreamPositions ¶
func (db *DB) ListStreamPositions(ctx context.Context, opts ListStreamPositions) (result ListStreamPositionsResult, err error)
ListStreamPositions lists specified stream segment positions.
func (*DB) MigrateToLatest ¶
MigrateToLatest migrates database to the latest version.
func (*DB) Now ¶ added in v1.30.1
Now returns the current time according to the first database adapter.
func (*DB) PrecommitConstraint ¶ added in v1.106.1
func (db *DB) PrecommitConstraint(ctx context.Context, opts PrecommitConstraint, adapter precommitTransactionAdapter) (result PrecommitConstraintResult, err error)
PrecommitConstraint ensures that only a single uncommitted object exists at the specified location.
func (*DB) SetObjectExactVersionLegalHold ¶ added in v1.113.1
func (db *DB) SetObjectExactVersionLegalHold(ctx context.Context, opts SetObjectExactVersionLegalHold) (err error)
SetObjectExactVersionLegalHold sets the legal hold configuration of an exact version of an object.
func (*DB) SetObjectExactVersionRetention ¶ added in v1.110.1
func (db *DB) SetObjectExactVersionRetention(ctx context.Context, opts SetObjectExactVersionRetention) (err error)
SetObjectExactVersionRetention sets the retention configuration of an exact version of an object.
func (*DB) SetObjectLastCommittedLegalHold ¶ added in v1.113.1
func (db *DB) SetObjectLastCommittedLegalHold(ctx context.Context, opts SetObjectLastCommittedLegalHold) (err error)
SetObjectLastCommittedLegalHold sets the legal hold configuration of the most recently committed version of an object.
func (*DB) SetObjectLastCommittedRetention ¶ added in v1.110.1
func (db *DB) SetObjectLastCommittedRetention(ctx context.Context, opts SetObjectLastCommittedRetention) (err error)
SetObjectLastCommittedRetention sets the retention configuration of the most recently committed version of an object.
func (*DB) TestMigrateToLatest ¶ added in v1.57.1
TestMigrateToLatest replaces the migration steps with only one step to create metabase db. It is applied to all db adapters.
func (*DB) TestingAllObjects ¶
TestingAllObjects gets all objects. Use only for testing purposes.
func (*DB) TestingAllSegments ¶
TestingAllSegments gets all segments. Use only for testing purposes.
func (*DB) TestingBatchInsertObjects ¶ added in v1.98.1
TestingBatchInsertObjects batch inserts objects for testing. This implementation does no verification on the correctness of objects.
func (*DB) TestingBatchInsertSegments ¶ added in v1.102.2
func (db *DB) TestingBatchInsertSegments(ctx context.Context, segments []RawSegment) (err error)
TestingBatchInsertSegments batch inserts segments for testing. This implementation does no verification on the correctness of segments.
func (*DB) TestingBeginObjectExactVersion ¶ added in v1.90.1
func (db *DB) TestingBeginObjectExactVersion(ctx context.Context, opts BeginObjectExactVersion) (committed Object, err error)
TestingBeginObjectExactVersion adds a pending object to the database, with specific version.
func (*DB) TestingDeleteAll ¶
TestingDeleteAll deletes all objects and segments from the database.
func (*DB) TestingGetState ¶
TestingGetState returns the state of the database.
func (*DB) TestingSetCleanup ¶ added in v1.31.1
TestingSetCleanup is used to set the callback for cleaning up test database.
func (*DB) TestingSetObjectVersion ¶ added in v1.112.2
func (db *DB) TestingSetObjectVersion(ctx context.Context, object ObjectStream, randomVersion Version) (rowsAffected int64, err error)
TestingSetObjectVersion sets the version of the object to the given value.
func (*DB) TestingSetPlacementAllSegments ¶ added in v1.112.2
func (db *DB) TestingSetPlacementAllSegments(ctx context.Context, placement storj.PlacementConstraint) (err error)
TestingSetPlacementAllSegments sets the placement of all segments to the given value.
func (*DB) UnderlyingTagSQL ¶
UnderlyingTagSQL returns *tagsql.DB. TODO: remove.
func (*DB) UpdateObjectLastCommittedMetadata ¶ added in v1.91.2
func (db *DB) UpdateObjectLastCommittedMetadata(ctx context.Context, opts UpdateObjectLastCommittedMetadata) (err error)
UpdateObjectLastCommittedMetadata updates an object metadata.
func (*DB) UpdateSegmentPieces ¶
func (db *DB) UpdateSegmentPieces(ctx context.Context, opts UpdateSegmentPieces) (err error)
UpdateSegmentPieces updates pieces for specified segment. If provided old pieces won't match current database state update will fail.
type DeleteBucketObjects ¶
type DeleteBucketObjects struct { Bucket BucketLocation BatchSize int }
DeleteBucketObjects contains arguments for deleting a whole bucket.
type DeleteExpiredObjects ¶
type DeleteExpiredObjects struct { ExpiredBefore time.Time AsOfSystemInterval time.Duration BatchSize int DeleteConcurrency int }
DeleteExpiredObjects contains all the information necessary to delete expired objects and segments.
type DeleteObjectExactVersion ¶
type DeleteObjectExactVersion struct { Version Version ObjectLocation ObjectLock ObjectLockDeleteOptions }
DeleteObjectExactVersion contains arguments necessary for deleting an exact version of object.
func (*DeleteObjectExactVersion) Verify ¶
func (obj *DeleteObjectExactVersion) Verify() error
Verify delete object fields.
type DeleteObjectLastCommitted ¶ added in v1.63.1
type DeleteObjectLastCommitted struct { ObjectLocation Versioned bool Suspended bool ObjectLock ObjectLockDeleteOptions }
DeleteObjectLastCommitted contains arguments necessary for deleting last committed version of object.
func (*DeleteObjectLastCommitted) Verify ¶ added in v1.63.1
func (obj *DeleteObjectLastCommitted) Verify() error
Verify delete object last committed fields.
type DeleteObjectResult ¶
type DeleteObjectResult struct { // Removed contains the list of objects that were removed from the metabase. Removed []Object // Markers contains the delete markers that were added. Markers []Object }
DeleteObjectResult result of deleting object.
type DeletePendingObject ¶
type DeletePendingObject struct {
ObjectStream
}
DeletePendingObject contains arguments necessary for deleting a pending object.
func (*DeletePendingObject) Verify ¶
func (opts *DeletePendingObject) Verify() error
Verify verifies delete pending object fields validity.
type DeleteZombieObjects ¶ added in v1.30.1
type DeleteZombieObjects struct { DeadlineBefore time.Time InactiveDeadline time.Time AsOfSystemInterval time.Duration BatchSize int }
DeleteZombieObjects contains all the information necessary to delete zombie objects and segments.
type EncryptedKeyAndNonce ¶ added in v1.39.4
type EncryptedKeyAndNonce struct { Position SegmentPosition EncryptedKeyNonce []byte EncryptedKey []byte }
EncryptedKeyAndNonce holds single segment position, encrypted key and nonce.
type EnsureNodeAliases ¶
EnsureNodeAliases contains arguments necessary for creating NodeAlias-es.
type FinishCopyObject ¶ added in v1.50.1
type FinishCopyObject struct { ObjectStream NewBucket BucketName NewEncryptedObjectKey ObjectKey NewStreamID uuid.UUID OverrideMetadata bool NewEncryptedMetadata []byte NewEncryptedMetadataKeyNonce storj.Nonce NewEncryptedMetadataKey []byte NewSegmentKeys []EncryptedKeyAndNonce // NewDisallowDelete indicates whether the user is allowed to delete an existing unversioned object. NewDisallowDelete bool // NewVersioned indicates that the object allows multiple versions. NewVersioned bool // Retention indicates retention settings of the object copy. Retention Retention // LegalHold indicates whether the object copy is under legal hold. LegalHold bool // VerifyLimits holds a callback by which the caller can interrupt the copy // if it turns out completing the copy would exceed a limit. // It will be called only once. VerifyLimits func(encryptedObjectSize int64, nSegments int64) error }
FinishCopyObject holds all data needed to finish object copy.
func (FinishCopyObject) NewLocation ¶ added in v1.92.1
func (finishCopy FinishCopyObject) NewLocation() ObjectLocation
NewLocation returns the new object location.
func (FinishCopyObject) Verify ¶ added in v1.50.1
func (finishCopy FinishCopyObject) Verify() error
Verify verifies metabase.FinishCopyObject data.
type FinishMoveObject ¶ added in v1.40.3
type FinishMoveObject struct { ObjectStream NewBucket BucketName NewSegmentKeys []EncryptedKeyAndNonce NewEncryptedObjectKey ObjectKey // Optional. Required if object has metadata. NewEncryptedMetadataKeyNonce storj.Nonce NewEncryptedMetadataKey []byte // NewDisallowDelete indicates whether the user is allowed to delete an existing unversioned object. NewDisallowDelete bool // NewVersioned indicates that the object allows multiple versions. NewVersioned bool // Retention indicates retention settings of the moved object // version. Retention Retention // LegalHold indicates legal hold settings of the moved object // version. LegalHold bool }
FinishMoveObject holds all data needed to finish object move.
func (FinishMoveObject) NewLocation ¶ added in v1.92.1
func (finishMove FinishMoveObject) NewLocation() ObjectLocation
NewLocation returns the new object location.
func (FinishMoveObject) Verify ¶ added in v1.40.3
func (finishMove FinishMoveObject) Verify() error
Verify verifies metabase.FinishMoveObject data.
type GetLatestObjectLastSegment ¶
type GetLatestObjectLastSegment struct {
ObjectLocation
}
GetLatestObjectLastSegment contains arguments necessary for fetching a last segment information.
type GetNodeAliasEntries ¶ added in v1.108.1
GetNodeAliasEntries contains arguments necessary for fetching node alias entries.
type GetObjectExactVersion ¶
type GetObjectExactVersion struct { Version Version ObjectLocation }
GetObjectExactVersion contains arguments necessary for fetching an information about exact object version.
func (*GetObjectExactVersion) Verify ¶
func (obj *GetObjectExactVersion) Verify() error
Verify verifies get object request fields.
type GetObjectExactVersionLegalHold ¶ added in v1.113.1
type GetObjectExactVersionLegalHold struct { ObjectLocation Version Version }
GetObjectExactVersionLegalHold contains arguments necessary for retrieving the legal hold configuration of an exact version of an object.
type GetObjectExactVersionRetention ¶ added in v1.110.1
type GetObjectExactVersionRetention struct { ObjectLocation Version Version }
GetObjectExactVersionRetention contains arguments necessary for retrieving the retention configuration of an exact version of an object.
type GetObjectLastCommitted ¶ added in v1.62.1
type GetObjectLastCommitted struct {
ObjectLocation
}
GetObjectLastCommitted contains arguments necessary for fetching an object information for last committed version.
type GetObjectLastCommittedLegalHold ¶ added in v1.113.1
type GetObjectLastCommittedLegalHold struct {
ObjectLocation
}
GetObjectLastCommittedLegalHold contains arguments necessary for retrieving the legal hold configuration of the most recently committed version of an object.
type GetObjectLastCommittedRetention ¶ added in v1.110.1
type GetObjectLastCommittedRetention struct {
ObjectLocation
}
GetObjectLastCommittedRetention contains arguments necessary for retrieving the retention configuration of the most recently committed version of an object.
type GetSegmentByPosition ¶
type GetSegmentByPosition struct { StreamID uuid.UUID Position SegmentPosition }
GetSegmentByPosition contains arguments necessary for fetching a segment on specific position.
func (*GetSegmentByPosition) Verify ¶
func (seg *GetSegmentByPosition) Verify() error
Verify verifies get segment request fields.
type GetStreamPieceCountByNodeID ¶
GetStreamPieceCountByNodeID contains arguments for GetStreamPieceCountByNodeID.
type GetTableStats ¶ added in v1.32.2
GetTableStats contains arguments necessary for getting table statistics.
type IterateCursor ¶
IterateCursor is a cursor used during iteration through objects.
The cursor is exclusive.
type IterateLoopSegments ¶ added in v1.31.1
type IterateLoopSegments struct { BatchSize int StartStreamID uuid.UUID EndStreamID uuid.UUID AsOfSystemInterval time.Duration SpannerReadTimestamp time.Time }
IterateLoopSegments contains arguments necessary for listing segments in metabase.
func (*IterateLoopSegments) Verify ¶ added in v1.31.1
func (opts *IterateLoopSegments) Verify() error
Verify verifies segments request fields.
type IterateObjectsWithStatus ¶
type IterateObjectsWithStatus struct { ProjectID uuid.UUID BucketName BucketName Recursive bool BatchSize int Prefix ObjectKey Cursor IterateCursor Pending bool IncludeCustomMetadata bool IncludeSystemMetadata bool }
IterateObjectsWithStatus contains arguments necessary for listing objects in a bucket.
func (*IterateObjectsWithStatus) Verify ¶
func (opts *IterateObjectsWithStatus) Verify() error
Verify verifies get object request fields.
type IteratePendingObjectsByKey ¶
type IteratePendingObjectsByKey struct { ObjectLocation BatchSize int Cursor StreamIDCursor }
IteratePendingObjectsByKey contains arguments necessary for listing pending objects by ObjectKey.
func (*IteratePendingObjectsByKey) Verify ¶
func (opts *IteratePendingObjectsByKey) Verify() error
Verify verifies get object request fields.
type ListBucketsStreamIDs ¶ added in v1.70.1
type ListBucketsStreamIDs struct { BucketList ListVerifyBucketList CursorBucket BucketLocation CursorStreamID uuid.UUID Limit int AsOfSystemTime time.Time AsOfSystemInterval time.Duration }
ListBucketsStreamIDs contains arguments necessary for listing stream segments from buckets.
type ListBucketsStreamIDsResult ¶ added in v1.70.1
type ListBucketsStreamIDsResult struct { StreamIDs []uuid.UUID Counts []int LastBucket BucketLocation }
ListBucketsStreamIDsResult is the result of listing segments of a list of buckets.
type ListObjects ¶ added in v1.65.1
type ListObjects struct { ProjectID uuid.UUID BucketName BucketName Recursive bool Limit int Prefix ObjectKey Cursor ListObjectsCursor Pending bool AllVersions bool IncludeCustomMetadata bool IncludeSystemMetadata bool }
ListObjects contains arguments necessary for listing objects.
For Pending = false, the versions are in descending order. For Pending = true, the versions are in ascending order.
func (*ListObjects) FirstVersion ¶ added in v1.106.1
func (opts *ListObjects) FirstVersion() Version
FirstVersion returns the first object version we need to iterate given the list objects logic.
func (*ListObjects) StartCursor ¶ added in v1.106.1
func (opts *ListObjects) StartCursor() ListObjectsCursor
StartCursor returns the starting object cursor for this listing.
func (*ListObjects) Verify ¶ added in v1.65.1
func (opts *ListObjects) Verify() error
Verify verifies get object request fields.
func (*ListObjects) VersionAscending ¶ added in v1.101.1
func (opts *ListObjects) VersionAscending() bool
VersionAscending returns whether the versions in the result are in ascending order.
type ListObjectsCursor ¶ added in v1.65.1
type ListObjectsCursor IterateCursor
ListObjectsCursor is a cursor used during iteration through objects.
type ListObjectsResult ¶ added in v1.65.1
type ListObjectsResult struct { Objects []ObjectEntry More bool }
ListObjectsResult result of listing objects.
type ListSegments ¶
type ListSegments struct { ProjectID uuid.UUID StreamID uuid.UUID Cursor SegmentPosition Limit int Range *StreamRange }
ListSegments contains arguments necessary for listing stream segments.
type ListSegmentsResult ¶
ListSegmentsResult result of listing segments.
type ListStreamPositions ¶
type ListStreamPositions struct { ProjectID uuid.UUID StreamID uuid.UUID Cursor SegmentPosition Limit int Range *StreamRange }
ListStreamPositions contains arguments necessary for listing stream segments.
type ListStreamPositionsResult ¶
type ListStreamPositionsResult struct { Segments []SegmentPositionInfo More bool }
ListStreamPositionsResult result of listing segments.
type ListVerifyBucketList ¶ added in v1.70.1
type ListVerifyBucketList struct {
Buckets []BucketLocation
}
ListVerifyBucketList represents a list of buckets.
func (*ListVerifyBucketList) Add ¶ added in v1.70.1
func (list *ListVerifyBucketList) Add(projectID uuid.UUID, bucketName BucketName)
Add adds a (projectID, bucketName) to the list of buckets to be checked.
type LoopSegmentEntry ¶
type LoopSegmentEntry struct { StreamID uuid.UUID Position SegmentPosition CreatedAt time.Time // non-nillable ExpiresAt *time.Time RepairedAt *time.Time // repair RootPieceID storj.PieceID EncryptedSize int32 // size of the whole segment (not a piece) PlainOffset int64 // verify PlainSize int32 // verify AliasPieces AliasPieces Redundancy storj.RedundancyScheme Pieces Pieces Placement storj.PlacementConstraint Source string }
LoopSegmentEntry contains information about segment metadata needed by metainfo loop.
func (LoopSegmentEntry) Inline ¶
func (s LoopSegmentEntry) Inline() bool
Inline returns true if segment is inline.
type LoopSegmentsIterator ¶ added in v1.31.1
type LoopSegmentsIterator interface {
Next(ctx context.Context, item *LoopSegmentEntry) bool
}
LoopSegmentsIterator iterates over a sequence of LoopSegmentEntry items.
type NodeAlias ¶
type NodeAlias int32
NodeAlias is a metabase local alias for NodeID-s to reduce segment table size.
type NodeAliasCache ¶
type NodeAliasCache struct {
// contains filtered or unexported fields
}
NodeAliasCache is a write-through cache for looking up node ID and alias mapping.
func NewNodeAliasCache ¶
func NewNodeAliasCache(db NodeAliasDB, fullRefresh bool) *NodeAliasCache
NewNodeAliasCache creates a new cache using the specified database.
func (*NodeAliasCache) Aliases ¶
func (cache *NodeAliasCache) Aliases(ctx context.Context, nodes []storj.NodeID) ([]NodeAlias, error)
Aliases returns node aliases corresponding to the node ID-s and returns an error when node is missing.
func (*NodeAliasCache) ConvertAliasesToPieces ¶
func (cache *NodeAliasCache) ConvertAliasesToPieces(ctx context.Context, aliasPieces AliasPieces) (_ Pieces, err error)
ConvertAliasesToPieces converts alias pieces to pieces.
func (*NodeAliasCache) EnsureAliases ¶ added in v1.65.1
func (cache *NodeAliasCache) EnsureAliases(ctx context.Context, nodes []storj.NodeID) ([]NodeAlias, error)
EnsureAliases returns node aliases corresponding to the node ID-s, adding missing node ID-s to the database when needed.
func (*NodeAliasCache) EnsurePiecesToAliases ¶ added in v1.65.1
func (cache *NodeAliasCache) EnsurePiecesToAliases(ctx context.Context, pieces Pieces) (_ AliasPieces, err error)
EnsurePiecesToAliases converts pieces to alias pieces and automatically adds storage node to alias table when necessary.
func (*NodeAliasCache) Latest ¶ added in v1.66.1
func (cache *NodeAliasCache) Latest(ctx context.Context) (_ *NodeAliasMap, err error)
Latest returns the latest NodeAliasMap.
func (*NodeAliasCache) Nodes ¶
func (cache *NodeAliasCache) Nodes(ctx context.Context, aliases []NodeAlias) ([]storj.NodeID, error)
Nodes returns node ID-s corresponding to the aliases, refreshing the cache once when an alias is missing. This results in an error when the alias is not in the database.
type NodeAliasDB ¶
type NodeAliasDB interface { EnsureNodeAliases(ctx context.Context, opts EnsureNodeAliases) error ListNodeAliases(ctx context.Context) (_ []NodeAliasEntry, err error) GetNodeAliasEntries(ctx context.Context, opts GetNodeAliasEntries) (_ []NodeAliasEntry, err error) }
NodeAliasDB is an interface for looking up node alises.
type NodeAliasEntry ¶
NodeAliasEntry is a mapping between NodeID and NodeAlias.
type NodeAliasMap ¶
type NodeAliasMap struct {
// contains filtered or unexported fields
}
NodeAliasMap contains bidirectional mapping between node ID and a NodeAlias.
The node ID to NodeAlias lookup is implemented as a map of 4-byte node ID prefixes to a linked list of node ID/alias pairs, so that the whole ID does not need to be hashed with each lookup.
func NewNodeAliasMap ¶
func NewNodeAliasMap(entries []NodeAliasEntry) *NodeAliasMap
NewNodeAliasMap creates a new alias map from the given entries.
func (*NodeAliasMap) Alias ¶ added in v1.66.1
func (m *NodeAliasMap) Alias(node storj.NodeID) (x NodeAlias, ok bool)
Alias returns alias for the given node ID.
func (*NodeAliasMap) Aliases ¶
Aliases returns aliases-s for the given node ID-s and node ID-s that are not in this map.
func (*NodeAliasMap) ContainsAll ¶
func (m *NodeAliasMap) ContainsAll(nodeIDs []storj.NodeID, nodeAliases []NodeAlias) bool
ContainsAll returns true when the table contains all entries.
func (*NodeAliasMap) Max ¶ added in v1.70.1
func (m *NodeAliasMap) Max() NodeAlias
Max returns the largest node alias in this map, -1 otherwise. Contrast with Size.
func (*NodeAliasMap) Merge ¶
func (m *NodeAliasMap) Merge(other *NodeAliasMap)
Merge merges the other map into m.
func (*NodeAliasMap) Node ¶
func (m *NodeAliasMap) Node(alias NodeAlias) (x storj.NodeID, ok bool)
Node returns NodeID for the given alias.
func (*NodeAliasMap) Nodes ¶
func (m *NodeAliasMap) Nodes(aliases []NodeAlias) (xs []storj.NodeID, missing []NodeAlias)
Nodes returns NodeID-s for the given aliases and aliases that are not in this map.
func (*NodeAliasMap) Size ¶
func (m *NodeAliasMap) Size() int
Size returns the number of entries in this map. Contrast with Max.
type Object ¶
type Object RawObject
Object object metadata. TODO define separated struct.
func (*Object) IsMigrated ¶
IsMigrated returns whether the object comes from PointerDB. Pointer objects are special that they are missing some information.
- TotalPlainSize = 0 and FixedSegmentSize = 0.
- Segment.PlainOffset = 0, Segment.PlainSize = 0
func (*Object) StreamVersionID ¶ added in v1.95.1
func (obj *Object) StreamVersionID() StreamVersionID
StreamVersionID returns byte representation of object stream version id.
type ObjectEntry ¶
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 }
ObjectEntry contains information about an item in a bucket.
func (ObjectEntry) Less ¶ added in v1.96.2
func (entry ObjectEntry) Less(other ObjectEntry) bool
Less implements sorting on object entries.
func (ObjectEntry) LessVersionAsc ¶ added in v1.100.2
func (entry ObjectEntry) LessVersionAsc(other ObjectEntry) bool
LessVersionAsc implements sorting on object entries.
func (ObjectEntry) StreamVersionID ¶ added in v1.95.1
func (entry ObjectEntry) StreamVersionID() StreamVersionID
StreamVersionID returns byte representation of object stream version id.
type ObjectKey ¶
type ObjectKey string
ObjectKey is an encrypted object key encoded using Path Component Encoding. It is not ascii safe.
func PrefixLimit ¶ added in v1.106.1
PrefixLimit returns the object key that can be used in where clause for querying objects matching a prefix.
func (*ObjectKey) DecodeSpanner ¶ added in v1.104.1
DecodeSpanner implements spanner.Decoder.
func (ObjectKey) EncodeSpanner ¶ added in v1.104.1
EncodeSpanner implements spanner.Encoder.
type ObjectLocation ¶
type ObjectLocation struct { ProjectID uuid.UUID BucketName BucketName ObjectKey ObjectKey }
ObjectLocation is decoded object key information.
func (ObjectLocation) Bucket ¶
func (obj ObjectLocation) Bucket() BucketLocation
Bucket returns bucket location this object belongs to.
func (ObjectLocation) Verify ¶
func (obj ObjectLocation) Verify() error
Verify object location fields.
type ObjectLockDeleteOptions ¶ added in v1.113.1
type ObjectLockDeleteOptions struct { // Enabled indicates that locked objects should be protected from deletion. Enabled bool // BypassGovernance allows governance mode retention restrictions to be bypassed. BypassGovernance bool }
ObjectLockDeleteOptions contains options specifying how objects that may be subject to Object Lock restrictions should be deleted.
type ObjectStatus ¶
type ObjectStatus byte
ObjectStatus defines the status that the object is in.
There are two types of objects:
- Regular (i.e. Committed), which is used for storing data.
- Delete Marker, which is used to show that an object has been deleted, while preserving older versions.
Each object can be in two states:
- Pending, meaning that it's still being uploaded.
- Committed, meaning it has finished uploading. Delete Markers are always considered committed, because they do not require committing.
There are two options for versioning:
- Unversioned, there's only one allowed per project, bucket and encryption key.
- Versioned, there can be any number of such objects for a given project, bucket and encryption key.
These lead to a few meaningful distinct statuses, listed below.
func (*ObjectStatus) DecodeSpanner ¶ added in v1.104.1
func (status *ObjectStatus) DecodeSpanner(val any) (err error)
DecodeSpanner implements spanner.Decoder.
func (ObjectStatus) EncodeSpanner ¶ added in v1.104.1
func (status ObjectStatus) EncodeSpanner() (any, error)
EncodeSpanner implements spanner.Encoder.
func (ObjectStatus) IsCommitted ¶ added in v1.110.1
func (status ObjectStatus) IsCommitted() bool
IsCommitted returns whether the status indicates that an object is committed.
func (ObjectStatus) IsDeleteMarker ¶ added in v1.91.2
func (status ObjectStatus) IsDeleteMarker() bool
IsDeleteMarker return whether the status is a delete marker.
func (ObjectStatus) IsUnversioned ¶ added in v1.110.1
func (status ObjectStatus) IsUnversioned() bool
IsUnversioned returns whether the status indicates that an object is unversioned.
func (ObjectStatus) String ¶ added in v1.96.2
func (status ObjectStatus) String() string
String returns textual representation of status.
type ObjectStream ¶
type ObjectStream struct { ProjectID uuid.UUID BucketName BucketName ObjectKey ObjectKey Version Version StreamID uuid.UUID }
ObjectStream uniquely defines an object and stream.
func (ObjectStream) Less ¶ added in v1.91.2
func (obj ObjectStream) Less(b ObjectStream) bool
Less implements sorting on object streams. Where ProjectID asc, BucketName asc, ObjectKey asc, Version desc.
func (ObjectStream) LessVersionAsc ¶ added in v1.100.2
func (obj ObjectStream) LessVersionAsc(b ObjectStream) bool
LessVersionAsc implements sorting on object streams. Where ProjectID asc, BucketName asc, ObjectKey asc, Version asc.
func (*ObjectStream) Location ¶
func (obj *ObjectStream) Location() ObjectLocation
Location returns object location.
type ObjectsIterator ¶
type ObjectsIterator interface {
Next(ctx context.Context, item *ObjectEntry) bool
}
ObjectsIterator iterates over a sequence of ObjectEntry items.
type ObjectsIteratorCursor ¶ added in v1.106.1
type ObjectsIteratorCursor struct { Key ObjectKey Version Version StreamID uuid.UUID Inclusive bool }
ObjectsIteratorCursor is the current location in an objects iterator.
func FirstIterateCursor ¶ added in v1.106.1
func FirstIterateCursor(recursive bool, cursor IterateCursor, prefix ObjectKey) ObjectsIteratorCursor
FirstIterateCursor adjust the cursor for a non-recursive iteration. The cursor is non-inclusive and we need to adjust to handle prefix as cursor properly. We return the next possible key from the prefix.
type PendingObjectEntry ¶ added in v1.87.1
type PendingObjectEntry struct { IsPrefix bool ObjectKey ObjectKey StreamID uuid.UUID CreatedAt time.Time ExpiresAt *time.Time EncryptedMetadataNonce []byte EncryptedMetadata []byte EncryptedMetadataEncryptedKey []byte Encryption storj.EncryptionParameters }
PendingObjectEntry contains information about an pending object item in a bucket.
type PendingObjectStream ¶ added in v1.85.1
type PendingObjectStream struct { ProjectID uuid.UUID BucketName BucketName ObjectKey ObjectKey StreamID uuid.UUID }
PendingObjectStream uniquely defines an pending object and stream.
func (*PendingObjectStream) Verify ¶ added in v1.85.1
func (obj *PendingObjectStream) Verify() error
Verify object stream fields.
type PendingObjectsIterator ¶ added in v1.87.1
type PendingObjectsIterator interface {
Next(ctx context.Context, item *PendingObjectEntry) bool
}
PendingObjectsIterator iterates over a sequence of PendingObjectEntry items.
type Pieces ¶
type Pieces []Piece
Pieces defines information for pieces.
func (Pieces) FindByNum ¶ added in v1.67.1
FindByNum finds a piece among the Pieces with the given piece number. If no such piece is found, `found` will be returned false.
func (Pieces) Less ¶
Less reports whether the piece with index i should sort before the piece with index j.
func (Pieces) Remove ¶ added in v1.36.1
Remove removes the specified pieces from the original pieces and returns the updated Pieces.
func (Pieces) Update ¶ added in v1.36.1
Update adds piecesToAdd pieces and removes piecesToRemove pieces from the original pieces struct and returns the updated Pieces.
It removes the piecesToRemove only if all piece number, node id match.
When adding a piece, it checks if the piece already exists using the piece Number If a piece already exists, it returns an empty pieces struct and an error.
type PostgresAdapter ¶ added in v1.102.2
type PostgresAdapter struct {
// contains filtered or unexported fields
}
PostgresAdapter uses Cockroach related SQL queries.
func (*PostgresAdapter) BeginObjectNextVersion ¶ added in v1.102.2
func (p *PostgresAdapter) BeginObjectNextVersion(ctx context.Context, opts BeginObjectNextVersion, object *Object) error
BeginObjectNextVersion implements Adapter.
func (*PostgresAdapter) BucketEmpty ¶ added in v1.106.1
func (p *PostgresAdapter) BucketEmpty(ctx context.Context, opts BucketEmpty) (empty bool, err error)
BucketEmpty returns true if bucket does not contain objects (pending or committed). This method doesn't check bucket existence.
func (*PostgresAdapter) CheckVersion ¶ added in v1.112.2
func (p *PostgresAdapter) CheckVersion(ctx context.Context) error
CheckVersion checks the database is the correct version.
func (*PostgresAdapter) CollectBucketTallies ¶ added in v1.107.1
func (p *PostgresAdapter) CollectBucketTallies(ctx context.Context, opts CollectBucketTallies) (result []BucketTally, err error)
CollectBucketTallies collect limited bucket tallies from given bucket locations.
func (*PostgresAdapter) CommitInlineSegment ¶ added in v1.104.1
func (p *PostgresAdapter) CommitInlineSegment(ctx context.Context, opts CommitInlineSegment) (err error)
CommitInlineSegment commits inline segment to the database.
func (*PostgresAdapter) CommitPendingObjectSegment ¶ added in v1.104.1
func (p *PostgresAdapter) CommitPendingObjectSegment(ctx context.Context, opts CommitSegment, aliasPieces AliasPieces) (err error)
CommitPendingObjectSegment commits segment to the database.
func (*PostgresAdapter) DeleteBucketObjects ¶ added in v1.107.1
func (p *PostgresAdapter) DeleteBucketObjects(ctx context.Context, opts DeleteBucketObjects) (deletedObjectCount, deletedSegmentCount int64, err error)
DeleteBucketObjects deletes all objects in the specified bucket. Deletion performs in batches, so in case of error while processing, this method will return the number of objects deleted to the moment when an error occurs.
func (*PostgresAdapter) DeleteInactiveObjectsAndSegments ¶ added in v1.106.1
func (p *PostgresAdapter) DeleteInactiveObjectsAndSegments(ctx context.Context, objects []ObjectStream, opts DeleteZombieObjects) (objectsDeleted, segmentsDeleted int64, err error)
DeleteInactiveObjectsAndSegments deletes inactive objects and associated segments.
func (*PostgresAdapter) DeleteObjectExactVersion ¶ added in v1.106.1
func (p *PostgresAdapter) DeleteObjectExactVersion(ctx context.Context, opts DeleteObjectExactVersion) (DeleteObjectResult, error)
DeleteObjectExactVersion deletes an exact object version.
func (*PostgresAdapter) DeleteObjectLastCommittedPlain ¶ added in v1.106.1
func (p *PostgresAdapter) DeleteObjectLastCommittedPlain(ctx context.Context, opts DeleteObjectLastCommitted) (DeleteObjectResult, error)
DeleteObjectLastCommittedPlain deletes an object last committed version when opts.Suspended and opts.Versioned are both false.
func (*PostgresAdapter) DeleteObjectLastCommittedSuspended ¶ added in v1.106.1
func (p *PostgresAdapter) DeleteObjectLastCommittedSuspended(ctx context.Context, opts DeleteObjectLastCommitted, deleterMarkerStreamID uuid.UUID) (result DeleteObjectResult, err error)
DeleteObjectLastCommittedSuspended deletes an object last committed version when opts.Suspended is true.
func (*PostgresAdapter) DeleteObjectLastCommittedVersioned ¶ added in v1.106.1
func (p *PostgresAdapter) DeleteObjectLastCommittedVersioned(ctx context.Context, opts DeleteObjectLastCommitted, deleterMarkerStreamID uuid.UUID) (result DeleteObjectResult, err error)
DeleteObjectLastCommittedVersioned deletes an object last committed version when opts.Versioned is true.
func (*PostgresAdapter) DeleteObjectsAndSegments ¶ added in v1.106.1
func (p *PostgresAdapter) DeleteObjectsAndSegments(ctx context.Context, objects []ObjectStream) (objectsDeleted, segmentsDeleted int64, err error)
DeleteObjectsAndSegments deletes expired objects and associated segments.
func (*PostgresAdapter) DeletePendingObject ¶ added in v1.106.1
func (p *PostgresAdapter) DeletePendingObject(ctx context.Context, opts DeletePendingObject) (result DeleteObjectResult, err error)
DeletePendingObject deletes a pending object with specified version and streamID.
func (*PostgresAdapter) EnsureNodeAliases ¶ added in v1.103.2
func (p *PostgresAdapter) EnsureNodeAliases(ctx context.Context, opts EnsureNodeAliases) (err error)
EnsureNodeAliases implements Adapter.
func (*PostgresAdapter) FindExpiredObjects ¶ added in v1.106.1
func (p *PostgresAdapter) FindExpiredObjects(ctx context.Context, opts DeleteExpiredObjects, startAfter ObjectStream, batchSize int) (expiredObjects []ObjectStream, err error)
FindExpiredObjects finds up to batchSize objects that expired before opts.ExpiredBefore.
func (*PostgresAdapter) FindZombieObjects ¶ added in v1.106.1
func (p *PostgresAdapter) FindZombieObjects(ctx context.Context, opts DeleteZombieObjects, startAfter ObjectStream, batchSize int) (objects []ObjectStream, err error)
FindZombieObjects locates up to batchSize zombie objects that need deletion.
func (*PostgresAdapter) GetLatestObjectLastSegment ¶ added in v1.106.1
func (p *PostgresAdapter) GetLatestObjectLastSegment(ctx context.Context, opts GetLatestObjectLastSegment) (segment Segment, aliasPieces AliasPieces, err error)
GetLatestObjectLastSegment returns an object last segment information.
func (*PostgresAdapter) GetNodeAliasEntries ¶ added in v1.108.1
func (p *PostgresAdapter) GetNodeAliasEntries(ctx context.Context, opts GetNodeAliasEntries) (_ []NodeAliasEntry, err error)
GetNodeAliasEntries implements Adapter.
func (*PostgresAdapter) GetObjectExactVersion ¶ added in v1.106.1
func (p *PostgresAdapter) GetObjectExactVersion(ctx context.Context, opts GetObjectExactVersion) (_ Object, err error)
GetObjectExactVersion returns object information for exact version.
func (*PostgresAdapter) GetObjectExactVersionLegalHold ¶ added in v1.113.1
func (p *PostgresAdapter) GetObjectExactVersionLegalHold(ctx context.Context, opts GetObjectExactVersionLegalHold) (_ bool, err error)
GetObjectExactVersionLegalHold returns the legal hold configuration of an exact version of an object.
func (*PostgresAdapter) GetObjectExactVersionRetention ¶ added in v1.110.1
func (p *PostgresAdapter) GetObjectExactVersionRetention(ctx context.Context, opts GetObjectExactVersionRetention) (_ Retention, err error)
GetObjectExactVersionRetention returns the retention configuration of an exact version of an object.
func (*PostgresAdapter) GetObjectLastCommitted ¶ added in v1.102.2
func (p *PostgresAdapter) GetObjectLastCommitted(ctx context.Context, opts GetObjectLastCommitted) (object Object, err error)
GetObjectLastCommitted implements Adapter.
func (*PostgresAdapter) GetObjectLastCommittedLegalHold ¶ added in v1.113.1
func (p *PostgresAdapter) GetObjectLastCommittedLegalHold(ctx context.Context, opts GetObjectLastCommittedLegalHold) (_ bool, err error)
GetObjectLastCommittedLegalHold returns the legal hold configuration of the most recently committed version of an object.
func (*PostgresAdapter) GetObjectLastCommittedRetention ¶ added in v1.110.1
func (p *PostgresAdapter) GetObjectLastCommittedRetention(ctx context.Context, opts GetObjectLastCommittedRetention) (_ Retention, err error)
GetObjectLastCommittedRetention returns the retention configuration of the most recently committed version of an object.
func (*PostgresAdapter) GetSegmentByPosition ¶ added in v1.106.1
func (p *PostgresAdapter) GetSegmentByPosition(ctx context.Context, opts GetSegmentByPosition) (segment Segment, aliasPieces AliasPieces, err error)
GetSegmentByPosition returns information about segment on the specified position.
func (*PostgresAdapter) GetSegmentPositionsAndKeys ¶ added in v1.106.1
func (p *PostgresAdapter) GetSegmentPositionsAndKeys(ctx context.Context, streamID uuid.UUID) (keysNonces []EncryptedKeyAndNonce, err error)
GetSegmentPositionsAndKeys fetches the Position, EncryptedKeyNonce, and EncryptedKey for all segments in the db for the given stream ID, ordered by position.
func (*PostgresAdapter) GetStreamPieceCountByAlias ¶ added in v1.107.1
func (p *PostgresAdapter) GetStreamPieceCountByAlias(ctx context.Context, opts GetStreamPieceCountByNodeID) (result map[NodeAlias]int64, err error)
GetStreamPieceCountByAlias returns piece count by node alias.
func (*PostgresAdapter) GetTableStats ¶ added in v1.104.1
func (p *PostgresAdapter) GetTableStats(ctx context.Context, opts GetTableStats) (result TableStats, err error)
GetTableStats implements Adapter.
func (*PostgresAdapter) Implementation ¶ added in v1.112.2
func (p *PostgresAdapter) Implementation() dbutil.Implementation
Implementation returns the dbutil.Implementation code for this adapter.
func (*PostgresAdapter) IterateLoopSegments ¶ added in v1.103.2
func (p *PostgresAdapter) IterateLoopSegments(ctx context.Context, aliasCache *NodeAliasCache, opts IterateLoopSegments, fn func(context.Context, LoopSegmentsIterator) error) (err error)
IterateLoopSegments implements Adapter.
func (*PostgresAdapter) ListBucketsStreamIDs ¶ added in v1.107.1
func (p *PostgresAdapter) ListBucketsStreamIDs(ctx context.Context, opts ListBucketsStreamIDs, bucketNamesBytes [][]byte, projectIDs []uuid.UUID) (result ListBucketsStreamIDsResult, err error)
ListBucketsStreamIDs lists the streamIDs of a list of buckets.
func (*PostgresAdapter) ListNodeAliases ¶ added in v1.103.2
func (p *PostgresAdapter) ListNodeAliases(ctx context.Context) (_ []NodeAliasEntry, err error)
ListNodeAliases implements Adapter.
func (*PostgresAdapter) ListObjects ¶ added in v1.106.1
func (p *PostgresAdapter) ListObjects(ctx context.Context, opts ListObjects) (result ListObjectsResult, err error)
ListObjects lists objects.
func (*PostgresAdapter) ListSegments ¶ added in v1.106.1
func (p *PostgresAdapter) ListSegments(ctx context.Context, opts ListSegments, aliasCache *NodeAliasCache) (result ListSegmentsResult, err error)
ListSegments lists specified stream segments.
func (*PostgresAdapter) ListStreamPositions ¶ added in v1.106.1
func (p *PostgresAdapter) ListStreamPositions(ctx context.Context, opts ListStreamPositions) (result ListStreamPositionsResult, err error)
ListStreamPositions lists specified stream segment positions.
func (*PostgresAdapter) MigrateToLatest ¶ added in v1.112.2
func (p *PostgresAdapter) MigrateToLatest(ctx context.Context) error
MigrateToLatest migrates database to the latest version.
func (*PostgresAdapter) Name ¶ added in v1.106.1
func (p *PostgresAdapter) Name() string
Name returns the name of the adapter.
func (*PostgresAdapter) Now ¶ added in v1.107.1
Now returns the current time according to the database.
func (*PostgresAdapter) PendingObjectExists ¶ added in v1.104.1
func (p *PostgresAdapter) PendingObjectExists(ctx context.Context, opts BeginSegment) (exists bool, err error)
PendingObjectExists checks whether an object already exists.
func (*PostgresAdapter) Ping ¶ added in v1.107.1
func (p *PostgresAdapter) Ping(ctx context.Context) error
Ping checks whether connection has been established.
func (*PostgresAdapter) PostgresMigration ¶ added in v1.112.2
func (p *PostgresAdapter) PostgresMigration() *migrate.Migration
PostgresMigration returns steps needed for migrating postgres database.
func (*PostgresAdapter) SetObjectExactVersionLegalHold ¶ added in v1.113.1
func (p *PostgresAdapter) SetObjectExactVersionLegalHold(ctx context.Context, opts SetObjectExactVersionLegalHold) (err error)
SetObjectExactVersionLegalHold sets the legal hold configuration of an exact version of an object.
func (*PostgresAdapter) SetObjectExactVersionRetention ¶ added in v1.110.1
func (p *PostgresAdapter) SetObjectExactVersionRetention(ctx context.Context, opts SetObjectExactVersionRetention) (err error)
SetObjectExactVersionRetention sets the retention configuration of an exact version of an object.
func (*PostgresAdapter) SetObjectLastCommittedLegalHold ¶ added in v1.113.1
func (p *PostgresAdapter) SetObjectLastCommittedLegalHold(ctx context.Context, opts SetObjectLastCommittedLegalHold) (err error)
SetObjectLastCommittedLegalHold sets the legal hold configuration of the most recently committed version of an object.
func (*PostgresAdapter) SetObjectLastCommittedRetention ¶ added in v1.110.1
func (p *PostgresAdapter) SetObjectLastCommittedRetention(ctx context.Context, opts SetObjectLastCommittedRetention) (err error)
SetObjectLastCommittedRetention sets the retention configuration of the most recently committed version of an object.
func (*PostgresAdapter) TestMigrateToLatest ¶ added in v1.110.1
func (p *PostgresAdapter) TestMigrateToLatest(ctx context.Context) error
TestMigrateToLatest creates a database and applies all the migration for test purposes.
func (*PostgresAdapter) TestingBatchInsertObjects ¶ added in v1.106.1
func (p *PostgresAdapter) TestingBatchInsertObjects(ctx context.Context, objects []RawObject) (err error)
TestingBatchInsertObjects batch inserts objects for testing.
func (*PostgresAdapter) TestingBatchInsertSegments ¶ added in v1.102.2
func (p *PostgresAdapter) TestingBatchInsertSegments(ctx context.Context, aliasCache *NodeAliasCache, segments []RawSegment) (err error)
TestingBatchInsertSegments implements postgres adapter.
func (*PostgresAdapter) TestingBeginObjectExactVersion ¶ added in v1.102.2
func (p *PostgresAdapter) TestingBeginObjectExactVersion(ctx context.Context, opts BeginObjectExactVersion, object *Object) error
TestingBeginObjectExactVersion implements Adapter.
func (*PostgresAdapter) TestingDeleteAll ¶ added in v1.103.2
func (p *PostgresAdapter) TestingDeleteAll(ctx context.Context) (err error)
TestingDeleteAll implements Adapter.
func (*PostgresAdapter) TestingGetAllObjects ¶ added in v1.104.1
func (p *PostgresAdapter) TestingGetAllObjects(ctx context.Context) (_ []RawObject, err error)
TestingGetAllObjects returns the state of the database.
func (*PostgresAdapter) TestingGetAllSegments ¶ added in v1.103.2
func (p *PostgresAdapter) TestingGetAllSegments(ctx context.Context, aliasCache *NodeAliasCache) (_ []RawSegment, err error)
TestingGetAllSegments implements Adapter.
func (*PostgresAdapter) TestingSetObjectVersion ¶ added in v1.112.2
func (p *PostgresAdapter) TestingSetObjectVersion(ctx context.Context, object ObjectStream, randomVersion Version) (rowsAffected int64, err error)
TestingSetObjectVersion sets the version of the object to the given value.
func (*PostgresAdapter) TestingSetPlacementAllSegments ¶ added in v1.112.2
func (p *PostgresAdapter) TestingSetPlacementAllSegments(ctx context.Context, placement storj.PlacementConstraint) (err error)
TestingSetPlacementAllSegments sets the placement of all segments to the given value.
func (*PostgresAdapter) UnderlyingDB ¶ added in v1.107.1
func (p *PostgresAdapter) UnderlyingDB() tagsql.DB
UnderlyingDB returns a handle to the underlying DB.
func (*PostgresAdapter) UpdateObjectLastCommittedMetadata ¶ added in v1.106.1
func (p *PostgresAdapter) UpdateObjectLastCommittedMetadata(ctx context.Context, opts UpdateObjectLastCommittedMetadata) (affected int64, err error)
UpdateObjectLastCommittedMetadata updates an object metadata.
func (*PostgresAdapter) UpdateSegmentPieces ¶ added in v1.106.1
func (p *PostgresAdapter) UpdateSegmentPieces(ctx context.Context, opts UpdateSegmentPieces, oldPieces, newPieces AliasPieces) (resultPieces AliasPieces, err error)
UpdateSegmentPieces updates pieces for specified segment, if pieces matches oldPieces.
func (*PostgresAdapter) UpdateTableStats ¶ added in v1.107.1
func (p *PostgresAdapter) UpdateTableStats(ctx context.Context) error
UpdateTableStats forces an update of table statistics. Probably useful mostly in test scenarios.
func (*PostgresAdapter) WithTx ¶ added in v1.104.1
func (p *PostgresAdapter) WithTx(ctx context.Context, f func(context.Context, TransactionAdapter) error) error
WithTx provides a TransactionAdapter for the context of a database transaction.
type PrecommitConstraint ¶ added in v1.106.1
type PrecommitConstraint struct { Location ObjectLocation Versioned bool DisallowDelete bool TestingPrecommitDeleteMode TestingPrecommitDeleteMode }
PrecommitConstraint is arguments to ensure that a single unversioned object or delete marker exists in the table per object location.
type PrecommitConstraintResult ¶ added in v1.106.1
type PrecommitConstraintResult struct { Deleted []Object // DeletedObjectCount returns how many objects were deleted. DeletedObjectCount int // DeletedSegmentCount returns how many segments were deleted. DeletedSegmentCount int // HighestVersion returns tha highest version that was present in the table. // It returns 0 if there was none. HighestVersion Version }
PrecommitConstraintResult returns the result of enforcing precommit constraint.
type PrecommitConstraintWithNonPendingResult ¶ added in v1.106.1
type PrecommitConstraintWithNonPendingResult struct { Deleted []Object // DeletedObjectCount returns how many objects were deleted. DeletedObjectCount int // DeletedSegmentCount returns how many segments were deleted. DeletedSegmentCount int // HighestVersion returns tha highest version that was present in the table. // It returns 0 if there was none. HighestVersion Version // HighestNonPendingVersion returns tha highest non-pending version that was present in the table. // It returns 0 if there was none. HighestNonPendingVersion Version }
PrecommitConstraintWithNonPendingResult contains the result for enforcing precommit constraint.
type PrecommitDeleteUnversionedWithNonPending ¶ added in v1.110.1
type PrecommitDeleteUnversionedWithNonPending struct { ObjectLocation ObjectLock ObjectLockDeleteOptions }
PrecommitDeleteUnversionedWithNonPending contains arguments necessary for deleting an unversioned object at a specified location and returning the highest non-pending version at that location.
type RawObject ¶
type RawObject struct { ObjectStream CreatedAt time.Time ExpiresAt *time.Time Status ObjectStatus SegmentCount int32 EncryptedMetadataNonce []byte EncryptedMetadata []byte EncryptedMetadataEncryptedKey []byte // TotalPlainSize is 0 for a migrated object. TotalPlainSize int64 TotalEncryptedSize int64 // FixedSegmentSize is 0 for a migrated object. FixedSegmentSize int32 Encryption storj.EncryptionParameters // ZombieDeletionDeadline defines when the pending raw object should be deleted from the database. // This is as a safeguard against objects that failed to upload and the client has not indicated // whether they want to continue uploading or delete the already uploaded data. ZombieDeletionDeadline *time.Time Retention Retention LegalHold bool }
RawObject defines the full object that is stored in the database. It should be rarely used directly.
type RawSegment ¶
type RawSegment struct { StreamID uuid.UUID Position SegmentPosition CreatedAt time.Time // non-nillable RepairedAt *time.Time ExpiresAt *time.Time RootPieceID storj.PieceID EncryptedKeyNonce []byte EncryptedKey []byte EncryptedSize int32 // size of the whole segment (not a piece) // PlainSize is 0 for a migrated object. PlainSize int32 // PlainOffset is 0 for a migrated object. PlainOffset int64 EncryptedETag []byte Redundancy storj.RedundancyScheme InlineData []byte Pieces Pieces Placement storj.PlacementConstraint }
RawSegment defines the full segment that is stored in the database. It should be rarely used directly.
type RawState ¶
type RawState struct { Objects []RawObject Segments []RawSegment }
RawState contains full state of a table.
type Retention ¶ added in v1.109.1
type Retention struct { Mode storj.RetentionMode RetainUntil time.Time }
Retention represents an object version's Object Lock retention configuration.
func (*Retention) Active ¶ added in v1.110.1
Active returns whether the retention configuration is enabled and active as of the given time.
func (*Retention) ActiveNow ¶ added in v1.112.2
ActiveNow returns whether the retention configuration is enabled and active as of the current time.
type Segment ¶
type Segment RawSegment
Segment segment metadata. TODO define separated struct.
type SegmentIterator ¶
type SegmentIterator func(ctx context.Context, segment *LoopSegmentEntry) bool
SegmentIterator returns the next segment.
type SegmentKey ¶
type SegmentKey []byte
SegmentKey is an encoded metainfo key. This is used as the key in pointerdb key-value store.
type SegmentLocation ¶
type SegmentLocation struct { ProjectID uuid.UUID BucketName BucketName ObjectKey ObjectKey Position SegmentPosition }
SegmentLocation is decoded segment key information.
func ParseSegmentKey ¶
func ParseSegmentKey(encoded SegmentKey) (SegmentLocation, error)
ParseSegmentKey parses an segment key into segment location.
func (SegmentLocation) Bucket ¶
func (seg SegmentLocation) Bucket() BucketLocation
Bucket returns bucket location this segment belongs to.
func (SegmentLocation) Encode ¶
func (seg SegmentLocation) Encode() SegmentKey
Encode converts segment location into a segment key.
func (SegmentLocation) Object ¶
func (seg SegmentLocation) Object() ObjectLocation
Object returns the object location associated with this segment location.
func (SegmentLocation) Verify ¶
func (seg SegmentLocation) Verify() error
Verify segment location fields.
type SegmentPosition ¶
SegmentPosition is segment part and index combined.
func SegmentPositionFromEncoded ¶
func SegmentPositionFromEncoded(v uint64) SegmentPosition
SegmentPositionFromEncoded decodes an uint64 into a SegmentPosition.
func (*SegmentPosition) DecodeSpanner ¶ added in v1.103.2
func (pos *SegmentPosition) DecodeSpanner(val any) (err error)
DecodeSpanner implements spanner.Decoder.
func (SegmentPosition) Encode ¶
func (pos SegmentPosition) Encode() uint64
Encode encodes a segment position into an uint64, that can be stored in a database.
func (SegmentPosition) EncodeSpanner ¶ added in v1.103.2
func (pos SegmentPosition) EncodeSpanner() (any, error)
EncodeSpanner implements spanner.Encoder.
func (SegmentPosition) Less ¶
func (pos SegmentPosition) Less(b SegmentPosition) bool
Less returns whether pos should before b.
func (*SegmentPosition) Scan ¶
func (params *SegmentPosition) Scan(value interface{}) error
Scan implements sql.Scanner interface.
type SegmentPositionInfo ¶
type SegmentPositionInfo struct { Position SegmentPosition // PlainSize is 0 for a migrated object. PlainSize int32 // PlainOffset is 0 for a migrated object. PlainOffset int64 CreatedAt *time.Time // TODO: make it non-nilable after we migrate all existing segments to have creation time EncryptedETag []byte EncryptedKeyNonce []byte EncryptedKey []byte }
SegmentPositionInfo contains information for segment position.
type SetObjectExactVersionLegalHold ¶ added in v1.113.1
type SetObjectExactVersionLegalHold struct { ObjectLocation Version Version Enabled bool }
SetObjectExactVersionLegalHold contains arguments necessary for setting the legal hold configuration of an exact version of an object.
func (*SetObjectExactVersionLegalHold) Verify ¶ added in v1.113.1
func (opts *SetObjectExactVersionLegalHold) Verify() error
Verify verifies the request fields.
type SetObjectExactVersionRetention ¶ added in v1.110.1
type SetObjectExactVersionRetention struct { ObjectLocation Version Version Retention Retention BypassGovernance bool }
SetObjectExactVersionRetention contains arguments necessary for setting the retention configuration of an exact version of an object.
func (*SetObjectExactVersionRetention) Verify ¶ added in v1.110.1
func (opts *SetObjectExactVersionRetention) Verify() (err error)
Verify verifies the request fields.
type SetObjectLastCommittedLegalHold ¶ added in v1.113.1
type SetObjectLastCommittedLegalHold struct { ObjectLocation Enabled bool }
SetObjectLastCommittedLegalHold contains arguments necessary for setting the legal hold configuration of the most recently committed version of an object.
func (SetObjectLastCommittedLegalHold) Verify ¶ added in v1.113.1
func (opts SetObjectLastCommittedLegalHold) Verify() error
Verify verifies the request fields.
type SetObjectLastCommittedRetention ¶ added in v1.110.1
type SetObjectLastCommittedRetention struct { ObjectLocation Retention Retention BypassGovernance bool }
SetObjectLastCommittedRetention contains arguments necessary for setting the retention configuration of the most recently committed version of an object.
func (SetObjectLastCommittedRetention) Verify ¶ added in v1.110.1
func (opts SetObjectLastCommittedRetention) Verify() (err error)
Verify verifies the request fields.
type SpannerAdapter ¶ added in v1.103.2
type SpannerAdapter struct {
// contains filtered or unexported fields
}
SpannerAdapter implements Adapter for Google Spanner connections..
func NewSpannerAdapter ¶ added in v1.103.2
func NewSpannerAdapter(ctx context.Context, cfg SpannerConfig, log *zap.Logger) (*SpannerAdapter, error)
NewSpannerAdapter creates a new Spanner adapter.
func (*SpannerAdapter) BeginObjectNextVersion ¶ added in v1.103.2
func (s *SpannerAdapter) BeginObjectNextVersion(ctx context.Context, opts BeginObjectNextVersion, object *Object) error
BeginObjectNextVersion implements Adapter.
func (*SpannerAdapter) BucketEmpty ¶ added in v1.106.1
func (s *SpannerAdapter) BucketEmpty(ctx context.Context, opts BucketEmpty) (empty bool, err error)
BucketEmpty returns true if bucket does not contain objects (pending or committed). This method doesn't check bucket existence.
func (*SpannerAdapter) CheckVersion ¶ added in v1.112.2
func (s *SpannerAdapter) CheckVersion(ctx context.Context) error
CheckVersion checks the database is the correct version.
func (*SpannerAdapter) Close ¶ added in v1.103.2
func (s *SpannerAdapter) Close() error
Close closes the internal client.
func (*SpannerAdapter) CollectBucketTallies ¶ added in v1.107.1
func (s *SpannerAdapter) CollectBucketTallies(ctx context.Context, opts CollectBucketTallies) (result []BucketTally, err error)
CollectBucketTallies collect limited bucket tallies from given bucket locations.
func (*SpannerAdapter) CommitInlineSegment ¶ added in v1.104.1
func (s *SpannerAdapter) CommitInlineSegment(ctx context.Context, opts CommitInlineSegment) (err error)
CommitInlineSegment commits inline segment to the database.
func (*SpannerAdapter) CommitPendingObjectSegment ¶ added in v1.104.1
func (s *SpannerAdapter) CommitPendingObjectSegment(ctx context.Context, opts CommitSegment, aliasPieces AliasPieces) (err error)
CommitPendingObjectSegment commits segment to the database.
func (*SpannerAdapter) DeleteBucketObjects ¶ added in v1.107.1
func (s *SpannerAdapter) DeleteBucketObjects(ctx context.Context, opts DeleteBucketObjects) (deletedObjectCount, deletedSegmentCount int64, err error)
DeleteBucketObjects deletes all objects in the specified bucket. Deletion performs in batches, so in case of error while processing, this method will return the number of objects deleted to the moment when an error occurs.
func (*SpannerAdapter) DeleteInactiveObjectsAndSegments ¶ added in v1.106.1
func (s *SpannerAdapter) DeleteInactiveObjectsAndSegments(ctx context.Context, objects []ObjectStream, opts DeleteZombieObjects) (objectsDeleted, segmentsDeleted int64, err error)
DeleteInactiveObjectsAndSegments deletes inactive objects and associated segments.
func (*SpannerAdapter) DeleteObjectExactVersion ¶ added in v1.106.1
func (s *SpannerAdapter) DeleteObjectExactVersion(ctx context.Context, opts DeleteObjectExactVersion) (DeleteObjectResult, error)
DeleteObjectExactVersion deletes an exact object version.
func (*SpannerAdapter) DeleteObjectLastCommittedPlain ¶ added in v1.106.1
func (s *SpannerAdapter) DeleteObjectLastCommittedPlain(ctx context.Context, opts DeleteObjectLastCommitted) (DeleteObjectResult, error)
DeleteObjectLastCommittedPlain deletes an object last committed version when opts.Suspended and opts.Versioned are both false.
func (*SpannerAdapter) DeleteObjectLastCommittedSuspended ¶ added in v1.106.1
func (s *SpannerAdapter) DeleteObjectLastCommittedSuspended(ctx context.Context, opts DeleteObjectLastCommitted, deleterMarkerStreamID uuid.UUID) (result DeleteObjectResult, err error)
DeleteObjectLastCommittedSuspended deletes an object last committed version when opts.Suspended is true.
func (*SpannerAdapter) DeleteObjectLastCommittedVersioned ¶ added in v1.106.1
func (s *SpannerAdapter) DeleteObjectLastCommittedVersioned(ctx context.Context, opts DeleteObjectLastCommitted, deleterMarkerStreamID uuid.UUID) (result DeleteObjectResult, err error)
DeleteObjectLastCommittedVersioned deletes an object last committed version when opts.Versioned is true.
func (*SpannerAdapter) DeleteObjectsAndSegments ¶ added in v1.106.1
func (s *SpannerAdapter) DeleteObjectsAndSegments(ctx context.Context, objects []ObjectStream) (objectsDeleted, segmentsDeleted int64, err error)
DeleteObjectsAndSegments deletes expired objects and associated segments.
func (*SpannerAdapter) DeletePendingObject ¶ added in v1.106.1
func (s *SpannerAdapter) DeletePendingObject(ctx context.Context, opts DeletePendingObject) (result DeleteObjectResult, err error)
DeletePendingObject deletes a pending object with specified version and streamID.
func (*SpannerAdapter) EnsureNodeAliases ¶ added in v1.103.2
func (s *SpannerAdapter) EnsureNodeAliases(ctx context.Context, opts EnsureNodeAliases) (err error)
EnsureNodeAliases implements Adapter.
func (*SpannerAdapter) FindExpiredObjects ¶ added in v1.106.1
func (s *SpannerAdapter) FindExpiredObjects(ctx context.Context, opts DeleteExpiredObjects, startAfter ObjectStream, batchSize int) (expiredObjects []ObjectStream, err error)
FindExpiredObjects finds up to batchSize objects that expired before opts.ExpiredBefore.
func (*SpannerAdapter) FindZombieObjects ¶ added in v1.106.1
func (s *SpannerAdapter) FindZombieObjects(ctx context.Context, opts DeleteZombieObjects, startAfter ObjectStream, batchSize int) (objects []ObjectStream, err error)
FindZombieObjects locates up to batchSize zombie objects that need deletion.
func (*SpannerAdapter) GetLatestObjectLastSegment ¶ added in v1.106.1
func (s *SpannerAdapter) GetLatestObjectLastSegment(ctx context.Context, opts GetLatestObjectLastSegment) (segment Segment, aliasPieces AliasPieces, err error)
GetLatestObjectLastSegment returns an object last segment information.
func (*SpannerAdapter) GetNodeAliasEntries ¶ added in v1.108.1
func (s *SpannerAdapter) GetNodeAliasEntries(ctx context.Context, opts GetNodeAliasEntries) (_ []NodeAliasEntry, err error)
GetNodeAliasEntries implements Adapter.
func (*SpannerAdapter) GetObjectExactVersion ¶ added in v1.106.1
func (s *SpannerAdapter) GetObjectExactVersion(ctx context.Context, opts GetObjectExactVersion) (object Object, err error)
GetObjectExactVersion returns object information for exact version.
func (*SpannerAdapter) GetObjectExactVersionLegalHold ¶ added in v1.113.1
func (s *SpannerAdapter) GetObjectExactVersionLegalHold(ctx context.Context, opts GetObjectExactVersionLegalHold) (_ bool, err error)
GetObjectExactVersionLegalHold returns the legal hold configuration of an exact version of an object.
func (*SpannerAdapter) GetObjectExactVersionRetention ¶ added in v1.110.1
func (s *SpannerAdapter) GetObjectExactVersionRetention(ctx context.Context, opts GetObjectExactVersionRetention) (_ Retention, err error)
GetObjectExactVersionRetention returns the retention configuration of an exact version of an object.
func (*SpannerAdapter) GetObjectLastCommitted ¶ added in v1.103.2
func (s *SpannerAdapter) GetObjectLastCommitted(ctx context.Context, opts GetObjectLastCommitted) (object Object, err error)
GetObjectLastCommitted implements Adapter.
func (*SpannerAdapter) GetObjectLastCommittedLegalHold ¶ added in v1.113.1
func (s *SpannerAdapter) GetObjectLastCommittedLegalHold(ctx context.Context, opts GetObjectLastCommittedLegalHold) (_ bool, err error)
GetObjectLastCommittedLegalHold returns the legal hold configuration of the most recently committed version of an object.
func (*SpannerAdapter) GetObjectLastCommittedRetention ¶ added in v1.110.1
func (s *SpannerAdapter) GetObjectLastCommittedRetention(ctx context.Context, opts GetObjectLastCommittedRetention) (_ Retention, err error)
GetObjectLastCommittedRetention returns the retention configuration of the most recently committed version of an object.
func (*SpannerAdapter) GetSegmentByPosition ¶ added in v1.106.1
func (s *SpannerAdapter) GetSegmentByPosition(ctx context.Context, opts GetSegmentByPosition) (segment Segment, aliasPieces AliasPieces, err error)
GetSegmentByPosition returns information about segment on the specified position.
func (*SpannerAdapter) GetSegmentPositionsAndKeys ¶ added in v1.106.1
func (s *SpannerAdapter) GetSegmentPositionsAndKeys(ctx context.Context, streamID uuid.UUID) (keysNonces []EncryptedKeyAndNonce, err error)
GetSegmentPositionsAndKeys fetches the Position, EncryptedKeyNonce, and EncryptedKey for all segments in the db for the given stream ID, ordered by position.
func (*SpannerAdapter) GetStreamPieceCountByAlias ¶ added in v1.107.1
func (s *SpannerAdapter) GetStreamPieceCountByAlias(ctx context.Context, opts GetStreamPieceCountByNodeID) (result map[NodeAlias]int64, err error)
GetStreamPieceCountByAlias returns piece count by node alias.
func (*SpannerAdapter) GetTableStats ¶ added in v1.104.1
func (s *SpannerAdapter) GetTableStats(ctx context.Context, opts GetTableStats) (result TableStats, err error)
GetTableStats (will) implement Adapter.
func (*SpannerAdapter) Implementation ¶ added in v1.112.2
func (s *SpannerAdapter) Implementation() dbutil.Implementation
Implementation returns the dbutil.Implementation code for the adapter.
func (*SpannerAdapter) IterateLoopSegments ¶ added in v1.103.2
func (s *SpannerAdapter) IterateLoopSegments(ctx context.Context, aliasCache *NodeAliasCache, opts IterateLoopSegments, fn func(context.Context, LoopSegmentsIterator) error) (err error)
IterateLoopSegments implements Adapter.
func (*SpannerAdapter) ListBucketsStreamIDs ¶ added in v1.107.1
func (s *SpannerAdapter) ListBucketsStreamIDs(ctx context.Context, opts ListBucketsStreamIDs, bucketNamesBytes [][]byte, projectIDs []uuid.UUID) (result ListBucketsStreamIDsResult, err error)
ListBucketsStreamIDs lists the streamIDs of a list of buckets.
func (*SpannerAdapter) ListNodeAliases ¶ added in v1.103.2
func (s *SpannerAdapter) ListNodeAliases(ctx context.Context) (aliases []NodeAliasEntry, err error)
ListNodeAliases implements Adapter.
func (*SpannerAdapter) ListObjects ¶ added in v1.106.1
func (s *SpannerAdapter) ListObjects(ctx context.Context, opts ListObjects) (result ListObjectsResult, err error)
ListObjects lists objects.
func (*SpannerAdapter) ListSegments ¶ added in v1.106.1
func (s *SpannerAdapter) ListSegments(ctx context.Context, opts ListSegments, aliasCache *NodeAliasCache) (result ListSegmentsResult, err error)
ListSegments lists specified stream segments.
func (*SpannerAdapter) ListStreamPositions ¶ added in v1.106.1
func (s *SpannerAdapter) ListStreamPositions(ctx context.Context, opts ListStreamPositions) (result ListStreamPositionsResult, err error)
ListStreamPositions lists specified stream segment positions.
func (*SpannerAdapter) MigrateToLatest ¶ added in v1.112.2
func (s *SpannerAdapter) MigrateToLatest(ctx context.Context) error
MigrateToLatest migrates database to the latest version.
func (*SpannerAdapter) Name ¶ added in v1.106.1
func (s *SpannerAdapter) Name() string
Name returns the name of the adapter.
func (*SpannerAdapter) Now ¶ added in v1.107.1
Now returns the current time according to the database.
func (*SpannerAdapter) PendingObjectExists ¶ added in v1.104.1
func (s *SpannerAdapter) PendingObjectExists(ctx context.Context, opts BeginSegment) (exists bool, err error)
PendingObjectExists checks whether an object already exists.
func (*SpannerAdapter) Ping ¶ added in v1.107.1
func (s *SpannerAdapter) Ping(ctx context.Context) error
Ping checks whether connection has been established.
func (*SpannerAdapter) SetObjectExactVersionLegalHold ¶ added in v1.113.1
func (s *SpannerAdapter) SetObjectExactVersionLegalHold(ctx context.Context, opts SetObjectExactVersionLegalHold) (err error)
SetObjectExactVersionLegalHold sets the legal hold configuration of an exact version of an object.
func (*SpannerAdapter) SetObjectExactVersionRetention ¶ added in v1.110.1
func (s *SpannerAdapter) SetObjectExactVersionRetention(ctx context.Context, opts SetObjectExactVersionRetention) (err error)
SetObjectExactVersionRetention sets the retention configuration of an exact version of an object.
func (*SpannerAdapter) SetObjectLastCommittedLegalHold ¶ added in v1.113.1
func (s *SpannerAdapter) SetObjectLastCommittedLegalHold(ctx context.Context, opts SetObjectLastCommittedLegalHold) (err error)
SetObjectLastCommittedLegalHold sets the legal hold configuration of the most recently committed version of an object.
func (*SpannerAdapter) SetObjectLastCommittedRetention ¶ added in v1.110.1
func (s *SpannerAdapter) SetObjectLastCommittedRetention(ctx context.Context, opts SetObjectLastCommittedRetention) (err error)
SetObjectLastCommittedRetention sets the retention configuration of the most recently committed version of an object.
func (*SpannerAdapter) SpannerMigration ¶ added in v1.114.2
func (s *SpannerAdapter) SpannerMigration() *migrate.Migration
SpannerMigration returns steps needed for migrating spanner database.
func (*SpannerAdapter) TestMigrateToLatest ¶ added in v1.110.1
func (s *SpannerAdapter) TestMigrateToLatest(ctx context.Context) error
TestMigrateToLatest creates a database and applies all the migration for test purposes.
func (*SpannerAdapter) TestingBatchInsertObjects ¶ added in v1.106.1
func (s *SpannerAdapter) TestingBatchInsertObjects(ctx context.Context, objects []RawObject) (err error)
TestingBatchInsertObjects batch inserts objects for testing.
func (*SpannerAdapter) TestingBatchInsertSegments ¶ added in v1.103.2
func (s *SpannerAdapter) TestingBatchInsertSegments(ctx context.Context, aliasCache *NodeAliasCache, segments []RawSegment) (err error)
TestingBatchInsertSegments implements SpannerAdapter.
func (*SpannerAdapter) TestingBeginObjectExactVersion ¶ added in v1.103.2
func (s *SpannerAdapter) TestingBeginObjectExactVersion(ctx context.Context, opts BeginObjectExactVersion, object *Object) error
TestingBeginObjectExactVersion implements Adapter.
func (*SpannerAdapter) TestingDeleteAll ¶ added in v1.103.2
func (s *SpannerAdapter) TestingDeleteAll(ctx context.Context) (err error)
TestingDeleteAll implements Adapter.
func (*SpannerAdapter) TestingGetAllObjects ¶ added in v1.104.1
func (s *SpannerAdapter) TestingGetAllObjects(ctx context.Context) (_ []RawObject, err error)
TestingGetAllObjects returns the state of the database.
func (*SpannerAdapter) TestingGetAllSegments ¶ added in v1.103.2
func (s *SpannerAdapter) TestingGetAllSegments(ctx context.Context, aliasCache *NodeAliasCache) (segments []RawSegment, err error)
TestingGetAllSegments implements Adapter.
func (*SpannerAdapter) TestingSetObjectVersion ¶ added in v1.112.2
func (s *SpannerAdapter) TestingSetObjectVersion(ctx context.Context, object ObjectStream, randomVersion Version) (rowsAffected int64, err error)
TestingSetObjectVersion sets the version of the object to the given value.
func (*SpannerAdapter) TestingSetPlacementAllSegments ¶ added in v1.112.2
func (s *SpannerAdapter) TestingSetPlacementAllSegments(ctx context.Context, placement storj.PlacementConstraint) (err error)
TestingSetPlacementAllSegments sets the placement of all segments to the given value.
func (*SpannerAdapter) UnderlyingDB ¶ added in v1.107.1
func (s *SpannerAdapter) UnderlyingDB() *spanner.Client
UnderlyingDB returns a handle to the underlying DB.
func (*SpannerAdapter) UpdateObjectLastCommittedMetadata ¶ added in v1.106.1
func (s *SpannerAdapter) UpdateObjectLastCommittedMetadata(ctx context.Context, opts UpdateObjectLastCommittedMetadata) (affected int64, err error)
UpdateObjectLastCommittedMetadata updates an object metadata.
func (*SpannerAdapter) UpdateSegmentPieces ¶ added in v1.106.1
func (s *SpannerAdapter) UpdateSegmentPieces(ctx context.Context, opts UpdateSegmentPieces, oldPieces, newPieces AliasPieces) (resultPieces AliasPieces, err error)
UpdateSegmentPieces updates pieces for specified segment, if pieces matches oldPieces.
func (*SpannerAdapter) UpdateTableStats ¶ added in v1.107.1
func (s *SpannerAdapter) UpdateTableStats(ctx context.Context) error
UpdateTableStats forces an update of table statistics. Probably useful mostly in test scenarios.
func (*SpannerAdapter) WithTx ¶ added in v1.104.1
func (s *SpannerAdapter) WithTx(ctx context.Context, f func(context.Context, TransactionAdapter) error) error
WithTx provides a TransactionAdapter for the context of a database transaction.
type SpannerConfig ¶ added in v1.103.2
type SpannerConfig struct { Database string `help:"Database definition for spanner connection in the form projects/P/instances/I/databases/DB"` ApplicationName string `help:"Application name to be used in spanner client as a tag for queries and transactions"` }
SpannerConfig includes all the configuration required by using spanner.
func NewTestSpannerConfig ¶ added in v1.103.2
func NewTestSpannerConfig(database SpannerTestDatabase) SpannerConfig
NewTestSpannerConfig creates SpannerConfig for testing.
type SpannerTestDatabase ¶ added in v1.103.2
type SpannerTestDatabase struct {
// contains filtered or unexported fields
}
SpannerTestDatabase manages Spanner database and migration for tests.
func NewSpannerTestDatabase ¶ added in v1.104.1
func NewSpannerTestDatabase(ctx context.Context, logger *zap.Logger, connstr string, withMigration bool) (SpannerTestDatabase, error)
NewSpannerTestDatabase creates the database (=creates / migrates the database).
func (SpannerTestDatabase) Close ¶ added in v1.103.2
func (d SpannerTestDatabase) Close() error
Close drops the temporary test database.
func (SpannerTestDatabase) Connection ¶ added in v1.104.1
func (d SpannerTestDatabase) Connection() string
Connection returns with the used connection string (with added unique suffix).
type StreamIDCursor ¶
StreamIDCursor is a cursor used during iteration through streamIDs of a pending object.
type StreamRange ¶
StreamRange allows to limit stream positions based on the plain offsets.
type StreamVersionID ¶ added in v1.95.1
StreamVersionID represents combined Version and StreamID suffix for purposes of public API. First 8 bytes represents Version and rest are object StreamID suffix. TODO(ver): we may consider renaming this type to VersionID but to do that we would need to rename metabase.Version into metabase.SequenceNumber/metabase.Sequence to avoid confusion.
func NewStreamVersionID ¶ added in v1.110.1
func NewStreamVersionID(version Version, streamID uuid.UUID) StreamVersionID
NewStreamVersionID returns a new stream version id.
func StreamVersionIDFromBytes ¶ added in v1.95.1
func StreamVersionIDFromBytes(bytes []byte) (_ StreamVersionID, err error)
StreamVersionIDFromBytes decodes stream version id from bytes.
func (StreamVersionID) Bytes ¶ added in v1.95.1
func (s StreamVersionID) Bytes() []byte
Bytes returnes stream version id bytes.
func (StreamVersionID) StreamIDSuffix ¶ added in v1.95.1
func (s StreamVersionID) StreamIDSuffix() []byte
StreamIDSuffix returns StreamID suffix encoded into stream version id.
func (StreamVersionID) Version ¶ added in v1.95.1
func (s StreamVersionID) Version() Version
Version returns Version encoded into stream version id.
type TableStats ¶ added in v1.32.2
type TableStats struct {
SegmentCount int64
}
TableStats contains information about the metabase status.
type TestingPrecommitDeleteMode ¶ added in v1.111.4
type TestingPrecommitDeleteMode int
TestingPrecommitDeleteMode represents what strategy to use when executing a precommit object deletion. We are using it only to test different strategies for deleting objects in the precommit phase. In production it shouldn't be set to anything other than DefaultUnversionedPrecommitMode.
const ( // DefaultUnversionedPrecommitMode represents a default precommit object deletion strategy. DefaultUnversionedPrecommitMode TestingPrecommitDeleteMode = 0 // WithPrecheckSQLUnversionedPrecommitMode represents a precommit object deletion strategy // that performs a preliminary check using a subquery within the DELETE query to ensure that // the object exists before attempting to delete it. WithPrecheckSQLUnversionedPrecommitMode TestingPrecommitDeleteMode = 1 // WithVersionPrecheckUnversionedPrecommitMode represents a precommit object deletion strategy // that refrains from executing a deletion query and exits early if no object versions are // present at the specified location. WithVersionPrecheckUnversionedPrecommitMode TestingPrecommitDeleteMode = 2 )
type TransactionAdapter ¶ added in v1.104.1
type TransactionAdapter interface {
// contains filtered or unexported methods
}
TransactionAdapter is a low level extension point to use datasource related queries inside of a transaction.
type UpdateObjectLastCommittedMetadata ¶ added in v1.91.2
type UpdateObjectLastCommittedMetadata struct { ObjectLocation StreamID uuid.UUID EncryptedMetadata []byte EncryptedMetadataNonce []byte EncryptedMetadataEncryptedKey []byte }
UpdateObjectLastCommittedMetadata contains arguments necessary for replacing an object metadata.
func (*UpdateObjectLastCommittedMetadata) Verify ¶ added in v1.91.2
func (obj *UpdateObjectLastCommittedMetadata) Verify() error
Verify object stream fields.
type UpdateSegmentPieces ¶
type UpdateSegmentPieces struct { // Name of the database adapter to use for this segment. If empty (""), check all adapters // until the segment is found. DBAdapterName string StreamID uuid.UUID Position SegmentPosition OldPieces Pieces NewRedundancy storj.RedundancyScheme NewPieces Pieces NewRepairedAt time.Time // sets new time of last segment repair (optional). }
UpdateSegmentPieces contains arguments necessary for updating segment pieces.
Source Files ¶
- accounting.go
- adapter.go
- adapter_spanner.go
- alias.go
- aliascache.go
- aliasmap.go
- aliaspiece.go
- commit.go
- commit_object.go
- common.go
- copy_object.go
- db.go
- delete.go
- delete_bucket.go
- delete_objects.go
- encoding.go
- get.go
- iterator.go
- iterator_spanner.go
- list.go
- list_objects.go
- list_pending.go
- list_segments.go
- list_verify_segments.go
- loop.go
- metadata.go
- move_object.go
- mud.go
- precommit.go
- raw.go
- stats.go
- streamstat.go
- testmigrate.go
- update.go
- util.go
Directories ¶
Path | Synopsis |
---|---|
Package zombiedeletion contains the functions needed to run zombie objects deletion chore.
|
Package zombiedeletion contains the functions needed to run zombie objects deletion chore. |