Support RETURN AS in SEARCH

Makefile

@@ -60,3 +60,8 @@ godoc:
 	echo "Open browser tab on localhost:6060"
 	$(GODOC)
 
+start-redis:
+	$(docker) run --name redisearch-go-tests -d --rm -p 6379:6379 redislabs/redisearch:edge
+
+stop-redis:
+	$(docker) stop redisearch-go-tests

redisearch/query.go

@@ -297,6 +297,20 @@ func (q *Query) SetReturnFields(fields ...string) *Query {
 	return q
 }
 
+// AddReturnFields adds the fields that should be returned from each result
+// to the ReturnFields property
+func (q *Query) AddReturnFields(fields ...string) *Query {
+	q.ReturnFields = append(q.ReturnFields, fields...)
+	return q
+}
+
+// AddReturnField adds a single field with AS name that should be returned from
+// each result to the ReturnFields property
+func (q *Query) AddReturnField(field string, asName string) *Query {
+	q.ReturnFields = append(q.ReturnFields, field, "AS", asName)
+	return q
+}
+
 // SetPayload sets a binary payload to the query, that can be used by custom scoring functions
 func (q *Query) SetPayload(payload []byte) *Query {
 	q.Payload = payload

redisearch/redisearch_test.go

@@ -447,3 +447,66 @@ func TestFilter(t *testing.T) {
 	assert.Equal(t, 0, total)
 	teardown(c)
 }
+
+func TestReturnFields(t *testing.T) {
+	c := createClient("TestReturnFields")
+	version, _ := c.getRediSearchVersion()
+	if version < 20200 {
+		// IndexDefinition is available for RediSearch 2.0+
+		return
+	}
+
+	// Create a schema
+	sc := NewSchema(DefaultOptions).
+		AddField(NewTextField("body")).
+		AddField(NewTextFieldOptions("title", TextFieldOptions{Weight: 5.0, Sortable: true})).
+		AddField(NewNumericFieldOptions("age", NumericFieldOptions{Sortable: true}))
+	c.Drop()
+	assert.Nil(t, c.CreateIndex(sc))
+
+	// Create a document
+	doc := NewDocument("TestFilter-doc1", 1.0)
+	doc.Set("title", "Hello world").
+		Set("body", "foo bar").
+		Set("age", 18)
+	assert.Nil(t, c.IndexOptions(DefaultIndexingOptions, doc))
+	// Searching with return fields
+	docs, total, err := c.Search(NewQuery("hello world").
+		AddReturnFields("body", "age").
+		AddReturnField("title", "doc_name"))
+	assert.Nil(t, err)
+	assert.Equal(t, 1, total)
+	assert.Equal(t, "foo bar", docs[0].Properties["body"])
+	assert.Equal(t, "18", docs[0].Properties["age"])
+	assert.Equal(t, "Hello world", docs[0].Properties["doc_name"])
+
+	// Test return fields with as name with json index
+	flush(c)
+
+	// Create index json
+	indexDefinition := NewIndexDefinition().SetIndexOn(JSON)
+	schema := NewSchema(DefaultOptions).
+		AddField(NewTextField("$.name")).
+		AddField(NewNumericField("$.age"))
+	err = c.CreateIndexWithIndexDefinition(schema, indexDefinition)
+	assert.Nil(t, err)
+
+	vanillaConnection := c.pool.Get()
+	_, err = vanillaConnection.Do("JSON.SET", "doc:1", "$", "{\"name\":\"Jon\", \"age\": 25}")
+	assert.Nil(t, err)
+
+	// Wait for the document to be indexed
+	info, err := c.Info()
+	assert.Nil(t, err)
+	for info.IsIndexing {
+		time.Sleep(time.Second)
+		info, _ = c.Info()
+	}
+
+	// Searching with return fields
+	docs, total, err = c.Search(NewQuery("*").AddReturnField("$.name", "name").AddReturnField("$.age", "years"))
+	assert.Nil(t, err)
+	assert.Equal(t, 1, total)
+	assert.Equal(t, "Jon", docs[0].Properties["name"])
+	assert.Equal(t, "25", docs[0].Properties["years"])
+}