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 and returns the assigned UUID.
	Store(o contracts.StoredObject) (id string, err error)

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

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

	// RemoveFromStore removes an object from the data store.
	RemoveFromStore(o contracts.StoredObject) error

	// Disconnect ends the connection.
	Disconnect() error
}

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