You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-1Lines changed: 12 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ For more information, see a use case illustration of [keeping a client map up to
41
41
### Archiving Stream Data
42
42
43
43
The HERE Workspace allows you to retain stream data for longer periods, which allows you to later query and process the retained data for non-real-time use cases.
44
-
For more information, see [Data Archiving Library Developer Guide.](https://developer.here.com/olp/documentation/data-archiving-library/dev_guide/index.html)
44
+
For more information, see [Data Archiving Library Developer Guide](https://developer.here.com/olp/documentation/data-archiving-library/dev_guide/index.html).
45
45
46
46
| Name | Description | Source | Labels / Topics |
47
47
| ---- | ----------- | ------ | --------------- |
@@ -51,6 +51,17 @@ For more information, see [Data Archiving Library Developer Guide.](https://deve
51
51
| Archiving SENSORIS stream data in Parquet| The example shows how to use the Data Archiving Library to quickly develop an archiving solution that archives SENSORIS data in Parquet format. |[Java](data-archive/java/sensoris-parquet-example)| Data Archiving Library, Flink, Stream, SENSORIS, Parquet |
52
52
| Archiving SENSORIS stream data in Protobuf| The example shows how to use the Data Archiving Library to quickly develop an archiving solution that archives SENSORIS data in Protobuf format. |[Java](data-archive/java/sensoris-protobuf-example)| Data Archiving Library, Flink, Stream, SENSORIS, Protobuf |
53
53
54
+
### Compacting Index Data
55
+
56
+
The HERE Workspace allows you to compact data files with the same index attribute values into one or more files based on the configuration.
57
+
Compaction reduces the index layer storage cost, improves query performance, and makes subsequent data processing more efficient.
58
+
For more information, see [Index Compaction Library Developer Guide](https://developer.here.com/olp/documentation/index-compaction-library/dev_guide/index.html).
59
+
60
+
| Name | Description | Source | Labels / Topics |
61
+
| ---- | ----------- | ------ | --------------- |
62
+
| Compacting Parquet format indexed data | The example shows how to use the Index Compaction Library to quickly develop a compaction application that compacts parquet format data. |[Java](index-compaction-batch/java/parquet-example)| Index Compaction Library, Spark, Batch, Parquet, SDII |
63
+
| Compacting Protobuf format indexed data | The example shows how to use the Index Compaction Library to quickly develop a compaction application that compacts protobuf format data. |[Java](index-compaction-batch/java/protobuf-example)| Index Compaction Library, Spark, Batch, Parquet, SDII |
64
+
54
65
### Small Examples Showing Usage of Location Library
55
66
56
67
The following examples demonstrate how to use the Location Library. Sources can be found [here for Java](location/java/standalone) and [here for Scala](location/scala/standalone).
The command returns the [HERE Resource Name (HRN)](https://developer.here.com/documentation/data-user-guide/user_guide/shared_content/topics/olp/concepts/hrn.html) of your new project. Note down this HRN as you'll need it later in this tutorial.
44
44
45
-
> Note: You don't have to provide a `--scope` parameter if your app has a default scope.
45
+
> Note:
46
+
> You don't have to provide a `--scope` parameter if your app has a default scope.
47
+
> For details on how to set a default project scope for an app, see the _Specify a
48
+
> default Project_ for Apps chapter of the [Teams and Permissions Guide](https://developer.here.com/documentation/access-control/user_guide/topics/manage-projects.html).
46
49
47
50
For more information on how to work with projects, see the [Organize your work in projects](https://developer.here.com/documentation/java-scala-dev/dev_guide/organize-work-in-projects/index.html) tutorial.
48
51
@@ -58,10 +61,10 @@ Use the **HERE platform portal** to [create the input catalog](https://developer
58
61
59
62
- For instructions on how to create a catalog, refer to **Create a Catalog** in [Data User Guide](#data-user-guide).
60
63
- For instructions on how to create a layer, refer to **Create a Layer** in [Data User Guide](#data-user-guide).
61
-
- For instructions on how to link a resource to a project, refer to **Project Resources Link** in [Command Line Interface Developer Guide](https://developer.here.com/documentation/open-location-platform-cli/user_guide/topics/project/project-resources-commands.html#project-resources-link).
64
+
- For instructions on how to link a resource to a project, refer to **Project Resources Link** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide).
62
65
- For instructions on how to share your project, refer to **Manage Projects** in [Teams and Permissions User Guide](#teams-and-permissions-user-guide).
63
66
64
-
Alternatively, you can use the **OLP CLI Commands** in [Command Line Interface Developer Guide](https://developer.here.com/documentation/open-location-platform-cli/user_guide/index.html) instead of the platform portal to create a new catalog with a `stream` layer:
67
+
Alternatively, you can use the **OLP CLI Commands** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide) instead of the platform portal to create a new catalog with a `stream` layer:
65
68
66
69
> Note:
67
70
> We recommend you to set values to variables so that you can easily copy and execute the following commands.
@@ -95,10 +98,10 @@ Use the **HERE platform portal** to [create the output catalog](https://develope
95
98
96
99
- For instructions on how to create a catalog, refer to **Create a Catalog** in [Data User Guide](#data-user-guide).
97
100
- For instructions on how to create a layer, refer to **Create a Layer** in [Data User Guide](#data-user-guide).
98
-
- For instructions on how to link a resource to a project, refer to **Project Resources Link** in [Command Line Interface Developer Guide](https://developer.here.com/documentation/open-location-platform-cli/user_guide/topics/project/project-resources-commands.html#project-resources-link).
101
+
- For instructions on how to link a resource to a project, refer to **Project Resources Link** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide).
99
102
- For instructions on how to share your project, refer to **Manage Projects** in [Teams and Permissions User Guide](#teams-and-permissions-user-guide).
100
103
101
-
Alternatively, you can use the **OLP CLI Commands** in [Command Line Interface Developer Guide](https://developer.here.com/documentation/open-location-platform-cli/user_guide/index.html) instead of the platform portal to create a new catalog with an `index` layer:
104
+
Alternatively, you can use the **OLP CLI Commands** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide) instead of the platform portal to create a new catalog with an `index` layer:
102
105
103
106
1. Use the [`olp catalog create`](https://developer.here.com/documentation/open-location-platform-cli/user_guide/topics/data/catalog-commands.html#catalog-create) command to create the catalog.
104
107
Make sure to note down the HRN returned by the following command for later use:
@@ -152,7 +155,7 @@ For information on using the platform portal to configure and run a pipeline, se
152
155
153
156
#### Use the Command Line Interface to Run a Pipeline
154
157
155
-
You can use the **OLP CLI Commands** in [Command Line Interface Developer Guide](https://developer.here.com/documentation/open-location-platform-cli/user_guide/index.html) to create pipeline components and activate it.
158
+
You can use the **OLP CLI Commands** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide) to create pipeline components and activate it.
156
159
157
160
First, configure data sources using the `config/pipeline-config.conf` file. This file contains the configuration of the data sources which are used as placeholders for Data Archiving Library examples:
158
161
@@ -165,7 +168,7 @@ pipeline.config {
165
168
}
166
169
```
167
170
168
-
You must replace `YOUR_OUTPUT_CATALOG_HRN` with the HRN of your output catalog and `YOUR_INPUT_CATALOG_HRN` with the HRN of your input catalog. To find the HRN, in the [HERE platform portal](#olp-portal), navigate to your catalog. The HRN is displayed in the upper left corner of the page.
171
+
You must replace `YOUR_OUTPUT_CATALOG_HRN` with the HRN of your output catalog and `YOUR_INPUT_CATALOG_HRN` with the HRN of your input catalog. To find the HRN, in the [HERE platform portal](#here-platform-portal), navigate to your catalog. The HRN is displayed in the upper left corner of the page.
169
172
170
173
You can use the OLP CLI to create pipeline components and activate the pipeline version with the following commands:
In the [HERE platform portal](https://platform.here.com/pipelines) / [HERE platform China portal](https://platform.hereolp.cn/pipelines)
195
198
navigate to your pipeline to see its status.
196
199
197
-
For more information on using the **OLP CLI** to configure and run a pipeline, see **Pipeline Commands** in [Command Line Interface Developer Guide](https://developer.here.com/documentation/open-location-platform-cli/user_guide/index.html).
200
+
For more information on using the **OLP CLI** to configure and run a pipeline, see **Pipeline Commands** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide).
198
201
199
202
> #### Note
200
203
> The selection of input and output catalog values using the portal when creating pipeline version or the values added to `pipeline.config` when using command line interface must be valid. These values represent a placeholder which will not be used by the the Data Archiving Library. Instead, values will be taken from the `application.conf` file. If you want to change or update the input/output catlogs, modify the `application.conf` file and rebuild.
201
204
202
205
## Verify the Output
203
206
204
-
In the [HERE platform portal](#olp-portal) select the _Pipelines_ tab and find your pipeline.
207
+
In the [HERE platform portal](#here-platform-portal) select the _Pipelines_ tab and find your pipeline.
205
208
- Verify pipeline is in `Running` state.
206
209
207
210
After the pipeline is running, you can ingest your data into the `stream` layer created in the `Create Input Catalog and Layer` section using one of the following:
208
211
-**Publish to a Stream Layer** in [Data API Developer Guide](#data-api-developer-guide)
209
212
-**Publish Data** in [Data Client Library Developer Guide](#data-client-library-developer-guide)
210
-
-**Stream** in [Command Line Interface Developer Guide](https://developer.here.com/documentation/open-location-platform-cli/user_guide/index.html)
213
+
-**Stream** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide)
211
214
212
215
> #### Note
213
216
> For ingesting data, make sure your app has `read` and `write` permission to your `stream` layer.
@@ -220,7 +223,7 @@ After the pipeline is running, you can ingest your data into the `stream` layer
220
223
After your data is archived in `index` layer, you can query/retrieve data using one of the following:
221
224
-**Get Data from an Index Layer** in [Data API Developer Guide](#data-api-developer-guide)
222
225
-**Get Data** in [Data Client Library Developer Guide](#data-client-library-developer-guide)
223
-
-**Partitions** in [Command Line Interface Developer Guide](https://developer.here.com/documentation/open-location-platform-cli/user_guide/index.html)
226
+
-**Partitions** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide)
224
227
> #### Note
225
228
> For querying metadata or retrieving data, make sure your app has `read` permission to your `index` layer.
226
229
> For instructions on how to manage app, refer to **Manage Apps** in [Teams and Permissions User Guide](#teams-and-permissions-user-guide).
0 commit comments