Add Session and Key param to Get-CouchDBConfiguration

MatteoGuadrini · Sep 17, 2019 · 2d5aef9 · 2d5aef9
1 parent de37891
commit 2d5aef9
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 5 deletions.
diff --git a/PSCouchDB/PSCouchDB.psd1 b/PSCouchDB/PSCouchDB.psd1
@@ -12,7 +12,7 @@
     RootModule        = 'PSCouchDB.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '1.12.9'
+    ModuleVersion     = '1.13.0'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()

diff --git a/PSCouchDB/PSCouchDB.psm1 b/PSCouchDB/PSCouchDB.psm1
@@ -2603,12 +2603,18 @@ function Get-CouchDBConfiguration () {
     .NOTES
     CouchDB API:
         GET /_node/{node-name}/_config
+        GET /_node/{node-name}/_config/{section}
+        GET /_node/{node-name}/_config/{section}/{key}
     .PARAMETER Server
     The CouchDB server name. Default is localhost.
     .PARAMETER Port
     The CouchDB server port. Default is 5984.
     .PARAMETER Node
     The CouchDB node of cluster. Default is couchdb@localhost.
+    .PARAMETER Session
+    The CouchDB configuration section name.
+    .PARAMETER Key
+    The CouchDB configuration option name.
     .PARAMETER Authorization
     The CouchDB authorization form; user and password.
     Authorization format like this: user:password
@@ -2628,11 +2634,21 @@ function Get-CouchDBConfiguration () {
         [string] $Server,
         [int] $Port,
         [string] $Node = $(if ((Get-CouchDBNode -Server $Server -Port $Port -Authorization $Authorization -Ssl:$Ssl).all_nodes -contains "couchdb@localhost") { "couchdb@localhost" } else { "couchdb@127.0.0.1" }),
+        [string] $Session,
+        [string] $Key,
         [string] $Authorization,
         [switch] $Ssl
     )
     $Database = "_node"
     $Document = "$Node/_config"
+    # Check Session parameter
+    if ($Session) {
+        $Document += "/$Session"
+    }
+    # Check Key parameter
+    if ($Session -and $Key) {
+        $Document += "/$Key"
+    }
     Send-CouchDBRequest -Server $Server -Port $Port -Method "GET" -Database $Database -Document $Document -Authorization $Authorization -Ssl:$Ssl
 }
 

diff --git a/docs/build/doctrees/cmdlets.doctree b/docs/build/doctrees/cmdlets.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/html/_sources/cmdlets.rst.txt b/docs/build/html/_sources/cmdlets.rst.txt
@@ -61,7 +61,7 @@ Configuration
 
 .. code-block:: powershell
 
-    Get-CouchDBConfiguration [[-Server] <String>] [[-Port] <Int32>] [[-Database] <String>] [[-Node] <String>] [[-Authorization] <String>] [-Ssl] [<CommonParameters>]
+    Get-CouchDBConfiguration [[-Server] <String>] [[-Port] <Int32>] [[-Node] <String>] [[-Session] <String>] [[-Key] <String>] [[-Authorization] <String>] [-Ssl] [<CommonParameters>]
 
 **Set-CouchDBConfiguration**
 

diff --git a/docs/build/html/cmdlets.html b/docs/build/html/cmdlets.html
@@ -206,7 +206,7 @@ <h3>Configuration<a class="headerlink" href="#configuration" title="Permalink to
 </pre></div>
 </div>
 <p><strong>Get-CouchDBConfiguration</strong></p>
-<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="nb">Get-CouchDBConfiguration</span> <span class="p">[[</span><span class="n">-Server</span><span class="p">]</span> <span class="p">&lt;</span><span class="n">String</span><span class="p">&gt;]</span> <span class="p">[[</span><span class="n">-Port</span><span class="p">]</span> <span class="p">&lt;</span><span class="n">Int32</span><span class="p">&gt;]</span> <span class="p">[[</span><span class="n">-Database</span><span class="p">]</span> <span class="p">&lt;</span><span class="n">String</span><span class="p">&gt;]</span> <span class="p">[[</span><span class="n">-Node</span><span class="p">]</span> <span class="p">&lt;</span><span class="n">String</span><span class="p">&gt;]</span> <span class="p">[[</span><span class="n">-Authorization</span><span class="p">]</span> <span class="p">&lt;</span><span class="n">String</span><span class="p">&gt;]</span> <span class="p">[</span><span class="n">-Ssl</span><span class="p">]</span> <span class="p">[&lt;</span><span class="n">CommonParameters</span><span class="p">&gt;]</span>
+<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="nb">Get-CouchDBConfiguration</span> <span class="p">[[</span><span class="n">-Server</span><span class="p">]</span> <span class="p">&lt;</span><span class="n">String</span><span class="p">&gt;]</span> <span class="p">[[</span><span class="n">-Port</span><span class="p">]</span> <span class="p">&lt;</span><span class="n">Int32</span><span class="p">&gt;]</span> <span class="p">[[</span><span class="n">-Node</span><span class="p">]</span> <span class="p">&lt;</span><span class="n">String</span><span class="p">&gt;]</span> <span class="p">[[</span><span class="n">-Session</span><span class="p">]</span> <span class="p">&lt;</span><span class="n">String</span><span class="p">&gt;]</span> <span class="p">[[</span><span class="n">-Key</span><span class="p">]</span> <span class="p">&lt;</span><span class="n">String</span><span class="p">&gt;]</span> <span class="p">[[</span><span class="n">-Authorization</span><span class="p">]</span> <span class="p">&lt;</span><span class="n">String</span><span class="p">&gt;]</span> <span class="p">[</span><span class="n">-Ssl</span><span class="p">]</span> <span class="p">[&lt;</span><span class="n">CommonParameters</span><span class="p">&gt;]</span>
 </pre></div>
 </div>
 <p><strong>Set-CouchDBConfiguration</strong></p>

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git a/docs/source/cmdlets.rst b/docs/source/cmdlets.rst
@@ -61,7 +61,7 @@ Configuration
 
 .. code-block:: powershell
 
-    Get-CouchDBConfiguration [[-Server] <String>] [[-Port] <Int32>] [[-Database] <String>] [[-Node] <String>] [[-Authorization] <String>] [-Ssl] [<CommonParameters>]
+    Get-CouchDBConfiguration [[-Server] <String>] [[-Port] <Int32>] [[-Node] <String>] [[-Session] <String>] [[-Key] <String>] [[-Authorization] <String>] [-Ssl] [<CommonParameters>]
 
 **Set-CouchDBConfiguration**