You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@drill.apache.org by dz...@apache.org on 2021/07/02 13:53:50 UTC

[drill] branch gh-pages updated: Update instructions for multlingual in README.md.

This is an automated email from the ASF dual-hosted git repository.

dzamo pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/drill.git


The following commit(s) were added to refs/heads/gh-pages by this push:
     new b3705d0  Update instructions for multlingual in README.md.
b3705d0 is described below

commit b3705d03e5670efabfd85d5334920c8dd35dce90
Author: James Turton <ja...@somecomputer.xyz>
AuthorDate: Fri Jul 2 15:50:24 2021 +0200

    Update instructions for multlingual in README.md.
---
 README.md                                          |  2 +
 .../rest-api/010-rest-api-introduction.md          | 47 +++++++++++++---------
 2 files changed, 29 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index b07a79b..5d87b02 100644
--- a/README.md
+++ b/README.md
@@ -135,6 +135,8 @@ Multilingual support was added to the website in June 2021 using the polyglot Je
 1. Add the two-letter language code (`lang-code` forthwith) to the `languages` property in _config.yml.
 2. Add a `lang-code/` subdirectory to the root directory.
 3. Add a `lang-code/` subdirectory to each collection that will be translated, e.g. `_docs/lang-code/`.
+4. Check the `exclude_from_localization` list in _config.yml to ensure that the content you
+want to translate is not excluded from processing by the multlingual plugin.
 
 ## Add translated site pages
 
diff --git a/_docs/en/developer-information/rest-api/010-rest-api-introduction.md b/_docs/en/developer-information/rest-api/010-rest-api-introduction.md
index 21aeb41..0bdf56c 100644
--- a/_docs/en/developer-information/rest-api/010-rest-api-introduction.md
+++ b/_docs/en/developer-information/rest-api/010-rest-api-introduction.md
@@ -66,15 +66,19 @@ Submit a query and return results.
 * `autoLimit`--Limits the number of rows returned from the result set. (Drill 1.16+)
 * `defaultSchema`--Sets the default schema for the query.  Equavalent to executing a `USE <schema>` prior to the query. (Drill 1.18+)
 
-For Drill 1.19+ Drill switched to a streaming HTTP connection for REST queries.  The result being that 
+In Drill 1.19+ Drill switched to a streaming HTTP connection for REST queries
+with the result that query result sets are no longer buffered in their entirety
+in heap memory before being returned to the HTTP requestor.
 
 **Request Body**
 
-        {
-          "queryType" : "SQL",
-          "query" : "<Drill query>",
-		  "autoLimit" : "<rows returned>"
-        }
+```json
+{
+  "queryType" : "SQL",
+  "query" : "<Drill query>",
+  "autoLimit" : "<rows returned>"
+}
+```
 
 **Example**
 
@@ -82,22 +86,25 @@ For Drill 1.19+ Drill switched to a streaming HTTP connection for REST queries.
 
 **Response Body**
 
-     {
-       "columns" : [ "id", "type", "name", "ppu", "sales", "batters", "topping", "filling" ],
-       "rows" : [ {
-         "id" : "0001",
-         "sales" : "35",
-         "name" : "Cake",
-         "topping" : "[{\"id\":\"5001\",\"type\":\"None\"},{\"id\":\"5002\",\"type\":\"Glazed\"},{\"id\":\"5005\",\"type\":\"Sugar\"},{\"id\":\"5007\",\"type\":\"Powdered Sugar\"},{\"id\":\"5006\",\"type\":\"Chocolate with Sprinkles\"},{\"id\":\"5003\",\"type\":\"Chocolate\"},{\"id\":\"5004\",\"type\":\"Maple\"}]",
-         "ppu" : "0.55",
-         "type" : "donut",
-         "batters" : "{\"batter\":[{\"id\":\"1001\",\"type\":\"Regular\"},{\"id\":\"1002\",\"type\":\"Chocolate\"},{\"id\":\"1003\",\"type\":\"Blueberry\"},{\"id\":\"1004\",\"type\":\"Devil's Food\"}]}",
-         "filling" : "[]"
-       } ]
-     }
+```json
+{
+  "columns" : [ "id", "type", "name", "ppu", "sales", "batters", "topping", "filling" ],
+  "rows" : [ {
+    "id" : "0001",
+    "sales" : "35",
+    "name" : "Cake",
+    "topping" : "[{\"id\":\"5001\",\"type\":\"None\"},{\"id\":\"5002\",\"type\":\"Glazed\"},{\"id\":\"5005\",\"type\":\"Sugar\"},{\"id\":\"5007\",\"type\":\"Powdered Sugar\"},{\"id\":\"5006\",\"type\":\"Chocolate with Sprinkles\"},{\"id\":\"5003\",\"type\":\"Chocolate\"},{\"id\":\"5004\",\"type\":\"Maple\"}]",
+    "ppu" : "0.55",
+    "type" : "donut",
+    "batters" : "{\"batter\":[{\"id\":\"1001\",\"type\":\"Regular\"},{\"id\":\"1002\",\"type\":\"Chocolate\"},{\"id\":\"1003\",\"type\":\"Blueberry\"},{\"id\":\"1004\",\"type\":\"Devil's Food\"}]}",
+    "filling" : "[]"
+  } ]
+}
+```
 
 **Error Reporting**
-Drill 1.19 added a streaming REST interface with the goal of reducing the response times from REST calls. As of Drill 1.19, error reporting is no longer enabled by default and in the event of a failed query, you will just get results as shown below:
+
+Drill 1.19 added a streaming REST interface with the goal of reducing the response times from REST calls. As of Drill 1.19, error reporting is no longer enabled by default and in the event of a failed query, you will only get results as shown below.
 
 ```json
 {