-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.go
39 lines (35 loc) · 1.18 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
// Copyright (C) 2022 PuzzleDB Contributors.
//
// 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.
package document
type IndexType = uint8
const (
PrimaryIndex IndexType = 1
SecondaryIndex IndexType = 2
)
type Index interface {
// Name returns the unique name.
Name() string
// Type returns the index type.
Type() IndexType
// Elements returns the schema elements.
Elements() []Element
// SetName sets the specified name to the index.
SetName(name string) Index
// SetType sets the specified type to the element.
SetType(t IndexType) Index
// AddElement returns the schema elements.
AddElement(elem Element) Index
// Data returns the raw representation data in memory.
Data() any
}