Skip to content

collectors ⚓︎

Collects data from the fields extracted from the data records (D).

Classes⚓︎

Functions⚓︎

collect_binary(c, fields, pos) ⚓︎

Collects BINARY data type from ixf as a string.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
str

Binary string.

Raises:

Type Description
DataCollectorError

When length exceeds 254 bytes.
Source code in src/db2ixf/collectors.py
Python
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
def collect_binary(c, fields, pos) -> str:
    """Collects BINARY data type from ixf as a string.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    str
        Binary string.

    Raises
    ------
    DataCollectorError
        When length exceeds 254 bytes.
    """
    length = int(c["IXFCLENG"])

    if length > 254:
        msg = "Length of a binary data types should not exceed 254 bytes."
        raise DataCollectorError(msg)

    field = fields[pos:pos + length]

    return field

collect_smallint(c, fields, pos) ⚓︎

Collects SMALLINT data type from ixf as an integer.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
int

Integer.
Source code in src/db2ixf/collectors.py
Python
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def collect_smallint(c, fields, pos) -> int:  # noqa
    """Collects SMALLINT data type from ixf as an integer.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    int
        Integer.
    """
    field = int(unpack("<h", fields[pos:pos + 2])[0])

    return field

collect_integer(c, fields, pos) ⚓︎

Collects INTEGER data type from ixf as an integer.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
int

Integer.
Source code in src/db2ixf/collectors.py
Python
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def collect_integer(c, fields, pos) -> int:  # noqa
    """Collects INTEGER data type from ixf as an integer.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    int
        Integer.
    """
    field = int(unpack("<i", fields[pos:pos + 4])[0])

    return field

collect_bigint(c, fields, pos) ⚓︎

Collects BIGINT data type from ixf as an integer.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
int

Integer.
Source code in src/db2ixf/collectors.py
Python
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def collect_bigint(c, fields, pos) -> int:  # noqa
    """Collects BIGINT data type from ixf as an integer.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    int
        Integer.
    """
    field = int(unpack("<q", fields[pos:pos + 8])[0])

    return field

collect_decimal(c, fields, pos) ⚓︎

Collects DECIMAL data type from ixf as a integer or a float.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
Union[int, float]

Integer or Float.
Source code in src/db2ixf/collectors.py
Python
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
def collect_decimal(c, fields, pos) -> Union[int, float]:
    """Collects DECIMAL data type from ixf as a integer or a float.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    Union[int, float]
        Integer or Float.
    """
    p = int(c["IXFCLENG"][0:3])
    s = int(c["IXFCLENG"][3:5])
    length = int((p + 2) / 2)
    field = fields[pos:pos + length]

    dec = 0.0
    for b in range(0, min(len(field), length) - 1):
        dec = dec * 100 + int(field[b] >> 4) * 10 + int(field[b] & 0x0f)
    dec = dec * 10 + int(field[-1] >> 4)

    if int(field[-1] & 0x0f) != 12:
        dec = -dec

    if s == 0:
        return Decimal(dec)

    return Decimal(dec / pow(10, s))

collect_floating_point(c, fields, pos) ⚓︎

Collects FLOATING POINT data type from ixf as a float.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
float

A python float object.

Raises:

Type Description
DataCollectorError

When facing extra bytes.
Source code in src/db2ixf/collectors.py
Python
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
def collect_floating_point(c, fields, pos) -> float:
    """Collects FLOATING POINT data type from ixf as a float.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    float
        A python float object.

    Raises
    ------
    DataCollectorError
        When facing extra bytes.
    """
    col_length = int(c["IXFCLENG"])

    if col_length == 4:
        return float(unpack(">f", fields[pos:pos + col_length])[0])

    if col_length == 8:
        return float(unpack(">d", fields[pos:pos + col_length])[0])

    raise DataCollectorError(
        f"Expecting 4 or 8 bytes, found {col_length} bytes"
    )

collect_char(c, fields, pos) ⚓︎

Collects CHAR data type from ixf as a string.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
str

String.

Raises:

Type Description
DataCollectorError

When length exceeds 254 bytes.
Source code in src/db2ixf/collectors.py
Python
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
def collect_char(c, fields, pos) -> str:
    """Collects CHAR data type from ixf as a string.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    str
        String.

    Raises
    ------
    DataCollectorError
        When length exceeds 254 bytes.
    """
    length = int(c["IXFCLENG"])

    if length > 254:
        msg = "Length of a char data types should not exceed 254 bytes."
        raise DataCollectorError(msg)

    sbcp, dbcp = get_ccsid_from_column(c)

    field = fields[pos:pos + length]

    if dbcp != 0:
        return decode_cell(field, dbcp, "d").strip()

    if sbcp != 0:
        return decode_cell(field, sbcp).strip()

    return str(field, "utf-8").strip()

collect_varchar(c, fields, pos) ⚓︎

Collects VARCHAR data type from ixf as a string.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
str

String.

Raises:

Type Description
DataCollectorError

When length of var char exceeds maximum length.
Source code in src/db2ixf/collectors.py
Python
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
255
256
257
258
259
260
261
262
263
def collect_varchar(c, fields, pos) -> str:
    """Collects VARCHAR data type from ixf as a string.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    str
        String.

    Raises
    ------
    DataCollectorError
        When length of var char exceeds maximum length.
    """
    max_length = int(c["IXFCLENG"])

    length = int(unpack("<h", fields[pos:pos + 2])[0])
    if length > max_length:
        msg = f"Length {length} exceeds the maximum length {max_length}."
        raise DataCollectorError(msg)

    pos += 2

    sbcp, dbcp = get_ccsid_from_column(c)

    field = fields[pos:pos + length]

    if dbcp != 0:
        return decode_cell(field, dbcp, "d").strip()

    if sbcp != 0:
        return decode_cell(field, sbcp).strip()

    return str(field, "utf-8").strip()

collect_longvarchar(c, fields, pos) ⚓︎

Collects LONGVARCHAR data type from ixf as a string.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
str

String.

Raises:

Type Description
DataCollectorError

When length of long var char exceeds maximum length.
Source code in src/db2ixf/collectors.py
Python
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
def collect_longvarchar(c, fields, pos) -> str:
    """Collects LONGVARCHAR data type from ixf as a string.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    str
        String.

    Raises
    ------
    DataCollectorError
        When length of long var char exceeds maximum length.
    """
    max_length = int(c["IXFCLENG"])
    length = int(unpack("<h", fields[pos:pos + 2])[0])
    if length > max_length:
        msg = f"Length {length} exceeds the maximum length {max_length}."
        raise DataCollectorError(msg)

    pos += 2

    sbcp, dbcp = get_ccsid_from_column(c)

    field = fields[pos:pos + length]

    if dbcp != 0:
        return decode_cell(field, dbcp, "d").strip()

    if sbcp != 0:
        return decode_cell(field, sbcp).strip()

    return str(field, "utf-8").strip()

collect_vargraphic(c, fields, pos) ⚓︎

Collects VARGRAPHIC data type from ixf as a string.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
str

String.

Raises:

Type Description
DataCollectorError

When length of var graphic exceeds maximum length.
Source code in src/db2ixf/collectors.py
Python
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
def collect_vargraphic(c, fields, pos) -> str:
    """Collects VARGRAPHIC data type from ixf as a string.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    str
        String.

    Raises
    ------
    DataCollectorError
        When length of var graphic exceeds maximum length.
    """
    max_length = int(c["IXFCLENG"])

    length = int(unpack("<h", fields[pos:pos + 2])[0])
    if length > max_length:
        msg = f"Length {length} exceeds the maximum length {max_length}."
        raise DataCollectorError(msg)

    pos += 2

    _, dbcp = get_ccsid_from_column(c)

    field = fields[pos:pos + (length * 2)]

    if dbcp != 0:
        return decode_cell(field, dbcp, "d").strip()

    _msg = "The string in double-byte characters has DBCS code page " \
           "equals to 0 (unknown encoding)"
    raise DataCollectorError(_msg)

collect_date(c, fields, pos) ⚓︎

Collects DATE data type from ixf as a date object.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
date

Date of format yyyy-mm-dd.
Source code in src/db2ixf/collectors.py
Python
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
def collect_date(c, fields, pos) -> date:  # noqa
    """Collects DATE data type from ixf as a date object.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    date
        Date of format yyyy-mm-dd.
    """
    field = str(fields[pos:pos + 10], encoding="utf-8").strip()

    return datetime.strptime(field, "%Y-%m-%d").date()

collect_time(c, fields, pos) ⚓︎

Collects TIME data type from ixf as a time object.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
time

Time of format HH:MM:SS.
Source code in src/db2ixf/collectors.py
Python
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
def collect_time(c, fields, pos) -> time:  # noqa
    """Collects TIME data type from ixf as a time object.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    time
        Time of format HH:MM:SS.
    """
    field = str(fields[pos:pos + 8], encoding="utf-8").strip()

    return datetime.strptime(field, "%H.%M.%S").time()

collect_timestamp(c, fields, pos) ⚓︎

Collects TIMESTAMP data type from ixf as a datetime object.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
datetime

Timestamp of format yyyy-mm-dd-hh.mm.ss.nnnnnn or yyyy-mm-dd-hh.mm.ss.
Source code in src/db2ixf/collectors.py
Python
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
def collect_timestamp(c, fields, pos) -> datetime:  # noqa
    """Collects TIMESTAMP data type from ixf as a datetime object.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    datetime
        Timestamp of format yyyy-mm-dd-hh.mm.ss.nnnnnn or yyyy-mm-dd-hh.mm.ss.
    """
    field = str(fields[pos:pos + 26], encoding="utf-8").strip()

    try:
        return datetime.strptime(field, "%Y-%m-%d-%H.%M.%S.%f")
    except ValueError:
        return datetime.strptime(field, "%Y-%m-%d-%H.%M.%S")

collect_clob(c, fields, pos) ⚓︎

Collects CLOB data type from ixf as a string object.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
str

String representing the CLOB (Character Large Object).

Raises:

Type Description
DataCollectorError

When length of the large object exceeds the maximum length Or When SBCP and DBCP are simultaneously equal to 0.
Source code in src/db2ixf/collectors.py
Python
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
def collect_clob(c, fields, pos) -> str:
    """Collects CLOB data type from ixf as a string object.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    str
        String representing the CLOB (Character Large Object).

    Raises
    ------
    DataCollectorError
        When length of the large object exceeds the maximum length Or
        When SBCP and DBCP are simultaneously equal to 0.
    """
    max_length = int(c["IXFCLENG"])

    length = int(unpack("<i", fields[pos:pos + 4])[0])
    if length > max_length:
        msg = f"Length {length} exceeds the maximum length {max_length}."
        raise DataCollectorError(msg)

    pos += 4

    sbcp, dbcp = get_ccsid_from_column(c)

    field = fields[pos:pos + length]

    if dbcp != 0:
        return decode_cell(field, dbcp, "d").strip()

    if sbcp != 0:
        return decode_cell(field, sbcp).strip()

    msg = "CLOB data type can not be a bit string as BLOB, " \
          "the SBCP and DBCP should not simultaneously be equal to 0."
    raise DataCollectorError(msg)

collect_blob(c, fields, pos) ⚓︎

Collects BLOB data type from ixf as a string.

Parameters:

Name Type Description Default
c dict

Column descriptor extracted from IXF file.

 required
fields str

Bytes string containing data of the row.

 required
pos int

Position of the column in the fields.

 required

Returns:

Type Description
str

string representing the BLOB (Blob Large Object).

Raises:

Type Description
DataCollectorError

When the length of the binary large object exceeds the maximum length.
Source code in src/db2ixf/collectors.py
Python
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
def collect_blob(c, fields, pos) -> str:
    """Collects BLOB data type from ixf as a string.

    Parameters
    ----------
    c : dict
        Column descriptor extracted from IXF file.
    fields : str
        Bytes string containing data of the row.
    pos : int
        Position of the column in the `fields`.

    Returns
    -------
    str
        string representing the BLOB (Blob Large Object).

    Raises
    ------
    DataCollectorError
        When the length of the binary large object exceeds the maximum length.
    """
    max_length = int(c["IXFCLENG"])

    length = int(unpack("<i", fields[pos:pos + 4])[0])
    if length > max_length:
        msg = f"Length {length} exceeds the maximum length {max_length}."
        raise DataCollectorError(msg)

    pos += 4

    sbcp, dbcp = get_ccsid_from_column(c)

    field = fields[pos:pos + length]

    if dbcp != 0:
        return decode_cell(field, dbcp, "d").strip()

    if sbcp != 0:
        return decode_cell(field, sbcp).strip()

    return field