1. Summary
These constants are used with the fields= parameter to control which fields are included in search results.
Multiple fields can be specified by combining the constants with the bitwise-OR operator (|).
fields = F_<a> | F_<b> | ...Since multiple fields are specified as a single integer is it not possible to control the
order of fields returned. The order of fields returned is fixed according to Display Order in the table below
when using result entry formats R_STR or
R_LIST. (Format R_DICT returns an unordered dictionary.)
As an alternative to fields=, some methods offer a select= parameter which makes it possible
to specify fields to be returned as properties. Returned fields will then appear in the specified
order when using R_STR or R_LIST result entry formats.
|
| Constant | Display Order | Description |
|---|---|---|
1 |
Identifier of the initial vertex in a neighborhood traversal |
|
2 |
Internal object identifier of the initial vertex in a neighborhood traversal |
|
3 |
Direction of the arc between two neighbor vertices |
|
4 |
Relationship type for the arc between two neighbor vertices |
|
5 |
Relationship modifier for the arc between two neighbor vertices |
|
6 |
Relationship value of the arc between two neighbor vertices |
|
7 |
Vertex identifier |
|
8 |
Internal object identifier of vertex |
|
9 |
Vertex type |
|
10 |
Vertex degree |
|
11 |
Vertex indegree |
|
12 |
Vertex outdegree |
|
13 |
Vertex vector |
|
14 |
Vertex properties |
|
15 |
Vertex rank score as computed by dynamic ranking formula |
|
16 |
Vertex vector similarity to the probe vector |
|
17 |
Vertex vector fingerprint hamming distance the the probe vector fingerprint |
|
18 |
Vertex creation timestamp |
|
19 |
Vertex modification timestamp |
|
20 |
Vertex expiration timestamp |
|
21 |
Vertex descriptor (for debugging) |
|
22 |
Vertex memory address (for debugging) |
|
23 |
Vertex memory allocator handle (for debugging) |
|
24 |
Binary dump of internal vertex data structure (for debugging) |
Shorthands for common combinations are also defined.
| Combined Constant | Value |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2. Field Codes
2.1. pyvgx.F_ANCHOR
pyvgx.F_ANCHOR = 1
Identifier string of the initial vertex in a neighborhood traversal.
2.2. pyvgx.F_ANCHOR_OBID
pyvgx.F_ANCHOR_OBID = 2
Internal object identifier of the initial vertex in a neighborhood traversal.
2.3. pyvgx.F_ARCDIR
pyvgx.F_ARCDIR = 256
Direction of the arc between two neighbor vertices.
2.4. pyvgx.F_REL
pyvgx.F_REL = 512
Relationship type for the arc between two neighbor vertices.
2.5. pyvgx.F_MOD
pyvgx.F_MOD = 1024
Relationship modifier for the arc between two neighbor vertices.
2.6. pyvgx.F_VAL
pyvgx.F_VAL = 2048
Relationship value of the arc between two neighbor vertices.
2.7. pyvgx.F_ID
pyvgx.F_ID = 4
Vertex identifier string.
2.8. pyvgx.F_OBID
pyvgx.F_OBID = 8
Internal object identifier of vertex.
2.9. pyvgx.F_TYPE
pyvgx.F_TYPE = 16
Vertex type string.
2.10. pyvgx.F_DEG
pyvgx.F_DEG = 32
Vertex degree.
2.11. pyvgx.F_IDEG
pyvgx.F_IDEG = 64
Vertex indegree.
2.12. pyvgx.F_ODEG
pyvgx.F_ODEG = 128
Vertex outdegree.
2.14. pyvgx.F_PROP
pyvgx.F_PROP = 8192
Vertex properties.
2.15. pyvgx.F_RANK
pyvgx.F_RANK = 65536
Dynamic rank score computed according to formula given in rank= parameter.
2.16. pyvgx.F_SIM
pyvgx.F_SIM = 131072
Vertex vector similarity to the probe vector
2.17. pyvgx.F_HAM
pyvgx.F_HAM = 262144
Vertex vector fingerprint hamming distance the the probe vector fingerprint.
2.18. pyvgx.F_TMC
pyvgx.F_TMC = 1048576
Vertex creation timestamp.
2.19. pyvgx.F_TMM
pyvgx.F_TMM = 2097152
Vertex modification timestamp.
2.20. pyvgx.F_TMX
pyvgx.F_TMX = 4194304
Vertex expiration timestamp.
2.21. pyvgx.F_DESCR
pyvgx.F_DESCR = 16777216
Vertex descriptor.
2.22. pyvgx.F_ADDR
pyvgx.F_ADDR = 33554432
Vertex memory address.
2.23. pyvgx.F_HANDLE
pyvgx.F_HANDLE = 67108864
Vertex memory allocator handle.
2.24. pyvgx.F_RAW
pyvgx.F_RAW = 134217728
Binary dump of internal vertex data.
2.25. pyvgx.F_NAMES
pyvgx.F_NAMES = F_ANCHOR + F_ANCHOR_OBID + F_ID + F_OBID + F_TYPE = 31
Vertex identifiers and type.
2.26. pyvgx.F_PRED
pyvgx.F_PRED = F_ARCDIR + F_REL + F_MOD + F_VAL = 3840
Arc fields.
2.27. pyvgx.F_ARC
pyvgx.F_ARC = F_PRED + F_ID = 3844
Arc fields plus terminal vertex identifier.
2.28. pyvgx.F_AARC
pyvgx.F_AARC = F_ANCHOR + F_ARC = 3845
Arc fields plus initial and terminal identifiers.
2.29. pyvgx.F_DEGREES
pyvgx.F_DEGREES = F_DEG + F_IDEG + F_ODEG = 224
Vertex degrees.
2.30. pyvgx.F_PROPS
pyvgx.F_PROPS = F_VEC + F_PROP = 12288
Vertex properties and vector.
2.31. pyvgx.F_RLV
pyvgx.F_RLV = F_SIM + F_HAM = 393216
Vertex similarity measures.
2.32. pyvgx.F_TSTAMP
pyvgx.F_TSTAMP = F_TMC + F_TMM + F_TMX = 7340032
Vertex timestamps.
2.33. pyvgx.F_DETAILS
pyvgx.F_DETAILS = F_DESCR + F_ADDR + F_HANDLE + F_RAW = 251658240
Internal vertex details.
2.34. pyvgx.F_ALL
pyvgx.F_ALL = F_NAMES + F_PRED + F_DEGREES + F_PROPS + F_RLV + F_TSTAMP + F_DETAILS = 259407871
All fields.
