-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcouchdb-cheat-sheet.tex
750 lines (653 loc) · 22 KB
/
couchdb-cheat-sheet.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
\documentclass[19pt,landscape,twocolumn]{article}
% PDF Bauen: pdflatex ./couchdb-cheat-sheet.tex
% fonts
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[german]{babel}
% document format
\usepackage{lscape}
\usepackage[top=1cm, bottom=1.5cm, left=1cm, right=1cm]{geometry}
\setlength{\parskip}{1.65mm plus0mm minus2mm}
% listings
\usepackage{fancyvrb} % http://ftp.math.purdue.edu/mirrors/ctan.org/macros/latex/contrib/fancyvrb/fancyvrb.pdf
\usepackage{color} % http://en.wikibooks.org/wiki/LaTeX/Colors
\definecolor{midnightblue}{rgb}{0.098,0.098,0.439}
\definecolor{grey}{RGB}{97,97,97}
% footer
\usepackage{fancyhdr} % ftp://ftp.mpi-sb.mpg.de/pub/tex/mirror/ftp.dante.de/pub/tex/macros/latex/contrib/fancyhdr/fancyhdr.pdf
\pagestyle{fancyplain}
\fancyhf{}
\renewcommand{\headrulewidth}{0pt}
\renewcommand{\footrulewidth}{0pt}
\lfoot{\fancyplain{}{CouchDB Cheat Sheet - Andreas Wenk}}
\rfoot{\fancyplain{}{\thepage}}
% URLs
\usepackage[pdfborder={0 0 0},urlcolor=blue,colorlinks=true,citecolor=blue]{hyperref}
% section formatting
\usepackage{titlesec}
\titleformat{\section}{\bf\fontsize{12}{12}\selectfont}{\thesection\quad}{0em}{}
\titleformat{\subsection}{\bf\fontsize{10}{10}\selectfont}{\thesubsection\quad}{0em}{}
% my commands
\newcommand{\mono}[1]{\texttt{\textendash\textendash {#1}}}
\newcommand{\htmlverb}[1]{{[}\textbf{{#1}}{]}}
\newcommand{\brackets}[1]{{[}{#1}{]}}
\newcommand{\setparskip}{\setlength{\parskip}{-6mm}}
\newcommand{\resetparskip}{\setlength{\parskip}{1mm}}
\DefineVerbatimEnvironment{code}{Verbatim}{fontsize=\small,xleftmargin=5mm,formatcom=\color{midnightblue}}
\DefineVerbatimEnvironment{response}{Verbatim}{baseline=t,fontsize=\footnotesize,xleftmargin=5mm,formatcom=\color{grey}}
\begin{document}
% set the font size for the whole document
\fontsize{9}{10}\selectfont
% title
\title{CouchDB-Cheat-Sheet}
\author{Andreas Wenk -- Version: 0.2.0 -- August 2011}
\date{}
\maketitle
\begin{abstract}
Dieses Cheat-Sheet ist eine Übersicht der RESTful API von CouchDB \cite{1}. Das Ziel ist es,
die gebräuchlichsten Requests jeweils anhand eines Beispiels zu zeigen. Unter \cite{2}
ist eine CouchDB zu finden, in der die Beispiele nachgestellt werden können (Basic-Auth: ohne
Daten `ok' klicken).
Unter \cite{3} ist die API-Referenz zu finden.
Damit die Listings so kurz als möglich sind, heisst die Datenbank, die als Beispiel dienen
soll `kina'. Die Grundstruktur der Dokumente in dieser Datenbank ist folgendermaßen:
\begin{code}
{
"_id": "fab911e6e9ed703bf536dccffe000937",
"_rev": "1-183f162a09532ccacf8223f6e2ba95f6",
"lang": "javascript"
}
\end{code}
Alle Beispiel-Requests werden unter Verwendung von cURL \cite{10} erstellt. Natürlich kann auch das von
CouchDB mitgelieferte Webinterface `Futon' genutzt werden. Allerdings rate ich davon ab, da
bei der Verwendung von cURL die Betrachtung der HTTP-Response zu wesentlich mehr Verständnis führt.
\end{abstract}
\section{Überblick}
CouchDB ist eine dokumentbasierte Datenbank und gehört zur Gruppe der NoSQL Datenbanken. CouchDB
ist ein Apache Open-Source Projekt und liegt aktuell in der Version 1.1.0 vor. Einige wichtige
Merkmale von CouchDB sind:
\begin{itemize}
\setlength{\parskip}{0pt}
\item in Erlang \cite{4} geschrieben
\item schemalos
\item API: HTTP Rest \cite{5}
\item implementiert ACID \cite{6} über MVCC \cite{7}
\item CAP Theorem \cite{8}:
\begin{itemize}
\item A (Availability) - ja
\item P (Partition Tolerance) - ja
\item C (Consistency) -> Eventual Consistency
\end{itemize}
\item MapReduce \cite{9} für Views
\item Asynchrone Replikation in beide Richtungen - Master / Master
\item Revisions Management
\end{itemize}
\section{Datenbanken}
\subsection{Alle Datenbanken im Cluster \htmlverb{GET} \htmlverb{\_all\_dbs}}
\begin{code}
curl -X GET http://127.0.0.1:5984/_all_dbs
\end{code}
\setparskip
\begin{response}
["_replicator","_users"]
\end{response}
\resetparskip
\subsection{Datenbank erstellen \htmlverb{PUT}}
\begin{code}
curl -X PUT http://127.0.0.1:5984/kina
\end{code}
\setparskip
\begin{response}
{"ok": true}
\end{response}
\resetparskip
\subsection{Datenbankinformationen erhalten \htmlverb{GET}}
\begin{code}
curl -X GET http://127.0.0.1:5984/kina
\end{code}
\setparskip
\begin{response}
{"db_name":"kina",
"doc_count":0,
"doc_del_count":0,
"update_seq":0,
"purge_seq":0,
"compact_running":false,
"disk_size":79,
"instance_start_time":"1312577294992829",
"disk_format_version":5,
"committed_update_seq":0}
\end{response}
\resetparskip
\subsection{Datenbank löschen \htmlverb{DELETE}}
\begin{code}
curl -X DELETE http://127.0.0.1:5984/kina
\end{code}
\setparskip
\begin{response}
{"ok": true}
\end{response}
\resetparskip
\subsection{Datenbank replizieren \htmlverb{POST} \htmlverb{\_replicate} (alte API)}
\emph{(params)} source=\brackets{url}, target=\brackets{url}, cancel=\brackets{true}, create\_target=\brackets{true},\newline
continuous=\brackets{true}, doc\_ids=\brackets{doc\_ids\_array}, filter=\brackets{filter\_name},\newline
proxy=\brackets{url}, query\_params=\brackets{params}
\subsubsection{lokal nach lokal}
\begin{code}
curl -X POST http://127.0.0.1:5984/_replicate \
-H "content-type:application/json" \
-d '{"source": "kina",
"target": "anik",
"create_target": true}'
\end{code}
\setparskip
\begin{response}
{"ok":true, "session_id":"f75eb944bac70f40e77953f484afb64c",
"source_last_seq":36, "history":
[{"session_id":"f75eb944bac70f40e77953f484afb64c",
"start_time":"Thu, 14 Apr 2011 20:36:12 GMT",
"end_time":"Thu, 14 Apr 2011 20:36:12 GMT",
"start_last_seq":0,
"end_last_seq":36,
"recorded_seq":36,
"missing_checked":0,
"missing_found":14,
"docs_read":14,
"docs_written":14,
"doc_write_failures":0
}]
}
\end{response}
\resetparskip
\subsubsection{remote nach lokal (umgekehrt genauso)}
\emph{(!)} Bei der Nutzung von \mono{create\_target} muss die Authentifizierung mit einem
User der Zieldatenbank erfolgen.
\begin{code}
curl -X POST http://127.0.0.1:5984/_replicate \
-H "content-type:application/json" \
-d '{"source": "kina",
"target": "http://starsky:[email protected]/anik",
"create_target": true}'
\end{code}
\setparskip
\begin{response}
{"ok":true,"session_id":"ed5fa48d0a5ce9cee6941381754d796d",
"source_last_seq":29,"replication_id_version":2,
"history":
[{"session_id":"ed5fa48d0a5ce9cee6941381754d796d",
"start_time":"Wed, 31 Aug 2011 19:34:40 GMT",
"end_time":"Wed, 31 Aug 2011 19:34:41 GMT",
"start_last_seq":0,
"end_last_seq":29,"recorded_seq":29,
"missing_checked":0,
"missing_found":14,
"docs_read":14,
"docs_written":14,
"doc_write_failures":0
}]
}
\end{response}
\resetparskip
\subsubsection{remote nach remote}
\begin{code}
curl -X POST http://127.0.0.1:5984/_replicate \
-H "content-type:application/json" \
-d '{"source": "http://andywenk.cloudant.com/kina",
"target": "http://starsky:[email protected]/kina",
"create_target": true}'
\end{code}
\setparskip
\begin{response}
{"ok":true,"no_changes":true}
\end{response}
\resetparskip
\subsection{Datenbank replizieren - filter}
Filter werden in \_design Dokumenten erstellt. Ein Filter kann später bei der Replikation genutzt werden, um nur
Dokumente zu replizieren, die den im Filter hinterlegten Kriterien entsprechen.
Filter erstellen:
\begin{code}
curl -X PUT http://127.0.0.1:5984/kina/_design/default \
-H "content-type: application/json" \
-d '{"filters":{
"lang":
"function(doc, req) {
return \"javascript\" == doc.lang
}"
}
}'
\end{code}
Filter anwenden (davon ausgehend, es gibt drei Dokumente mit lang = javascript):
\begin{code}
curl -X POST http://127.0.0.1:5984/_replicate \
-H "content-type:application/json" \
-d '{"source": "kina",
"target": "anik",
"create_target": true,
"filter": "default/lang"}'
\end{code}
\setparskip
\begin{response}
{"ok":true,"session_id":"3546d87233636b04440e6e023c3e3018",
"source_last_seq":6,
"replication_id_version":2, "history":
[{"session_id":"3546d87233636b04440e6e023c3e3018",
[...]
"docs_read":3,
"docs_written":3,
"doc_write_failures":0
}]
}
\end{response}
\resetparskip
Filter erstellen mit dynamischem Parameter (Auszug):
\begin{code}
curl [...]
-d '{"filters":{
"lang":
"function(doc, req) {
return req.query.lang == doc.lang
}"
}
}'
\end{code}
Filter anwenden (Auszug):
\begin{code}
curl [...]
-d '{"source": "kina",
"target": "anik",
"create_target": true,
"query_params": {
"lang":"javascript"
}
}'
\end{code}
Filter andwenden unter Angabe von genauen Dokument IDs (Auszug):
\begin{code}
curl [...]
-d '{"source": "kina",
"target": "anik",
"create_target": true,
"doc_ids": ["id_1", "id_2", "id_n"]
}'
\end{code}
\subsection{Datenbank replizieren mit der Datenbank \htmlverb{\_replicate}}
\emph{(params)} source=\brackets{url}, target=\brackets{url}, cancel=\brackets{true}, create\_target=\brackets{true},\newline
continuous=\brackets{true}, doc\_ids=\brackets{doc\_ids\_array}, filter=\brackets{filter\_name},\newline
proxy=\brackets{url}, query\_params=\brackets{params}\newline
Dokumentation unter \cite{11} zu finden
\subsection{Änderungen in der DB verfolgen \htmlverb{GET} \htmlverb{\_changes}}
\emph{(params)} since=\brackets{sequence\_number}, style=all\_docs, limit=\brackets{n}, \newline
feed=\brackets{continuous,longpolling}, heartbeat=\brackets{milliseconds} \newline
filter=filter\_name, include\_docs=\brackets{true,false}, timeout=\brackets{milliseconds}
\begin{code}
curl -X GET "http://127.0.0.1:5984/kina/_changes \
?feed=continuous&heartbeat=2000"
\end{code}
\setparskip
\begin{response}
{"seq":3,"id":"kn0001","changes":
[{"rev":"3-5570e8bbb34412db757c2df4bfa1099b"}]}
{"seq":4,"id":"fab911e6e9ed703bf536dccffe000937","changes":
[{"rev":"1-183f162a09532ccacf8223f6e2ba95f6"}]}
[...]
\end{response}
\resetparskip
\subsection{Aktuelle tasks abfragen \htmlverb{GET} \htmlverb{\_active\_tasks}}
\begin{code}
curl -X GET http://127.0.0.1:5984/_active_tasks
\end{code}
\setparskip
\begin{response}
[{"pid":"<0.7356.3>","changes_done":159756,
"database":"kina","progress":6,
"started_on":1359732010,"total_changes":2292848,
"type":"database_compaction","updated_on":1359732068
}]
\end{response}
\resetparskip
\subsection{Compaction: Datenbank \htmlverb{POST} \htmlverb{\_compact}}
\begin{code}
curl -X POST http://127.0.0.1:5984/kina/_compact \
-H "content-type:application/json"
\end{code}
\setparskip
\begin{response}
{"ok":true}
\end{response}
\resetparskip
\subsection{Compaction: Design Dokumente \htmlverb{POST} \htmlverb{\_compact/design-doc}}
\begin{code}
curl -X POST http://127.0.0.1:5984/kina/_compact/default \
-H "content-type:application/json"
\end{code}
\setparskip
\begin{response}
{"ok":true}
\end{response}
\resetparskip
\subsection{Compaction: Views \htmlverb{POST} \htmlverb{\_view\_cleanup}}
\begin{code}
curl -X POST http://127.0.0.1:5984/kina/_view_cleanup \
-H "content-type:application/json"
\end{code}
\setparskip
\begin{response}
{"ok":true}
\end{response}
\resetparskip
\section{Dokumente}
Prinzipiell sollte beim Erstellen auf IDs zurückgegriffen werden, die CouchDB
generiert. Allerdings macht es in manchen Fällen auch Sinn eigene IDs zu nutzen.
\subsection{UUIDs ausgeben \htmlverb{GET} \htmlverb{\_uuids}}
\emph{(params)} count={[}n{]}
\begin{code}
curl -X GET http://127.0.0.1:5984/_uuids?count=3
\end{code}
\setparskip
\begin{response}
{"uuids":
["b7fc0ca7dffcc6d0f240c1e5bb000998",
"b7fc0ca7dffcc6d0f240c1e5bb000fe8",
"b7fc0ca7dffcc6d0f240c1e5bb001c9a"]
}
\end{response}
\resetparskip
\subsection{Alle Dokumente erhalten \htmlverb{GET} \htmlverb{\_all\_docs}}
\emph{(params)} descending=true, key=\brackets{key}, st-artkey=\brackets{key}, startkey\_docid=\brackets{docid}, \newline
endkey=\brackets{key}, endkey\_docid=\brackets{docid}, group=\brackets{true,false}, group\_level=\brackets{0-n}, \newline
inclusive\_end=\brackets{true,false}, limit=\brackets{n}, reduce=\brackets{true,false}, skip=\brackets{n}, stale=ok, \newline
update\_seq=\brackets{true,false}
\begin{code}
curl -X GET http://127.0.0.1:5984/kina/_all_docs
\end{code}
\setparskip
\begin{response}
{"total_rows":12,"offset":0,"rows":[
{"id":"7341477ce373f9cc76f351e5980008bb",
"key":"7341477ce373f9cc76f351e5980008bb",
"value":{"rev":"2-f0bfca3976ad04bce05b2ade242519d7"}},
{"id":"7341477ce373f9cc76f351e5980015cd",
"key":"7341477ce373f9cc76f351e5980015cd",
"value":{"rev":"2-d6f5f2cb326c1f68f95d2bfbef329280"}}]}
\end{response}
\resetparskip
\subsection{Mehrere Dokumente mit key(id) erhalten \htmlverb{POST} \htmlverb{\_all\_docs}}
\emph{(params)} siehe: Alle Dokumente erhalten \newline
\emph{(!)} gut nutzbar, um mit einem Request mehrere Dokumente zu erhalten
\begin{code}
curl -X POST http://127.0.0.1:5984/kina/_all_docs?include_docs=true \
-H "content-type:application/json" \
-d '{"keys": [
"fab911e6e9ed703bf536dccffe000937",
"7341477ce373f9cc76f351e5980015cd"
]}'
\end{code}
\setparskip
\begin{response}
{"total_rows":12,"offset":0,"rows":[
{"id":"fab911e6e9ed703bf536dccffe000937",
"key":"fab911e6e9ed703bf536dccffe000937",
"value":{"rev":"1-183f162a09532ccacf8223f6e2ba95f6"},
"doc":{"_id":"fab911e6e9ed703bf536dccffe000937",
"_rev":"1-183f162a09532ccacf8223f6e2ba95f6",
"lang":"javascript"}},
{"id":"7341477ce373f9cc76f351e5980015cd",
"key":"7341477ce373f9cc76f351e5980015cd",
"value":{"rev":"3-99b698d0caba3c9892a385dd0efe2a3d"},
"doc":{"_id":"7341477ce373f9cc76f351e5980015cd",
"_rev":"3-99b698d0caba3c9892a385dd0efe2a3d",
"lang":"lisp"}}
]}
\end{response}
\resetparskip
\subsection{Dokument erstellen mit CouchDB ID \htmlverb{PUT}}
\begin{code}
curl -X PUT http://127.0.0.1:5984/kina/ \
b7fc0ca7dffcc6d0f240c1e5bb000998
\end{code}
\setparskip
\begin{response}
{"ok":true,"id":"b7fc0ca7dffcc6d0f240c1e5bb000998",
"rev":"1-967a00dff5e02add41819138abb3284d"}
\end{response}
\resetparskip
\subsection{Dokument erstellen mit eigener ID \htmlverb{PUT}}
\begin{code}
curl -X PUT http://127.0.0.1:5984/kina/kn0001 -d '{}'
\end{code}
\setparskip
\begin{response}
{"ok":true,"id":"kn0001",
"rev":"3-5570e8bbb34412db757c2df4bfa1099b"}
\end{response}
\resetparskip
\subsection{Dokument erstellen \htmlverb{POST}}
\begin{code}
curl -X POST http://127.0.0.1:5984/kina/ \
-H "content-type: application/json" \
-d '{}'
\end{code}
\setparskip
\begin{response}
{"ok":true,"id":"b7fc0ca7dffcc6d0f240c1e5bb000fe8",
"rev":"1-367b00dfc5e02axd41819138abb3284d"}
\end{response}
\resetparskip
\subsection{Dokument anfragen \htmlverb{GET}}
\emph{(params)} rev={[}revision{]}, revs=true, revs\_info=true
\begin{code}
curl -X GET http://127.0.0.1:5984/kina/ \
b7fc0ca7dffcc6d0f240c1e5bb000998
\end{code}
\setparskip
\begin{response}
{"_id":"b7fc0ca7dffcc6d0f240c1e5bb000998",
"_rev":"1-367b00dfc5e02axd41819138abb3284d",
"inhalt":"hier steht was"}
\end{response}
\resetparskip
\subsection{Dokument erweitern / aktualisieren \htmlverb{PUT}}
\emph{(params)} rev=revision \newline
\emph{(header)} if-match=revision
\begin{code}
curl -X PUT http://127.0.0.1:5984/kina/ \
fab911e6e9ed703bf536dccffe000937 \
-d '{"_rev":"1-183f162a09532ccacf8223f6e2ba95f6",
"lang": "php"}'
\end{code}
\begin{code}
curl -X PUT http://127.0.0.1:5984/kina/ \
fab911e6e9ed703bf536dccffe000937 \
-H "if-match:1-183f162a09532ccacf8223f6e2ba95f6" \
-d '{"lang":"php"}'
\end{code}
\setparskip
\begin{response}
{"ok":true,"id":"fab911e6e9ed703bf536dccffe000937",
"rev":"2-cf8bad0865d8296870352617ab3afdba"}
\end{response}
\resetparskip
\subsection{Dokument löschen \htmlverb{DELETE}}
\emph{(params)} rev=revision \newline
\emph{(header)} if-match=revision \newline
\emph{(!)} Dokument wird nur aus dem Index gelöscht und markiert \newline
mit \mono{deleted:true}
\begin{code}
curl -X DELETE http://127.0.0.1:5984/kina/ \
7341477ce373f9cc76f351e598001cdd \
?rev=1-9533bf3b3c5cda717ed000b186fdafae
\end{code}
\begin{code}
curl -X DELETE http://127.0.0.1:5984/kina/ \
7341477ce373f9cc76f351e598001cdd \
-H "if-match:1-9533bf3b3c5cda717ed000b186fdafae"
\end{code}
\setparskip
\begin{response}
{"ok":true,"id":"7341477ce373f9cc76f351e598001cdd",
"rev":"2-5c7fb5dfeaf6f7cea149922fa1cdaf96"}
\end{response}
\resetparskip
\subsection{Dokument-Attachment speichern \htmlverb{PUT}}
\emph{(params)} rev=revision \newline
\emph{(headers)} content-length:\brackets{bytes}, content-type:\brackets{MIME-type document}, if-match:revision
\emph{(!)} generell könnte auch nur die Option \mono{data} für eine reine Textdatei \newline
verwendet werden
\begin{code}
curl -X PUT http://127.0.0.1:5984/kina/ \
b7fc0ca7dffcc6d0f240c1e5bb000998/ \
geburtstag.txt?rev=2-1726cd3e40ffd356591114f014b1ac22 \
--data-binary @geburtstag.txt \
-H "content-type: text/plain;charset=utf-8"
\end{code}
\setparskip
\begin{response}
HTTP/1.1 201 Created
Server: CouchDB/1.1.0 (Erlang OTP/R14B03)
Location: http://127.0.0.1:5984/datenbankname/
b7fc0ca7dffcc6d0f240c1e5bb000998/geburtstag.txt
Etag: "2-1726cd3e40ffd356591114f014b1ac22"
Date: Mon, 07 Feb 2011 22:53:25 GMT
Content-Type: text/plain;charset=utf-8
Content-Length: 66
Cache-Control: must-revalidate
{"ok":true,"id":"b7fc0ca7dffcc6d0f240c1e5bb000998",
"rev":"2-1726cd3e40ffd356591114f014b1ac22"}
\end{response}
\resetparskip
\subsection{Dokument-Attachment anfragen \htmlverb{GET}}
\begin{code}
curl -X GET http://127.0.0.1:5984/kina/ \
b7fc0ca7dffcc6d0f240c1e5bb000998/geburtstag.txt
\end{code}
\setparskip
\begin{response}
HTTP/1.1 200 OK
Server: CouchDB/1.1.0 (Erlang OTP/R14B03)
ETag: "2-1726cd3e40ffd356591114f014b1ac22"
Date: Sun, 28 Aug 2011 20:32:14 GMT
Content-Type: text/plain;charset=utf-8
Content-Length: 66
Cache-Control: must-revalidate
Accept-Ranges: none
\end{response}
\resetparskip
\subsection{Dokument-Attachment löschen \htmlverb{DELETE}}
\emph{(params)} rev=revision \newline
\emph{(headers)} if-match:revision
\begin{code}
curl -X GET http://127.0.0.1:5984/kina/ \
b7fc0ca7dffcc6d0f240c1e5bb000998/geburtstag.txt
\end{code}
\setparskip
\begin{response}
{"ok":true,"id":"b7fc0ca7dffcc6d0f240c1e5bb000998",
"rev":"3-f1d8176c2ea671ad75bd85a55dea4d05"}
\end{response}
\resetparskip
\subsection{Dokument permanent löschen \htmlverb{POST} \htmlverb{\_purge}}
\emph{(!)} Refernez zum Dokument wird gelöscht; wird nicht repliziert. Um den\newline
Plattenplatz auch frei zu bekommen, muss \mono{\_compact} ausgeführt werden
\begin{code}
curl -X POST http://127.0.0.1:5984/kina/_purge/ \
-H "content-type:application/json" \
-d '{"7341477ce373f9cc76f351e598001cdd":
["2-5c7fb5dfeaf6f7cea149922fa1cdaf96"]
}'
\end{code}
\setparskip
\begin{response}
{"purge_seq":1,"purged":{
"7341477ce373f9cc76f351e598001cdd":
["2-5c7fb5dfeaf6f7cea149922fa1cdaf96"]
}
}
\end{response}
\resetparskip
\subsection{Dokument Info \htmlverb{HEAD}}
\emph{(params)} rev=revision, revs=\brackets{true,false}, revs\_info=\brackets{true,false}
\begin{code}
curl --head -X GET http://127.0.0.1:5984/kina/ \
fab911e6e9ed703bf536dccffe000937?revs=true
\end{code}
\setparskip
\begin{response}
HTTP/1.1 200 OK
Server: CouchDB/1.1.0 (Erlang OTP/R14B03)
Etag: "1-183f162a09532ccacf8223f6e2ba95f6"
Date: Sun, 28 Aug 2011 14:40:35 GMT
Content-Type: text/plain;charset=utf-8
Content-Length: 175
Cache-Control: must-revalidate
\end{response}
\resetparskip
\subsection{Dokument kopieren \htmlverb{COPY}}
\emph{(i)} Die ID 7341477ce373f9cc76f351e598001d4c wurde zuerst per \_uuids request \newline
erfragt. Um in ein bestehendes Dokument zu kopieren, wird die ID des Zieldokuments angegeben
\emph{(header)} Destination:docid \newline
\emph{(params)} rev=revision
\begin{code}
curl -X COPY http://127.0.0.1:5984/kina/ \
fab911e6e9ed703bf536dccffe000937 \
-H "destination:7341477ce373f9cc76f351e598001d4c"
\end{code}
\setparskip
\begin{response}
{"id":"7341477ce373f9cc76f351e598001d4c",
"rev":"1-5a5db37cb3735e769ea8d133b28f04a1"}
\end{response}
\resetparskip
\subsection{Mehrere Dokumente anlegen \htmlverb{POST} \htmlverb{\_bulk\_docs}}
\emph{(options)} all\_or\_nothing:\brackets{true,false (=non-atomic=default)}, docs:\brackets{key:value,...}
\begin{code}
curl -X POST http://127.0.0.1:5984/kina/_bulk_docs \
-H "content-type:application/json" \
-d '{"docs":[
{"lang":"c"},
{"lang":"c++"}
]}'
\end{code}
\setparskip
\begin{response}
[{"id":"7341477ce373f9cc76f351e5980008bb",
"rev":"1-f491c132ea24ecf492e0b5ae18467876"},
{"id":"7341477ce373f9cc76f351e5980015cd",
"rev":"1-9533bf3b3c5cda717ed000b186fdafae"}]
\end{response}
\resetparskip
\subsection{Mehrere Dokumente aktualisieren \htmlverb{POST} \htmlverb{\_bulk\_docs}}
\emph{(options)} all\_or\_nothing:\brackets{true,false (=non-atomic=default)}, docs:\brackets{key:value,...}
\begin{code}
curl -X POST http://127.0.0.1:5984/kina/_bulk_docs \
-H "content-type:application/json" \
-d '{"docs":[
{"_id":"7341477ce373f9cc76f351e5980008bb",
"_rev": "1-f491c132ea24ecf492e0b5ae18467876",
"lang":"erlang"},
{"_id":"7341477ce373f9cc76f351e5980015cd",
"_rev":"1-9533bf3b3c5cda717ed000b186fdafae",
"lang":"lisp"}
]}'
\end{code}
\setparskip
\begin{response}
[{"id":"7341477ce373f9cc76f351e5980008bb",
"rev":"2-f0bfca3976ad04bce05b2ade242519d7"},
{"id":"7341477ce373f9cc76f351e5980015cd",
"rev":"2-d6f5f2cb326c1f68f95d2bfbef329280"}]
\end{response}
\resetparskip
\begin{thebibliography}{sotief}
\bibitem{1}\url{http://couchdb.apache.org}
\bibitem{2}\url{https://cloudant.com/futon/database.html?andywenk%2Fkina}
\bibitem{3}\url{http://wiki.apache.org/couchdb/Reference}
\bibitem{4}\url{http://www.erlang.org}
\bibitem{5}\url{http://en.wikipedia.org/wiki/Representational_State_Transfer}
\bibitem{6}\url{http://en.wikipedia.org/wiki/ACID}
\bibitem{7}\url{http://en.wikipedia.org/wiki/Multiversion_concurrency_control}
\bibitem{8}\url{http://www.julianbrowne.com/article/viewer/brewers-cap-theorem}
\bibitem{9}\url{http://en.wikipedia.org/wiki/MapReduce}
\bibitem{10}\url{http://curl.haxx.se/}
\bibitem{11}\url{https://gist.github.com/832610}
\end{thebibliography}
\end{document}