mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-05-19 06:00:40 -04:00
Code Issues Packages Projects Releases Wiki Activity

Rename index package to indexer

Browse Source
This commit is contained in:
Ilja Neumann
2020-10-01 13:21:42 +02:00
parent 6f05c0998e
commit 36f8931621
10 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
accounts/pkg/index/data_test.go → accounts/pkg/indexer/data_test.go
View File

@@ -1,4 +1,4 @@
package index
package indexer
import (
"encoding/json"

2
accounts/pkg/index/errors.go → accounts/pkg/indexer/errors.go
View File

@@ -1,4 +1,4 @@
package index
package indexer
import (
"fmt"

28
accounts/pkg/index/index.go → accounts/pkg/indexer/indexer.go
View File

@@ -1,13 +1,13 @@
// Package index provides symlink-based index for on-disk document-directories.
package index
// Package indexer provides symlink-based indexer for on-disk document-directories.
package indexer
import (
"github.com/rs/zerolog"
"path"
)
// Index is a facade to configure and query over multiple indices.
type Index struct {
// Indexer is a facade to configure and query over multiple indices.
type Indexer struct {
config *Config
indices indexMap
}
@@ -18,8 +18,8 @@ type Config struct {
Log zerolog.Logger
}
// IndexType can be implemented to create new index-strategies. See Unique for example.
// Each index implementation is bound to one data-column (IndexBy) and a data-type (TypeName)
// IndexType can be implemented to create new indexer-strategies. See Unique for example.
// Each indexer implementation is bound to one data-column (IndexBy) and a data-type (TypeName)
type IndexType interface {
Init() error
Lookup(v string) ([]string, error)
@@ -32,14 +32,14 @@ type IndexType interface {
FilesDir() string
}
func NewIndex(cfg *Config) *Index {
return &Index{
func NewIndex(cfg *Config) *Indexer {
return &Indexer{
config: cfg,
indices: indexMap{},
}
}
func (i Index) AddUniqueIndex(t interface{}, indexBy, pkName, entityDirName string) error {
func (i Indexer) AddUniqueIndex(t interface{}, indexBy, pkName, entityDirName string) error {
typeName := getTypeFQN(t)
fullDataPath := path.Join(i.config.DataDir, entityDirName)
indexPath := path.Join(i.config.DataDir, i.config.IndexRootDirName)
@@ -50,7 +50,7 @@ func (i Index) AddUniqueIndex(t interface{}, indexBy, pkName, entityDirName stri
return idx.Init()
}
func (i Index) AddNonUniqueIndex(t interface{}, indexBy, pkName, entityDirName string) error {
func (i Indexer) AddNonUniqueIndex(t interface{}, indexBy, pkName, entityDirName string) error {
typeName := getTypeFQN(t)
fullDataPath := path.Join(i.config.DataDir, entityDirName)
indexPath := path.Join(i.config.DataDir, i.config.IndexRootDirName)
@@ -61,8 +61,8 @@ func (i Index) AddNonUniqueIndex(t interface{}, indexBy, pkName, entityDirName s
return idx.Init()
}
// Add a new entry to the index
func (i Index) Add(t interface{}) error {
// Add a new entry to the indexer
func (i Indexer) Add(t interface{}) error {
typeName := getTypeFQN(t)
fields, ok := i.indices[typeName]
@@ -89,7 +89,7 @@ func (i Index) Add(t interface{}) error {
// Find a entry by type,field and value.
// // Find a User type by email
// man.Find("User", "Email", "foo@example.com")
func (i Index) Find(typeName, key, value string) (pk string, err error) {
func (i Indexer) Find(typeName, key, value string) (pk string, err error) {
var res = []string{}
if indices, ok := i.indices[typeName][key]; ok {
for _, idx := range indices {
@@ -111,7 +111,7 @@ func (i Index) Find(typeName, key, value string) (pk string, err error) {
}
*/
func (i Index) Delete(typeName, pk string) error {
func (i Indexer) Delete(typeName, pk string) error {
return nil
}

2
accounts/pkg/index/index_test.go → accounts/pkg/indexer/indexer_test.go
View File

@@ -1,4 +1,4 @@
package index
package indexer
import (
"github.com/rs/zerolog"

4
accounts/pkg/index/map.go → accounts/pkg/indexer/map.go
View File

@@ -1,6 +1,6 @@
package index
package indexer
// indexMap stores the index layout at runtime.
// indexMap stores the indexer layout at runtime.
type indexMap map[tName]typeMapping
type tName = string

2
accounts/pkg/index/non_unique.go → accounts/pkg/indexer/non_unique.go
View File

@@ -1,4 +1,4 @@
package index
package indexer
import (
"errors"

2
accounts/pkg/index/non_unique_test.go → accounts/pkg/indexer/non_unique_test.go
View File

@@ -1,4 +1,4 @@
package index
package indexer
import (
"github.com/stretchr/testify/assert"

2
accounts/pkg/index/reflect.go → accounts/pkg/indexer/reflect.go
View File

@@ -1,4 +1,4 @@
package index
package indexer
import (
"errors"

4
accounts/pkg/index/unique.go → accounts/pkg/indexer/unique.go
View File

@@ -1,4 +1,4 @@
package index
package indexer
import (
"errors"
@@ -11,7 +11,7 @@ import (
// Unique ensures that only one document of the same type and key-value combination can exist in the index.
//
// Modeled by creating a index-folder per entity and key with symlinks which point to respective documents which contain
// Modeled by creating a indexer-folder per entity and key with symlinks which point to respective documents which contain
// the link-filename as value.
//
// Directory Layout

4
accounts/pkg/index/unique_test.go → accounts/pkg/indexer/unique_test.go
View File

@@ -1,4 +1,4 @@
package index
package indexer
import (
"github.com/stretchr/testify/assert"
@@ -114,7 +114,7 @@ func TestErrors(t *testing.T) {
func getUniqueIdxSut(t *testing.T) (sut IndexType, dataPath string) {
dataPath = writeIndexTestData(t, testData, "Id")
sut = NewUniqueIndex("User", "Email", path.Join(dataPath, "users"), path.Join(dataPath, "index.disk"))
sut = NewUniqueIndex("User", "Email", path.Join(dataPath, "users"), path.Join(dataPath, "indexer.disk"))
err := sut.Init()
if err != nil {
t.Fatal(err)