forked from aerospike/aerospike-client-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
key.go
125 lines (103 loc) · 3.46 KB
/
key.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
// Copyright 2013-2014 Aerospike, Inc.
//
// 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 aerospike
import (
"bytes"
"fmt"
"hash"
"github.com/aerospike/aerospike-client-go/pkg/ripemd160"
. "github.com/aerospike/aerospike-client-go/types"
ParticleType "github.com/aerospike/aerospike-client-go/types/particle_type"
)
// Unique record identifier. Records can be identified using a specified namespace,
// an optional set name, and a user defined key which must be unique within a set.
// Records can also be identified by namespace/digest which is the combination used
// on the server.
type Key struct {
// namespace. Equivalent to database name.
namespace string
// Optional set name. Equivalent to database table.
setName string
// Unique server hash value generated from set name and user key.
digest []byte
// Original user key. This key is immediately converted to a hash digest.
// This key is not used or returned by the server. If the user key needs
// to persist on the server, the key should be explicitly stored in a bin.
userKey interface{}
}
// returns Namespace
func (ky *Key) Namespace() string {
return ky.namespace
}
// Returns Set name
func (ky *Key) SetName() string {
return ky.setName
}
// Returns current key digest
func (ky *Key) Digest() []byte {
return ky.digest
}
func (ky *Key) Equals(other *Key) bool {
return (ky.namespace == other.namespace) &&
(ky.setName == other.setName) &&
bytes.Equal(ky.digest, other.digest)
}
// Return string representation of key.
func (ky *Key) String() string {
return fmt.Sprintf("%s %s %v", ky.namespace, ky.setName, ky.userKey)
}
// Initialize key from namespace, optional set name and user key.
// The set name and user defined key are converted to a digest before sending to the server.
// The server handles record identifiers by digest only.
func NewKey(namespace string, setName string, key interface{}) (newKey *Key, err error) {
newKey = &Key{
namespace: namespace,
setName: setName,
userKey: key,
}
newKey.digest, err = computeDigest(&newKey.setName, NewValue(key))
return newKey, err
}
// Initialize key from namespace, digest and optional set name.
func NewKeyByDigest(namespace string, setName string, digest [20]byte) *Key {
return &Key{
namespace: namespace,
setName: setName,
digest: digest[:],
}
}
// Generate unique server hash value from set name, key type and user defined key.
// The hash function is RIPEMD-160 (a 160 bit hash).
func computeDigest(setName *string, key Value) ([]byte, error) {
keyType := key.GetType()
if keyType == ParticleType.NULL {
return nil, NewAerospikeError(PARAMETER_ERROR, "Invalid key: nil")
}
// retrieve hash from hash pool
h := hashPool.Get().(hash.Hash)
h.Reset()
defer hashPool.Put(h)
h.Write([]byte(*setName))
h.Write([]byte{byte(keyType)})
h.Write(key.getBytes())
return h.Sum(nil), nil
}
// hash pool
var hashPool *Pool
func init() {
hashPool = NewPool(1024)
hashPool.New = func() interface{} {
return ripemd160.New()
}
}