docs: add format ReQL command

_jekyll/_data/api_java.yml

@@ -219,6 +219,8 @@
           permalink: upcase
         - name: downcase
           permalink: downcase
+        - name: format
+          permalink: format
 - section:
     name: Math and logic
     commands:

_jekyll/_data/api_javascript.yml

@@ -219,6 +219,8 @@
           permalink: upcase
         - name: downcase
           permalink: downcase
+        - name: format
+          permalink: format
 - section:
     name: Math and logic
     commands:

_jekyll/_data/api_python.yml

@@ -217,6 +217,8 @@
           permalink: upcase
         - name: downcase
           permalink: downcase
+        - name: format
+          permalink: format
 - section:
     name: Math and logic
     commands:

_jekyll/_data/api_ruby.yml

@@ -215,6 +215,8 @@
           permalink: upcase
         - name: downcase
           permalink: downcase
+        - name: format
+          permalink: format
 - section:
     name: Math and logic
     commands:

_scripts/dataexplorer.py

@@ -1,10 +1,9 @@
+import codecs
+import json
+import os
 import re
 import markdown
-import os
-import sys
 import yaml
-import json
-import codecs
 
 IGNORED_FILES = ["index.md", "accessing-rql/event_emitter.md"]
 
@@ -118,7 +117,7 @@ def add_io_field(file_name, result):
             if is_yaml == True:
                 yaml_raw += line
 
-    yaml_data = yaml.load(yaml_raw)
+    yaml_data = yaml.load(yaml_raw, Loader=yaml.Loader)
     if "io" in yaml_data:
         result[yaml_data["permalink"]]["io"] = yaml_data["io"]
     else:
@@ -131,7 +130,7 @@ def browse_files(base, result):
     for path, dirs, files in os.walk(base):
         rel = path[len(base)+1:]
         for item in files:
-            print os.path.join(rel, item)
+            print(os.path.join(rel, item))
             if os.path.join(rel, item) not in IGNORED_FILES:
                 add_io_field(os.path.join(path, item), result)
 

api/java/index.md

@@ -1932,6 +1932,46 @@ Result:
 
 [Read more about this command →](split/)
 
+## [format](format/) ##
+
+{% apibody %}
+r.format(string, object) → string
+{% endapibody %}
+
+Format command takes a string as a template and formatting parameters as an object. The parameters in the template string must exist as keys in the object, otherwise, an error raised. The template must be a string literal and cannot be the result of other commands.
+
+__Example:__ Using simple parameters for formatting.
+
+```java
+r.format("{name} loves {candy}.",
+    r.hashMap("name", "Bob").with("candy", "candy floss")
+).run(conn, callback)
+```
+
+Result:
+
+```java
+"Bob loves candy floss."
+```
+
+__Example:__ Using row for formatting.
+
+```java
+r.table("movies").map({
+  id: r.row('id'),
+  ratings: r.http(r.format('http://example.com/movies/?title={title}&release={year}', r.row))
+})
+```
+
+Result:
+
+```java
+// `ratings` is the result of the HTTP request
+[{ id: 1, ratings: { positive: 99, negative: 0 }}]
+```
+
+[Read more about this command →](format/)
+
 ## [upcase](upcase/) ##
 
 {% apibody %}

api/java/string-manipulation/downcase.md

@@ -7,6 +7,7 @@ related_commands:
     upcase: upcase/
     match: match/
     split: split/
+    format: format/
 ---
 
 # Command syntax #

api/java/string-manipulation/format.md

@@ -0,0 +1,54 @@
+---
+layout: api-command
+language: Java
+permalink: api/java/format/
+command: format
+io:
+    -   - r
+        - string
+related_commands:
+    match: match/
+    split: split/
+    upcase: upcase/
+    downcase: downcase/
+---
+
+# Command syntax #
+
+{% apibody %}
+r.format(string, object) → string
+{% endapibody %}
+
+# Description #
+
+Format command takes a string as a template and formatting parameters as an object. The parameters in the template string must exist as keys in the object, otherwise, an error raised. The template must be a string literal and cannot be the result of other commands.
+
+__Example:__ Using simple parameters for formatting.
+
+```java
+r.format("{name} loves {candy}.",
+    r.hashMap("name", "Bob").with("candy", "candy floss")
+).run(conn, callback)
+```
+
+Result:
+
+```java
+"Bob loves candy floss."
+```
+
+__Example:__ Using row for formatting.
+
+```java
+r.table("movies").map({
+  id: r.row('id'),
+  ratings: r.http(r.format('http://example.com/movies/?title={title}&release={year}', r.row))
+})
+```
+
+Result:
+
+```java
+// `ratings` is the result of the HTTP request
+[{ id: 1, ratings: { positive: 99, negative: 0 }}]
+```

api/java/string-manipulation/match.md

@@ -10,6 +10,7 @@ related_commands:
     upcase: upcase/
     downcase: downcase/
     split: split/
+    format: format/
 ---
 
 # Command syntax #

api/java/string-manipulation/split.md

@@ -7,6 +7,7 @@ related_commands:
     upcase: upcase/
     downcase: downcase/
     match: match/
+    format: format/
 ---
 
 # Command syntax #

api/java/string-manipulation/upcase.md

@@ -7,6 +7,7 @@ related_commands:
     downcase: downcase/
     match: match/
     split: split/
+    format: format/
 ---
 
 # Command syntax #

api/javascript/index.md

@@ -2009,6 +2009,47 @@ Result:
 
 [Read more about this command →](split/)
 
+## [format](format/) ##
+
+{% apibody %}
+r.format(string, object) → string
+{% endapibody %}
+
+Format command takes a string as a template and formatting parameters as an object. The parameters in the template string must exist as keys in the object, otherwise, an error raised. The template must be a string literal and cannot be the result of other commands.
+
+__Example:__ Using simple parameters for formatting.
+
+```js
+r.format("{name} loves {candy}.", {
+    "name": "Bob",
+    "candy": "candy floss",
+}).run(conn, callback)
+```
+
+Result:
+
+```js
+"Bob loves candy floss."
+```
+
+__Example:__ Using row for formatting.
+
+```js
+r.table("movies").map({
+  id: r.row('id'),
+  ratings: r.http(r.format('http://example.com/movies/?title={title}&release={year}', r.row))
+})
+```
+
+Result:
+
+```js
+// `ratings` is the result of the HTTP request
+[{ id: 1, ratings: { positive: 99, negative: 0 }}]
+```
+
+[Read more about this command →](format/)
+
 ## [upcase](upcase/) ##
 
 {% apibody %}

api/javascript/string-manipulation/downcase.md

@@ -10,6 +10,7 @@ related_commands:
     upcase: upcase/
     match: match/
     split: split/
+    format: format/
 ---
 
 # Command syntax #

api/javascript/string-manipulation/format.md

@@ -0,0 +1,55 @@
+---
+layout: api-command
+language: JavaScript
+permalink: api/javascript/format/
+command: format
+io:
+    -   - r
+        - string
+related_commands:
+    match: match/
+    split: split/
+    upcase: upcase/
+    downcase: downcase/
+---
+
+# Command syntax #
+
+{% apibody %}
+r.format(string, object) → string
+{% endapibody %}
+
+# Description #
+
+Format command takes a string as a template and formatting parameters as an object. The parameters in the template string must exist as keys in the object, otherwise, an error raised. The template must be a string literal and cannot be the result of other commands.
+
+__Example:__ Using simple parameters for formatting.
+
+```js
+r.format("{name} loves {candy}.", {
+    "name": "Bob",
+    "candy": "candy floss",
+}).run(conn, callback)
+```
+
+Result:
+
+```js
+"Bob loves candy floss."
+```
+
+__Example:__ Using row for formatting.
+
+```js
+r.table("movies").map({
+  id: r.row('id'),
+  ratings: r.http(r.format('http://example.com/movies/?title={title}&release={year}', r.row))
+})
+```
+
+Result:
+
+```js
+// `ratings` is the result of the HTTP request
+[{ id: 1, ratings: { positive: 99, negative: 0 }}]
+```

api/javascript/string-manipulation/match.md

@@ -10,6 +10,7 @@ related_commands:
     upcase: upcase/
     downcase: downcase/
     split: split/
+    format: format/
 ---
 
 # Command syntax #

api/javascript/string-manipulation/split.md

@@ -10,6 +10,7 @@ related_commands:
     upcase: upcase/
     downcase: downcase/
     match: match/
+    format: format/
 ---
 
 # Command syntax #

api/javascript/string-manipulation/upcase.md

@@ -10,6 +10,7 @@ related_commands:
     downcase: downcase/
     match: match/
     split: split/
+    format: format/
 ---
 
 # Command syntax #

api/python/index.md

@@ -1899,6 +1899,49 @@ __Example:__ Split on whitespace.
 
 [Read more about this command →](split/)
 
+## [format](format/) ##
+
+{% apibody %}
+r.format(string, object) → string
+{% endapibody %}
+
+Format command takes a string as a template and formatting parameters as an object. The parameters in the template string must exist as keys in the object, otherwise, an error raised. The template must be a string literal and cannot be the result of other commands.
+
+__Example:__ Using simple parameters for formatting.
+
+```py
+r.format("{name} loves {candy}.", {
+    "name": "Bob",
+    "candy": "candy floss",
+}).run(conn)
+```
+
+Result:
+
+```py
+"Bob loves candy floss."
+```
+
+__Example:__ Using row for formatting.
+
+```py
+r.table("movies").map({
+  id: r.row('id'),
+  ratings: r.http(r.format('http://example.com/movies/?title={title}&release={year}', r.row))
+}).run(conn)
+```
+
+Result:
+
+```py
+# `ratings` is the result of the HTTP request
+[{ id: 1, ratings: { positive: 99, negative: 0 }}]
+```
+
+[Read more about this command →](format/)
+
+## [upcase](upcase/) ##
+
 ## [upcase](upcase/) ##
 
 {% apibody %}

api/python/string-manipulation/downcase.md

@@ -7,6 +7,7 @@ related_commands:
     upcase: upcase/
     match: match/
     split: split/
+    format: format/
 ---
 
 # Command syntax #