interfaces

Documentation

Overview

interfaces establishes the contract required for any implementation of the export store functionality in a database provider.

Index

• type StoreClient

Types

type StoreClient

type StoreClient interface {
	// Store persists a stored object to the data store.
	Store(o models.StoredObject) error

	// RetrieveFromStore gets an object from the data store.
	RetrieveFromStore(appServiceKey string) (objects []models.StoredObject, err error)

	// Update replaces the data currently in the store with the provided data.
	Update(o models.StoredObject) error

	// UpdateRetryCount modifies the RetryCount variable for a given object.
	UpdateRetryCount(id string, count int) error

	// RemoveFromStore removes an object from the data store.
	RemoveFromStore(id string) error

	// NewClient provides a factory for building a StoreClient
	NewClient(config db.Configuration) (StoreClient, error)
}

StoreClient establishes the contracts required to persist exported data before being forwarded.