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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
/*-
* Public Domain 2014-2018 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.
*/
#include <string.h>
#include <limits.h>
#include <errno.h>
#include <stdlib.h>
#include <wiredtiger_ext.h>
/*
* A simple WiredTiger extractor that separates a single string field,
* interpreted as column separated values (CSV), into component pieces.
* When an index is configured with this extractor and app_metadata
* set to a number N, the Nth field is returned as a string.
*
* For example, if a value in the primary table is
* "Paris,France,CET,2273305"
* and this extractor is configured with app_metadata=2, then
* the extractor for this value would return "CET".
*/
/* Local extractor structure. */
typedef struct {
WT_EXTRACTOR extractor; /* Must come first */
WT_EXTENSION_API *wt_api; /* Extension API */
int field; /* Field to extract */
int format_isnum; /* Field contents are numeric */
} CSV_EXTRACTOR;
/*
* csv_error --
* Display an error from this module in a standard way.
*/
static int
csv_error(const CSV_EXTRACTOR *csv_extractor,
WT_SESSION *session, int err, const char *msg)
{
WT_EXTENSION_API *wt_api;
wt_api = csv_extractor->wt_api;
(void)wt_api->err_printf(wt_api, session,
"csv extraction: %s: %s", msg, wt_api->strerror(wt_api, NULL, err));
return (err);
}
/*
* csv_extract --
* WiredTiger CSV extraction.
*/
static int
csv_extract(WT_EXTRACTOR *extractor, WT_SESSION *session,
const WT_ITEM *key, const WT_ITEM *value, WT_CURSOR *result_cursor)
{
const CSV_EXTRACTOR *csv_extractor;
WT_EXTENSION_API *wt_api;
size_t len;
int i, ret, val;
char *copy, *p, *pend, *valstr;
(void)key; /* Unused parameters */
csv_extractor = (const CSV_EXTRACTOR *)extractor;
wt_api = csv_extractor->wt_api;
/* Unpack the value. */
if ((ret = wt_api->struct_unpack(wt_api,
session, value->data, value->size, "S", &valstr)) != 0)
return (ret);
p = valstr;
pend = strchr(p, ',');
for (i = 0; i < csv_extractor->field && pend != NULL; i++) {
p = pend + 1;
pend = strchr(p, ',');
}
if (i == csv_extractor->field) {
if (pend == NULL)
pend = p + strlen(p);
/*
* The key we must return is a null terminated string, but p
* is not necessarily NULL-terminated. So make a copy, just
* for the duration of the insert.
*/
len = (size_t)(pend - p);
if ((copy = malloc(len + 1)) == NULL)
return (errno);
strncpy(copy, p, len);
copy[len] = '\0';
if (csv_extractor->format_isnum) {
if ((val = atoi(copy)) < 0) {
ret = csv_error(csv_extractor,
session, EINVAL, "invalid key value");
free(copy);
return (ret);
}
result_cursor->set_key(result_cursor, val);
} else
result_cursor->set_key(result_cursor, copy);
ret = result_cursor->insert(result_cursor);
free(copy);
if (ret != 0)
return (ret);
}
return (0);
}
/*
* csv_customize --
* The customize function creates a customized extractor,
* needed to save the field number and format.
*/
static int
csv_customize(WT_EXTRACTOR *extractor, WT_SESSION *session,
const char *uri, WT_CONFIG_ITEM *appcfg, WT_EXTRACTOR **customp)
{
const CSV_EXTRACTOR *orig;
CSV_EXTRACTOR *csv_extractor;
WT_CONFIG_ITEM field, format;
WT_CONFIG_PARSER *parser;
WT_EXTENSION_API *wt_api;
long field_num;
int ret;
(void)uri; /* Unused parameters */
orig = (const CSV_EXTRACTOR *)extractor;
wt_api = orig->wt_api;
if ((ret = wt_api->config_parser_open(wt_api, session, appcfg->str,
appcfg->len, &parser)) != 0)
return (ret);
if ((ret = parser->get(parser, "field", &field)) != 0) {
if (ret == WT_NOTFOUND)
(void)wt_api->err_printf(
wt_api, session, "field not found");
else
(void)wt_api->err_printf(
wt_api, session, "WT_CONFIG_PARSER.get: field: %s",
wt_api->strerror(wt_api, session, ret));
goto err;
}
if ((ret = parser->get(parser, "format", &format)) != 0) {
if (ret == WT_NOTFOUND)
(void)wt_api->err_printf(
wt_api, session, "format not found");
else
(void)wt_api->err_printf(
wt_api, session, "WT_CONFIG_PARSER.get: format: %s",
wt_api->strerror(wt_api, session, ret));
goto err;
}
ret = parser->close(parser);
parser = NULL;
if (ret != 0) {
(void)wt_api->err_printf(
wt_api, session, "WT_CONFIG_PARSER.close: %s",
wt_api->strerror(wt_api, session, ret));
}
field_num = strtol(field.str, NULL, 10);
if (field_num < 0 || field_num > INT_MAX) {
(void)wt_api->err_printf(
wt_api, session, "field: invalid format");
ret = EINVAL;
goto err;
}
if (format.len != 1 || (format.str[0] != 'S' && format.str[0] != 'i')) {
(void)wt_api->err_printf(
wt_api, session, "format: invalid format");
ret = EINVAL;
goto err;
}
if ((csv_extractor = calloc(1, sizeof(CSV_EXTRACTOR))) == NULL) {
ret = errno;
goto err;
}
*csv_extractor = *orig;
csv_extractor->field = (int)field_num;
csv_extractor->format_isnum = (format.str[0] == 'i');
*customp = (WT_EXTRACTOR *)csv_extractor;
return (0);
err: if (parser != NULL)
(void)parser->close(parser);
return (ret);
}
/*
* csv_terminate --
* Terminate is called to free the CSV and any associated memory.
*/
static int
csv_terminate(WT_EXTRACTOR *extractor, WT_SESSION *session)
{
(void)session; /* Unused parameters */
/* Free the allocated memory. */
free(extractor);
return (0);
}
/*
* wiredtiger_extension_init --
* WiredTiger CSV extraction extension.
*/
int
wiredtiger_extension_init(WT_CONNECTION *connection, WT_CONFIG_ARG *config)
{
CSV_EXTRACTOR *csv_extractor;
int ret;
(void)config; /* Unused parameters */
if ((csv_extractor = calloc(1, sizeof(CSV_EXTRACTOR))) == NULL)
return (errno);
csv_extractor->extractor.extract = csv_extract;
csv_extractor->extractor.customize = csv_customize;
csv_extractor->extractor.terminate = csv_terminate;
csv_extractor->wt_api = connection->get_extension_api(connection);
if ((ret = connection->add_extractor(
connection, "csv", (WT_EXTRACTOR *)csv_extractor, NULL)) == 0)
return (0);
free(csv_extractor);
return (ret);
}
|