Added more documentation and examples for GetAll

Fixes #266

Author: dancannon

CHANGELOG.md

@@ -4,6 +4,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+### Added
+ - Added more documentation and examples for `GetAll`.
+
 ### Fixed
 - Fixed `RunWrite` not defering its call to `Cursor.Close()`. This could cause issues if an error occurred when decoding the result.
 

example_query_select_test.go

@@ -30,6 +30,79 @@ func ExampleTerm_Get() {
 	// Output: Superman
 }
 
+// Find a document by ID.
+func ExampleTerm_GetAll() {
+	// Fetch the row from the database
+	res, err := DB("examples").Table("heroes").GetAll(2).Run(session)
+	if err != nil {
+		fmt.Print(err)
+		return
+	}
+	defer res.Close()
+
+	if res.IsNil() {
+		fmt.Print("Row not found")
+		return
+	}
+
+	var hero map[string]interface{}
+	err = res.One(&hero)
+	if err != nil {
+		fmt.Printf("Error scanning database result: %s", err)
+		return
+	}
+	fmt.Print(hero["name"])
+
+	// Output: Superman
+}
+
+// Find a document by ID.
+func ExampleTerm_GetAll_multiple() {
+	// Fetch the row from the database
+	res, err := DB("examples").Table("heroes").GetAll(1, 2).Run(session)
+	if err != nil {
+		fmt.Print(err)
+		return
+	}
+	defer res.Close()
+
+	var heroes []map[string]interface{}
+	err = res.All(&heroes)
+	if err != nil {
+		fmt.Printf("Error scanning database result: %s", err)
+		return
+	}
+	fmt.Print(heroes[0]["name"])
+
+	// Output: Superman
+}
+
+// Find all document with an indexed value.
+func ExampleTerm_GetAllByIndex() {
+	// Fetch the row from the database
+	res, err := DB("examples").Table("heroes").GetAllByIndex("code_name", "man_of_steel").Run(session)
+	if err != nil {
+		fmt.Print(err)
+		return
+	}
+	defer res.Close()
+
+	if res.IsNil() {
+		fmt.Print("Row not found")
+		return
+	}
+
+	var hero map[string]interface{}
+	err = res.One(&hero)
+	if err != nil {
+		fmt.Printf("Error scanning database result: %s", err)
+		return
+	}
+	fmt.Print(hero["name"])
+
+	// Output: Superman
+}
+
 // Find a document and merge another document with it.
 func ExampleTerm_Get_merge() {
 	// Fetch the row from the database

query_select.go

@@ -61,7 +61,10 @@ func (t Term) Get(args ...interface{}) Term {
 	return constructMethodTerm(t, "Get", p.Term_GET, args, map[string]interface{}{})
 }
 
-// GetAll gets all documents where the given value matches the value of the primary index.
+// GetAll gets all documents where the given value matches the value of the primary
+// index. Multiple values can be passed this function if you want to select multiple
+// documents. If the documents you are fetching have composite keys then each
+// argument should be a slice. For more information see the examples.
 func (t Term) GetAll(keys ...interface{}) Term {
 	return constructMethodTerm(t, "GetAll", p.Term_GET_ALL, keys, map[string]interface{}{})
 }

testdata_test.go

@@ -24,6 +24,9 @@ func setupTestData() {
 			[]interface{}{Row.Field("date"), Row.Field("title")},
 		).Exec(session)
 
+		DB("examples").Table("heroes").IndexCreate("code_name").Exec(session)
+		DB("examples").Table("heroes").IndexWait().Exec(session)
+
 		DB("examples").Table("games").IndexCreate("type").Exec(session)
 		DB("examples").Table("games").IndexWait().Exec(session)