backends

package

Go to main page

Versions in this module

v4

v4.0.8

Nov 14, 2024

v4.0.7

Aug 28, 2023

v4.0.6

Aug 24, 2023

v4.0.5

Jul 26, 2023

v4.0.4

Jul 26, 2023

v4.0.3

Jul 26, 2023

v4.0.2

Jul 26, 2023

Changes in this version

type Backend

+ SetEndpoint func(string)

type ConnectOptions

+ Endpoint string

type DynamoBackend

+ func (self *DynamoBackend) SetEndpoint(endpoint string)

v4.0.1

Sep 6, 2022

v4.0.0

Sep 6, 2022

Changes in this version

+ var AutopingTimeout = 5 * time.Second

+ var DefaultAmazonRegion = `us-east-1`

+ var DefaultAutoregister = false

+ var DefaultCompoundJoiner = `:`

+ var DefaultSharedCredentialsFile = `~/.aws/credentials`

+ var DefaultSharedCredentialsProfile = `default`

+ var ElasticsearchBatchFlushCount = 1

+ var ElasticsearchBatchFlushInterval = 10 * time.Second

+ var ElasticsearchConnectTimeout = 3 * time.Second

+ var ElasticsearchDocumentType = `document`

+ var ElasticsearchIdentityField = `_id`

+ var ElasticsearchRequestTimeout = 30 * time.Second

+ var ElasticsearchResponseHeaderTimeout = 10 * time.Second

+ var ElasticsearchTLSTimeout = 10 * time.Second

+ var IndexerPageSize int = 100

+ var IndexerResultsStop = fmt.Errorf(`stop indexer results`)

+ var InitialPingTimeout = time.Duration(10) * time.Second

+ var MaxFacetCardinality int = 10000

+ var NotImplementedError = fmt.Errorf("Not Implemented")

+ var SqlArrayFieldHintLength = 131069

+ var SqlObjectFieldHintLength = 131071

+ func DefaultQueryImplementation(ctx context.Context, indexer Indexer, collection *dal.Collection, ...) (*dal.RecordSet, error)

+ func PopulateRecordSetPageDetails(recordset *dal.RecordSet, f *filter.Filter, page IndexPage)

+ func RegisterBackend(name string, fn BackendFunc)

+ func RegisterSqlInitFunc(scheme string, fn SqlInitFunc)

+ func RegisterSqlPreInitFunc(scheme string, fn SqlPreInitFunc)

+ type Aggregator interface

+ AggregatorConnectionString func() *dal.ConnectionString

+ AggregatorInitialize func(Backend) error

+ Average func(ctx context.Context, collection *dal.Collection, field string, ...) (float64, error)

+ Count func(ctx context.Context, collection *dal.Collection, f ...*filter.Filter) (uint64, error)

+ GroupBy func(ctx context.Context, collection *dal.Collection, fields []string, ...) (*dal.RecordSet, error)

+ Maximum func(ctx context.Context, collection *dal.Collection, field string, ...) (float64, error)

+ Minimum func(ctx context.Context, collection *dal.Collection, field string, ...) (float64, error)

+ Sum func(ctx context.Context, collection *dal.Collection, field string, ...) (float64, error)

+ type Backend interface

+ CreateCollection func(ctx context.Context, definition *dal.Collection) error

+ Delete func(ctx context.Context, collection string, ids ...interface{}) error

+ DeleteCollection func(ctx context.Context, collection string) error

+ Exists func(ctx context.Context, collection string, id interface{}) bool

+ Flush func() error

+ GetCollection func(collection string) (*dal.Collection, error)

+ GetConnectionString func() *dal.ConnectionString

+ Initialize func() error

+ Insert func(ctx context.Context, collection string, records *dal.RecordSet) error

+ ListCollections func() ([]string, error)

+ Ping func(context.Context, time.Duration) error

+ RegisterCollection func(*dal.Collection)

+ Retrieve func(ctx context.Context, collection string, id interface{}, fields ...string) (*dal.Record, error)

+ SetIndexer func(dal.ConnectionString) error

+ String func() string

+ Supports func(feature ...BackendFeature) bool

+ Update func(ctx context.Context, collection string, records *dal.RecordSet, ...) error

+ WithAggregator func(collection *dal.Collection) Aggregator

+ WithSearch func(collection *dal.Collection, filters ...*filter.Filter) Indexer

+ func MakeBackend(connection dal.ConnectionString) (Backend, error)

+ func NewDynamoBackend(connection dal.ConnectionString) Backend

+ func NewSqlBackend(connection dal.ConnectionString) Backend

+ type BackendFeature int

+ const CompositeKeys

+ const Constraints

+ const PartialSearch

+ type BackendFunc func(dal.ConnectionString) Backend

+ type CachingBackend struct

+ func NewCachingBackend(parent Backend) *CachingBackend

+ func (self *CachingBackend) CreateCollection(ctx context.Context, definition *dal.Collection) error

+ func (self *CachingBackend) Delete(ctx context.Context, collection string, ids ...interface{}) error

+ func (self *CachingBackend) DeleteCollection(ctx context.Context, collection string) error

+ func (self *CachingBackend) Exists(ctx context.Context, collection string, id interface{}) bool

+ func (self *CachingBackend) Flush() error

+ func (self *CachingBackend) GetCollection(collection string) (*dal.Collection, error)

+ func (self *CachingBackend) GetConnectionString() *dal.ConnectionString

+ func (self *CachingBackend) Initialize() error

+ func (self *CachingBackend) Insert(ctx context.Context, collection string, records *dal.RecordSet) error

+ func (self *CachingBackend) ListCollections() ([]string, error)

+ func (self *CachingBackend) Ping(ctx context.Context, d time.Duration) error

+ func (self *CachingBackend) RegisterCollection(c *dal.Collection)

+ func (self *CachingBackend) ResetCache()

+ func (self *CachingBackend) Retrieve(ctx context.Context, collection string, id interface{}, fields ...string) (*dal.Record, error)

+ func (self *CachingBackend) SetIndexer(cs dal.ConnectionString) error

+ func (self *CachingBackend) String() string

+ func (self *CachingBackend) Supports(feature ...BackendFeature) bool

+ func (self *CachingBackend) Update(ctx context.Context, collection string, records *dal.RecordSet, ...) error

+ func (self *CachingBackend) WithAggregator(collection *dal.Collection) Aggregator

+ func (self *CachingBackend) WithSearch(collection *dal.Collection, filters ...*filter.Filter) Indexer

+ type ConnectOptions struct

+ AdditionalIndexers []string

+ AutocreateCollections bool

+ Indexer string

+ SkipInitialize bool

+ type DynamoBackend struct

+ func (self *DynamoBackend) CreateCollection(ctx context.Context, definition *dal.Collection) error

+ func (self *DynamoBackend) Delete(ctx context.Context, name string, ids ...interface{}) error

+ func (self *DynamoBackend) DeleteCollection(ctx context.Context, name string) error

+ func (self *DynamoBackend) DeleteQuery(ctx context.Context, collection *dal.Collection, flt *filter.Filter) error

+ func (self *DynamoBackend) Exists(ctx context.Context, name string, id interface{}) bool

+ func (self *DynamoBackend) Flush() error

+ func (self *DynamoBackend) FlushIndex() error

+ func (self *DynamoBackend) GetBackend() Backend

+ func (self *DynamoBackend) GetCollection(name string) (*dal.Collection, error)

+ func (self *DynamoBackend) GetConnectionString() *dal.ConnectionString

+ func (self *DynamoBackend) Index(ctx context.Context, collection *dal.Collection, records *dal.RecordSet) error

+ func (self *DynamoBackend) IndexConnectionString() *dal.ConnectionString

+ func (self *DynamoBackend) IndexExists(ctx context.Context, collection *dal.Collection, id interface{}) bool

+ func (self *DynamoBackend) IndexInitialize(Backend) error

+ func (self *DynamoBackend) IndexRemove(ctx context.Context, collection *dal.Collection, ids []interface{}) error

+ func (self *DynamoBackend) IndexRetrieve(ctx context.Context, collection *dal.Collection, id interface{}) (*dal.Record, error)

+ func (self *DynamoBackend) Initialize() error

+ func (self *DynamoBackend) Insert(ctx context.Context, name string, records *dal.RecordSet) error

+ func (self *DynamoBackend) ListCollections() ([]string, error)

+ func (self *DynamoBackend) ListValues(ctx context.Context, collection *dal.Collection, fields []string, ...) (map[string][]interface{}, error)

+ func (self *DynamoBackend) Ping(ctx context.Context, timeout time.Duration) error

+ func (self *DynamoBackend) Query(ctx context.Context, collection *dal.Collection, f *filter.Filter, ...) (*dal.RecordSet, error)

+ func (self *DynamoBackend) QueryFunc(ctx context.Context, collection *dal.Collection, flt *filter.Filter, ...) error

+ func (self *DynamoBackend) RegisterCollection(definition *dal.Collection)

+ func (self *DynamoBackend) Retrieve(ctx context.Context, name string, id interface{}, fields ...string) (*dal.Record, error)

+ func (self *DynamoBackend) SetIndexer(indexConnString dal.ConnectionString) error

+ func (self *DynamoBackend) String() string

+ func (self *DynamoBackend) Supports(features ...BackendFeature) bool

+ func (self *DynamoBackend) Update(ctx context.Context, name string, records *dal.RecordSet, target ...string) error

+ func (self *DynamoBackend) WithAggregator(collection *dal.Collection) Aggregator

+ func (self *DynamoBackend) WithSearch(collection *dal.Collection, filters ...*filter.Filter) Indexer

+ type ElasticsearchIndexer struct

+ func NewElasticsearchIndexer(connection dal.ConnectionString) *ElasticsearchIndexer

+ func (self *ElasticsearchIndexer) AggregatorConnectionString() *dal.ConnectionString

+ func (self *ElasticsearchIndexer) AggregatorInitialize(parent Backend) error

+ func (self *ElasticsearchIndexer) Average(ctx context.Context, collection *dal.Collection, field string, ...) (float64, error)

+ func (self *ElasticsearchIndexer) Count(ctx context.Context, collection *dal.Collection, flt ...*filter.Filter) (uint64, error)

+ func (self *ElasticsearchIndexer) DeleteQuery(ctx context.Context, collection *dal.Collection, f *filter.Filter) error

+ func (self *ElasticsearchIndexer) FlushIndex() error

+ func (self *ElasticsearchIndexer) GetBackend() Backend

+ func (self *ElasticsearchIndexer) GroupBy(ctx context.Context, collection *dal.Collection, groupBy []string, ...) (*dal.RecordSet, error)

+ func (self *ElasticsearchIndexer) Index(ctx context.Context, collection *dal.Collection, records *dal.RecordSet) error

+ func (self *ElasticsearchIndexer) IndexConnectionString() *dal.ConnectionString

+ func (self *ElasticsearchIndexer) IndexExists(ctx context.Context, collection *dal.Collection, id interface{}) bool

+ func (self *ElasticsearchIndexer) IndexInitialize(parent Backend) error

+ func (self *ElasticsearchIndexer) IndexRemove(ctx context.Context, collection *dal.Collection, ids []interface{}) error

+ func (self *ElasticsearchIndexer) IndexRetrieve(ctx context.Context, collection *dal.Collection, id interface{}) (*dal.Record, error)

+ func (self *ElasticsearchIndexer) ListValues(ctx context.Context, collection *dal.Collection, fields []string, ...) (map[string][]interface{}, error)

+ func (self *ElasticsearchIndexer) Maximum(ctx context.Context, collection *dal.Collection, field string, ...) (float64, error)

+ func (self *ElasticsearchIndexer) Minimum(ctx context.Context, collection *dal.Collection, field string, ...) (float64, error)

+ func (self *ElasticsearchIndexer) Query(ctx context.Context, collection *dal.Collection, f *filter.Filter, ...) (*dal.RecordSet, error)

+ func (self *ElasticsearchIndexer) QueryFunc(ctx context.Context, collection *dal.Collection, f *filter.Filter, ...) error

+ func (self *ElasticsearchIndexer) Sum(ctx context.Context, collection *dal.Collection, field string, ...) (float64, error)

+ type IndexOperation int

+ const DeleteOperation

+ const InspectionOperation

+ const PersistOperation

+ const RetrieveOperation

+ type IndexPage struct

+ Limit int

+ Offset int

+ Page int

+ TotalPages int

+ TotalResults int64

+ type IndexResultFunc func(record *dal.Record, err error, page IndexPage) error

+ type IndexSelectionStrategy int

+ const All

+ const AllExceptFirst

+ const First

+ const Random

+ const Sequential

+ func (self IndexSelectionStrategy) IsCompoundable() bool

+ type Indexer interface

+ DeleteQuery func(ctx context.Context, collection *dal.Collection, f *filter.Filter) error

+ FlushIndex func() error

+ GetBackend func() Backend

+ Index func(ctx context.Context, collection *dal.Collection, records *dal.RecordSet) error

+ IndexConnectionString func() *dal.ConnectionString

+ IndexExists func(ctx context.Context, collection *dal.Collection, id interface{}) bool

+ IndexInitialize func(Backend) error

+ IndexRemove func(ctx context.Context, collection *dal.Collection, ids []interface{}) error

+ IndexRetrieve func(ctx context.Context, collection *dal.Collection, id interface{}) (*dal.Record, error)

+ ListValues func(ctx context.Context, collection *dal.Collection, fields []string, ...) (map[string][]interface{}, error)

+ Query func(ctx context.Context, collection *dal.Collection, filter *filter.Filter, ...) (*dal.RecordSet, error)

+ QueryFunc func(ctx context.Context, collection *dal.Collection, filter *filter.Filter, ...) error

+ func MakeIndexer(connection dal.ConnectionString) (Indexer, error)

+ type IndexerResult struct

+ Index int

+ Indexer Indexer

+ type IndexerResultFunc func(indexer Indexer, current int, last int) error

+ type Mapper interface

+ All func(ctx context.Context, into interface{}) error

+ Average func(ctx context.Context, field string, flt interface{}) (float64, error)

+ Count func(ctx context.Context, flt interface{}) (uint64, error)

+ Create func(ctx context.Context, from interface{}) error

+ CreateOrUpdate func(ctx context.Context, id interface{}, from interface{}) error

+ Delete func(ctx context.Context, ids ...interface{}) error

+ DeleteQuery func(ctx context.Context, flt interface{}) error

+ Drop func(ctx context.Context) error

+ Each func(ctx context.Context, destZeroValue interface{}, resultFn ResultFunc) error

+ Exists func(ctx context.Context, id interface{}) bool

+ Find func(ctx context.Context, flt interface{}, into interface{}) error

+ FindFunc func(ctx context.Context, flt interface{}, destZeroValue interface{}, ...) error

+ Get func(ctx context.Context, id interface{}, into interface{}) error

+ GetBackend func() Backend

+ GetCollection func() *dal.Collection

+ GroupBy func(ctx context.Context, fields []string, aggregates []filter.Aggregate, ...) (*dal.RecordSet, error)

+ List func(ctx context.Context, fields []string) (map[string][]interface{}, error)

+ ListWithFilter func(ctx context.Context, fields []string, flt interface{}) (map[string][]interface{}, error)

+ Maximum func(ctx context.Context, field string, flt interface{}) (float64, error)

+ Migrate func(ctx context.Context) error

+ Minimum func(ctx context.Context, field string, flt interface{}) (float64, error)

+ Sum func(ctx context.Context, field string, flt interface{}) (float64, error)

+ Update func(ctx context.Context, from interface{}) error

+ type MultiIndex struct

+ DeleteStrategy IndexSelectionStrategy

+ InspectionStrategy IndexSelectionStrategy

+ PersistStrategy IndexSelectionStrategy

+ RetrievalStrategy IndexSelectionStrategy

+ func NewMultiIndex(connectionStrings ...string) *MultiIndex

+ func (self *MultiIndex) AddIndexer(indexer Indexer) error

+ func (self *MultiIndex) AddIndexerByConnectionString(cs string) error

+ func (self *MultiIndex) DeleteQuery(ctx context.Context, collection *dal.Collection, f *filter.Filter) error

+ func (self *MultiIndex) EachSelectedIndex(ctx context.Context, collection *dal.Collection, operation IndexOperation, ...) error

+ func (self *MultiIndex) FlushIndex() error

+ func (self *MultiIndex) GetBackend() Backend

+ func (self *MultiIndex) Index(ctx context.Context, collection *dal.Collection, records *dal.RecordSet) error

+ func (self *MultiIndex) IndexConnectionString() *dal.ConnectionString

+ func (self *MultiIndex) IndexExists(ctx context.Context, collection *dal.Collection, id interface{}) bool

+ func (self *MultiIndex) IndexInitialize(backend Backend) error

+ func (self *MultiIndex) IndexRemove(ctx context.Context, collection *dal.Collection, ids []interface{}) error

+ func (self *MultiIndex) IndexRetrieve(ctx context.Context, collection *dal.Collection, id interface{}) (*dal.Record, error)

+ func (self *MultiIndex) ListValues(ctx context.Context, collection *dal.Collection, fields []string, ...) (map[string][]interface{}, error)

+ func (self *MultiIndex) Query(ctx context.Context, collection *dal.Collection, filter *filter.Filter, ...) (*dal.RecordSet, error)

+ func (self *MultiIndex) QueryFunc(ctx context.Context, collection *dal.Collection, filter *filter.Filter, ...) error

+ func (self *MultiIndex) SelectIndex(collection *dal.Collection, operation IndexOperation, lastIndexer int) ([]IndexerResult, error)

+ type ResultFunc func(ptrToInstance interface{}, err error)

+ type SqlBackend struct

+ func (self *SqlBackend) AggregatorConnectionString() *dal.ConnectionString

+ func (self *SqlBackend) AggregatorInitialize(parent Backend) error

+ func (self *SqlBackend) Average(ctx context.Context, collection *dal.Collection, field string, ...) (float64, error)

+ func (self *SqlBackend) Count(ctx context.Context, collection *dal.Collection, f ...*filter.Filter) (uint64, error)

+ func (self *SqlBackend) CreateCollection(ctx context.Context, definition *dal.Collection) error

+ func (self *SqlBackend) Delete(ctx context.Context, name string, ids ...interface{}) error

+ func (self *SqlBackend) DeleteCollection(ctx context.Context, collectionName string) error

+ func (self *SqlBackend) DeleteQuery(ctx context.Context, collection *dal.Collection, f *filter.Filter) error

+ func (self *SqlBackend) Exists(ctx context.Context, name string, id interface{}) bool

+ func (self *SqlBackend) Flush() error

+ func (self *SqlBackend) FlushIndex() error

+ func (self *SqlBackend) GetBackend() Backend

+ func (self *SqlBackend) GetCollection(name string) (*dal.Collection, error)

+ func (self *SqlBackend) GetConnectionString() *dal.ConnectionString

+ func (self *SqlBackend) GroupBy(ctx context.Context, collection *dal.Collection, groupBy []string, ...) (*dal.RecordSet, error)

+ func (self *SqlBackend) Index(ctx context.Context, collection *dal.Collection, records *dal.RecordSet) error

+ func (self *SqlBackend) IndexConnectionString() *dal.ConnectionString

+ func (self *SqlBackend) IndexExists(ctx context.Context, collection *dal.Collection, id interface{}) bool

+ func (self *SqlBackend) IndexInitialize(parent Backend) error

+ func (self *SqlBackend) IndexRemove(ctx context.Context, collection *dal.Collection, ids []interface{}) error

+ func (self *SqlBackend) IndexRetrieve(ctx context.Context, collection *dal.Collection, id interface{}) (*dal.Record, error)

+ func (self *SqlBackend) Initialize() error

+ func (self *SqlBackend) Insert(ctx context.Context, name string, recordset *dal.RecordSet) error

+ func (self *SqlBackend) ListCollections() ([]string, error)

+ func (self *SqlBackend) ListValues(ctx context.Context, collection *dal.Collection, fields []string, ...) (map[string][]interface{}, error)

+ func (self *SqlBackend) Maximum(ctx context.Context, collection *dal.Collection, field string, ...) (float64, error)

+ func (self *SqlBackend) Migrate(ctx context.Context) error

+ func (self *SqlBackend) Minimum(ctx context.Context, collection *dal.Collection, field string, ...) (float64, error)

+ func (self *SqlBackend) Ping(ctx context.Context, timeout time.Duration) error

+ func (self *SqlBackend) Query(ctx context.Context, collection *dal.Collection, f *filter.Filter, ...) (*dal.RecordSet, error)

+ func (self *SqlBackend) QueryFunc(ctx context.Context, collection *dal.Collection, f *filter.Filter, ...) error

+ func (self *SqlBackend) RegisterCollection(collection *dal.Collection)

+ func (self *SqlBackend) Retrieve(ctx context.Context, name string, id interface{}, fields ...string) (*dal.Record, error)

+ func (self *SqlBackend) SetIndexer(indexConnString dal.ConnectionString) error

+ func (self *SqlBackend) String() string

+ func (self *SqlBackend) Sum(ctx context.Context, collection *dal.Collection, field string, ...) (float64, error)

+ func (self *SqlBackend) Supports(features ...BackendFeature) bool

+ func (self *SqlBackend) Update(ctx context.Context, name string, recordset *dal.RecordSet, target ...string) error

+ func (self *SqlBackend) WithAggregator(collection *dal.Collection) Aggregator

+ func (self *SqlBackend) WithSearch(collection *dal.Collection, filters ...*filter.Filter) Indexer

+ type SqlInitFunc func(*SqlBackend) (string, string, error)

+ type SqlPreInitFunc func(*SqlBackend)

v4.0.0-alpha.1

Sep 6, 2022

Other modules containing this package

github.com/PerformLine/pivot/v3

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL