forked from tigerbeetle/tigerbeetle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs.zig
411 lines (370 loc) · 12.7 KB
/
docs.zig
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
const Docs = @import("../docs_types.zig").Docs;
pub const JavaDocs = Docs{
.readme = "java/README.md",
.markdown_name = "java",
.extension = "java",
.proper_name = "Java",
.test_linux_docker_image = "alpine",
.test_source_path = "src/main/java/",
.name = "tigerbeetle-java",
.description =
\\The TigerBeetle client for Java.
\\
\\[![javadoc](https://javadoc.io/badge2/com.tigerbeetle/tigerbeetle-java/javadoc.svg)](https://javadoc.io/doc/com.tigerbeetle/tigerbeetle-java)
\\
\\[![maven-central](https://img.shields.io/maven-central/v/com.tigerbeetle/tigerbeetle-java)](https://central.sonatype.com/namespace/com.tigerbeetle)
,
.prerequisites =
\\* Java >= 11
\\* Maven >= 3.6 (not strictly necessary but it's what our guides assume)
,
.project_file_name = "pom.xml",
.project_file =
\\<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
\\ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
\\ <modelVersion>4.0.0</modelVersion>
\\
\\ <groupId>api</groupId>
\\ <artifactId>api</artifactId>
\\ <version>1.0-SNAPSHOT</version>
\\
\\ <properties>
\\ <maven.compiler.source>11</maven.compiler.source>
\\ <maven.compiler.target>11</maven.compiler.target>
\\ </properties>
\\
\\ <build>
\\ <plugins>
\\ <plugin>
\\ <groupId>org.apache.maven.plugins</groupId>
\\ <artifactId>maven-compiler-plugin</artifactId>
\\ <version>3.8.1</version>
\\ <configuration>
\\ <compilerArgs>
\\ <arg>-Xlint:all,-options,-path</arg>
\\ </compilerArgs>
\\ </configuration>
\\ </plugin>
\\
\\ <plugin>
\\ <groupId>org.codehaus.mojo</groupId>
\\ <artifactId>exec-maven-plugin</artifactId>
\\ <version>1.6.0</version>
\\ <configuration>
\\ <mainClass>Main</mainClass>
\\ </configuration>
\\ </plugin>
\\ </plugins>
\\ </build>
\\
\\ <dependencies>
\\ <dependency>
\\ <groupId>com.tigerbeetle</groupId>
\\ <artifactId>tigerbeetle-java</artifactId>
\\ <!-- Grab the latest commit from: https://repo1.maven.org/maven2/com/tigerbeetle/tigerbeetle-java/maven-metadata.xml -->
\\ <version>0.0.1-3431</version>
\\ </dependency>
\\ </dependencies>
\\</project>
,
.test_file_name = "Main",
.install_sample_file =
\\package com.tigerbeetle.examples;
\\
\\import com.tigerbeetle.*;
\\
\\public final class Main {
\\ public static void main(String[] args) {
\\ System.out.println("Import ok!");
\\ }
\\}
,
.install_prereqs = "apk add -U maven openjdk11",
.current_commit_pre_install_commands =
\\mvn deploy:deploy-file -Durl=file://$(pwd) -Dfile=$(find . -name '*-SNAPSHOT.jar') -DgroupId=com.tigerbeetle -DartifactId=tigerbeetle-java -Dpackaging=jar -Dversion=0.0.1-3431
\\mkdir -p $HOME/.m2/
\\echo '<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd"><localRepository>'$(pwd)'</localRepository></settings>' > $HOME/.m2/settings.xml
,
.current_commit_post_install_commands = "",
.install_commands =
\\mvn install
,
.install_sample_file_build_commands =
\\mvn compile
,
.install_sample_file_test_commands = "mvn exec:java",
.install_documentation = "",
.examples = "",
.client_object_example =
\\Client client = new Client(
\\ 0,
\\ new String[] {"3001", "3002", "3003"}
\\);
,
.client_object_documentation =
\\If you create a `Client` like this, don't forget to call
\\`client.close()` when you are done with it. Otherwise you
\\can use the
\\[try-with-resources](https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html)
\\syntax:
\\```java
\\try (var client = new Client(...)) {
\\ // Use client
\\} catch (Exception e) {
\\ // Handle exception
\\}
\\```
,
.create_accounts_example =
\\AccountBatch accounts = new AccountBatch(1);
\\accounts.add();
\\accounts.setId(137);
\\accounts.setUserData(UInt128.asBytes(new java.math.BigInteger("92233720368547758070")));
\\accounts.setLedger(1);
\\accounts.setCode(718);
\\accounts.setFlags(0);
\\
\\CreateAccountResultBatch accountErrors = client.createAccounts(accounts);
,
.create_accounts_documentation =
\\The 128-bit fields like `id` and `user_data` have a few
\\overrides to make it easier to integrate. You can either
\\pass in a long, a pair of longs (least and most
\\significant bits), or a `byte[]`.
\\
\\There is also a `com.tigerbeetle.UInt128` helper with static
\\methods for converting 128-bit little-endian unsigned integers
\\between instances of `long`, `UUID`, `BigInteger` and `byte[]`.
,
.account_flags_documentation =
\\To toggle behavior for an account, combine enum values stored in the
\\`AccountFlags` object with bitwise-or:
\\
\\* `AccountFlags.LINKED`
\\* `AccountFlags.DEBITS_MUST_NOT_EXCEED_CREDITS`
\\* `AccountFlags.CREDITS_MUST_NOT_EXCEED_CREDITS`
,
.account_flags_example =
\\accounts = new AccountBatch(3);
\\
\\// First account
\\accounts.add();
\\// Code to fill out fields for first account
\\accounts.setFlags(AccountFlags.LINKED | AccountFlags.DEBITS_MUST_NOT_EXCEED_CREDITS);
\\
\\// Second account
\\accounts.add();
\\// Code to fill out fields for second account
\\
\\accountErrors = client.createAccounts(accounts);
,
.create_accounts_errors_example =
\\accounts = new AccountBatch(3);
\\
\\// First account
\\accounts.add();
\\// Code to fill out fields for first account
\\
\\// Second account
\\accounts.add();
\\// Code to fill out fields for second account
\\
\\// Third account
\\accounts.add();
\\// Code to fill out fields for third account
\\
\\accountErrors = client.createAccounts(accounts);
\\while (accountErrors.next()) {
\\ switch (accountErrors.getResult()) {
\\ case Exists:
\\ System.err.printf("Account at %d already exists.\n",
\\ accountErrors.getIndex());
\\ break;
\\
\\ default:
\\ System.err.printf("Error creating account at %d: %s\n",
\\ accountErrors.getIndex(),
\\ accountErrors.getResult());
\\ break;
\\ }
\\}
,
.create_accounts_errors_documentation = "",
.lookup_accounts_example =
\\IdBatch ids = new IdBatch(2);
\\ids.add(137);
\\ids.add(138);
\\accounts = client.lookupAccounts(ids);
,
.create_transfers_example =
\\TransferBatch transfers = new TransferBatch(1);
\\transfers.add();
\\transfers.setId(1);
\\transfers.setDebitAccountId(1);
\\transfers.setCreditAccountId(2);
\\transfers.setUserData(2);
\\transfers.setTimeout(0);
\\transfers.setLedger(1);
\\transfers.setCode(1);
\\transfers.setFlags(0);
\\transfers.setAmount(10);
\\
\\CreateTransferResultBatch transferErrors = client.createTransfers(transfers);
,
.create_transfers_documentation = "",
.create_transfers_errors_example =
\\while (transferErrors.next()) {
\\ switch (transferErrors.getResult()) {
\\ case ExceedsCredits:
\\ System.err.printf("Transfer at %d exceeds credits.\n",
\\ transferErrors.getIndex());
\\ break;
\\
\\ default:
\\ System.err.printf("Error creating transfer at %d: %s\n",
\\ transferErrors.getIndex(),
\\ transferErrors.getResult());
\\ break;
\\ }
\\}
,
.create_transfers_errors_documentation = "",
.no_batch_example =
\\for (int i = 0; i < transfers.length; i++) {
\\ TransferBatch batch = new TransferBatch(1);
\\ batch.add();
\\ batch.setId(transfers[i].getId());
\\ batch.setDebitAccountId(transfers[i].getDebitAccountId());
\\ batch.setCreditAccountId(transfers[i].getCreditAccountId());
\\
\\ CreateTransferResultBatch errors = client.createTransfers(batch);
\\ // error handling omitted
\\}
,
.batch_example =
\\var BATCH_SIZE = 8191;
\\for (int i = 0; i < transfers.length; i += BATCH_SIZE) {
\\ TransferBatch batch = new TransferBatch(BATCH_SIZE);
\\
\\ for (int j = 0; j < BATCH_SIZE && i + j < transfers.length; j++) {
\\ batch.add();
\\ batch.setId(transfers[i + j].getId());
\\ batch.setDebitAccountId(transfers[i + j].getDebitAccountId());
\\ batch.setCreditAccountId(transfers[i + j].getCreditAccountId());
\\ }
\\
\\ CreateTransferResultBatch errors = client.createTransfers(batch);
\\ // error handling omitted
\\}
,
.transfer_flags_documentation =
\\To toggle behavior for an account, combine enum values stored in the
\\`TransferFlags` object with bitwise-or:
\\
\\* `TransferFlags.NONE`
\\* `TransferFlags.LINKED`
\\* `TransferFlags.PENDING`
\\* `TransferFlags.POST_PENDING_TRANSFER`
\\* `TransferFlags.VOID_PENDING_TRANSFER`
,
.transfer_flags_link_example =
\\transfers = new TransferBatch(2);
\\
\\// First transfer
\\transfers.add();
\\// Code to fill out fields for first transfer
\\transfers.setFlags(TransferFlags.LINKED);
\\
\\// Second transfer
\\transfers.add();
\\// Code to fill out fields for second transfer
\\transferErrors = client.createTransfers(transfers);
,
.transfer_flags_post_example =
\\transfers = new TransferBatch(1);
\\
\\// First transfer
\\transfers.add();
\\// Code to fill out fields for first transfer
\\transfers.setFlags(TransferFlags.POST_PENDING_TRANSFER);
\\transferErrors = client.createTransfers(transfers);
,
.transfer_flags_void_example =
\\transfers = new TransferBatch(1);
\\
\\// First transfer
\\transfers.add();
\\// Code to fill out fields for first transfer
\\transfers.setFlags(TransferFlags.VOID_PENDING_TRANSFER);
\\transferErrors = client.createTransfers(transfers);
,
.lookup_transfers_example =
\\ids = new IdBatch(2);
\\ids.add(1);
\\ids.add(2);
\\transfers = client.lookupTransfers(ids);
,
.linked_events_example =
\\transfers = new TransferBatch(10);
\\
\\// An individual transfer (successful):
\\transfers.add();
\\transfers.setId(1);
\\
\\// A chain of 4 transfers (the last transfer in the chain closes the chain with linked=false):
\\transfers.add();
\\transfers.setId(2); // Commit/rollback.
\\transfers.setFlags(TransferFlags.LINKED);
\\
\\transfers.add();
\\transfers.setId(3); // Commit/rollback.
\\transfers.setFlags(TransferFlags.LINKED);
\\
\\transfers.add();
\\transfers.setId(2); // Fail with exists
\\transfers.setFlags(TransferFlags.LINKED);
\\
\\transfers.add();
\\transfers.setId(4); // Fail without committing
\\
\\// An individual transfer (successful):
\\// This should not see any effect from the failed chain above.
\\transfers.add();
\\transfers.setId(2);
\\
\\// A chain of 2 transfers (the first transfer fails the chain):
\\transfers.add();
\\transfers.setId(2);
\\transfers.setFlags(TransferFlags.LINKED);
\\
\\transfers.add();
\\transfers.setId(3);
\\
\\// A chain of 2 transfers (successful):
\\transfers.add();
\\transfers.setId(3);
\\transfers.setFlags(TransferFlags.LINKED);
\\
\\transfers.add();
\\transfers.setId(4);
\\
\\transferErrors = client.createTransfers(transfers);
,
.developer_setup_sh_commands =
\\git clone https://github.com/tigerbeetledb/tigerbeetle
\\cd tigerbeetle
\\git checkout $GIT_SHA
\\cd src/clients/java
\\./scripts/install.sh
\\[ "$TEST" = "true" ] && mvn test || echo "Skipping client unit tests"
,
.developer_setup_pwsh_commands = "",
.test_main_prefix =
\\package com.tigerbeetle.examples;
\\
\\import com.tigerbeetle.*;
\\public final class Main {
\\ public static void main(String[] args) throws com.tigerbeetle.RequestException {
,
.test_main_suffix = "} }",
};