/
index.go
61 lines (52 loc) · 1.88 KB
/
index.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
//
// DISCLAIMER
//
// Copyright 2017 ArangoDB GmbH, Cologne, Germany
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Copyright holder is ArangoDB GmbH, Cologne, Germany
//
// Author Ewout Prangsma
//
package driver
import "context"
// IndexType represents a index type as string
type IndexType string
// Symbolic constants for index types
const (
PrimaryIndex = IndexType("primary")
FullTextIndex = IndexType("fulltext")
HashIndex = IndexType("hash")
SkipListIndex = IndexType("skiplist")
PersistentIndex = IndexType("persistent")
GeoIndex = IndexType("geo")
EdgeIndex = IndexType("edge")
TTLIndex = IndexType("ttl")
)
// Index provides access to a single index in a single collection.
type Index interface {
// Name returns the collection specific ID of the index. This value should be used for all functions
// the require a index _name_.
Name() string
// ID returns the ID of the index. Effectivly this is `<collection-name>/<index.Name()>`.
ID() string
// UserName returns the user provided name of the index or empty string if non is provided. This _name_
// is used in querys to provides hints for the optimizer about preferred indexes.
UserName() string
// Type returns the type of the index
Type() IndexType
// Remove removes the entire index.
// If the index does not exist, a NotFoundError is returned.
Remove(ctx context.Context) error
}