/
README
171 lines (126 loc) · 5.93 KB
/
README
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
_______ _______ _______ _______ _______ _______
( ____ )( ___ )( ____ \|\ /| ( ____ \( ___ )|\ /|( ____ \|\ /|
| ( )|| ( ) || ( \/| ) ( | | ( \/| ( ) || ) ( || ( \/| ) ( |
| (____)|| | | || (_____ | (___) | _____ | | | | | || | | || | | (___) |
| _____)| | | |(_____ )| ___ |(_____)| | | | | || | | || | | ___ |
| ( | | | | ) || ( ) | | | | | | || | | || | | ( ) |
| ) | (___) |/\____) || ) ( | | (____/\| (___) || (___) || (____/\| ) ( |
|/ (_______)\_______)|/ \| (_______/(_______)(_______)(_______/|/ \|
________________________________________________________________________________________
+-----------------+
| 1. Introduction |
+-----------------+
PoSh-Couch is a PowerShell module for interacting with CouchDB. It provides a way to
interact directly with CouchDB on Windows which does not come with a command-line tool
such as curl for making web requests simply.
+--------------+
| 2. Changelog |
+--------------+
v0.6
----
1. Brings cmdlet names into a consistent, namespaced format.
2. Bugfix: data was output to a file caled "0"; the query string was never appended to
the URL.
3. Introduces new cmdlets for getting a list of all available databases from a
specified server, for retrieving a specific document, for deleting a specific
document, and for deleting a specific database.
v0.5
----
1. Provides error handling of dodgy HTTP requests to CouchDB.
2. Updates the cmdlet-names to be PowerShell-friendly, using the correct PowerShell
verbs.
v0.1
----
Basic functionality available; not officially released.
+-----------------+
| 3. Installation |
+-----------------+
Download the module file, CouchDB.psm1, from http://github.com/downloads/alastairs/
posh-couch/CouchDB.psm1. Save it to a handy location that is easy to reach from the
command-line.
Find the downloaded module file in My Computer and right-click it, choosing
"Properties" from the context menu. On the "General" tab, click the button labelled
"Unblock".
Run a PowerShell console as Administrator. This needs to be done even if you have
administrative privileges on your machine. Run the commmand
> Set-ExecutionPolicy RemoteSigned
Close the Administrator PowerShell window.
+----------+
| 4. Usage |
+----------+
In a regular PowerShell window, run the command
> Import-Module "Path\to\CouchDB.psm1"
If the module import completes successfully, you will receive no feedback.
+----------------------+
| 5. Available cmdlets |
+----------------------+
For a full list of cmdlets provided by this module, run the command
> Get-Command -Module CouchDB
Documentation of each cmdlet, including paramter documentation and examples of usage,
is available by running the command
> Get-Help <cmdlet-name>
v0.6
----
Additions
---------
------------------------|-----------------------------------------
Cmdlet Name | Description
------------------------|-----------------------------------------
Get-CouchDbDatabases | Gets a list of all the available
| CouchDB databases on a server.
------------------------|-----------------------------------------
Get-CouchDbDocument | Retrieves a CouchDB document.
------------------------|-----------------------------------------
Remove-CouchDbDatabase | Deletes a CouchDB database.
------------------------|-----------------------------------------
Remove-CouchDbDocument | Deletes a CouchDB document.
------------------------|-----------------------------------------
Modifications
-------------
---------------------|---------------------------------|------------------------------
Cmdlet Name | Description | Modification Notes
---------------------|---------------------------------|------------------------------
New-CouchDbDatabase | Creates a new CouchDB database. | Renamed from New-Database.
---------------------|---------------------------------|------------------------------
New-CouchDbDocument | Creates a new document in the | Renamed from New-Document.
| specified CouchDB database. |
---------------------|---------------------------------|------------------------------
Deletions
---------
None.
v0.5
----
Additions
---------
None.
Modifications
-------------
-----------------|---------------------------------|---------------------------------
Cmdlet Name | Description | Modification Notes
-----------------|---------------------------------|---------------------------------
New-Database | Creates a new CouchDB database. | Renamed from Create-Database.
-----------------|---------------------------------|---------------------------------
New-Document | Creates a new document in the | Renamed from Create-Document.
| specified CouchDB database. |
-----------------|---------------------------------|---------------------------------
Deletions
---------
None.
v0.1
----
Additions
---------
---------------------|-----------------------------------------
Cmdlet Name | Description
---------------------|-----------------------------------------
Create-Database | Creates a new CouchDB database.
---------------------|-----------------------------------------
Create-Document | Creates a new document in the
| specified CouchDB database.
---------------------|-----------------------------------------
Modifications
-------------
None.
Deletions
---------
None.