Skip to content

Commit

Permalink
doc: minor updates to hello-world example and Apache IoTDB online doc.
Browse files Browse the repository at this point in the history
Minor improvements to the listed documentation.

Signed-off-by: Stephen Lawrence <[email protected]>
  • Loading branch information
slawr committed Jan 31, 2025
1 parent a3d64c2 commit ea7cd6a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/docs-gen/content/manuals/apache-iotdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The ["Basic Functions"](https://iotdb.apache.org/UserGuide/latest/Basic-Concept/

In IoTDB terminology *measurement* is the key in a key/value pair. In VSS terms the leaf node name. The timeseries is the record of the measurement on the time axis. A timeseries is a series of time/value data points.

The IoTDB data model supports hierarchical partitioning and like VSS uses a dot notation to separate the levels. This means if we simply appended a VSS leaf node name like `Vehicle.CurrentLocation.Longitude` as the measurement (key) name to the end of a IoTDB path such as `root.test2.dev1` the `Vehicle.CurrentLocation.` IoTDB would treat it as part of the IoTDB data model partitioning which could cause unwanted issues when scaling over millions of vehicles.
The IoTDB data model supports hierarchical partitioning and like VSS uses a dot notation to separate the levels. This means if we simply appended a VSS leaf node name like `Vehicle.CurrentLocation.Longitude` as the measurement (key) name to the end of a IoTDB path such as `root.test2.dev1` IoTDB would treat the VSS path prefix `Vehicle.CurrentLocation.` as part of the IoTDB data model partitioning which could cause unwanted issues when scaling over millions of vehicles.

We have separated those two concepts by quoting the VSS leaf node name using backticks when processing the name in IoTDB. As shown below:
```
Expand Down Expand Up @@ -157,7 +157,7 @@ Steps:


### User Defined functions
IoTDB also allows you to integrate your own functions as User Defined Functions (UDF). The [UDF section](https://iotdb.apache.org/UserGuide/latest/User-Manual/UDF-development.html) of the IoTDB documentation explains how to develop and register your own.
IoTDB also allows you to integrate your own functions as User Defined Functions (UDF). The [UDF development section](https://iotdb.apache.org/UserGuide/latest/User-Manual/UDF-development.html) of the IoTDB documentation explains how to develop and register your own.

## VISSR (VISS) integration
As part of the initial development of the playground the team extended VISSR to support connections to Apache IoTDB as a VISSR data store backend and upstreamed the support.
Expand Down
5 changes: 5 additions & 0 deletions examples/cdsp-hello-world/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# Central Data Service Playground Hello World

> [!NOTE]
> Apologies. As you can see the team has been busy adding features and not got around to finishing this example yet. In the meantime, please take a look at the deployment section of the [Docker README.md](https://github.com/COVESA/cdsp/blob/main/docker/README.md#deploy-with-docker-compose) which gives guidance on starting the Playground and sanity testing it is running correctly.
This is a simple "hello-world" example for the Central Data Service Playground (CDSP).

Goals:
1. Act as a sanity test that the Playground is running correctly
2. Provide a simplistic example of VSS and VISS use in the Playground.

## Logical/Implementation Concept
This example does not expand the concept of the Playground. Therefore please see the Playground documentation for a description of the Logical and Implementation concepts behind it.

Expand Down

0 comments on commit ea7cd6a

Please sign in to comment.