[Groonga-commit] groonga/groonga at 913503b [master] doc: document about pretty print support

Back to archive index

Kouhei Sutou null+****@clear*****
Tue Nov 24 14:56:22 JST 2015


Kouhei Sutou	2015-11-24 14:56:22 +0900 (Tue, 24 Nov 2015)

  New Revision: 913503b75bb29716b8ed553ca9dc4a7c6492df61
  https://github.com/groonga/groonga/commit/913503b75bb29716b8ed553ca9dc4a7c6492df61

  Message:
    doc: document about pretty print support

  Added files:
    doc/source/reference/command/pretty_print.rst
  Modified files:
    doc/source/reference/command.rst

  Modified: doc/source/reference/command.rst (+1 -0)
===================================================================
--- doc/source/reference/command.rst    2015-11-24 13:03:43 +0900 (b4fb6c2)
+++ doc/source/reference/command.rst    2015-11-24 14:56:22 +0900 (f753658)
@@ -16,6 +16,7 @@ This section describes about command and built-in commands.
 
    command/command_version
    command/output_format
+   command/pretty_print
    command/request_id
    command/return_code
    commands/*

  Added: doc/source/reference/command/pretty_print.rst (+45 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/reference/command/pretty_print.rst    2015-11-24 14:56:22 +0900 (2e1c806)
@@ -0,0 +1,45 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Pretty print
+============
+
+Summary
+-------
+
+.. versionadded:: 5.0.9
+
+Groonga supports pretty print when you choose JSON for
+:doc:`output_format`.
+
+How to use
+----------
+
+Just specify ``yes`` to ``output_pretty`` parameter::
+
+  > status --output_pretty yes
+  [
+    [
+      0,
+      1448344438.43783,
+      5.29289245605469e-05
+    ],
+    {
+      "alloc_count": 233,
+      "starttime": 1448344437,
+      "start_time": 1448344437,
+      "uptime": 1,
+      "version": "5.0.9-135-g0763d91",
+      "n_queries": 0,
+      "cache_hit_rate": 0.0,
+      "command_version": 1,
+      "default_command_version": 1,
+      "max_command_version": 2
+    }
+  ]
+
+Here is a result without ``output_pretty`` parameter::
+
+  > status --output_pretty yes
+  [[0,1448344438.43783,5.29289245605469e-05],{"alloc_count":233,"starttime":1448344437,...}]
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Back to archive index