github.com/cs3org/reva/v2@v2.27.7/pkg/storage/utils/indexer/index/index.go (about)

     1  // Copyright 2018-2022 CERN
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  //
    15  // In applying this license, CERN does not waive the privileges and immunities
    16  // granted to it by virtue of its status as an Intergovernmental Organization
    17  // or submit itself to any jurisdiction.
    18  
    19  package index
    20  
    21  import (
    22  	"context"
    23  
    24  	"github.com/cs3org/reva/v2/pkg/storage/utils/indexer/option"
    25  )
    26  
    27  // Index can be implemented to create new indexer-strategies. See Unique for example.
    28  // Each indexer implementation is bound to one data-column (IndexBy) and a data-type (TypeName)
    29  type Index interface {
    30  	Init() error
    31  	Lookup(v string) ([]string, error)
    32  	LookupCtx(ctx context.Context, v ...string) ([]string, error)
    33  	Add(id, v string) (string, error)
    34  	Remove(id string, v string) error
    35  	Update(id, oldV, newV string) error
    36  	Search(pattern string) ([]string, error)
    37  	CaseInsensitive() bool
    38  	IndexBy() option.IndexBy
    39  	TypeName() string
    40  	FilesDir() string
    41  	Delete() error // Delete deletes the index folder from its storage.
    42  }