/
parameters.xml
1003 lines (999 loc) · 46.6 KB
/
parameters.xml
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
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
144
145
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
179
180
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
220
221
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
264
265
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
307
308
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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
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
466
467
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
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<appendix version="5.0" xml:id="parameters" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns="http://docbook.org/ns/docbook"
xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:html="http://www.w3.org/1999/xhtml">
<title>Parameters</title>
<para>
There are two kinds of parameters that can be used to configure the behavior of SymmetricDS:
<emphasis>Startup Parameters</emphasis> and <emphasis>Runtime Parameters</emphasis>.
Startup Parameters are required to be in a system property or a property file, while
Runtime Parameters can also be found in the Parameter table from the database.
Parameters are re-queried from their source at a configured interval and can
also be refreshed on demand by using the JMX API.
The following table shows the source of parameters and the hierarchy of precedence.
<table>
<title>Parameter Locations</title>
<tgroup cols="3">
<colspec colwidth="115px" />
<colspec colwidth="50px" />
<colspec colwidth="220px" />
<thead>
<row>
<entry>Location</entry>
<entry>Required</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<emphasis>symmetric-default.properties</emphasis>
</entry>
<entry>Y</entry>
<entry>
Packaged inside symmetric-ds.jar file. This file has all the default
settings along with descriptions.
</entry>
</row>
<row>
<entry>
<emphasis>symmetric.properties</emphasis>
</entry>
<entry>N</entry>
<entry>
Provided by the end user on the classpath. The first
symmetric.properties found on the classpath will be used.
</entry>
</row>
<row>
<entry>
<emphasis>symmetric.properties</emphasis>
</entry>
<entry>N</entry>
<entry>
Provided by the end user in the current system user's user.home
directory.
</entry>
</row>
<row>
<entry>
<emphasis>named properties file 1</emphasis>
</entry>
<entry>N</entry>
<entry>
Provided by the end user as a Java system property (i.e.
-Dsymmetric.override.properties.file.1=file://my.properties) or in
the constructor of a
<literal>SymmetricEngine</literal>
.
</entry>
</row>
<row>
<entry>
<emphasis>named properties file 2</emphasis>
</entry>
<entry>N</entry>
<entry>
Provided by the end user as a Java system property (i.e.
-Dsymmetric.override.properties.file.2=classpath://my.properties) or
in the constructor of a
<literal>SymmetricEngine</literal>
.
</entry>
</row>
<row>
<entry>
<emphasis>Java System Properties</emphasis>
</entry>
<entry>N</entry>
<entry>
Any SymmetricDS property can be passed in as a -D property to the
runtime. It will take precedence over any properties file property.
</entry>
</row>
<row>
<entry>
<emphasis>Parameter table</emphasis>
</entry>
<entry>N</entry>
<entry>
A table which contains SymmetricDS parameters. Parameters can be targeted at a specific node group and
even at a specific external id. These settings will take precedence over all of the above.
</entry>
</row>
<row>
<entry>
<emphasis>IParameterFilter</emphasis>
</entry>
<entry>N</entry>
<entry>
An extension point which allows parameters to be sourced from another location or customized.
These settings will take precedence over all of the above.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<section id="ap01-startup">
<title>Startup Parameters</title>
<para>
Startup parameters are read once from properties files and apply only during start up.
The following properties are used:
<variablelist>
<varlistentry>
<term>
<command>db.jndi.name</command>
</term>
<listitem>
<para>
The name of the database connection pool to use, which is registered in the JNDI
directory tree of the application server. It is recommended that this DataSource is
NOT transactional, because SymmetricDS will handle its own transactions. If NOT using
a JNDI connection pool, you must provide information about the database connection
using the
<literal>db.driver</literal>
,
<literal>db.url</literal>
,
<literal>db.user</literal>
, and
<literal>db.password</literal>
properties instead, which will create a pool of connections using the
<literal>db.pool</literal>
properties. [ Default: ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.driver</command>
</term>
<listitem>
<para>
The class name of the JDBC driver. If
<literal>db.jndi.name</literal>
is set, this property is ignored. [ Default: com.mysql.jdbc.Driver ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.url</command>
</term>
<listitem>
<para>
The JDBC URL used to connect to the database. If
<literal>db.jndi.name</literal>
is set, this property is ignored.
[ Default: jdbc:mysql://localhost/symmetric ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.user</command>
</term>
<listitem>
<para>
The database username, which is used to login, create, and update SymmetricDS tables.
To use an encrypted username, see <xref linkend="encrypted-passwords"/>.
If
<literal>db.jndi.name</literal>
is set, this property is ignored. [ Default: symmetric ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.password</command>
</term>
<listitem>
<para>
The password for the database user.
To use an encrypted password, see <xref linkend="encrypted-passwords"/>.
If
<literal>db.jndi.name</literal>
is set, this property is ignored. [ Default: ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.pool.initial.size</command>
</term>
<listitem>
<para>
The initial size of the connection pool. If
<literal>db.jndi.name</literal>
is set, this property is ignored. [ Default: 5 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.pool.max.active</command>
</term>
<listitem>
<para>
The maximum number of connections that will be allocated in the pool. If
<literal>db.jndi.name</literal>
is set, this property is ignored. [ Default: 10 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.pool.max.wait.millis</command>
</term>
<listitem>
<para>
This is how long a request for a connection from the datasource will wait before
giving up. If
<literal>db.jndi.name</literal>
is set, this property is ignored. [ Default: 30000 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.pool.min.evictable.idle.millis</command>
</term>
<listitem>
<para>
This is how long a connection can be idle before it will be evicted. If
<literal>db.jndi.name</literal>
is set, this property is ignored. [ Default: 120000 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.spring.bean.name</command>
</term>
<listitem>
<para>
The name of a Spring bean to use as the DataSource. If you want to use a different
DataSource other than the provided DBCP version that SymmetricDS uses out of the box,
you may set this to be the Spring bean name of your DataSource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.sql.query.timeout.seconds</command>
</term>
<listitem>
<para>
The timeout in seconds for queries running on the database.
[ Default: 300 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.tx.timeout.seconds</command>
</term>
<listitem>
<para>
This is how long the default transaction time is. This needs to be fairly big to
account for large data loads. [ Default: 7200 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.jdbc.streaming.results.fetch.size</command>
</term>
<listitem>
<para>
This is the default fetch size for streaming result sets into memory from the
database. [ Default: 1000 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.default.schema</command>
</term>
<listitem>
<para>
This is the schema that will be used for metadata lookup. Some dialect automatically
figure this out using database specific SQL to get the current schema. [ Default:  ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>db.metadata.ignore.case</command>
</term>
<listitem>
<para>
Indicates that case should be ignored when looking up references to
tables using the metadata api. [ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>auto.config.database</command>
</term>
<listitem>
<para>
If this is true, the configuration and runtime tables used by SymmetricDS are
automatically created during startup. [ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>auto.upgrade</command>
</term>
<listitem>
<para>
If this is true, when symmetric starts up it will try to upgrade tables to latest version.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>auto.sync.configuration</command>
</term>
<listitem>
<para>
If this is true, create triggers for the SymmetricDS configuration table that
will synchronize changes to node groups that pull from the node where this
property is set.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>https.allow.self.signed.certs</command>
</term>
<listitem>
<para>
If this is true, a Symmetric client node to accept self signed
certificates.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>http.basic.auth.username</command>
</term>
<listitem>
<para>
If specified, a Symmetric client node will use basic authentication
when communicating with its server node using the given user name.
[ Default: ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>http.basic.auth.password</command>
</term>
<listitem>
<para>
If specified, the password used for basic authentication.
[ Default: ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>https.verified.server.names</command>
</term>
<listitem>
<para>
A list of comma separated server names that will always verify when using https.
This is useful if the URL's hostname and the server's identification hostname
don't match exactly using the default rules for the JRE. A special value
of "all" may be specified to allow all hostnames to verify.
[ Default: ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>sync.table.prefix</command>
</term>
<listitem>
<para>
When symmetric tables are created and accessed, this is the prefix to use for the
table name. [ Default: sym ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>engine.name</command>
</term>
<listitem>
<para>
This is the engine name. This should be set if you have more than one engine running
in the same JVM. It is used to name the JMX management bean.
[ Default: Default ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>start.push.job</command>
</term>
<listitem>
<para>Whether the push job is enabled for this node. [ Default: true]</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>start.pull.job</command>
</term>
<listitem>
<para>
Whether the pull job is enabled for this node. [ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>start.purge.job</command>
</term>
<listitem>
<para>
Whether the purge job is enabled for this node. [ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>start.synctriggers.job</command>
</term>
<listitem>
<para>
Whether the sync triggers job is enabled for this node.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>start.heartbeat.job</command>
</term>
<listitem>
<para>
Whether the heartbeat job is enabled for this node. The heartbeat job simply inserts
an event to update the heartbeat_time column on the node table for the current node.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>start.watchdog.job</command>
</term>
<listitem>
<para>
Whether the watchdog job is enabled for this node. The watchdog job monitors child
nodes to detect if they are offline. Refer to
<xref linkend="extensions-offline-server-listener"/> for
more information.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>job.purge.period.time.ms</command>
</term>
<listitem>
<para>
This is how often the purge job will be run. [ Default: 600000 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>job.statflush.period.time.ms</command>
</term>
<listitem>
<para>
This is how often accumulated statistics will be flushed out to the database from memory.
[ Default: 600000 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>web.base.servlet.path</command>
</term>
<listitem>
<para>
The base servlet path for when embedding SymmetricDS with in another web application.
[ Default:  ]
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section id="ap01-runtime">
<title>Runtime Parameters</title>
<para>
Runtime parameters are read periodically from properties files or the database.
The following properties are used:
<variablelist>
<varlistentry>
<term>
<command>auto.registration</command>
</term>
<listitem>
<para>
If this is true, registration is opened automatically for nodes requesting it.
[ Default: false ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>auto.reload</command>
</term>
<listitem>
<para>
If this is true, a reload is automatically sent to nodes when they register.
[ Default: false ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>auto.update.node.values.from.properties</command>
</term>
<listitem>
<para>
Update the node row in the database from the local properties during a heartbeat operation.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>http.concurrent.workers.max</command>
</term>
<listitem>
<para>
This is the number of HTTP concurrent push/pull requests symmetric will accept. This
is controlled by the NodeConcurrencyFilter. The maximum number of database connections
in the database pool should be set to twice this number.[ Default: 20 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>offline.node.detection.period.minutes</command>
</term>
<listitem>
<para>
This is the minimum number of minutes that a child node has been offline before taking action. Refer to
<xref linkend="extensions-offline-server-listener"/> for
more information.
[ Default: 120 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>outgoing.batches.peek.ahead.window.after.max.size</command>
</term>
<listitem>
<para>
This is the maximum number of events that will be peeked at to look for additional transaction rows after
the max batch size is reached. The more concurrency in your db and the longer the transaction takes the
bigger this value might have to be.
[ Default: 100 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>incoming.batches.skip.duplicates</command>
</term>
<listitem>
<para>
Whether or not to skip duplicate batches that are received. A duplicate batch is
identified by the batch ID already existing in the incoming batch table. If this
happens, it means an acknowledgement was lost due to failure or there is a bug.
Accepting a duplicate batch in this case can mean overwriting data with old data.
Another cause of duplicates is when the batch sequence number is reset, which might
happen in a lab environement. Skipping a duplicate batch in this case would prevent
data changes from loading. Generally, in a production envionment, this setting should
be true. [ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>num.of.ack.retries</command>
</term>
<listitem>
<para>
This is the number of times we will attempt to send an ACK back to the remote node
when pulling and loading data.
[ Default: 5 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>time.between.ack.retries.ms</command>
</term>
<listitem>
<para>
This is the amount of time to wait between trying to send an ACK back to the remote node
when pulling and loading data.
[ Default: 5000 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>dataextractor.enabled</command>
</term>
<listitem>
<para>
Enable or disable all data extraction at a node for all channels other than the config channel.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>dataloader.enabled</command>
</term>
<listitem>
<para>
Enable or disable all data loading at a node for all channels other than the config channel.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>dataloader.enable.fallback.update</command>
</term>
<listitem>
<para>
If an insert is received, but the row already exists, then
try an update instead.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>dataloader.enable.fallback.insert</command>
</term>
<listitem>
<para>
If an update is received, but it affects no rows, then try to insert
instead.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>dataloader.allow.missing.delete</command>
</term>
<listitem>
<para>
If a delete is received, but it affects no rows, then continue.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>cluster.server.id</command>
</term>
<listitem>
<para>
Set this if you want to give your server a unique name to be used to identify which server did what action. Typically useful when running in
a clustered environment. This is currently used by the ClusterService when locking for a node.
[ Default:  ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>cluster.lock.timeout.ms</command>
</term>
<listitem>
<para>
Time limit of lock before it is considered abandoned and can be broken.
[ Default: 1800000 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>cluster.lock.enabled</command>
</term>
<listitem>
<para>
[ Default: false ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>initial.load.delete.first</command>
</term>
<listitem>
<para>
Set this if tables should be purged prior to an initial load.
[ Default: false ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>initial.load.create.first</command>
</term>
<listitem>
<para>
Set this if tables (and their indexes) should be created prior to an initial load.
[ Default: false ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>http.timeout.ms</command>
</term>
<listitem>
<para>
Sets both the connection and read timeout on the internal HttpUrlConnection.
[ Default: 600000s ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>http.compression</command>
</term>
<listitem>
<para>
Whether or not to use compression over HTTP connections.
Currently, this setting only affects the push connection of the source node.
Compression on a pull is enabled using a filter in the web.xml for the PullServlet.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>web.compression.disabled</command>
</term>
<listitem>
<para>
Disable compression from occurring on Servlet communication. This property only
affects the outbound HTTP traffic streamed by the PullServlet and PushServlet.
[ Default: false ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>compression.level</command>
</term>
<listitem>
<para>
Set the compression level this node will use when compressing synchronization payloads.
Valid values include: NO_COMPRESSION = 0, BEST_SPEED = 1, BEST_COMPRESSION = 9, DEFAULT_COMPRESSION = -1
[ Default: -1 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>compression.strategy</command>
</term>
<listitem>
<para>
Set the compression strategy this node will use when compressing synchronization payloads.
Valid values include: FILTERED = 1, HUFFMAN_ONLY = 2, DEFAULT_STRATEGY = 0
[ Default: 0 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>stream.to.file.enabled</command>
</term>
<listitem>
<para>
Save data to the file system before transporting it to the client or loading
it to the database if the number of bytes is past a certain threshold. This allows
for better compression and better use of database and network resources. Statistics
in the batch tables will be more accurate if this is set to true because each timed
operation is independent of the others.
[ Default: true ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>stream.to.file.threshold.bytes</command>
</term>
<listitem>
<para>
If stream.to.file.enabled is true, then the threshold number of bytes at which a file
will be written is controlled by this property. Note that for a synchronization the
entire payload of the synchronization will be buffered in memory up to this number (at
which point it will be written and continue to stream to disk)
[ Default: 32767 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>job.random.max.start.time.ms</command>
</term>
<listitem>
<para>
When starting jobs, symmetric attempts to randomize the start time to spread out load.
This is the maximum wait period before starting a job.
[ Default: 10000 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>purge.retention.minutes</command>
</term>
<listitem>
<para>
This is the retention for how long synchronization data will be kept in the
SymmetricDS synchronization tables. Note that data will be purged only if the purge
job is enabled. [ Default: 7200 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>statistic.retention.minutes</command>
</term>
<listitem>
<para>
This is the retention for how long statistic data will be kept in the
SymmetricDS staistic table. Note that data will be purged only if the purge
job is enabled. [ Default: 7200 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>job.route.period.time.ms</command>
</term>
<listitem>
<para>This is how often the route job will be run. [ Default: 10000 ]</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>job.push.period.time.ms</command>
</term>
<listitem>
<para>This is how often the push job will be run. [ Default: 60000 ]</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>job.pull.period.time.ms</command>
</term>
<listitem>
<para>This is how often the pull job will be run. [ Default: 60000 ]</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>job.synctriggers.aftermidnight.minutes</command>
</term>
<listitem>
<para>
If scheduled, the sync triggers job will run nightly. This is how long after midnight
that job will run. [ Default: 15 ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>schema.version</command>
</term>
<listitem>
<para>
This is hook to give the user a mechanism to indicate the schema version that is being
synchronized. This property is only valid if you use the default IRuntimeConfiguration
implementation. [ Default: ? ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>registration.url</command>
</term>
<listitem>
<para>
The URL where this node can connect for registration to receive its configuration.
This property is only valid if you use the default IRuntimeConfiguration
implementation. [ Default: ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>sync.url</command>
</term>
<listitem>
<para>
The URL where this node can be contacting for synchronization.
[ Default: http://localhost:8080/sync ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>group.id</command>
</term>
<listitem>
<para>
The node group id for this node. [ Default: default ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>external.id</command>
</term>
<listitem>
<para>
The secondary identifier for this node that has meaning to the system where it is
deployed. While the node id is a generated sequence number, the external ID could have
meaning in the user's domain, such as a retail store number.
[ Default: ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>transport.type</command>
</term>
<listitem>
<para>
Specify the transport type. Supported values currently include: http, internal.
[ Default: http ]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>hsqldb.initialize.db</command>
</term>
<listitem>
<para>
If using the HsqlDbDialect, this property indicates whether Symmetric should setup the embedded database properties or if an
external application will be doing so.
[ Default: true ]
</para>
</listitem>
</varlistentry>
</variablelist>