Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matteoguadrini/pscouchdb
Advanced CLI for CouchDB server
https://github.com/matteoguadrini/pscouchdb
cli cloudant cloudant-database cloudant-nosql-database cmdlet couchbase couchbase-cluster couchbase-exporter couchbase-server couchdb couchdb-adapter couchdb-client couchdb-database couchdb-mango couchdb-server database powershell powershell-cmdlets powershell-gallery powershell-module
Last synced: about 1 month ago
JSON representation
Advanced CLI for CouchDB server
- Host: GitHub
- URL: https://github.com/matteoguadrini/pscouchdb
- Owner: MatteoGuadrini
- License: gpl-3.0
- Created: 2018-01-26T12:15:44.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T12:29:21.000Z (over 1 year ago)
- Last Synced: 2023-10-20T21:41:20.806Z (about 1 year ago)
- Topics: cli, cloudant, cloudant-database, cloudant-nosql-database, cmdlet, couchbase, couchbase-cluster, couchbase-exporter, couchbase-server, couchdb, couchdb-adapter, couchdb-client, couchdb-database, couchdb-mango, couchdb-server, database, powershell, powershell-cmdlets, powershell-gallery, powershell-module
- Language: PowerShell
- Homepage: https://matteoguadrini.github.io/PSCouchDB
- Size: 11.7 MB
- Stars: 38
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PSCouchDB: Advanced CLI for CouchDB server
**Docs**: [ReadTheDocs](https://pscouchdb.readthedocs.io)
## Installation and simple usage
1. Download and install CouchDB following the [docs](http://docs.couchdb.org/en/latest/install/index.html).
2. 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](https://www.powershellgallery.com/packages/PSCouchDB).
> INFORMATION: This module is not signed. Before import or execute cmdlet on this module, see [about_signing](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_signing) session. To skip this part and continue, run ```Set-ExecutionPolicy -ExecutionPolicy Unrestricted```
> ATTENTION: If you are using CouchDB version 2, use the PSCouchDB 1.X version; if instead you are using CouchDB version 3 or 4, use the PSCouchDB version 2.X```
3. Now, configure database mode, in single node (cluster of one single node) or cluster, run this cmdlet:
```powershell
# Single node cluster
Enable-CouchDBCluster -SingleNode -Authorization "admin:password"
# Cluster (with three node)
Enable-CouchDBCluster -Authorization "admin:password"
```
For more details, see the [docs](https://pscouchdb.readthedocs.io/en/latest/config.html).
4. Now, open powershell and create a first personal database:
```powershell
New-CouchDBDatabase -Database test -Authorization "admin:password"
```
5. Create a sample document for `test` database:
```powershell
$Data = '{
"name": "Arthur Dent",
"planet": "Heart"
}'
New-CouchDBDocument -Database test -Document "Hitchhikers" -Data $Data -Authorization "admin:password"
```
6. Add attachment file in our docuemnt:
```powershell
$rev = (Get-CouchDBDocument -Database test -Document "Hitchhikers")._rev
"Ultimate Question of Life, the Universe and Everything" | Out-File C:\file.txt
New-CouchDBAttachment -Database test -Document "Hitchhikers" -revision $rev -Attachment C:\file.txt -Authorization "admin:password"
```
7. Finally, get a document:
```powershell
Get-CouchDBAttachment -Database test -Document "Hitchhikers" -Attachment file.txt
```
These are just some of the operations you can do with this CLI.
PSCouchDB supports all [API](https://docs.couchdb.org/en/stable/api/index.html) of CouchDB server. If you want to find out more, follow the docs.
## Test PSCouchDB
Before test this module, [install latest](#installation-and-simple-usage) version of *CouchDB* server and latest installation of [*Pester* module](https://pester-docs.netlify.app/docs/introduction/installation).
> WARNING: Test this module in testing enviroment ONLY.
```powershell
git clone "https://github.com/MatteoGuadrini/PSCouchDB.git"
cd "PSCouchDB/PSCouchDB/tests"
foreach ($f in (Get-ChildItem $PWD)) {
& pwsh $f.FullName # use powershell before 6.X
}
```
### Complete documentation
For other operation, for more details and for learning all cmdlets and possibilities, see the [docs](https://pscouchdb.readthedocs.io/en/latest/).
### Kanban board
If you are curious, if you want to contribute or simply see the features, look at the project's kanban board here: [KANBAN](https://github.com/MatteoGuadrini/PSCouchDB/projects).
### Cmdlet help
If you want to have an overview of the module, do this:
```powershell
help about_pscouchdb
```
Search for the cmdlets using a keyword pattern and then view the help:
```powershell
Search-CouchDBHelp -Pattern Database | foreach {Get-Help $_.Name}
```
or see [docs](https://pscouchdb.readthedocs.io/en/latest).
For a little demonstration, see [here](https://asciinema.org/a/232696)
## Licence
This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/MatteoGuadrini/PSCouchDB) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
[](https://treeware.earth)
## [Donation and Support](https://pscouchdb.readthedocs.io/en/latest/support.html).