stores

package
v0.0.0-...-999fc6a Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 13, 2025 License: MIT Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source 
const AWS = "S3"
View Source 
const AZURE = "AZURE"
View Source 
const FILE_SYSTEM = "FILE_SYSTEM"
View Source 
const GOOGLE = "GOOGLE"

Variables

This section is empty.

Functions

func RegisterStore 

func RegisterStore(name string, factory func() StreamStore)

Types

type FileSystemStore added in v0.0.8 

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

func (*FileSystemStore) CreateTier added in v0.0.8 

func (fs *FileSystemStore) CreateTier(ctx context.Context, args *models.CreateTierArgs) error

func (*FileSystemStore) DeletePage added in v0.0.8 

func (fs *FileSystemStore) DeletePage(ctx context.Context, args *models.DeletePageArgs) error

func (*FileSystemStore) DeletePartition added in v0.0.8 

func (fs *FileSystemStore) DeletePartition(ctx context.Context, args *models.DeletePartitionArgs) error

func (*FileSystemStore) DeleteSpace added in v0.0.8 

func (fs *FileSystemStore) DeleteSpace(ctx context.Context, args *models.DeleteSpaceArgs) error

func (*FileSystemStore) GetPages added in v0.0.8 

func (fs *FileSystemStore) GetPages(ctx context.Context, args *models.GetPagesArgs) enumerators.Enumerator[int32]

func (*FileSystemStore) GetPartitions added in v0.0.8 

func (fs *FileSystemStore) GetPartitions(ctx context.Context, args *models.GetPartitionsArgs) enumerators.Enumerator[string]

func (*FileSystemStore) GetSpaces added in v0.0.8 

func (fs *FileSystemStore) GetSpaces(ctx context.Context, args *models.GetSpacesArgs) enumerators.Enumerator[string]

func (*FileSystemStore) ReadManifest added in v0.0.8 

func (fs *FileSystemStore) ReadManifest(ctx context.Context, args *models.ReadManifestArgs) (*models.ManifestWrapper, error)

func (*FileSystemStore) ReadPage added in v0.0.8 

func (fs *FileSystemStore) ReadPage(ctx context.Context, args *models.ReadPageArgs) enumerators.Enumerator[*models.Entry]

func (*FileSystemStore) Scavenge added in v0.0.8 

func (fs *FileSystemStore) Scavenge(ctx context.Context) error

func (*FileSystemStore) WriteManifest added in v0.0.8 

func (fs *FileSystemStore) WriteManifest(ctx context.Context, args *models.WriteManifestArgs) (models.ConcurrencyTag, error)

func (*FileSystemStore) WritePage added in v0.0.8 

func (fs *FileSystemStore) WritePage(ctx context.Context, args *models.WritePageArgs, entries enumerators.Enumerator[*models.Entry]) (*models.Page, error)

type GoogleStreamStore 

type GoogleStreamStore struct {
}

FileSystemStreamStore represents a store for file-based streams

func (*GoogleStreamStore) CreateTier 

func (s *GoogleStreamStore) CreateTier(ctx context.Context, args *models.CreateTierArgs) error

CreateTier implements StreamStore.

func (*GoogleStreamStore) DeletePage 

func (s *GoogleStreamStore) DeletePage(ctx context.Context, args *models.DeletePageArgs) error

DeletePage implements StreamStore.

func (*GoogleStreamStore) DeletePartition 

func (s *GoogleStreamStore) DeletePartition(ctx context.Context, args *models.DeletePartitionArgs) error

DeletePartition implements StreamStore.

func (*GoogleStreamStore) DeleteSpace 

func (s *GoogleStreamStore) DeleteSpace(ctx context.Context, args *models.DeleteSpaceArgs) error

DeleteSpace implements StreamStore.

func (*GoogleStreamStore) GetPages 

func (s *GoogleStreamStore) GetPages(ctx context.Context, args *models.GetPagesArgs) enumerators.Enumerator[int32]

GetPages implements StreamStore.

func (*GoogleStreamStore) GetPartitions 

func (s *GoogleStreamStore) GetPartitions(ctx context.Context, args *models.GetPartitionsArgs) enumerators.Enumerator[string]

GetPartitions implements StreamStore.

func (*GoogleStreamStore) GetSpaces 

func (s *GoogleStreamStore) GetSpaces(ctx context.Context, args *models.GetSpacesArgs) enumerators.Enumerator[string]

GetSpaces implements StreamStore.

func (*GoogleStreamStore) ReadManifest 

func (s *GoogleStreamStore) ReadManifest(ctx context.Context, args *models.ReadManifestArgs) (*models.ManifestWrapper, error)

ReadManifest implements StreamStore.

func (*GoogleStreamStore) ReadPage 

func (s *GoogleStreamStore) ReadPage(ctx context.Context, args *models.ReadPageArgs) enumerators.Enumerator[*models.Entry]

ReadPage implements StreamStore.

func (*GoogleStreamStore) Scavenge added in v0.0.8 

func (s *GoogleStreamStore) Scavenge(ctx context.Context) error

ScavengeTier implements StreamStore.

func (*GoogleStreamStore) WriteManifest 

func (s *GoogleStreamStore) WriteManifest(ctx context.Context, args *models.WriteManifestArgs) (models.ConcurrencyTag, error)

WriteManifest implements StreamStore.

func (*GoogleStreamStore) WritePage 

func (s *GoogleStreamStore) WritePage(ctx context.Context, args *models.WritePageArgs, entries enumerators.Enumerator[*models.Entry]) (*models.Page, error)

WritePage implements StreamStore.

type S3StreamStore 

type S3StreamStore struct {
}

FileSystemStreamStore represents a store for file-based streams

func (*S3StreamStore) CreateTier 

func (s *S3StreamStore) CreateTier(ctx context.Context, args *models.CreateTierArgs) error

CreateTier implements StreamStore.

func (*S3StreamStore) DeletePage 

func (s *S3StreamStore) DeletePage(ctx context.Context, args *models.DeletePageArgs) error

DeletePage implements StreamStore.

func (*S3StreamStore) DeletePartition 

func (s *S3StreamStore) DeletePartition(ctx context.Context, args *models.DeletePartitionArgs) error

DeletePartition implements StreamStore.

func (*S3StreamStore) DeleteSpace 

func (s *S3StreamStore) DeleteSpace(ctx context.Context, args *models.DeleteSpaceArgs) error

DeleteSpace implements StreamStore.

func (*S3StreamStore) GetPages 

func (s *S3StreamStore) GetPages(ctx context.Context, args *models.GetPagesArgs) enumerators.Enumerator[int32]

GetPages implements StreamStore.

func (*S3StreamStore) GetPartitions 

func (s *S3StreamStore) GetPartitions(ctx context.Context, args *models.GetPartitionsArgs) enumerators.Enumerator[string]

GetPartitions implements StreamStore.

func (*S3StreamStore) GetSpaces 

func (s *S3StreamStore) GetSpaces(ctx context.Context, args *models.GetSpacesArgs) enumerators.Enumerator[string]

GetSpaces implements StreamStore.

func (*S3StreamStore) ReadManifest 

func (s *S3StreamStore) ReadManifest(ctx context.Context, args *models.ReadManifestArgs) (*models.ManifestWrapper, error)

ReadManifest implements StreamStore.

func (*S3StreamStore) ReadPage 

func (s *S3StreamStore) ReadPage(ctx context.Context, args *models.ReadPageArgs) enumerators.Enumerator[*models.Entry]

ReadPage implements StreamStore.

func (*S3StreamStore) Scavenge added in v0.0.8 

func (s *S3StreamStore) Scavenge(ctx context.Context) error

ScavengeTier implements StreamStore.

func (*S3StreamStore) WriteManifest 

func (s *S3StreamStore) WriteManifest(ctx context.Context, args *models.WriteManifestArgs) (models.ConcurrencyTag, error)

WriteManifest implements StreamStore.

func (*S3StreamStore) WritePage 

func (s *S3StreamStore) WritePage(ctx context.Context, args *models.WritePageArgs, entries enumerators.Enumerator[*models.Entry]) (*models.Page, error)

WritePage implements StreamStore.

type StreamStore 

type StreamStore interface {

	// CreatePartition creates a new stream based on the provided arguments.
	// Arguments: CreatePartitionArgs - the parameters for creating the stream.
	// Returns: error - an error if stream creation fails, nil if successful.
	CreateTier(ctx context.Context, args *models.CreateTierArgs) error

	// ReadManifest reads the manifest associated with a specific stream or space.
	// Arguments: ReadManifestArgs - the parameters to locate the manifest.
	// Returns: ManifestWrapper - the wrapped manifest data, or an error if reading fails.
	ReadManifest(ctx context.Context, args *models.ReadManifestArgs) (*models.ManifestWrapper, error)

	// WriteManifest writes a manifest to storage.
	// Arguments: WriteManifestArgs - contains details for writing the manifest.
	// Returns: ConcurrencyTag - the concurrency tag representing the write operation's version.
	//          error - any error encountered during the write process.
	WriteManifest(ctx context.Context, args *models.WriteManifestArgs) (models.ConcurrencyTag, error)

	// ReadPage retrieves entries from a specific page.
	// Arguments: ReadPageArgs - contains the parameters needed to locate the page.
	// Returns: Enumerator[*models.Entry] - a lazy enumerator for the entries within the page.
	//          The entries are retrieved on demand as the enumerator is iterated over.
	ReadPage(ctx context.Context, args *models.ReadPageArgs) enumerators.Enumerator[*models.Entry]

	// WritePage writes a page containing entries to storage.
	// Arguments: WritePageArgs - parameters for creating the page and its entries.
	// Returns: Page - the page that was written, Entry - an entry in the page,
	//          and an error if there was a failure in writing.
	WritePage(ctx context.Context, args *models.WritePageArgs, entries enumerators.Enumerator[*models.Entry]) (*models.Page, error)

	// DeletePage deletes a specific page from storage.
	// Arguments: DeletePageArgs - parameters identifying the page to be deleted.
	// Returns: error - any error encountered during the deletion of the page.
	DeletePage(ctx context.Context, args *models.DeletePageArgs) error

	// GetPages retrieves a list of page numbers.
	// Arguments: GetPagesArgs - parameters for retrieving the page information.
	// Returns: Enumerator[int32] - a lazy enumerator of page numbers.
	//          The page numbers are returned one by one as the enumerator is iterated over.
	GetPages(ctx context.Context, args *models.GetPagesArgs) enumerators.Enumerator[int32]

	// GetSpaces retrieves a list of space keys.
	// Arguments: GetSpacesArgs - parameters for retrieving space information.
	// Returns: Enumerator[string] - a lazy enumerator of space keys.
	//          The space keys are returned one by one as the enumerator is iterated over.
	GetSpaces(ctx context.Context, args *models.GetSpacesArgs) enumerators.Enumerator[string]

	// GetPartitions retrieves a list of stream keys.
	// Arguments: GetPartitionsArgs - parameters for retrieving stream information.
	// Returns: Enumerator[string] - a lazy enumerator of stream keys.
	//          The stream keys are returned one by one as the enumerator is iterated over.
	GetPartitions(ctx context.Context, args *models.GetPartitionsArgs) enumerators.Enumerator[string]

	// DeleteSpace deletes a space from storage.
	// Arguments: DeleteSpaceArgs - parameters identifying the space to be deleted.
	// Returns: error - any error encountered during the deletion of the space.
	DeleteSpace(ctx context.Context, args *models.DeleteSpaceArgs) error

	// DeletePartition deletes a stream from storage.
	// Arguments: DeletePartitionArgs - parameters identifying the stream to be deleted.
	// Returns: error - any error encountered during the deletion of the stream.
	DeletePartition(ctx context.Context, args *models.DeletePartitionArgs) error

	// Scavenge deletes obsolete pages.
	Scavenge(ctx context.Context) error
}

StreamStore defines the interface for operations on stream data, including stream creation, reading and writing manifests, managing pages, and handling spaces and streams.

func NewFileSystemStore 

func NewFileSystemStore() StreamStore

func NewGoogleStore 

func NewGoogleStore() StreamStore

NewFileSystemStore creates a new instance of FileSystemPartitionStore

func NewS3Store 

func NewS3Store() StreamStore

NewFileSystemStore creates a new instance of FileSystemPartitionStore

func NewStore 

func NewStore(name string) StreamStore

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.