forked from arangodb/go-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcollection_indexes.go
179 lines (159 loc) · 9.17 KB
/
collection_indexes.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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
//
// 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"
// CollectionIndexes provides access to the indexes in a single collection.
type CollectionIndexes interface {
// Index opens a connection to an existing index within the collection.
// If no index with given name exists, an NotFoundError is returned.
Index(ctx context.Context, name string) (Index, error)
// IndexExists returns true if an index with given name exists within the collection.
IndexExists(ctx context.Context, name string) (bool, error)
// Indexes returns a list of all indexes in the collection.
Indexes(ctx context.Context) ([]Index, error)
// EnsureFullTextIndex creates a fulltext index in the collection, if it does not already exist.
// Fields is a slice of attribute names. Currently, the slice is limited to exactly one attribute.
// The index is returned, together with a boolean indicating if the index was newly created (true) or pre-existing (false).
EnsureFullTextIndex(ctx context.Context, fields []string, options *EnsureFullTextIndexOptions) (Index, bool, error)
// EnsureGeoIndex creates a hash index in the collection, if it does not already exist.
// Fields is a slice with one or two attribute paths. If it is a slice with one attribute path location,
// then a geo-spatial index on all documents is created using location as path to the coordinates.
// The value of the attribute must be a slice with at least two double values. The slice must contain the latitude (first value)
// and the longitude (second value). All documents, which do not have the attribute path or with value that are not suitable, are ignored.
// If it is a slice with two attribute paths latitude and longitude, then a geo-spatial index on all documents is created
// using latitude and longitude as paths the latitude and the longitude. The value of the attribute latitude and of the
// attribute longitude must a double. All documents, which do not have the attribute paths or which values are not suitable, are ignored.
// The index is returned, together with a boolean indicating if the index was newly created (true) or pre-existing (false).
EnsureGeoIndex(ctx context.Context, fields []string, options *EnsureGeoIndexOptions) (Index, bool, error)
// EnsureHashIndex creates a hash index in the collection, if it does not already exist.
// Fields is a slice of attribute paths.
// The index is returned, together with a boolean indicating if the index was newly created (true) or pre-existing (false).
EnsureHashIndex(ctx context.Context, fields []string, options *EnsureHashIndexOptions) (Index, bool, error)
// EnsurePersistentIndex creates a persistent index in the collection, if it does not already exist.
// Fields is a slice of attribute paths.
// The index is returned, together with a boolean indicating if the index was newly created (true) or pre-existing (false).
EnsurePersistentIndex(ctx context.Context, fields []string, options *EnsurePersistentIndexOptions) (Index, bool, error)
// EnsureSkipListIndex creates a skiplist index in the collection, if it does not already exist.
// Fields is a slice of attribute paths.
// The index is returned, together with a boolean indicating if the index was newly created (true) or pre-existing (false).
EnsureSkipListIndex(ctx context.Context, fields []string, options *EnsureSkipListIndexOptions) (Index, bool, error)
// EnsureTTLIndex creates a TLL collection, if it does not already exist.
// The index is returned, together with a boolean indicating if the index was newly created (true) or pre-existing (false).
EnsureTTLIndex(ctx context.Context, field string, expireAfter int, options *EnsureTTLIndexOptions) (Index, bool, error)
// EnsureZKDIndex creates a ZKD multi-dimensional index for the collection, if it does not already exist.
// Note that zkd indexes are an experimental feature in ArangoDB 3.9.
EnsureZKDIndex(ctx context.Context, fields []string, options *EnsureZKDIndexOptions) (Index, bool, error)
}
// EnsureFullTextIndexOptions contains specific options for creating a full text index.
type EnsureFullTextIndexOptions struct {
// MinLength is the minimum character length of words to index. Will default to a server-defined
// value if unspecified (0). It is thus recommended to set this value explicitly when creating the index.
MinLength int
// InBackground if true will not hold an exclusive collection lock for the entire index creation period (rocksdb only).
InBackground bool
// Name optional user defined name used for hints in AQL queries
Name string
// Estimates determines if the to-be-created index should maintain selectivity estimates or not.
Estimates *bool
}
// EnsureGeoIndexOptions contains specific options for creating a geo index.
type EnsureGeoIndexOptions struct {
// If a geo-spatial index on a location is constructed and GeoJSON is true, then the order within the array
// is longitude followed by latitude. This corresponds to the format described in http://geojson.org/geojson-spec.html#positions
GeoJSON bool
// InBackground if true will not hold an exclusive collection lock for the entire index creation period (rocksdb only).
InBackground bool
// Name optional user defined name used for hints in AQL queries
Name string
// Estimates determines if the to-be-created index should maintain selectivity estimates or not.
Estimates *bool
}
// EnsureHashIndexOptions contains specific options for creating a hash index.
type EnsureHashIndexOptions struct {
// If true, then create a unique index.
Unique bool
// If true, then create a sparse index.
Sparse bool
// If true, de-duplication of array-values, before being added to the index, will be turned off.
// This flag requires ArangoDB 3.2.
// Note: this setting is only relevant for indexes with array fields (e.g. "fieldName[*]")
NoDeduplicate bool
// InBackground if true will not hold an exclusive collection lock for the entire index creation period (rocksdb only).
InBackground bool
// Name optional user defined name used for hints in AQL queries
Name string
// Estimates determines if the to-be-created index should maintain selectivity estimates or not.
Estimates *bool
}
// EnsurePersistentIndexOptions contains specific options for creating a persistent index.
type EnsurePersistentIndexOptions struct {
// If true, then create a unique index.
Unique bool
// If true, then create a sparse index.
Sparse bool
// InBackground if true will not hold an exclusive collection lock for the entire index creation period (rocksdb only).
InBackground bool
// Name optional user defined name used for hints in AQL queries
Name string
// Estimates determines if the to-be-created index should maintain selectivity estimates or not.
Estimates *bool
}
// EnsureSkipListIndexOptions contains specific options for creating a skip-list index.
type EnsureSkipListIndexOptions struct {
// If true, then create a unique index.
Unique bool
// If true, then create a sparse index.
Sparse bool
// If true, de-duplication of array-values, before being added to the index, will be turned off.
// This flag requires ArangoDB 3.2.
// Note: this setting is only relevant for indexes with array fields (e.g. "fieldName[*]")
NoDeduplicate bool
// InBackground if true will not hold an exclusive collection lock for the entire index creation period (rocksdb only).
InBackground bool
// Name optional user defined name used for hints in AQL queries
Name string
// Estimates determines if the to-be-created index should maintain selectivity estimates or not.
Estimates *bool
}
// EnsureTTLIndexOptions provides specific options for creating a TTL index
type EnsureTTLIndexOptions struct {
// InBackground if true will not hold an exclusive collection lock for the entire index creation period (rocksdb only).
InBackground bool
// Name optional user defined name used for hints in AQL queries
Name string
// Estimates determines if the to-be-created index should maintain selectivity estimates or not.
Estimates *bool
}
// EnsureZKDIndexOptions provides specific options for creating a ZKD index
type EnsureZKDIndexOptions struct {
// If true, then create a unique index.
Unique bool
// InBackground if true will not hold an exclusive collection lock for the entire index creation period (rocksdb only).
InBackground bool
// Name optional user defined name used for hints in AQL queries
Name string
// fieldValueTypes is required and the only allowed value is "double". Future extensions of the index will allow other types.
FieldValueTypes string
// If true, then create a sparse index.
// TODO: The sparse property is not supported yet
// Sparse bool
}