You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by GitBox <gi...@apache.org> on 2023/01/06 23:24:31 UTC
[GitHub] [druid] vtlim opened a new pull request, #13641: docs: Refresh the update data tutorial
vtlim opened a new pull request, #13641:
URL: https://github.com/apache/druid/pull/13641
Updates structure and style in the update data tutorial.
This PR has:
- [x] been self-reviewed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] vtlim commented on a diff in pull request #13641: docs: Refresh the update data tutorial
Posted by GitBox <gi...@apache.org>.
vtlim commented on code in PR #13641:
URL: https://github.com/apache/druid/pull/13641#discussion_r1065150007
##########
docs/tutorials/tutorial-update-data.md:
##########
@@ -24,33 +24,39 @@ sidebar_label: "Updating existing data"
-->
-This tutorial demonstrates how to update existing data, showing both overwrites and appends.
+This tutorial shows you how to update data in a datasource by overwriting existing data and adding new data to the datasource.
-For this tutorial, we'll assume you've already downloaded Apache Druid as described in
-the [single-machine quickstart](index.md) and have it running on your local machine.
+## Prerequisites
-It will also be helpful to have finished [Tutorial: Loading a file](../tutorials/tutorial-batch.md), [Tutorial: Querying data](../tutorials/tutorial-query.md), and [Tutorial: Rollup](../tutorials/tutorial-rollup.md).
+Before starting this tutorial, download and run Apache Druid on your local machine as described in
+the [single-machine quickstart](index.md).
-## Overwrite
+You should also be familiar with the material in the following tutorials:
+* [Tutorial: Loading a file](../tutorials/tutorial-batch.md)
Review Comment:
I agree with the change. My preference would be to change this text once the other files get updated so they remain consistent until then.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] techdocsmith commented on a diff in pull request #13641: docs: Refresh the update data tutorial
Posted by "techdocsmith (via GitHub)" <gi...@apache.org>.
techdocsmith commented on code in PR #13641:
URL: https://github.com/apache/druid/pull/13641#discussion_r1093939838
##########
docs/tutorials/tutorial-update-data.md:
##########
@@ -24,33 +24,39 @@ sidebar_label: "Updating existing data"
-->
-This tutorial demonstrates how to update existing data, showing both overwrites and appends.
+This tutorial shows you how to update data in a datasource by overwriting existing data and adding new data to the datasource.
-For this tutorial, we'll assume you've already downloaded Apache Druid as described in
-the [single-machine quickstart](index.md) and have it running on your local machine.
+## Prerequisites
-It will also be helpful to have finished [Tutorial: Loading a file](../tutorials/tutorial-batch.md), [Tutorial: Querying data](../tutorials/tutorial-query.md), and [Tutorial: Rollup](../tutorials/tutorial-rollup.md).
+Before starting this tutorial, download and run Apache Druid on your local machine as described in
+the [single-machine quickstart](index.md).
-## Overwrite
+You should also be familiar with the material in the following tutorials:
+* [Tutorial: Loading a file](../tutorials/tutorial-batch.md)
+* [Tutorial: Querying data](../tutorials/tutorial-query.md)
+* [Tutorial: Roll-up](../tutorials/tutorial-rollup.md)
-This section of the tutorial will cover how to overwrite an existing interval of data.
+## Load initial data
Review Comment:
nit: use of "initial" here seems awkwrd. "Load some data to start?" "Load seed data?"
##########
docs/tutorials/tutorial-update-data.md:
##########
@@ -24,33 +24,39 @@ sidebar_label: "Updating existing data"
-->
-This tutorial demonstrates how to update existing data, showing both overwrites and appends.
+This tutorial shows you how to update data in a datasource by overwriting existing data and adding new data to the datasource.
-For this tutorial, we'll assume you've already downloaded Apache Druid as described in
-the [single-machine quickstart](index.md) and have it running on your local machine.
+## Prerequisites
-It will also be helpful to have finished [Tutorial: Loading a file](../tutorials/tutorial-batch.md), [Tutorial: Querying data](../tutorials/tutorial-query.md), and [Tutorial: Rollup](../tutorials/tutorial-rollup.md).
+Before starting this tutorial, download and run Apache Druid on your local machine as described in
+the [single-machine quickstart](index.md).
-## Overwrite
+You should also be familiar with the material in the following tutorials:
+* [Tutorial: Loading a file](../tutorials/tutorial-batch.md)
+* [Tutorial: Querying data](../tutorials/tutorial-query.md)
+* [Tutorial: Roll-up](../tutorials/tutorial-rollup.md)
-This section of the tutorial will cover how to overwrite an existing interval of data.
+## Load initial data
-### Load initial data
+Load an initial data set to which you will overwrite and append data.
Review Comment:
note initial bothers me less here "an initial data set"
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] techdocsmith merged pull request #13641: docs: Refresh the update data tutorial
Posted by "techdocsmith (via GitHub)" <gi...@apache.org>.
techdocsmith merged PR #13641:
URL: https://github.com/apache/druid/pull/13641
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] writer-jill commented on a diff in pull request #13641: docs: Refresh the update data tutorial
Posted by GitBox <gi...@apache.org>.
writer-jill commented on code in PR #13641:
URL: https://github.com/apache/druid/pull/13641#discussion_r1064443765
##########
docs/tutorials/tutorial-update-data.md:
##########
@@ -61,24 +67,30 @@ dsql> select * from "updates-tutorial";
Retrieved 3 rows in 1.42s.
```
-### Overwrite the initial data
+The datasource contains three rows of data with an `animal` dimension and a `number` metric.
+
+## Overwrite data
-To overwrite this data, we can submit another task for the same interval, but with different input data.
+To overwrite the data, you submit another task for the same interval but with different input data.
Review Comment:
```suggestion
To overwrite the data, submit another task for the same interval but with different input data.
```
##########
docs/tutorials/tutorial-update-data.md:
##########
@@ -118,22 +131,24 @@ dsql> select * from "updates-tutorial";
Retrieved 6 rows in 0.02s.
```
-## Append to the data
+## Append data
-Let's try another way of appending data.
+Now you append data to the datasource without changing the existing data.
+Use the ingestion spec located at `quickstart/tutorial/updates-append-index2.json`.
-The `quickstart/tutorial/updates-append-index2.json` task spec reads input from `quickstart/tutorial/updates-data4.json` and will append its data to the `updates-tutorial` datasource. Note that `appendToExisting` is set to `true` in this spec.
+The spec directs Druid to ingest data from `quickstart/tutorial/updates-data4.json` and append it to the `updates-tutorial` datasource. The property `appendToExisting` is set to `true` in this spec.
-Let's submit that task:
+Submit the task:
```bash
bin/post-index-task --file quickstart/tutorial/updates-append-index2.json --url http://localhost:8081
```
-When the new data is loaded, we can see two additional rows after "octopus". Note that the new "bear" row with number 222 has not been rolled up with the existing bear-111 row, because the new data is held in a separate segment.
+When the task completes, query the data again. Two additional rows are added after `octopus`.
+Druid does not roll up the new `bear` row with the existing `bear` row because it stored the new data in a separate segment.
Review Comment:
```suggestion
Druid doesn't roll up the new `bear` row with the existing `bear` row because it stored the new data in a separate segment.
```
Google recommends using contractions:
https://developers.google.com/style/contractions
##########
docs/tutorials/tutorial-update-data.md:
##########
@@ -118,22 +131,24 @@ dsql> select * from "updates-tutorial";
Retrieved 6 rows in 0.02s.
```
-## Append to the data
+## Append data
-Let's try another way of appending data.
+Now you append data to the datasource without changing the existing data.
+Use the ingestion spec located at `quickstart/tutorial/updates-append-index2.json`.
-The `quickstart/tutorial/updates-append-index2.json` task spec reads input from `quickstart/tutorial/updates-data4.json` and will append its data to the `updates-tutorial` datasource. Note that `appendToExisting` is set to `true` in this spec.
+The spec directs Druid to ingest data from `quickstart/tutorial/updates-data4.json` and append it to the `updates-tutorial` datasource. The property `appendToExisting` is set to `true` in this spec.
-Let's submit that task:
+Submit the task:
```bash
bin/post-index-task --file quickstart/tutorial/updates-append-index2.json --url http://localhost:8081
```
-When the new data is loaded, we can see two additional rows after "octopus". Note that the new "bear" row with number 222 has not been rolled up with the existing bear-111 row, because the new data is held in a separate segment.
+When the task completes, query the data again. Two additional rows are added after `octopus`.
Review Comment:
```suggestion
Druid adds two additional rows after `octopus`. When the task completes, query the data again to see them.
```
##########
docs/tutorials/tutorial-update-data.md:
##########
@@ -24,33 +24,39 @@ sidebar_label: "Updating existing data"
-->
-This tutorial demonstrates how to update existing data, showing both overwrites and appends.
+This tutorial shows you how to update data in a datasource by overwriting existing data and adding new data to the datasource.
-For this tutorial, we'll assume you've already downloaded Apache Druid as described in
-the [single-machine quickstart](index.md) and have it running on your local machine.
+## Prerequisites
-It will also be helpful to have finished [Tutorial: Loading a file](../tutorials/tutorial-batch.md), [Tutorial: Querying data](../tutorials/tutorial-query.md), and [Tutorial: Rollup](../tutorials/tutorial-rollup.md).
+Before starting this tutorial, download and run Apache Druid on your local machine as described in
+the [single-machine quickstart](index.md).
-## Overwrite
+You should also be familiar with the material in the following tutorials:
+* [Tutorial: Loading a file](../tutorials/tutorial-batch.md)
Review Comment:
I think we're getting rid of the "Tutorial: " prefix - at least that's what Charles commented on a review of my latest tutorial.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org