Skip to content

Commit dd24b96

Browse files
sorkikderme
authored andcommitted
doc/configuration: add tx_cbor
1 parent 8484205 commit dd24b96

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

doc/configuration.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Below is a sample `insert_options` section that shows all the defaults:
2424
// ...
2525
2626
"insert_options": {
27+
"tx_cbor": "disable",
2728
"tx_out": {
2829
"value": "enable"
2930
},
@@ -54,6 +55,7 @@ Below is a sample `insert_options` section that shows all the defaults:
5455
| Property | Type | Required |
5556
| :------------------------------------------- | :--------- | :------ |
5657
| [preset](#preset) | `enum` | Optional |
58+
| [tx\_cbor](#tx-cbor) | `enum` | Optional |
5759
| [tx\_out](#tx-out) | `object` | Optional |
5860
| [ledger](#ledger) | `enum` | Optional |
5961
| [shelley](#shelley) | `object` | Optional |
@@ -67,7 +69,7 @@ Below is a sample `insert_options` section that shows all the defaults:
6769
### Preset
6870

6971
Preset is an aggregate setting that overrides all other properties. For example, setting
70-
preset to `"full"` will enable all insert options.
72+
preset to `"full"` will enable all insert options except `"tx_cbor"`.
7173

7274
`preset`
7375

@@ -91,6 +93,7 @@ This is equivalent to enabling all other settings.
9193
This is equivalent to setting:
9294

9395
```
96+
"tx_cbor": "disable",
9497
"tx_out": {
9598
"value": "bootstrap"
9699
},
@@ -121,6 +124,7 @@ to the `tx_out` and `ma_tx_out` tables. After that db-sync can be restarted wit
121124
This is equivalent to setting:
122125

123126
```
127+
"tx_cbor": "disable",
124128
"tx_out": {
125129
"value": "disable"
126130
},
@@ -146,6 +150,7 @@ Disables most data except `block`, `tx`, and governance data.
146150
This is equivalent to setting:
147151

148152
```
153+
"tx_cbor": "disable",
149154
"tx_out": {
150155
"value": "disable"
151156
},
@@ -165,6 +170,19 @@ This is equivalent to setting:
165170

166171
Disables almost all data except `block` and `tx` tables.
167172

173+
### Tx CBOR
174+
175+
`tx_cbor`
176+
177+
* Type: `string`
178+
179+
**enum**: The value of this property must be equal to one of the following values:
180+
181+
| Value | Explanation |
182+
| :--------- | :------------------------------------- |
183+
| `"enable"` | Enable transaction CBOR collection |
184+
| `"disable"` | Disable transaction CBOR collection |
185+
168186
### Tx Out
169187

170188
`tx_out`

0 commit comments

Comments
 (0)