Skip to content

Commit

Permalink
Add Notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jason-fox committed Dec 18, 2023
1 parent f6c2fdc commit 92084df
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 44 deletions.
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ EXPOSED_PORT=1026

# Orion variables
ORION_LD_PORT=1026
ORION_LD_VERSION=1.4.0
ORION_LD_VERSION=1.5.0-pre-1549

# Scorpio variables
SCORPIO_PORT=9090
Expand Down
40 changes: 20 additions & 20 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ NGSI-LD では、`observedAt` _property-of-property_ は測定値のタイムス
_property-of-property_ が含まれているため、**CrateDB**データベース内の `time_index` 列は、**CrateDB** 自体の中でレコードの
作成時間を使用するよりも、**Orion Context Broker** によって使用される **MongoDB** データベース内にあるデータと一致します。

#### :one: リクエスト:
#### 1️⃣ リクエスト:

```console
curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \
Expand Down Expand Up @@ -411,7 +411,7 @@ curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \
- `notification` URL は公開されたポートと一致する必要があります
- `throttling` 値は、変更がサンプリングされるレートを定義します

#### :two: リクエスト:
#### 2️⃣ リクエスト:

```console
curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \
Expand Down Expand Up @@ -445,10 +445,10 @@ curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \

### QuantumLeap のサブスクリプションの確認

何よりもまず、ステップ :one::two: で作成したサブスクリプションが機能していることを確認します (つまり、それぞれに
何よりもまず、ステップ 1️⃣2️⃣ で作成したサブスクリプションが機能していることを確認します (つまり、それぞれに
少なくとも1つの通知が送信されました)。

#### :three: リクエスト:
#### 3️⃣ リクエスト:

```console
curl -X GET \
Expand Down Expand Up @@ -536,7 +536,7 @@ API のドキュメントは[こちら](https://app.swaggerhub.com/apis/smartsdk
使用してデータが Orion にプッシュされる場合にのみ必要です (マルチテナンシー・シナリオの場合)。これらのヘッダの整合に
失敗すると、データは返されません。

#### :four: リクエスト:
#### 4️⃣ リクエスト:

```console
curl -X GET \
Expand Down Expand Up @@ -564,7 +564,7 @@ curl -X GET \

この例は、`urn:ngsi-ld:Device:filling001` の4番目, 5番目, 6番目のサンプルの `filling` 値を示しています。

#### :five: リクエスト:
#### 5️⃣ リクエスト:

```console
curl -X GET \
Expand Down Expand Up @@ -592,7 +592,7 @@ curl -X GET \

この例は、`urn:ngsi-ld:Device:filling001` からサンプリングされた最新の3つの `filling` 値を示しています。

#### :six: リクエスト:
#### 6️⃣ リクエスト:

```console
curl -X GET \
Expand Down Expand Up @@ -628,7 +628,7 @@ curl -X GET \
-H 'Accept: application/json'
```

#### :seven: リクエスト:
#### 7️⃣ リクエスト:

```console
curl -X GET \
Expand Down Expand Up @@ -668,7 +668,7 @@ curl -X GET \
<!--lint enable no-blockquote-without-marker-->
#### :eight: リクエスト:
#### 8️⃣ リクエスト:
```console
curl -X GET \
Expand Down Expand Up @@ -697,7 +697,7 @@ curl -X GET \
この例は、`2018-06-27T09:00:00` から `2018-06-30T23:59:59` の間に発生した `urn:ngsi-ld:Device:filling001`
最大 `filling` 値を示しています。

#### :nine: リクエスト:
#### 9️⃣ リクエスト:

```console
curl -X GET \
Expand Down Expand Up @@ -732,7 +732,7 @@ curl -X GET \
> [NGSI v2 specification](http://fiware.github.io/specifications/ngsiv2/stable/) の地理的クエリのセクションで詳しく
> 説明されているクエリの完全なセットを実装します。
#### :one::zero: リクエスト:
#### 1️⃣0️⃣ リクエスト:

```console
curl -X GET \
Expand Down Expand Up @@ -779,7 +779,7 @@ curl -X GET \
> [NGSI v2 specification](http://fiware.github.io/specifications/ngsiv2/stable/) の地理的クエリのセクションで詳しく
> 説明されているクエリの完全なセットを実装します。
#### :one::one: リクエスト:
#### 1️⃣1️⃣ リクエスト:

```console
curl -X GET \
Expand Down Expand Up @@ -842,7 +842,7 @@ SQL ステートメントは JSON 形式で POST リクエストのボディと
データが永続化されているかどうかを確認するもう1つの方法は、`table_schema` が作成されているかどうかを確認することです。
これは、次のように **CrateDB** HTTP エンドポイントにリクエストを送信することで実行できます:

#### :one::two: リクエスト:
#### 1️⃣2️⃣ リクエスト:

```console
curl -iX POST \
Expand Down Expand Up @@ -872,7 +872,7 @@ curl -iX POST \
**QuantumLeap**は、エンティティ・タイプに基づいて、**CrateDB**データベース内の個別のテーブルにデータを永続化します。
テーブル名は、プレフィックス `et` とエンティティ・タイプ名を小文字で使用して構成されます。

#### :one::three: リクエスト:
#### 1️⃣3️⃣ リクエスト:

```console
curl -X POST \
Expand Down Expand Up @@ -905,7 +905,7 @@ curl -X POST \
SQL ステートメントは、 `ORDERBY` 句 と `LIMIT` 句を使用してデータを並べ替えます。詳細については、**CrateDB**
[ドキュメント](https://crate.io/docs/crate/reference/en/latest/sql/statements/select.html)をご覧ください。

#### :one::four: リクエスト:
#### 1️⃣4️⃣ リクエスト:

```console
curl -iX POST \
Expand Down Expand Up @@ -936,7 +936,7 @@ curl -iX POST \
SQL ステートメントは、`OFFSET` 句を使用して必要な行 (rows) を取得します。詳細については、**CrateDB**
[ドキュメント](https://crate.io/docs/crate/reference/en/latest/sql/statements/select.html)をご覧ください。

#### :one::five: リクエスト:
#### 1️⃣5️⃣ リクエスト:

```console
curl -iX POST \
Expand Down Expand Up @@ -968,7 +968,7 @@ SQL ステートメントは、`ORDER BY ... DESC` 句を `LIMIT` 句と組み
詳細については、**CrateDB**
[ドキュメント](https://crate.io/docs/crate/reference/en/latest/sql/statements/select.html)をご覧ください。

#### :one::six: リクエスト:
#### 1️⃣6️⃣ リクエスト:

```console
curl -iX POST \
Expand Down Expand Up @@ -1000,7 +1000,7 @@ SQL ステートメントは、`SUM` 関数と `GROUPBY` 句を使用して関
[日時関数](https://crate.io/docs/crate/reference/en/latest/general/builtins/scalar.html#date-and-time-functions)
(Date-Time Functions) を提供します。タイムスタンプを切り捨てて、グループ化できるデータに変換します。

#### :one::seven: リクエスト:
#### 1️⃣7️⃣ リクエスト:

```console
curl -iX POST \
Expand Down Expand Up @@ -1034,7 +1034,7 @@ SQL ステートメントは、`MIN` 関数と `GROUPBY` 句を使用して関
[日時関数](https://crate.io/docs/crate/reference/en/latest/general/builtins/scalar.html#date-and-time-functions)
(Date-Time Functions) を提供します。タイムスタンプを切り捨てて、グループ化できるデータに変換します。

#### :one::eight: リクエスト:
#### 1️⃣8️⃣ リクエスト:

```console
curl -iX POST \
Expand Down Expand Up @@ -1069,7 +1069,7 @@ SQL ステートメントは、`MAX` 関数と `WHERE` 句を使用して関連
[集約関数](https://crate.io/docs/crate/reference/en/latest/general/dql/selects.html#data-aggregation)
(Aggregate Functions) を提供します。

#### :one::nine: リクエスト:
#### 1️⃣9️⃣ リクエスト:

```console
curl -iX POST \
Expand Down
49 changes: 26 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,8 @@ repository:
./services [orion|scorpio|stellio]
```

> :information_source: **Note:** If you want to clean up and start over again you can do so with the following command:
> [!NOTE]
> If you want to clean up and start over again you can do so with the following command:
>
> ```console
> ./services stop
Expand Down Expand Up @@ -347,7 +348,7 @@ monitored contains this _property-of-property_, the `time_index` column within t
data found within the **MongoDB** database used by the **Orion Context Broker** rather than using the creation time of
the record within the **CrateDB** itself.

#### :one: Request:
#### 1️⃣ Request:

```console
curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \
Expand Down Expand Up @@ -391,7 +392,7 @@ including the `throttling` attribute in the request body.
- The `notification` URL must match the exposed port.
- The `throttling` value defines the rate that changes are sampled.

#### :two: Request:
#### 2️⃣ Request:

```console
curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \
Expand Down Expand Up @@ -423,10 +424,10 @@ curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \

### Checking Subscriptions for QuantumLeap

Before anything, check the subscriptions you created in steps :one: and :two: are working (i.e., at least one
Before anything, check the subscriptions you created in steps 1️⃣ and 2️⃣ are working (i.e., at least one
notification for each was sent).

#### :three: Request:
#### 3️⃣ Request:

```console
curl -X GET \
Expand Down Expand Up @@ -510,7 +511,7 @@ Note the use of the `Fiware-Service` header which is the NGSI-v2 equivalent of `
when data are pushed to Orion using such headers (in multitenancy scenarios). Failing to align these headers will result
in no data being returned.

#### :four: Request:
#### 4️⃣ Request:

```console
curl -X GET \
Expand All @@ -536,7 +537,7 @@ curl -X GET \

This example shows the fourth, fifth and sixth sampled `filling` values of `urn:ngsi-ld:Device:filling001`.

#### :five: Request:
#### 5️⃣ Request:

```console
curl -X GET \
Expand All @@ -562,7 +563,7 @@ curl -X GET \

This example shows the latest three sampled `filling` values from `urn:ngsi-ld:Device:filling001`.

#### :six: Request:
#### 6️⃣ Request:

```console
curl -X GET \
Expand Down Expand Up @@ -596,7 +597,7 @@ curl -X GET \
-H 'Accept: application/json'
```

#### :seven: Request:
#### 7️⃣ Request:

```console
curl -X GET \
Expand Down Expand Up @@ -634,7 +635,7 @@ This example shows minimum `filling` values from `urn:ngsi-ld:Device:filling001`
<!--lint enable no-blockquote-without-marker-->
#### :eight: Request:
#### 8️⃣ Request:
```console
curl -X GET \
Expand All @@ -661,7 +662,7 @@ curl -X GET \
This example shows maximum `filling` value of `urn:ngsi-ld:Device:filling001` that occurred between from
`2018-06-27T09:00:00` to `2018-06-30T23:59:59`.

#### :nine: Request:
#### 9️⃣ Request:

```console
curl -X GET \
Expand Down Expand Up @@ -690,11 +691,12 @@ This example shows the latest heart rate sampled `heartRate` values of animal th
around the Berlin Tiergarten and on the device monitor page, you should be able to see data for
`urn:ngsi-ld:Device:cow001` and `urn:ngsi-ld:Device:pig001` .

> :information_source: **Note:** Geographical queries are only available starting from version `0.5` of QuantumLeap
> [!NOTE]
> Geographical queries are only available starting from version `0.5` of QuantumLeap
> which implements the full set of queries detailed in the Geographical Queries section of the
> [NGSI v2 specification](http://fiware.github.io/specifications/ngsiv2/stable/).
#### :one::zero: Request:
#### 1️⃣0️⃣ Request:

```console
curl -X GET \
Expand Down Expand Up @@ -735,11 +737,12 @@ This example shows the latest four sampled `filling` values of filling sensors t
centered at `52°33'16.9"N 13°23'55.0"E` (Bornholmer Straße 65, Berlin, Germany). Even if you have turned on all the
filling sensors available on the device monitor page, you should only see data for `urn:ngsi-ld:Device:filling001`.

> :information_source: **Note:** Geographical queries are only available starting from version `0.5` of QuantumLeap
> [!NOTE]
> Geographical queries are only available starting from version `0.5` of QuantumLeap
> which implements the full set of queries detailed in the Geographical Queries section of the
> [NGSI v2 specification](http://fiware.github.io/specifications/ngsiv2/stable/).
#### :one::one: Request:
#### 1️⃣1️⃣ Request:

```console
curl -X GET \
Expand Down Expand Up @@ -797,7 +800,7 @@ so the team is aware.
Another way to see if data are being persisted is to check if a `table_schema` has been created. This can be done by
making a request to the **CrateDB** HTTP endpoint as shown:

#### :one::two: Request:
#### 1️⃣2️⃣ Request:

```console
curl -iX POST \
Expand Down Expand Up @@ -827,7 +830,7 @@ the subscription exists, and has been configured to send data to the correct loc
**QuantumLeap** will persist data into separate tables within the **CrateDB** database based on the entity type. Table
names are formed with the `et` prefix and the entity type name in lowercase.

#### :one::three: Request:
#### 1️⃣3️⃣ Request:

```console
curl -X POST \
Expand Down Expand Up @@ -858,7 +861,7 @@ database.
The SQL statement uses `ORDER BY` and `LIMIT` clauses to sort the data. More details can be found under within the
**CrateDB** [documentation](https://crate.io/docs/crate/reference/en/latest/sql/statements/select.html)

#### :one::four: Request:
#### 1️⃣4️⃣ Request:

```console
curl -iX POST \
Expand Down Expand Up @@ -887,7 +890,7 @@ curl -iX POST \
The SQL statement uses an `OFFSET` clause to retrieve the required rows. More details can be found under within the
**CrateDB** [documentation](https://crate.io/docs/crate/reference/en/latest/sql/statements/select.html).

#### :one::five: Request:
#### 1️⃣5️⃣ Request:

```console
curl -iX POST \
Expand Down Expand Up @@ -917,7 +920,7 @@ The SQL statement uses an `ORDER BY ... DESC` clause combined with a `LIMIT` cla
details can be found under within the **CrateDB**
[documentation](https://crate.io/docs/crate/reference/en/latest/sql/statements/select.html).

#### :one::six: Request:
#### 1️⃣6️⃣ Request:

```console
curl -iX POST \
Expand Down Expand Up @@ -948,7 +951,7 @@ of
[Date-Time Functions](https://crate.io/docs/crate/reference/en/latest/general/builtins/scalar.html#date-and-time-functions)
to truncate and convert the timestamps into data which can be grouped.

#### :one::seven: Request:
#### 1️⃣7️⃣ Request:

```console
curl -iX POST \
Expand Down Expand Up @@ -981,7 +984,7 @@ of
[Date-Time Functions](https://crate.io/docs/crate/reference/en/latest/general/builtins/scalar.html#date-and-time-functions)
to truncate and convert the timestamps into data which can be grouped.

#### :one::eight: Request:
#### 1️⃣8️⃣ Request:

```console
curl -iX POST \
Expand Down Expand Up @@ -1013,7 +1016,7 @@ The SQL statement uses a `MAX` function and a `WHERE` clause to retrieve the rel
of [Aggregate Functions](https://crate.io/docs/crate/reference/en/latest/general/dql/selects.html#data-aggregation) to
aggregate data in different ways.

#### :one::nine: Request:
#### 1️⃣9️⃣ Request:

```console
curl -iX POST \
Expand Down

0 comments on commit 92084df

Please sign in to comment.