Introduction¶
PSCouchDB is a powershell module to semplify your work on couchdb database.
Warning
Before continuing, install the latest version of CouchDB, following the documentation.
Installation¶
Download and install latest PSCouchDB module by copying it under %Windir%\System32\WindowsPowerShell\v1.0\Modules
for all users or under %UserProfile%\Documents\WindowsPowerShell\Modules
for the current user or install through PowershellGallery.
Note
For unix users the powershell module path is /usr/local/share/powershell/Modules
for all users and ~/.local/share/powershell/Modules
for current user.
Install with git¶
Installation by git from Github.
git clone https://github.com/MatteoGuadrini/PSCouchDB.git
cd PSCouchDB
# for Windows
copy /Y PSCouchDB %Windir%\System32\WindowsPowerShell\v1.0\Modules
# for Unix
cp -var PSCouchDB /usr/local/share/powershell/Modules
Signing¶
Important
This module is not signed. Before import or execute cmdlet on this module, see about_signing session.
Verify execution of scripts is allowed with Get-ExecutionPolicy
(should be RemoteSigned or Unrestricted).
If scripts are not enabled, run PowerShell as Administrator and call Set-ExecutionPolicy RemoteSigned -Scope CurrentUser -Confirm
.
Start¶
To get started, let’s look at all the cmdlets in the module through this command:
Search-CouchDBHelp -Pattern . | Format-Table name -AutoSize
If we wanted to get only the cmdlets for a given task, use:
Search-CouchDBHelp -Pattern replication
and display the help of one the cmdlet found:
Search-CouchDBHelp -Pattern New-CouchDBReplication | Get-Help -Full
or search CouchDB API name:
Search-CouchDBHelp -Pattern _cluster_setup
or help about a module.
Get-Help about_pscouchdb