Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Compatibility note

  • Loading branch information...
commit 9bd4eccc8b7608fde930ed6cd8ef08eb1990a555 1 parent 51a6076
Jason Smith authored December 09, 2011

Showing 1 changed file with 9 additions and 3 deletions. Show diff stats Hide diff stats

  1. 12  README.md
12  README.md
Source Rendered
... ...
@@ -1,8 +1,8 @@
1 1
 # Ping the CouchDB query server
2 2
 
3  
-Pingquery CouchDB is a plugin to help ascertain whether the query server is working normally. It provides a new URL where an admin can submit an expression in that language, (`2 + 2`), and compare it to the expected output (`4`).
  3
+Pingquery is a plugin to help ascertain whether the query server is working normally. It provides a new URL where an admin can submit an expression in that language, (`2 + 2`), and compare it to the expected output (`4`).
4 4
 
5  
-## Example: a good ping
  5
+## Good ping example
6 6
 
7 7
     POST /_pingquery/javascript HTTP/1.1
8 8
     Authorization: Basic <admin credentials>
@@ -20,7 +20,7 @@ Pingquery CouchDB is a plugin to help ascertain whether the query server is work
20 20
 
21 21
     {"ok":true,"match":"Hello, world"}
22 22
 
23  
-## Example: a bad ping
  23
+## Bad ping example
24 24
 
25 25
     POST /_pingquery/javascript HTTP/1.1
26 26
     Authorization: Basic <admin credentials>
@@ -48,6 +48,12 @@ I like to use cURL from a cron job to detect problems:
48 48
     $ echo $?
49 49
     0
50 50
 
  51
+## Compatibility
  52
+
  53
+Pingquery works with all query server languages: JavaScript, CoffeeScript, Native (Erlang), Python, Ruby, etc.
  54
+
  55
+To execute a ping, the plugin tricks the query server into running a standard `_show` function, then examines the output.
  56
+
51 57
 ## Building
52 58
 
53 59
 If you hate Freedom, just sign up for an [Iris Couch][ic] account, since they run hosted CouchDB with this plugin.

0 notes on commit 9bd4ecc

Please sign in to comment.
Something went wrong with that request. Please try again.