Return-Path: Delivered-To: apmail-couchdb-commits-archive@www.apache.org Received: (qmail 5301 invoked from network); 9 Dec 2009 09:22:31 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 9 Dec 2009 09:22:31 -0000 Received: (qmail 51155 invoked by uid 500); 9 Dec 2009 09:22:31 -0000 Delivered-To: apmail-couchdb-commits-archive@couchdb.apache.org Received: (qmail 51039 invoked by uid 500); 9 Dec 2009 09:22:30 -0000 Mailing-List: contact commits-help@couchdb.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@couchdb.apache.org Delivered-To: mailing list commits@couchdb.apache.org Received: (qmail 51028 invoked by uid 500); 9 Dec 2009 09:22:29 -0000 Delivered-To: apmail-incubator-couchdb-commits@incubator.apache.org Received: (qmail 51025 invoked by uid 99); 9 Dec 2009 09:22:29 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 09 Dec 2009 09:22:29 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.130] (HELO eos.apache.org) (140.211.11.130) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 09 Dec 2009 09:22:27 +0000 Received: from eos.apache.org (localhost [127.0.0.1]) by eos.apache.org (Postfix) with ESMTP id EE8EB16E07; Wed, 9 Dec 2009 09:22:05 +0000 (GMT) MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable From: Apache Wiki To: Apache Wiki Date: Wed, 09 Dec 2009 09:22:05 -0000 Message-ID: <20091209092205.12216.52526@eos.apache.org> Subject: =?utf-8?q?=5BCouchdb_Wiki=5D_Update_of_=22API=5FCheatsheet=22_by_DirkjanO?= =?utf-8?q?chtman?= X-Virus-Checked: Checked by ClamAV on apache.org Dear Wiki user, You have subscribed to a wiki page or wiki category on "Couchdb Wiki" for c= hange notification. The "API_Cheatsheet" page has been changed by DirkjanOchtman. The comment on this change is: Summarize all API endpoints in condensed tab= le format.. http://wiki.apache.org/couchdb/API_Cheatsheet?action=3Ddiff&rev1=3D8&rev2= =3D9 -------------------------------------------------- - See [[HTTP_view_API]] for the view options that apply to most ''GET'' ope= rations. + See [[HTTP_view_API]] for the view options that apply to many ''GET'' ope= rations. = - =3D CouchDB Server Level Requests =3D + =3D CouchDB Server Level =3D = - =3D=3D info =3D=3D + ||/||Info||GET||Get MOTD and version|||| + ||/_all_dbs||Databases||GET||Get a list of databases|||| + ||/_config||Config||GET||Get configuration data|||| + ||/_uuids||UUIDs||GET /_uuids?count=3D1||Get a number of UUIDs|||| + ||/_replicate||Replication||POST /_replicate source=3Dx&target=3Dy||Repli= cate, see [[Replication]]|||| + ||/_active_tasks||Active tasks||GET /_active_tasks||Active task list (com= paction, replication, etc.)|||| = + =3D Database level =3D - GET / - = - =3D=3D all_dbs =3D=3D - = - GET /_all_dbs - = - =3D=3D config =3D=3D - = - GET /_config - = - =3D=3D stats =3D=3D - = - GET /_stats - = - =3D=3D UUIDs =3D=3D - = - GET /_uuids (takes a count parameter) - = - =3D=3D replicate =3D=3D - = - POST /_replicate (see [[Replication]]) - = - =3D CouchDB Database Level Requests =3D = '''Note''': Document names must always have embedded '''/''' translated t= o '''%2F'''. E.g. "GET /'''db'''/foo%2fbar" for the document named "foo/bar= ". Attachment names may have embedded slashes. = - =3D=3D compact =3D=3D + ||/'''db'''||Creation||PUT /'''db'''||Database creation|||| + ||/'''db'''||Deletion||DELETE /'''db'''||Database deletion|||| + ||/'''db'''||Info||GET /'''db'''||Database information|||| + ||/'''db'''/_compact||Compaction||POST /'''db'''/_compact||Data compactio= n|||| + ||/'''db'''||Documents||GET /'''db'''/_all_docs||List of all documents|||| + ||/'''db'''||Get document||GET /'''db'''/'''doc'''||Retrieve a document||= || + ||/'''db'''||Create document||POST /'''db''' {"foo": "bar"}||Create new d= ocument|||| + ||/'''db'''/'''doc'''||Update document||PUT /'''db'''/'''doc''' {"foo": "= test"}||Save updated document|||| + ||/'''db'''/'''doc'''||Delete document||DELETE /'''db'''/'''doc'''||Delet= e document|||| + ||/'''db'''/_bulk_docs||Bulk document update||POST /'''db'''/_bulk_docs [= {"foo": "bar"}]||Update many documents at once|||| + ||/'''db'''/_temp_view||Temporary view||POST /'''db'''/_temp_View {'''vie= w-code'''}||Run an ad-hoc view|||| + ||/'''db'''/_design/'''design-doc'''/_view/'''view'''||View||GET /'''db''= '/_design/'''design-doc'''/_view/'''view'''||View query (see [[HTTP_view_AP= I]])||(in 0.9.x, this was /'''db'''/_view/'''design-doc'''/'''view''')|| = - POST /'''db'''/_compact - = - =3D=3D create =3D=3D - = - PUT /'''db''' - = - =3D=3D drop =3D=3D - = - DELETE /'''db''' - = - =3D=3D info =3D=3D - = - GET /'''db''' - = - =3D=3D all_docs =3D=3D - = - GET /'''db'''/_all_docs - = - =3D=3D open_doc =3D=3D - = - GET /'''db'''/'''doc_id''' - = - =3D=3D save_doc (CREATE) =3D=3D - = - POST /'''db''' - = - =3D=3D save_doc (UPDATE) =3D=3D - = - PUT /'''db'''/'''doc_id''' - = - =3D=3D remove_doc =3D=3D - = - DELETE /'''db'''/'''doc_id''' - = - =3D=3D bulk_docs =3D=3D - = - POST /'''db'''/_bulk_docs - = - =3D=3D query (aka temporary view) =3D=3D - = - POST /'''db'''/_temp_view - = - =3D=3D view =3D=3D - = - If you are using CouchDB < 0.9.0: - = - GET /'''db'''/_view/'''designname'''/'''viewname''' - = - Otherwise - = - GET /'''db'''/_design/'''designname'''/_view/'''viewname''' -=20