summaryrefslogtreecommitdiff
path: root/src/third_party/wiredtiger/test/suite/test_search_near02.py
blob: a8377aac0786bb9251ea36af905062c6ca52fdef (plain)
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
#!/usr/bin/env python
#
# Public Domain 2014-present MongoDB, Inc.
# Public Domain 2008-2014 WiredTiger, Inc.
#
# This is free and unencumbered software released into the public domain.
#
# Anyone is free to copy, modify, publish, use, compile, sell, or
# distribute this software, either in source code form or as a compiled
# binary, for any purpose, commercial or non-commercial, and by any
# means.
#
# In jurisdictions that recognize copyright laws, the author or authors
# of this software dedicate any and all copyright interest in the
# software to the public domain. We make this dedication for the benefit
# of the public at large and to the detriment of our heirs and
# successors. We intend this dedication to be an overt act of
# relinquishment in perpetuity of all present and future rights to this
# software under copyright law.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#

import wiredtiger, wttest, unittest
from wtscenario import make_scenarios

# test_search_near02.py
# Check the search_near API returns the correct key according to visibility rules and its
# configuration.
# When prefix search is disabled, the search_near API should always return the closest key (in
# lexicographic order) as long as one exists and is visible.
# When prefix search is enabled, in addition to the previous rules, search_near returns a key that
# matches the prefix being searched.
class test_search_near02(wttest.WiredTigerTestCase):
    key_format_values = [
        ('fixed_string', dict(key_format='10s')),
        ('var_string', dict(key_format='S')),
        ('byte_array', dict(key_format='u')),
    ]

    scenarios = make_scenarios(key_format_values)

    def check_key(self, key):
        if self.key_format == 'u':
            return key.encode()
        elif self.key_format == '10s':
            return key.ljust(10, "\x00")
        else:
            return key

    def test_search_near(self):
        uri = 'table:test_search_near'
        self.session.create(uri, 'key_format={},value_format=S'.format(self.key_format))
        cursor = self.session.open_cursor(uri)
        cursor2 = self.session.open_cursor(uri, None, "debug=(release_evict=true)")
        # Basic character array.
        l = "abcdefghijklmnopqrstuvwxyz"

        # Insert keys aaa -> aaz with timestamp 200.
        prefix = "aa"
        self.session.begin_transaction()
        for k in range (0, 25):
            key = prefix + l[k]
            cursor[key] = key
        self.session.commit_transaction('commit_timestamp=' + self.timestamp_str(200))

        # Insert key aaz with timestamp 50.
        self.session.begin_transaction()
        cursor[prefix + "z"] = prefix + "z"
        self.session.commit_transaction('commit_timestamp=' + self.timestamp_str(50))

        # Insert key aazab with timestamp 250.
        self.session.begin_transaction()
        cursor[prefix + "zab"] = prefix + "zab"
        self.session.commit_transaction('commit_timestamp=' + self.timestamp_str(250))

        # Evict the whole range.
        for k in range (0, 26):
            cursor2.set_key(prefix + l[k])
            self.assertEqual(cursor2.search(), 0)
            self.assertEqual(cursor2.reset(), 0)

        cursor2.set_key(prefix + "zab")
        self.assertEqual(cursor2.search(), 0)
        self.assertEqual(cursor2.reset(), 0)

        # Start a transaction at timestamp 100, aaz should be the only key that is visible.
        self.session.begin_transaction('read_timestamp=' + self.timestamp_str(100))
        cursor3 = self.session.open_cursor(uri)

        # Prefix search is disabled by default.
        # Search near should always return the only visible key.
        cursor3.set_key("aa")
        self.assertEqual(cursor3.search_near(), 1)
        self.assertEqual(cursor3.get_key(), self.check_key("aaz"))

        cursor3.set_key("az")
        self.assertEqual(cursor3.search_near(), -1)
        self.assertEqual(cursor3.get_key(), self.check_key("aaz"))

        cursor3.set_key("aaz")
        self.assertEqual(cursor3.search_near(), 0)
        self.assertEqual(cursor3.get_key(), self.check_key("aaz"))

        cursor3.set_key("aazab")
        self.assertEqual(cursor3.search_near(), -1)
        self.assertEqual(cursor3.get_key(), self.check_key("aaz"))

        # Enable prefix search.
        cursor3.reconfigure("prefix_key=true")

        # The only visible key is aaz. As long we are looking for a key that starts with either "a",
        # "aa" or "aaz", search near should return back aaz. Otherwise, search near should return
        # WT_NOTFOUND.
        cursor3.set_key("a")
        self.assertEqual(cursor3.search_near(), 1)
        self.assertEqual(cursor3.get_key(), self.check_key("aaz"))

        cursor3.set_key("aa")
        self.assertEqual(cursor3.search_near(), 1)
        self.assertEqual(cursor3.get_key(), self.check_key("aaz"))

        cursor3.set_key("aaz")
        self.assertEqual(cursor3.search_near(), 0)
        self.assertEqual(cursor3.get_key(), self.check_key("aaz"))

        cursor3.set_key("az")
        self.assertEqual(cursor3.search_near(), wiredtiger.WT_NOTFOUND)

        cursor3.set_key("b")
        self.assertEqual(cursor3.search_near(), wiredtiger.WT_NOTFOUND)

        cursor3.close()
        self.session.commit_transaction()

        # Start a transaction at timestamp 25, no keys are visible.
        # Since no keys are visible, search_near should always return WT_NOTFOUND.
        self.session.begin_transaction('read_timestamp=' + self.timestamp_str(25))
        cursor3 = self.session.open_cursor(uri)

        cursor3.set_key("aaz")
        self.assertEqual(cursor3.search_near(), wiredtiger.WT_NOTFOUND)

        # Enable prefix search.
        cursor3.reconfigure("prefix_key=true")

        cursor3.set_key("aaz")
        self.assertEqual(cursor3.search_near(), wiredtiger.WT_NOTFOUND)

        cursor3.close()
        self.session.commit_transaction()

        # Start a transaction at timestamp 250, all keys should be visible.
        self.session.begin_transaction('read_timestamp=' + self.timestamp_str(250))
        cursor3 = self.session.open_cursor(uri)

        # Search near for aa, should return the closest visible key: aaa.
        cursor3.set_key("aa")
        self.assertEqual(cursor3.search_near(), 1)
        self.assertEqual(cursor3.get_key(), self.check_key("aaa"))

        # Search near for aaz, should return the existing visible key: aaz.
        cursor3.set_key("aaz")
        self.assertEqual(cursor3.search_near(), 0)
        self.assertEqual(cursor3.get_key(), self.check_key("aaz"))

        # Search near for az, should return the closest visible key: aazab.
        cursor3.set_key("az")
        self.assertEqual(cursor3.search_near(), -1)
        self.assertEqual(cursor3.get_key(), self.check_key("aazab"))

        # Enable prefix search.
        cursor3.reconfigure("prefix_key=true")

        # Search near for a, should return the closest visible key with a matching prefix: aaa.
        cursor3.set_key("a")
        self.assertEqual(cursor3.search_near(), 1)
        self.assertEqual(cursor3.get_key(), self.check_key("aaa"))

        # Search near for aa, should return the closest visible key with a matching prefix: aaa.
        cursor3.set_key("aa")
        self.assertEqual(cursor3.search_near(), 1)
        self.assertEqual(cursor3.get_key(), self.check_key("aaa"))

        # Search near for aaz, should return the existing visible key with a matching prefix: aaz.
        cursor3.set_key("aaz")
        self.assertEqual(cursor3.search_near(), 0)
        self.assertEqual(cursor3.get_key(), self.check_key("aaz"))

        # Search near for aaza, should return the closest visible key with a matching prefix: aazab.
        cursor3.set_key("aaza")
        self.assertEqual(cursor3.search_near(), 1)
        self.assertEqual(cursor3.get_key(), self.check_key("aazab"))

        # Search near for az, no keys match the prefix, hence search_near returns WT_NOTFOUND.
        cursor3.set_key("az")
        self.assertEqual(cursor3.search_near(), wiredtiger.WT_NOTFOUND)
        cursor3.close()
        self.session.commit_transaction()