Put mappings, API help etc.

Author: olivere

README.md

@@ -3,6 +3,10 @@
 `es` is a small command line tool to interact with the
 ElasticSearch search engine.
 
+Notice that you could do all of this with `curl` commands, as
+seen on the [ElasticSearch API](http://www.elasticsearch.org/guide/reference/api/).
+However, you probably save a few keystrokes with `es`.
+
 ## Setup
 
 You need to compile yourself currently:
@@ -14,7 +18,17 @@ You need to compile yourself currently:
 
 ## Commands
 
-Lets list indices.
+Before we start, you can always lookup the ElasticSearch API via
+the `api` command, like so:
+
+	$ es api indices
+
+The `api` command will open up a browser window with the API page
+that matches the specified command. You can find the complete
+[ElasticSearch API here](http://www.elasticsearch.org/guide/reference/api/).
+
+Let's get started. First we list existing indices, either all of them
+or via a regular expression.
 
 	$ es indices
 	master
@@ -24,7 +38,9 @@ Lets list indices.
 	master
 	marvel
 
-And create a new index. This can be useful if you e.g. added templates.
+Let's create a new index. Use the -f flag to force creation, i.e. it will
+not print an error if the index already exists (and won't touch the 
+existing index).
 
 	$ es create twitter
 	$ es indices
@@ -36,7 +52,7 @@ And create a new index. This can be useful if you e.g. added templates.
 	Error: IndexAlreadyExistsException[[twitter] Already exists] (400)
 	$ es create -f twitter
 
-Now, lets delete indices.
+Delete indices again.
 
 	$ es delete twitter
 	$ es indices
@@ -51,7 +67,7 @@ Now, lets delete indices.
 	marvel
 	dummy
 
-Let's review the mapping of an index.
+Let's review mappings, and even create mappings from the command line.
 
 	$ es mapping dummy
 	{
@@ -60,6 +76,21 @@ Let's review the mapping of an index.
 	}
 	$ es mapping nonexistent
 	Error: IndexMissingException[[nonexistent] missing] (404)
+	$ es create twitter
+	$ es put-mapping twitter tweet < tweet-mapping.json
+	$ es mapping twitter
+	{
+	  "twitter" : {
+	    "tweet" : {
+	      "properties" : {
+	        "message" : {
+	          "type" : "string",
+	          "store" : "yes"
+	        }
+	      }
+	    }
+	  }
+	}
 
 Templates, oh how I love thee... here's a sample session.
 

api.go

@@ -3,14 +3,56 @@ package main
 import (
 	"bytes"
 	"encoding/json"
+	"fmt"
 	"log"
 	"io"
 	"io/ioutil"
 	"net/http"
+	"os"
+	"os/exec"
 	"runtime"
 	"strings"
 )
 
+var cmdApi = &Command{
+	Usage:  "api <command>",
+	Short:  "show API for command",
+	Long:   `Opens browser with API details for the specified command.`,
+	ApiUrl: "",
+}
+
+func init() {
+	cmdApi.Run = runApi
+}
+
+func runApi(cmd *Command, args []string) {
+	if len(args) == 0 {
+		printUsage()
+		return
+	}
+
+	if len(args) != 1 {
+		log.Fatal("too many arguments")
+	}
+
+	for _, cmd := range commands {
+		if cmd.Name() == args[0] && len(cmd.ApiUrl) > 0 {
+			// open browser
+			openBrowser := "open"
+			if _, err := exec.LookPath("xdg-open"); err == nil {
+				openBrowser = "xdg-open"
+			}
+			exec.Command(openBrowser, cmd.ApiUrl).Start()
+			return
+		}
+	}
+
+	fmt.Fprintf(os.Stderr, "No API information for command: %s\n", args[0])
+	os.Exit(2)
+}
+
+// Generic API for accessing ElasticSearch server starts here.
+
 type Request http.Request
 
 func ESReq(method, path string) *Request {

create_index.go

@@ -8,14 +8,15 @@ import (
 var cmdCreateIndex = &Command{
 	Run:   runCreateIndex,
 	Usage: "create [-f] <index>",
-	Short: "creates index",
+	Short: "create index",
 	Long: `
 Creates an empty index.
 
 Example:
 
   $ es create marvel
 `,
+	ApiUrl: "http://www.elasticsearch.org/guide/reference/api/admin-indices-create-index.html",
 }
 
 func init() {

create_template.go

@@ -18,6 +18,7 @@ Example:
 
   $ es create-template marvel < marvel-template.json
 `,
+	ApiUrl: "http://www.elasticsearch.org/guide/reference/api/admin-indices-templates.html",
 }
 
 func runCreateTemplate(cmd *Command, args []string) {

delete_index.go

@@ -8,14 +8,15 @@ import (
 var cmdDeleteIndex = &Command{
 	Run:   runDeleteIndex,
 	Usage: "delete [-f] <index>",
-	Short: "deletes index",
+	Short: "delete index",
 	Long: `
 Deletes an index.
 
 Example:
 
   $ es delete marvel
 `,
+	ApiUrl: "http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-index.html",
 }
 
 func init() {

delete_template.go

@@ -6,10 +6,11 @@ import (
 )
 
 var cmdDeleteTemplate = &Command{
-	Run:   runDeleteTemplate,
-	Usage: "delete-template [-f] <template>",
-	Short: "deletes a template",
-	Long:  `Deletes the specified template.`,
+	Run:    runDeleteTemplate,
+	Usage:  "delete-template [-f] <template>",
+	Short:  "delete template",
+	Long:   `Deletes the specified template.`,
+	ApiUrl: "http://www.elasticsearch.org/guide/reference/api/admin-indices-templates.html",
 }
 
 func init() {

help.go

@@ -7,10 +7,11 @@ import (
 )
 
 var cmdVersion = &Command{
-	Run:   runVersion,
-	Usage: "version",
-	Short: "show version",
-	Long:  `Shows the version string.`,
+	Run:    runVersion,
+	Usage:  "version",
+	Short:  "show version",
+	Long:   `Shows the version string.`,
+	ApiUrl: "",
 }
 
 func runVersion(cmd *Command, args []string) {

indices.go

@@ -21,6 +21,7 @@ Example:
   $ es indices 'mas.*'
   master
 `,
+	ApiUrl: "http://www.elasticsearch.org/guide/reference/api/index_.html",
 }
 
 func init() {

main.go

@@ -22,6 +22,8 @@ type Command struct {
 	Usage string
 	Short string
 	Long  string
+
+	ApiUrl string
 }
 
 func (c *Command) printUsage() {
@@ -41,18 +43,19 @@ func (c *Command) Name() string {
 // Running es on the command line will print these commands in order.
 var commands = []*Command{
 	cmdIndices,
-	cmdMapping,
-
 	cmdCreateIndex,
 	cmdDeleteIndex,
 
+	cmdMapping,
+	cmdPutMapping,
+
 	cmdTemplates,
 	cmdTemplate,
 	cmdCreateTemplate,
 	cmdDeleteTemplate,
 
 	cmdVersion,
-
+	cmdApi,
 	cmdHelp,
 }
 

mapping.go

@@ -17,6 +17,7 @@ Example:
 
   $ es mapping twitter
 `,
+	ApiUrl: "http://www.elasticsearch.org/guide/reference/api/admin-indices-get-mapping.html",
 }
 
 func runMapping(cmd *Command, args []string) {

put_mapping.go

@@ -0,0 +1,54 @@
+package main
+
+import (
+	"bufio"
+	"encoding/json"
+	"log"
+	"os"
+)
+
+var cmdPutMapping = &Command{
+	Run:   runPutMapping,
+	Usage: "put-mapping <index> <type>",
+	Short: "create or update mapping",
+	Long: `
+Creates or updates a mapping for a document type on an index.
+http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping.html
+
+Example:
+
+  $ es put-mapping twitter tweet < tweet-mapping.json
+`,
+	ApiUrl: "http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping.html",
+}
+
+func runPutMapping(cmd *Command, args []string) {
+	if len(args) != 2 {
+		cmd.printUsage()
+		os.Exit(1)
+	}
+
+	index := args[0]
+	doctype := args[1]
+
+	var response struct {
+		Ok     bool   `json:"ok,omitempty"`
+		Ack    bool   `json:"acknowledged,omitempty"`
+		Error  string `json:"error,omitempty"`
+		Status int    `json:"status,omitempty"`
+	}
+
+	// parse Stdin into JSON
+	var data interface{}
+	reader := bufio.NewReader(os.Stdin)
+	if err := json.NewDecoder(reader).Decode(&data); err != nil {
+		log.Fatal("invalid json\n")
+	}
+
+	req := ESReq("PUT", "/"+index+"/"+doctype+"/_mapping")
+	req.SetBodyJson(data)
+	req.Do(&response)
+	if len(response.Error) > 0 {
+		log.Fatalf("Error: %v (%v)\n", response.Error, response.Status)
+	}
+}

template.go

@@ -19,6 +19,7 @@ Example:
   {
   }
 `,
+	ApiUrl: "http://www.elasticsearch.org/guide/reference/api/admin-indices-templates.html",
 }
 
 func init() {

templates.go

@@ -21,6 +21,7 @@ Example:
   $ es templates 'mas.*'
   master-template
 `,
+	ApiUrl: "http://www.elasticsearch.org/guide/reference/api/admin-indices-templates.html",
 }
 
 func init() {