Return-Path: X-Original-To: apmail-drill-commits-archive@www.apache.org Delivered-To: apmail-drill-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 883791818E for ; Wed, 25 Nov 2015 22:02:50 +0000 (UTC) Received: (qmail 63247 invoked by uid 500); 25 Nov 2015 22:02:50 -0000 Delivered-To: apmail-drill-commits-archive@drill.apache.org Received: (qmail 63167 invoked by uid 500); 25 Nov 2015 22:02:50 -0000 Mailing-List: contact commits-help@drill.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: commits@drill.apache.org Delivered-To: mailing list commits@drill.apache.org Received: (qmail 62591 invoked by uid 99); 25 Nov 2015 22:02:50 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 25 Nov 2015 22:02:50 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id DB5DFE1125; Wed, 25 Nov 2015 22:02:49 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: bridgetb@apache.org To: commits@drill.apache.org Date: Wed, 25 Nov 2015 22:02:57 -0000 Message-Id: <3c2a086ca7e74781b488764743990656@git.apache.org> In-Reply-To: <6b23d18928664538ae260ceb1af9fdb8@git.apache.org> References: <6b23d18928664538ae260ceb1af9fdb8@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [09/31] drill git commit: line breaks line breaks Project: http://git-wip-us.apache.org/repos/asf/drill/repo Commit: http://git-wip-us.apache.org/repos/asf/drill/commit/104bace1 Tree: http://git-wip-us.apache.org/repos/asf/drill/tree/104bace1 Diff: http://git-wip-us.apache.org/repos/asf/drill/diff/104bace1 Branch: refs/heads/gh-pages Commit: 104bace1393163f4b6c941158feea34aec29acbc Parents: 7e147f5 Author: Kristine Hahn Authored: Fri Nov 20 14:51:09 2015 -0800 Committer: Kristine Hahn Committed: Wed Nov 25 10:13:42 2015 -0800 ---------------------------------------------------------------------- _docs/developer-information/009-rest-api.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/drill/blob/104bace1/_docs/developer-information/009-rest-api.md ---------------------------------------------------------------------- diff --git a/_docs/developer-information/009-rest-api.md b/_docs/developer-information/009-rest-api.md index 266d7a8..7432b6e 100644 --- a/_docs/developer-information/009-rest-api.md +++ b/_docs/developer-information/009-rest-api.md @@ -22,7 +22,7 @@ Several examples in the document use the donuts.json file. To download this file The following short description of methods link to more information and examples: * [List information about system/session options]({{site.baseurl}}/docs/rest-api/#get-options-json). -* [Change the value or type of the named option](). +* [Change the value or type of the named option]({{site.baseurl}}/drill/docs/rest-api/#post-option-optionname). * [Submit a query to Drill and return query results](). * @@ -73,9 +73,11 @@ List the name, default, and data type of the system and session options. Change the value or type of the named option. **Parameter** + optionName--The name of a [Drill system option]({{site.baseurl}}/docs/configuration-options-introduction/#system-options). **Request Body** + Enclose option values of kind STRING in double quotation marks. { @@ -86,6 +88,7 @@ Enclose option values of kind STRING in double quotation marks. } **Example** + curl -X POST -H "Content-Type: application/json" -d '{"name" : "store.json.all_text_mode", "value" : true, "type" : "SYSTEM", "kind" : "BOOLEAN"}' http://localhost:8047/option/store.json.all_text_mode @@ -131,6 +134,7 @@ Get the profiles of running and completed queries. Get the profile of given queryid. **Parameter** + queryid--The UUID of the query in [standard UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format that Drill assigns to each query. **Example** @@ -149,6 +153,7 @@ queryid--The UUID of the query in [standard UUID](https://en.wikipedia.org/wiki/ Cancel the query having the given queryid. **Parameter** + queryid--The UUID of the query in [standard UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format that Drill assigns to each query. **Example** @@ -177,6 +182,7 @@ Submits a query, waits until the query completes, and then returns the results a * query--A SQL query that runs in Drill. **Request Body** + { "queryType" : "SQL", "query" : "" @@ -248,6 +254,7 @@ Get the list of storage plugin names and configurations. Get the named storage plugin name and configuration. **Parameter** + name--The assigned name in the storage plugin definition. **Example** @@ -272,6 +279,7 @@ name--The assigned name in the storage plugin definition. Enable or disable the named storage plugin. **Parameters** + * name--The assigned name in the storage plugin definition. * val--Either true (to enable) or false (to disable). @@ -292,6 +300,7 @@ Enable or disable the named storage plugin. Create or update a storage plugin configuration. **Parameters** + name--The name of the storage plugin configuration to create or update. **Request Body** @@ -326,6 +335,7 @@ Valid storage plugin types include file, hbase, hive, mongo, and jdbc. Construct Delete a storage plugin configuration. **Parameter** + name--The name of the storage plugin configuration to delete. **Example**