@@ -54,6 +54,7 @@ influxdb3 serve
54
54
- [ object-store] ( #object-store )
55
55
- [ data-dir] ( #data-dir )
56
56
- [ node-id] ( #node-id )
57
+ - [ cluster-id] ( #cluster-id )
57
58
- [ mode] ( #mode )
58
59
- [ license-email] ( #license-email )
59
60
- [ query-file-limit] ( #query-file-limit )
@@ -112,7 +113,6 @@ influxdb3 serve
112
113
- [ Memory] ( #memory )
113
114
- [ ram-pool-data-bytes] ( #ram-pool-data-bytes )
114
115
- [ exec-mem-pool-bytes] ( #exec-mem-pool-bytes )
115
- - [ buffer-mem-limit-mb] ( #buffer-mem-limit-mb )
116
116
- [ force-snapshot-mem-threshold] ( #force-snapshot-mem-threshold )
117
117
- [ Write-Ahead Log (WAL)] ( #write-ahead-log-wal )
118
118
- [ wal-flush-interval] ( #wal-flush-interval )
@@ -123,17 +123,14 @@ influxdb3 serve
123
123
- [ read-from-node-ids] ( #read-from-node-ids )
124
124
- [ replication-interval] ( #replication-interval )
125
125
- [ Compaction] ( #compaction )
126
- - [ compactor-id] ( #compactor-id )
127
- - [ compact-from-node-ids] ( #compact-from-node-ids )
128
- - [ run-compactions] ( #run-compactions )
129
126
- [ compaction-row-limit] ( #compaction-row-limit )
130
127
- [ compaction-max-num-files-per-plan] ( #compaction-max-num-files-per-plan )
131
128
- [ compaction-gen2-duration] ( #compaction-gen2-duration )
132
129
- [ compaction-multipliers] ( #compaction-multipliers )
133
130
- [ gen1-duration] ( #gen1-duration )
134
131
- [ Caching] ( #caching )
135
132
- [ preemptive-cache-age] ( #preemptive-cache-age )
136
- - [ parquet-mem-cache-size-mb ] ( #parquet-mem-cache-size-mb )
133
+ - [ parquet-mem-cache-size] ( #parquet-mem-cache-size )
137
134
- [ parquet-mem-cache-prune-percentage] ( #parquet-mem-cache-prune-percentage )
138
135
- [ parquet-mem-cache-prune-interval] ( #parquet-mem-cache-prune-interval )
139
136
- [ disable-parquet-mem-cache] ( #disable-parquet-mem-cache )
@@ -153,6 +150,7 @@ influxdb3 serve
153
150
- [ bucket] ( #bucket )
154
151
- [ data-dir] ( #data-dir )
155
152
- [ node-id] ( #node-id )
153
+ - [ cluster-id] ( #cluster-id )
156
154
- [ mode] ( #mode )
157
155
- [ license-email] ( #license-email )
158
156
- [ query-file-limit] ( #query-file-limit )
@@ -162,12 +160,12 @@ influxdb3 serve
162
160
Specifies which object storage to use to store Parquet files.
163
161
This option supports the following values:
164
162
165
- - ` memory ` _ (default)_
166
- - ` memory-throttled `
167
- - ` file `
168
- - ` s3 `
169
- - ` google `
170
- - ` azure `
163
+ - ` memory ` _ (default)_ : Effectively no object persistence
164
+ - ` memory-throttled ` : Like ` memory ` but with latency and throughput that somewhat resembles a cloud object store
165
+ - ` file ` : Stores objects in the local filesystem (must also set ` --data-dir ` )
166
+ - ` s3 ` : Amazon S3 (must also set ` --bucket ` , ` --aws-access-key-id ` , ` --aws-secret-access-key ` , and possibly ` --aws-default-region ` )
167
+ - ` google ` : Google Cloud Storage (must also set ` --bucket ` and ` --google-service-account ` )
168
+ - ` azure ` : Microsoft Azure blob storage (must also set ` --bucket ` , ` --azure-storage-account ` , and ` --azure-storage-access-key ` )
171
169
172
170
| influxdb3 serve option | Environment variable |
173
171
| :--------------------- | :----------------------- |
@@ -197,17 +195,30 @@ configuration--for example, the same bucket.
197
195
198
196
---
199
197
198
+ #### cluster-id
199
+
200
+ Specifies the cluster identifier that prefixes the object store path for the Enterprise Catalog.
201
+ This value must be different than the [ ` --node-id ` ] ( #node-id ) value.
202
+
203
+ | influxdb3 serve option | Environment variable |
204
+ | :--------------------- | :--------------------------------- |
205
+ | ` --cluster-id ` | ` INFLUXDB3_ENTERPRISE_CLUSTER_ID ` |
206
+
207
+ ---
208
+
200
209
#### mode
201
210
202
211
Sets the mode to start the server in.
203
212
204
213
This option supports the following values:
205
214
206
- - ` read `
207
- - ` read_write ` _ (default)_
208
- - ` compactor `
215
+ - ` all ` _ (default)_
216
+ - ` ingest `
217
+ - ` query `
218
+ - ` compact `
219
+ - ` process `
209
220
210
- ** Default:** ` read_write `
221
+ ** Default:** ` all `
211
222
212
223
| influxdb3 serve option | Environment variable |
213
224
| :--------------------- | :-------------------------- |
@@ -844,36 +855,25 @@ Specifies the size of the RAM cache used to store data, in bytes.
844
855
845
856
#### exec-mem-pool-bytes
846
857
847
- Specifies the size of the memory pool used during query execution, in bytes.
858
+ Specifies the size of memory pool used during query execution.
859
+ Can be given as absolute value in bytes or as a percentage of the total available memory (for example: ` 10% ` ).
848
860
849
- ** Default:** ` 8589934592 `
861
+ ** Default:** ` 20% `
850
862
851
863
| influxdb3 serve option | Environment variable |
852
864
| :---------------------- | :------------------------------ |
853
865
| ` --exec-mem-pool-bytes ` | ` INFLUXDB3_EXEC_MEM_POOL_BYTES ` |
854
866
855
867
---
856
868
857
- #### buffer-mem-limit-mb
858
-
859
- Specifies the size limit of the buffered data in MB. If this limit is exceeded,
860
- the server forces a snapshot.
861
-
862
- ** Default:** ` 5000 `
863
-
864
- | influxdb3 serve option | Environment variable |
865
- | :---------------------- | :------------------------------ |
866
- | ` --buffer-mem-limit-mb ` | ` INFLUXDB3_BUFFER_MEM_LIMIT_MB ` |
867
-
868
- ---
869
-
870
869
#### force-snapshot-mem-threshold
870
+ <span id =" buffer-mem-limit-mb " />
871
871
872
872
Specifies the threshold for the internal memory buffer. Supports either a
873
- percentage (portion of available memory)of or absolute value
874
- (total bytes)--for example: ` 70% ` or ` 100000 ` .
873
+ percentage (portion of available memory) or absolute value in MB
874
+ (total bytes)--for example: ` 70% ` or ` 1000 MB ` .
875
875
876
- ** Default:** ` 70 %`
876
+ ** Default:** ` 50 %`
877
877
878
878
| influxdb3 serve option | Environment variable |
879
879
| :------------------------------- | :--------------------------------------- |
@@ -972,47 +972,31 @@ Defines the interval at which each replica specified in the
972
972
973
973
### Compaction
974
974
975
- - [ compactor-id] ( #compactor-id )
976
- - [ compact-from-node-ids] ( #compact-from-node-ids )
977
- - [ run-compactions] ( #run-compactions )
978
975
- [ compaction-row-limit] ( #compaction-row-limit )
979
976
- [ compaction-max-num-files-per-plan] ( #compaction-max-num-files-per-plan )
980
977
- [ compaction-gen2-duration] ( #compaction-gen2-duration )
981
978
- [ compaction-multipliers] ( #compaction-multipliers )
979
+ - [ compaction-cleanup-wait] ( #compaction-cleanup-wait )
982
980
- [ gen1-duration] ( #gen1-duration )
983
981
984
982
#### compactor-id
985
983
986
- Specifies the prefix in the object store where all compacted data is written.
987
- Provide this option only if this server should handle compaction for its own
988
- write buffer and any replicas it manages.
989
-
990
- | influxdb3 serve option | Environment variable |
991
- | :--------------------- | :---------------------------------- |
992
- | ` --compactor-id ` | ` INFLUXDB3_ENTERPRISE_COMPACTOR_ID ` |
984
+ > [ !Important]
985
+ > This option has been superseded by using ` --mode compact ` . See the [ mode] ( #mode ) section for details.
993
986
994
987
---
995
988
996
989
#### compact-from-node-ids
997
990
998
- Defines a comma-separated list of writer identifier prefixes from which data is
999
- compacted.
1000
-
1001
- | influxdb3 serve option | Environment variable |
1002
- | :-------------------------- | :--------------------------------------------- |
1003
- | ` --compact-from-node-ids ` | ` INFLUXDB3_ENTERPRISE_COMPACT_FROM_WRITER_IDS ` |
991
+ > [ !Important]
992
+ > This option has been superseded by using ` --mode compact ` . See the [ mode] ( #mode ) section for details.
1004
993
1005
994
---
1006
995
1007
996
#### run-compactions
1008
997
1009
- Indicates that the server should run compactions. Only a single server should
1010
- run compactions for a given ` compactor-id ` . This option is only applicable if a
1011
- ` compactor-id ` is set.
1012
-
1013
- | influxdb3 serve option | Environment variable |
1014
- | :--------------------- | :------------------------------------- |
1015
- | ` --run-compactions ` | ` INFLUXDB3_ENTERPRISE_RUN_COMPACTIONS ` |
998
+ > [ !Important]
999
+ > This option has been superseded by using ` --mode compact ` . See the [ mode] ( #mode ) section for details.
1016
1000
1017
1001
---
1018
1002
@@ -1070,6 +1054,19 @@ compaction levels. The first element specifies the duration of the first level
1070
1054
1071
1055
---
1072
1056
1057
+ #### compaction-cleanup-wait
1058
+
1059
+ Specifies the amount of time that the compactor waits after finishing a compaction run
1060
+ to delete files marked as needing deletion during that compaction run.
1061
+
1062
+ ** Default:** ` 10m `
1063
+
1064
+ | influxdb3 serve option | Environment variable |
1065
+ | :-------------------------- | :--------------------------------------------- |
1066
+ | ` --compaction-cleanup-wait ` | ` INFLUXDB3_ENTERPRISE_COMPACTION_CLEANUP_WAIT ` |
1067
+
1068
+ ---
1069
+
1073
1070
#### gen1-duration
1074
1071
1075
1072
Specifies the duration that Parquet files are arranged into. Data timestamps
@@ -1088,7 +1085,7 @@ compactor can merge into larger generations.
1088
1085
### Caching
1089
1086
1090
1087
- [ preemptive-cache-age] ( #preemptive-cache-age )
1091
- - [ parquet-mem-cache-size-mb ] ( #parquet-mem-cache-size-mb )
1088
+ - [ parquet-mem-cache-size] ( #parquet-mem-cache-size )
1092
1089
- [ parquet-mem-cache-prune-percentage] ( #parquet-mem-cache-prune-percentage )
1093
1090
- [ parquet-mem-cache-prune-interval] ( #parquet-mem-cache-prune-interval )
1094
1091
- [ disable-parquet-mem-cache] ( #disable-parquet-mem-cache )
@@ -1108,17 +1105,16 @@ Specifies the interval to prefetch into the Parquet cache during compaction.
1108
1105
1109
1106
---
1110
1107
1111
- #### parquet-mem-cache-size-mb
1108
+ #### parquet-mem-cache-size
1109
+ <span id =" parquet-mem-cache-size-mb " />
1112
1110
1113
- Defines the size of the in-memory Parquet cache in megabytes (MB) .
1111
+ Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory .
1114
1112
1115
- ** Default:** ` 1000 `
1113
+ ** Default:** ` 20% `
1116
1114
1117
- | influxdb3 serve option | Environment variable |
1118
- | :---------------------------- | :------------------------------------ |
1119
- | ` --parquet-mem-cache-size-mb ` | ` INFLUXDB3_PARQUET_MEM_CACHE_SIZE_MB ` |
1120
-
1121
- ---
1115
+ | influxdb3 serve option | Environment variable |
1116
+ | :-------------------------- | :---------------------------------- |
1117
+ | ` --parquet-mem-cache-size ` | ` INFLUXDB3_PARQUET_MEM_CACHE_SIZE ` |
1122
1118
1123
1119
#### parquet-mem-cache-prune-percentage
1124
1120
@@ -1225,7 +1221,12 @@ engine uses.
1225
1221
1226
1222
Specifies the Python package manager that the processing engine uses.
1227
1223
1228
- ** Default:** ` 10s `
1224
+ This option supports the following values:
1225
+ - ` discover ` _ (default)_ : Automatically discover available package manager
1226
+ - ` pip ` : Use pip package manager
1227
+ - ` uv ` : Use uv package manager
1228
+
1229
+ ** Default:** ` discover `
1229
1230
1230
1231
| influxdb3 serve option | Environment variable |
1231
1232
| :--------------------- | :------------------- |
0 commit comments