Skip to content

Commit 1e1f1e8

Browse files
javierjavier
authored
[docs] Changed docs and examples to use the trades table (#80)
1 parent d328c5d commit 1e1f1e8

32 files changed

+254
-341
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ See the [flush troubleshooting](doc/CONSIDERATIONS.md) docs for more details on
3333
how to debug ILP/TCP.
3434

3535
For an overview and code examples, see the
36-
[InfluxDB Line Protocol page of the developer docs](https://questdb.io/docs/develop/insert-data/#influxdb-line-protocol).
36+
[Ingestion overview page of the developer docs](https://questdb.io/docs/ingestion-overview/).
3737

3838
To understand the protocol in more depth, consult the
3939
[protocol reference docs](https://questdb.io/docs/reference/api/ilp/overview/).

‎ci/compile.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ steps:
88
env:
99
JAVA_HOME: $(JAVA_HOME_11_X64)
1010
displayName: "Build Makefile with CMake"
11-
- script: cmake --build build
11+
- script: cmake --build build --config Release
1212
env:
1313
JAVA_HOME: $(JAVA_HOME_11_X64)
1414
displayName: "Make"

‎ci/run_all_tests.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ def main():
3838
test_line_sender_path = next(iter(
3939
build_dir.glob(f'**/test_line_sender{exe_suffix}')))
4040
system_test_path = pathlib.Path('system_test') / 'test.py'
41-
qdb_v = '8.0.1' # The version of QuestDB we'll test against.
41+
qdb_v = '8.1.0' # The version of QuestDB we'll test against.
4242

4343
run_cmd('cargo', 'test', '--', '--nocapture', cwd='questdb-rs')
4444
run_cmd('cargo', 'test', '--all-features', '--', '--nocapture', cwd='questdb-rs')

‎doc/C.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,21 +62,20 @@ re-usable, but a buffer may only be flushed via the sender after a call to
6262
`line_sender_buffer_at_*(..)` (preferred) or `line_sender_buffer_at_now()`.
6363

6464
```c
65-
line_sender_table_name table_name = QDB_TABLE_NAME_LITERAL("c_cars");
66-
line_sender_column_name id_name = QDB_COLUMN_NAME_LITERAL("id");
67-
line_sender_column_name x_name = QDB_COLUMN_NAME_LITERAL("x");
65+
line_sender_table_name table_name = QDB_TABLE_NAME_LITERAL("trades");
66+
line_sender_column_name symbol_name = QDB_COLUMN_NAME_LITERAL("symbol");
67+
line_sender_column_name price_name = QDB_COLUMN_NAME_LITERAL("price");
6868

6969
line_sender_buffer* buffer = line_sender_buffer_new();
7070

7171
if (!line_sender_buffer_table(buffer, table_name, &err))
7272
goto on_error;
7373

74-
line_sender_utf8 id_value = QDB_UTF8_LITERAL(
75-
"d6e5fe92-d19f-482a-a97a-c105f547f721");
76-
if (!line_sender_buffer_symbol(buffer, id_name, id_value, &err))
74+
line_sender_utf8 symbol_value = QDB_UTF8_LITERAL("ETH-USD");
75+
if (!line_sender_buffer_symbol(buffer, symbol_name, symbol_value, &err))
7776
goto on_error;
7877

79-
if (!line_sender_buffer_column_f64(buffer, x_name, 30.5, &err))
78+
if (!line_sender_buffer_column_f64(buffer, price_name, 2615.54, &err))
8079
goto on_error;
8180

8281
if (!line_sender_buffer_at_nanos(buffer, line_sender_now_nanos(), &err))

‎doc/CPP.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ re-usable, but a buffer may only be flushed via the sender after a call to
5858
```cpp
5959
questdb::ingress::line_sender_buffer buffer;
6060
buffer
61-
.table("cpp_cars")
62-
.symbol("id", "d6e5fe92-d19f-482a-a97a-c105f547f721")
63-
.column("x", 30.5)
61+
.table("trades")
62+
.symbol("symbol", "ETH-USD")
63+
.column("price", 2615.54)
6464
.at(timestamp_nanos::now());
6565

6666
// To insert more records, call `buffer.table(..)...` again.

‎examples.manifest.yaml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
header: |-
2525
[C client library docs](https://github.com/questdb/c-questdb-client/blob/main/doc/C.md)
2626
auth:
27-
kid: testUser1
27+
kid: admin
2828
d: 5UjEMuA0Pj5pjK8a-fa24dyIf-Es5mYny3oE_Wmus48
2929
x: fLKYEaoEb9lrn3nkwLDA-M_xnuFOdSt9y0Z7_vWSHLU
3030
y: Dt5tbS1dEDMSYfym3fgMv0B99szno-dFc1rYF9t0aac
@@ -38,7 +38,7 @@
3838
header: |-
3939
[C++ client library docs](https://github.com/questdb/c-questdb-client/blob/main/doc/CPP.md)
4040
auth:
41-
kid: testUser1
41+
kid: admin
4242
d: 5UjEMuA0Pj5pjK8a-fa24dyIf-Es5mYny3oE_Wmus48
4343
x: fLKYEaoEb9lrn3nkwLDA-M_xnuFOdSt9y0Z7_vWSHLU
4444
y: Dt5tbS1dEDMSYfym3fgMv0B99szno-dFc1rYF9t0aac
@@ -52,7 +52,7 @@
5252
header: |-
5353
[Rust client library docs](https://docs.rs/crate/questdb-rs/latest)
5454
auth:
55-
kid: testUser1
55+
kid: admin
5656
d: 5UjEMuA0Pj5pjK8a-fa24dyIf-Es5mYny3oE_Wmus48
5757
x: fLKYEaoEb9lrn3nkwLDA-M_xnuFOdSt9y0Z7_vWSHLU
5858
y: Dt5tbS1dEDMSYfym3fgMv0B99szno-dFc1rYF9t0aac
@@ -67,7 +67,7 @@
6767
header: |-
6868
[C client library docs](https://github.com/questdb/c-questdb-client/blob/main/doc/C.md)
6969
auth:
70-
kid: testUser1
70+
kid: admin
7171
d: 5UjEMuA0Pj5pjK8a-fa24dyIf-Es5mYny3oE_Wmus48
7272
x: fLKYEaoEb9lrn3nkwLDA-M_xnuFOdSt9y0Z7_vWSHLU
7373
y: Dt5tbS1dEDMSYfym3fgMv0B99szno-dFc1rYF9t0aac
@@ -81,7 +81,7 @@
8181
header: |-
8282
[C++ client library docs](https://github.com/questdb/c-questdb-client/blob/main/doc/CPP.md)
8383
auth:
84-
kid: testUser1
84+
kid: admin
8585
d: 5UjEMuA0Pj5pjK8a-fa24dyIf-Es5mYny3oE_Wmus48
8686
x: fLKYEaoEb9lrn3nkwLDA-M_xnuFOdSt9y0Z7_vWSHLU
8787
y: Dt5tbS1dEDMSYfym3fgMv0B99szno-dFc1rYF9t0aac
@@ -95,7 +95,7 @@
9595
header: |-
9696
[Rust client library docs](https://docs.rs/crate/questdb-rs/latest)
9797
auth:
98-
kid: testUser1
98+
kid: admin
9999
d: 5UjEMuA0Pj5pjK8a-fa24dyIf-Es5mYny3oE_Wmus48
100100
x: fLKYEaoEb9lrn3nkwLDA-M_xnuFOdSt9y0Z7_vWSHLU
101101
y: Dt5tbS1dEDMSYfym3fgMv0B99szno-dFc1rYF9t0aac

‎examples/line_sender_c_example.c‎

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ static bool example(const char* host, const char* port)
2020

2121
sender = line_sender_from_conf(conf_str_utf8, &err);
2222
if (!sender)
23-
goto on_error;
23+
goto on_error;
2424

2525
free(conf_str);
2626
conf_str = NULL;
@@ -31,37 +31,28 @@ static bool example(const char* host, const char* port)
3131
// We prepare all our table names and column names in advance.
3232
// If we're inserting multiple rows, this allows us to avoid
3333
// re-validating the same strings over and over again.
34-
line_sender_table_name table_name = QDB_TABLE_NAME_LITERAL("c_cars");
35-
line_sender_column_name id_name = QDB_COLUMN_NAME_LITERAL("id");
36-
line_sender_column_name x_name = QDB_COLUMN_NAME_LITERAL("x");
37-
line_sender_column_name y_name = QDB_COLUMN_NAME_LITERAL("y");
38-
line_sender_column_name booked_name = QDB_COLUMN_NAME_LITERAL("booked");
39-
line_sender_column_name passengers_name = QDB_COLUMN_NAME_LITERAL(
40-
"passengers");
41-
line_sender_column_name driver_name = QDB_COLUMN_NAME_LITERAL("driver");
42-
43-
if (!line_sender_buffer_table(buffer, table_name, &err))
44-
goto on_error;
34+
line_sender_table_name table_name = QDB_TABLE_NAME_LITERAL("c_trades");
35+
line_sender_column_name symbol_name = QDB_COLUMN_NAME_LITERAL("symbol");
36+
line_sender_column_name side_name = QDB_COLUMN_NAME_LITERAL("side");
37+
line_sender_column_name price_name = QDB_COLUMN_NAME_LITERAL("price");
38+
line_sender_column_name amount_name = QDB_COLUMN_NAME_LITERAL("amount");
4539

46-
line_sender_utf8 id_value = QDB_UTF8_LITERAL(
47-
"d6e5fe92-d19f-482a-a97a-c105f547f721");
48-
if (!line_sender_buffer_symbol(buffer, id_name, id_value, &err))
49-
goto on_error;
5040

51-
if (!line_sender_buffer_column_f64(buffer, x_name, 30.5, &err))
41+
if (!line_sender_buffer_table(buffer, table_name, &err))
5242
goto on_error;
5343

54-
if (!line_sender_buffer_column_f64(buffer, y_name, -150.25, &err))
44+
line_sender_utf8 symbol_value = QDB_UTF8_LITERAL("ETH-USD");
45+
if (!line_sender_buffer_symbol(buffer, symbol_name, symbol_value, &err))
5546
goto on_error;
5647

57-
if (!line_sender_buffer_column_bool(buffer, booked_name, true, &err))
48+
line_sender_utf8 side_value = QDB_UTF8_LITERAL("sell");
49+
if (!line_sender_buffer_symbol(buffer, side_name, side_value, &err))
5850
goto on_error;
5951

60-
if (!line_sender_buffer_column_i64(buffer, passengers_name, 3, &err))
52+
if (!line_sender_buffer_column_f64(buffer, price_name, 2615.54, &err))
6153
goto on_error;
6254

63-
line_sender_utf8 driver_value = QDB_UTF8_LITERAL("John Doe");
64-
if (!line_sender_buffer_column_str(buffer, driver_name, driver_value, &err))
55+
if (!line_sender_buffer_column_f64(buffer, amount_name, 0.00044, &err))
6556
goto on_error;
6657

6758
// 1997-07-04 04:56:55 UTC

‎examples/line_sender_c_example_auth.c‎

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ static bool example(const char* host, const char* port)
1111
line_sender_buffer* buffer = NULL;
1212
char* conf_str = concat(
1313
"tcp::addr=", host, ":", port, ";"
14-
"username=testUser1;"
14+
"username=admin;"
1515
"token=5UjEMuA0Pj5pjK8a-fa24dyIf-Es5mYny3oE_Wmus48;"
1616
"token_x=fLKYEaoEb9lrn3nkwLDA-M_xnuFOdSt9y0Z7_vWSHLU;"
1717
"token_y=Dt5tbS1dEDMSYfym3fgMv0B99szno-dFc1rYF9t0aac;");
@@ -25,7 +25,7 @@ static bool example(const char* host, const char* port)
2525

2626
sender = line_sender_from_conf(conf_str_utf8, &err);
2727
if (!sender)
28-
goto on_error;
28+
goto on_error;
2929

3030
free(conf_str);
3131
conf_str = NULL;
@@ -36,37 +36,28 @@ static bool example(const char* host, const char* port)
3636
// We prepare all our table names and column names in advance.
3737
// If we're inserting multiple rows, this allows us to avoid
3838
// re-validating the same strings over and over again.
39-
line_sender_table_name table_name = QDB_TABLE_NAME_LITERAL("c_cars_auth");
40-
line_sender_column_name id_name = QDB_COLUMN_NAME_LITERAL("id");
41-
line_sender_column_name x_name = QDB_COLUMN_NAME_LITERAL("x");
42-
line_sender_column_name y_name = QDB_COLUMN_NAME_LITERAL("y");
43-
line_sender_column_name booked_name = QDB_COLUMN_NAME_LITERAL("booked");
44-
line_sender_column_name passengers_name = QDB_COLUMN_NAME_LITERAL(
45-
"passengers");
46-
line_sender_column_name driver_name = QDB_COLUMN_NAME_LITERAL("driver");
47-
48-
if (!line_sender_buffer_table(buffer, table_name, &err))
49-
goto on_error;
39+
line_sender_table_name table_name = QDB_TABLE_NAME_LITERAL("c_trades_auth");
40+
line_sender_column_name symbol_name = QDB_COLUMN_NAME_LITERAL("symbol");
41+
line_sender_column_name side_name = QDB_COLUMN_NAME_LITERAL("side");
42+
line_sender_column_name price_name = QDB_COLUMN_NAME_LITERAL("price");
43+
line_sender_column_name amount_name = QDB_COLUMN_NAME_LITERAL("amount");
5044

51-
line_sender_utf8 id_value = QDB_UTF8_LITERAL(
52-
"d6e5fe92-d19f-482a-a97a-c105f547f721");
53-
if (!line_sender_buffer_symbol(buffer, id_name, id_value, &err))
54-
goto on_error;
5545

56-
if (!line_sender_buffer_column_f64(buffer, x_name, 30.5, &err))
46+
if (!line_sender_buffer_table(buffer, table_name, &err))
5747
goto on_error;
5848

59-
if (!line_sender_buffer_column_f64(buffer, y_name, -150.25, &err))
49+
line_sender_utf8 symbol_value = QDB_UTF8_LITERAL("ETH-USD");
50+
if (!line_sender_buffer_symbol(buffer, symbol_name, symbol_value, &err))
6051
goto on_error;
6152

62-
if (!line_sender_buffer_column_bool(buffer, booked_name, true, &err))
53+
line_sender_utf8 side_value = QDB_UTF8_LITERAL("sell");
54+
if (!line_sender_buffer_symbol(buffer, side_name, side_value, &err))
6355
goto on_error;
6456

65-
if (!line_sender_buffer_column_i64(buffer, passengers_name, 3, &err))
57+
if (!line_sender_buffer_column_f64(buffer, price_name, 2615.54, &err))
6658
goto on_error;
6759

68-
line_sender_utf8 driver_value = QDB_UTF8_LITERAL("John Doe");
69-
if (!line_sender_buffer_column_str(buffer, driver_name, driver_value, &err))
60+
if (!line_sender_buffer_column_f64(buffer, amount_name, 0.00044, &err))
7061
goto on_error;
7162

7263
// 1997-07-04 04:56:55 UTC

‎examples/line_sender_c_example_auth_tls.c‎

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ static bool example(const char* host, const char* port)
1111
line_sender_buffer* buffer = NULL;
1212
char* conf_str = concat(
1313
"tcps::addr=", host, ":", port, ";"
14-
"username=testUser1;"
14+
"username=admin;"
1515
"token=5UjEMuA0Pj5pjK8a-fa24dyIf-Es5mYny3oE_Wmus48;"
1616
"token_x=fLKYEaoEb9lrn3nkwLDA-M_xnuFOdSt9y0Z7_vWSHLU;"
1717
"token_y=Dt5tbS1dEDMSYfym3fgMv0B99szno-dFc1rYF9t0aac;");
@@ -25,7 +25,7 @@ static bool example(const char* host, const char* port)
2525

2626
sender = line_sender_from_conf(conf_str_utf8, &err);
2727
if (!sender)
28-
goto on_error;
28+
goto on_error;
2929

3030
free(conf_str);
3131
conf_str = NULL;
@@ -36,37 +36,28 @@ static bool example(const char* host, const char* port)
3636
// We prepare all our table names and column names in advance.
3737
// If we're inserting multiple rows, this allows us to avoid
3838
// re-validating the same strings over and over again.
39-
line_sender_table_name table_name = QDB_TABLE_NAME_LITERAL("c_cars_auth_tls");
40-
line_sender_column_name id_name = QDB_COLUMN_NAME_LITERAL("id");
41-
line_sender_column_name x_name = QDB_COLUMN_NAME_LITERAL("x");
42-
line_sender_column_name y_name = QDB_COLUMN_NAME_LITERAL("y");
43-
line_sender_column_name booked_name = QDB_COLUMN_NAME_LITERAL("booked");
44-
line_sender_column_name passengers_name = QDB_COLUMN_NAME_LITERAL(
45-
"passengers");
46-
line_sender_column_name driver_name = QDB_COLUMN_NAME_LITERAL("driver");
47-
48-
if (!line_sender_buffer_table(buffer, table_name, &err))
49-
goto on_error;
39+
line_sender_table_name table_name = QDB_TABLE_NAME_LITERAL("c_trades_auth_tls");
40+
line_sender_column_name symbol_name = QDB_COLUMN_NAME_LITERAL("symbol");
41+
line_sender_column_name side_name = QDB_COLUMN_NAME_LITERAL("side");
42+
line_sender_column_name price_name = QDB_COLUMN_NAME_LITERAL("price");
43+
line_sender_column_name amount_name = QDB_COLUMN_NAME_LITERAL("amount");
5044

51-
line_sender_utf8 id_value = QDB_UTF8_LITERAL(
52-
"d6e5fe92-d19f-482a-a97a-c105f547f721");
53-
if (!line_sender_buffer_symbol(buffer, id_name, id_value, &err))
54-
goto on_error;
5545

56-
if (!line_sender_buffer_column_f64(buffer, x_name, 30.5, &err))
46+
if (!line_sender_buffer_table(buffer, table_name, &err))
5747
goto on_error;
5848

59-
if (!line_sender_buffer_column_f64(buffer, y_name, -150.25, &err))
49+
line_sender_utf8 symbol_value = QDB_UTF8_LITERAL("ETH-USD");
50+
if (!line_sender_buffer_symbol(buffer, symbol_name, symbol_value, &err))
6051
goto on_error;
6152

62-
if (!line_sender_buffer_column_bool(buffer, booked_name, true, &err))
53+
line_sender_utf8 side_value = QDB_UTF8_LITERAL("sell");
54+
if (!line_sender_buffer_symbol(buffer, side_name, side_value, &err))
6355
goto on_error;
6456

65-
if (!line_sender_buffer_column_i64(buffer, passengers_name, 3, &err))
57+
if (!line_sender_buffer_column_f64(buffer, price_name, 2615.54, &err))
6658
goto on_error;
6759

68-
line_sender_utf8 driver_value = QDB_UTF8_LITERAL("John Doe");
69-
if (!line_sender_buffer_column_str(buffer, driver_name, driver_value, &err))
60+
if (!line_sender_buffer_column_f64(buffer, amount_name, 0.00044, &err))
7061
goto on_error;
7162

7263
// 1997-07-04 04:56:55 UTC

‎examples/line_sender_c_example_from_conf.c‎

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,45 +12,36 @@ int main(int argc, const char* argv[])
1212
"tcp::addr=localhost:9009;");
1313
line_sender* sender = line_sender_from_conf(conf, &err);
1414
if (!sender)
15-
goto on_error;
15+
goto on_error;
1616

1717
buffer = line_sender_buffer_new();
1818
line_sender_buffer_reserve(buffer, 64 * 1024); // 64KB buffer initial size.
1919

2020
// We prepare all our table names and column names in advance.
2121
// If we're inserting multiple rows, this allows us to avoid
2222
// re-validating the same strings over and over again.
23-
line_sender_table_name table_name = QDB_TABLE_NAME_LITERAL("c_cars_from_conf");
24-
line_sender_column_name id_name = QDB_COLUMN_NAME_LITERAL("id");
25-
line_sender_column_name x_name = QDB_COLUMN_NAME_LITERAL("x");
26-
line_sender_column_name y_name = QDB_COLUMN_NAME_LITERAL("y");
27-
line_sender_column_name booked_name = QDB_COLUMN_NAME_LITERAL("booked");
28-
line_sender_column_name passengers_name = QDB_COLUMN_NAME_LITERAL(
29-
"passengers");
30-
line_sender_column_name driver_name = QDB_COLUMN_NAME_LITERAL("driver");
31-
32-
if (!line_sender_buffer_table(buffer, table_name, &err))
33-
goto on_error;
23+
line_sender_table_name table_name = QDB_TABLE_NAME_LITERAL("c_trades_from_conf");
24+
line_sender_column_name symbol_name = QDB_COLUMN_NAME_LITERAL("symbol");
25+
line_sender_column_name side_name = QDB_COLUMN_NAME_LITERAL("side");
26+
line_sender_column_name price_name = QDB_COLUMN_NAME_LITERAL("price");
27+
line_sender_column_name amount_name = QDB_COLUMN_NAME_LITERAL("amount");
3428

35-
line_sender_utf8 id_value = QDB_UTF8_LITERAL(
36-
"d6e5fe92-d19f-482a-a97a-c105f547f721");
37-
if (!line_sender_buffer_symbol(buffer, id_name, id_value, &err))
38-
goto on_error;
3929

40-
if (!line_sender_buffer_column_f64(buffer, x_name, 30.5, &err))
30+
if (!line_sender_buffer_table(buffer, table_name, &err))
4131
goto on_error;
4232

43-
if (!line_sender_buffer_column_f64(buffer, y_name, -150.25, &err))
33+
line_sender_utf8 symbol_value = QDB_UTF8_LITERAL("ETH-USD");
34+
if (!line_sender_buffer_symbol(buffer, symbol_name, symbol_value, &err))
4435
goto on_error;
4536

46-
if (!line_sender_buffer_column_bool(buffer, booked_name, true, &err))
37+
line_sender_utf8 side_value = QDB_UTF8_LITERAL("sell");
38+
if (!line_sender_buffer_symbol(buffer, side_name, side_value, &err))
4739
goto on_error;
4840

49-
if (!line_sender_buffer_column_i64(buffer, passengers_name, 3, &err))
41+
if (!line_sender_buffer_column_f64(buffer, price_name, 2615.54, &err))
5042
goto on_error;
5143

52-
line_sender_utf8 driver_value = QDB_UTF8_LITERAL("John Doe");
53-
if (!line_sender_buffer_column_str(buffer, driver_name, driver_value, &err))
44+
if (!line_sender_buffer_column_f64(buffer, amount_name, 0.00044, &err))
5445
goto on_error;
5546

5647
// 1997-07-04 04:56:55 UTC

0 commit comments

Comments
 (0)