radixdb-plugin-abi 1.1.0

Stable low-level C ABI for trusted RadixDB native plugins
Documentation 
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

//! Closed numeric domains of ABI 1.0.

pub type RadixAbiStatusV1 = u32;

pub const RADIX_ABI_MAJOR: u16 = 1;
pub const RADIX_ABI_MINOR: u16 = 0;

pub const RADIX_STATUS_OK: RadixAbiStatusV1 = 0;
pub const RADIX_STATUS_INVALID_ARGUMENT: RadixAbiStatusV1 = 1;
pub const RADIX_STATUS_DOMAIN_ERROR: RadixAbiStatusV1 = 2;
pub const RADIX_STATUS_LIMIT_EXCEEDED: RadixAbiStatusV1 = 3;
pub const RADIX_STATUS_CANCELLED: RadixAbiStatusV1 = 4;
pub const RADIX_STATUS_INTERNAL_ERROR: RadixAbiStatusV1 = 5;
pub const RADIX_STATUS_PANIC: RadixAbiStatusV1 = 6;
pub const RADIX_STATUS_UNSUPPORTED_ABI: RadixAbiStatusV1 = 7;
pub const RADIX_STATUS_CONTRACT_VIOLATION: RadixAbiStatusV1 = 8;
pub const RADIX_STATUS_DEPENDENCY_MISSING: RadixAbiStatusV1 = 9;

pub const RADIX_DIAGNOSTIC_INVALID_INPUT: u32 = 1;
pub const RADIX_DIAGNOSTIC_DOMAIN: u32 = 2;
pub const RADIX_DIAGNOSTIC_LIMIT: u32 = 3;
pub const RADIX_DIAGNOSTIC_CANCELLED: u32 = 4;
pub const RADIX_DIAGNOSTIC_INTERNAL: u32 = 5;
pub const RADIX_DIAGNOSTIC_PLUGIN_PANIC: u32 = 6;
pub const RADIX_DIAGNOSTIC_ABI_CONTRACT: u32 = 7;
pub const RADIX_DIAGNOSTIC_DEPENDENCY: u32 = 8;

pub const RADIX_DESCRIPTOR_EXTERNAL_TYPE: u16 = 1;
pub const RADIX_DESCRIPTOR_SCALAR_FUNCTION: u16 = 2;
pub const RADIX_DESCRIPTOR_OPERATOR: u16 = 3;
pub const RADIX_DESCRIPTOR_OPERATOR_CLASS: u16 = 4;
pub const RADIX_DESCRIPTOR_PLANNER_SUPPORT: u16 = 5;

pub const RADIX_TYPE_REF_BUILTIN: u16 = 1;
pub const RADIX_TYPE_REF_EXTERNAL: u16 = 2;
pub const RADIX_EXTERNAL_STORAGE_FIXED: u16 = 1;
pub const RADIX_EXTERNAL_STORAGE_VARIABLE: u16 = 2;

pub const RADIX_COLUMN_LAYOUT_FIXED: u16 = 1;
pub const RADIX_COLUMN_LAYOUT_VARIABLE: u16 = 2;

pub const RADIX_VOLATILITY_IMMUTABLE: u16 = 1;
pub const RADIX_VOLATILITY_STABLE: u16 = 2;
pub const RADIX_VOLATILITY_VOLATILE: u16 = 3;
pub const RADIX_CANCELLATION_BOUNDED: u16 = 1;
pub const RADIX_RECHECK_EXACT: u16 = 1;
pub const RADIX_RECHECK_ALWAYS: u16 = 2;

pub const RADIX_ACCESS_METHOD_BTREE: u16 = 1;
pub const RADIX_ACCESS_METHOD_HASH: u16 = 2;
pub const RADIX_ACCESS_METHOD_BITMAP: u16 = 3;
pub const RADIX_ACCESS_METHOD_HNSW: u16 = 4;

pub const RADIX_LOG_INFO: u16 = 1;
pub const RADIX_LOG_WARN: u16 = 2;
pub const RADIX_LOG_ERROR: u16 = 3;
pub const RADIX_LOG_DEBUG: u16 = 4;

pub const RADIX_PACKAGE_CAP_EXTERNAL_TYPES: u64 = 1 << 0;
pub const RADIX_PACKAGE_CAP_SCALAR_FUNCTIONS: u64 = 1 << 1;
pub const RADIX_PACKAGE_CAP_BATCH_FUNCTIONS: u64 = 1 << 2;
pub const RADIX_PACKAGE_CAP_OPERATORS: u64 = 1 << 3;
pub const RADIX_PACKAGE_CAP_OPERATOR_CLASSES: u64 = 1 << 4;
pub const RADIX_PACKAGE_CAP_PLANNER_SUPPORT: u64 = 1 << 5;
pub const RADIX_PACKAGE_CAP_ALL: u64 = (1 << 6) - 1;

pub const RADIX_TYPE_CAP_EQUALITY: u64 = 1 << 0;
pub const RADIX_TYPE_CAP_HASH: u64 = 1 << 1;
pub const RADIX_TYPE_CAP_ORDERING: u64 = 1 << 2;
pub const RADIX_TYPE_CAP_TEXT_INPUT: u64 = 1 << 3;
pub const RADIX_TYPE_CAP_TEXT_OUTPUT: u64 = 1 << 4;
pub const RADIX_TYPE_CAP_BINARY_INPUT: u64 = 1 << 5;
pub const RADIX_TYPE_CAP_BINARY_OUTPUT: u64 = 1 << 6;
pub const RADIX_TYPE_CAP_ALL: u64 = (1 << 7) - 1;

pub const RADIX_VALUE_FLAG_NULL: u32 = 1 << 0;
pub const RADIX_VALUE_FLAG_ALL: u32 = RADIX_VALUE_FLAG_NULL;
pub const RADIX_RESULT_ITEM_FLAG_NULL: u32 = 1 << 0;
pub const RADIX_RESULT_ITEM_FLAG_ALL: u32 = RADIX_RESULT_ITEM_FLAG_NULL;

pub const RADIX_HASH_COMPONENT_BYTES: u16 = 1;
pub const RADIX_HASH_COMPONENT_I64: u16 = 2;
pub const RADIX_HASH_COMPONENT_U64: u16 = 3;
pub const RADIX_HASH_COMPONENT_F64_BITS: u16 = 4;
pub const RADIX_HASH_COMPONENT_EXTERNAL: u16 = 5;

pub const RADIX_MAX_LOCAL_ID_BYTES: u32 = 255;
pub const RADIX_MAX_DIAGNOSTIC_BYTES: u32 = 4 * 1024;
pub const RADIX_MAX_EXTERNAL_VALUE_BYTES: u32 = 16 * 1024 * 1024;
pub const RADIX_MAX_DESCRIPTOR_ENTRIES: u32 = u16::MAX as u32;
pub const RADIX_MAX_FUNCTION_ARGUMENTS: u32 = 1024;
pub const RADIX_MAX_PLANNER_SPANS: u32 = 4096;
pub const RADIX_MAX_HASH_COMPONENTS: u32 = 256;
pub const RADIX_MAX_HASH_BYTES: u32 = 64 * 1024;

/// Built-in tags admitted by ABI 1.0. Zero is `Null` and is not a stored type.
pub const RADIX_BUILTIN_TYPE_MIN: u16 = 1;
pub const RADIX_BUILTIN_TYPE_MAX: u16 = 11;
pub const RADIX_BUILTIN_INTEGER: u16 = 1;
pub const RADIX_BUILTIN_FLOAT: u16 = 2;
pub const RADIX_BUILTIN_TEXT: u16 = 3;
pub const RADIX_BUILTIN_BOOLEAN: u16 = 4;
pub const RADIX_BUILTIN_TIMESTAMP: u16 = 5;
pub const RADIX_BUILTIN_JSON: u16 = 6;
pub const RADIX_BUILTIN_VECTOR: u16 = 7;
pub const RADIX_BUILTIN_UUID: u16 = 8;
pub const RADIX_BUILTIN_DECIMAL: u16 = 9;
pub const RADIX_BUILTIN_DATE: u16 = 10;
pub const RADIX_BUILTIN_BYTES: u16 = 11;