diff --git a/PSCouchDB/PSCouchDB.psd1 b/PSCouchDB/PSCouchDB.psd1 index ff0a1cc..4a5a95b 100755 --- a/PSCouchDB/PSCouchDB.psd1 +++ b/PSCouchDB/PSCouchDB.psd1 @@ -144,6 +144,7 @@ "Set-CouchDBRevisionLimit", "Set-CouchDBSession", "Set-CouchDBProxy", + "Set-CouchDBMaintenanceMode", "Grant-CouchDBDatabasePermission", "Revoke-CouchDBDatabasePermission", "Request-CouchDBReplication", @@ -290,7 +291,8 @@ "rmdoc", "rmuser", "rmadmin", - "cdsa" + "cdsa", + "cdbmaint" ) # DSC resources to export from this module diff --git a/PSCouchDB/alias/CouchDBalias.ps1 b/PSCouchDB/alias/CouchDBalias.ps1 index eb9d67c..d65c567 100644 --- a/PSCouchDB/alias/CouchDBalias.ps1 +++ b/PSCouchDB/alias/CouchDBalias.ps1 @@ -56,6 +56,7 @@ New-Alias -Name "scrpl" -Value Set-CouchDBReplication -Option ReadOnly New-Alias -Name "scrl" -Value Set-CouchDBRevisionLimit -Option ReadOnly New-Alias -Name "scs" -Value Set-CouchDBSession -Option ReadOnly New-Alias -Name "sps" -Value Set-CouchDBProxy -Option ReadOnly +New-Alias -Name "cdbmaint" -Value Set-CouchDBMaintenanceMode -Option ReadOnly New-Alias -Name "gcdbp" -Value Grant-CouchDBDatabasePermission -Option ReadOnly New-Alias -Name "rcdbp" -Value Revoke-CouchDBDatabasePermission -Option ReadOnly New-Alias -Name "rcdbr" -Value Request-CouchDBReplication -Option ReadOnly diff --git a/PSCouchDB/functions/CouchDBserver.ps1 b/PSCouchDB/functions/CouchDBserver.ps1 index f7e3b0b..679bebd 100644 --- a/PSCouchDB/functions/CouchDBserver.ps1 +++ b/PSCouchDB/functions/CouchDBserver.ps1 @@ -1046,3 +1046,68 @@ function Remove-CouchDBProxy () { $Global:PSDefaultParameterValues["*CouchDB*:ProxyCredential"] = $null $Global:PSDefaultParameterValues["*CouchDB*:ProxyServer"] = $null } + +function Set-CouchDBMaintenanceMode () { + <# + .SYNOPSIS + Enable/Disable maintenance mode. + .DESCRIPTION + Enable/Disable maintenance mode. + .NOTES + CouchDB API: + GET /_db_updates + .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 Maintenance + Maintenance on/off. Default is $true. + .PARAMETER Authorization + The CouchDB authorization form; user and password. + Authorization format like this: user:password + ATTENTION: if the password is not specified, it will be prompted. + .PARAMETER Ssl + Set ssl connection on CouchDB server. + This modify protocol to https and port to 6984. + .PARAMETER ProxyServer + Proxy server through which all non-local calls pass. + Ex. ... -ProxyServer 'http://myproxy.local:8080' ... + .PARAMETER ProxyCredential + Proxy server credential. It must be specified with a PSCredential object. + .EXAMPLE + Set-CouchDBMaintenanceMode -Authorization admin:password + Enable maintenance mode. + .EXAMPLE + Set-CouchDBMaintenanceMode -Maintenance:$false -Authorization admin:password + Disable maintenance mode. + .LINK + https://pscouchdb.readthedocs.io/en/latest/server.html#server-operation + #> + [CmdletBinding()] + param( + [Parameter(ValueFromPipeline = $true)] + [string] $Server, + [int] $Port, + [string] $Node, + [bool] $Maintenance = $true, + $Authorization, + [switch] $Ssl, + [string] $ProxyServer, + [pscredential] $ProxyCredential + ) + # Compose doc + if (-not($Node)) { + if ((Get-CouchDBNode -Server $Server -Port $Port -Authorization $Authorization -Ssl:$Ssl -ProxyServer $ProxyServer -ProxyCredential $ProxyCredential).name) { + $Node = (Get-CouchDBNode -Server $Server -Port $Port -Authorization $Authorization -Ssl:$Ssl -ProxyServer $ProxyServer -ProxyCredential $ProxyCredential).name + } else { + $Node = Read-Host "Enter the node name (ex. couchdb@localhost)" + } + } + $Database = "_node" + $Document = "$Node/_config/couchdb/maintenance_mode" + $Data = $Maintenance | ConvertTo-Json + # Request + Send-CouchDBRequest -Server $Server -Port $Port -Method "PUT" -Database $Database -Document $Document -Data $Data -Authorization $Authorization -Ssl:$Ssl -ProxyServer $ProxyServer -ProxyCredential $ProxyCredential +} \ No newline at end of file diff --git a/docs/build/doctrees/cmdlets.doctree b/docs/build/doctrees/cmdlets.doctree index f570c44..017be80 100644 Binary files a/docs/build/doctrees/cmdlets.doctree and b/docs/build/doctrees/cmdlets.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 82e72ef..4875b7a 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/server.doctree b/docs/build/doctrees/server.doctree index 6a68c08..10072f5 100644 Binary files a/docs/build/doctrees/server.doctree and b/docs/build/doctrees/server.doctree differ diff --git a/docs/build/html/_sources/cmdlets.rst.txt b/docs/build/html/_sources/cmdlets.rst.txt index 2d49f15..25e236c 100644 --- a/docs/build/html/_sources/cmdlets.rst.txt +++ b/docs/build/html/_sources/cmdlets.rst.txt @@ -245,6 +245,12 @@ Server Remove-CouchDBReshards [[-Server] ] [[-Port] ] [-JobId] [[-Authorization] ] [-Ssl] [[-ProxyServer] ] [[-ProxyCredential] ] [] +**Set-CouchDBMaintenanceMode** + +.. code-block:: powershell + + Set-CouchDBMaintenanceMode [[-Server] ] [[-Port] ] [[-Node] ] [[-Maintenance] ] [[-Authorization] ] [-Ssl] [[-ProxyServer] ] [[-ProxyCredential] ] [] + Replication *********** diff --git a/docs/build/html/_sources/server.rst.txt b/docs/build/html/_sources/server.rst.txt index 674729d..06ab210 100644 --- a/docs/build/html/_sources/server.rst.txt +++ b/docs/build/html/_sources/server.rst.txt @@ -309,4 +309,19 @@ Request, configure, or stop, a replication operation. using module PSCouchDB $rep = New-Object PSCouchDBReplication -ArgumentList 'test','test_dump' $rep.AddDocIds(@("Hitchhikers","Hitchhikers_Guide")) - Request-CouchDBReplication -Data $rep -Authorization "admin:password" \ No newline at end of file + Request-CouchDBReplication -Data $rep -Authorization "admin:password" + +Enable/Disable Maintenance +__________________________ + +Enable maintenance mode. + +.. code-block:: powershell + + Set-CouchDBMaintenanceMode -Authorization "admin:password" + +Disable maintenance mode. + +.. code-block:: powershell + + Set-CouchDBMaintenanceMode -Maintenance $false -Authorization "admin:password" \ No newline at end of file diff --git a/docs/build/html/cmdlets.html b/docs/build/html/cmdlets.html index e56adc5..e3a6bc4 100644 --- a/docs/build/html/cmdlets.html +++ b/docs/build/html/cmdlets.html @@ -345,6 +345,10 @@

Server
Remove-CouchDBReshards [[-Server] <String>] [[-Port] <Int32>] [-JobId] <String> [[-Authorization] <Object>] [-Ssl] [[-ProxyServer] <String>] [[-ProxyCredential] <PSCredential>] [<CommonParameters>]
+

Set-CouchDBMaintenanceMode

+
Set-CouchDBMaintenanceMode [[-Server] <String>] [[-Port] <Int32>] [[-Node] <String>] [[-Maintenance] <Boolean>] [[-Authorization] <Object>] [-Ssl] [[-ProxyServer] <String>] [[-ProxyCredential] <PSCredential>] [<CommonParameters>]
+
+

Replication

diff --git a/docs/build/html/index.html b/docs/build/html/index.html index 169f619..4eda863 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -227,6 +227,7 @@

Welcome to PSCouchDB’s documentation!Modify replica
  • Remove replica
  • Replication request
    • +
  • Enable/Disable Maintenance
  • Authentication
    • diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 7b86c00..4c219f6 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["auth","classes","cmdlets","config","databases","ddoc","documents","index","intro","permission","server","support","uses"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["auth.rst","classes.rst","cmdlets.rst","config.rst","databases.rst","ddoc.rst","documents.rst","index.rst","intro.rst","permission.rst","server.rst","support.rst","uses.rst"],objects:{},objnames:{},objtypes:{},terms:{"00000000":4,"001":10,"100":[6,12],"120":1,"121":1,"122":1,"127":[1,3],"1500":4,"1990":11,"1fffffff":4,"1gb":12,"2019_00_01_00":4,"2c903913030efb4d711db085b1f44107":[1,6],"300":1,"399796e5ce019e04311637e8a8a0f402":6,"400":4,"404":6,"412":4,"443":[1,3],"4705a219cdcca7c72aac4f623f5c46a8":9,"5984":[1,5],"5xx":10,"60000":10,"638b90b9acf73cbb113afdfdba458bec80da6a6be23599019fb7b051cedfcc93":10,"6984":[1,3],"7051cbe5c8faecd085a3fa619e6e6337":[4,6],"7bf1766d9a5f3e4a60b400e98d62f523":6,"80000000":10,"8080":[1,10],"825cb35de44c433bfb2df415563a19d":4,"85a961d0d9b235b7b4f07baed1a38fda":5,"88972423aac3fe5d474dd17d3ee18a8b":5,"9a68ee74a8276c7f11146245ba43676f":6,"boolean":[2,6],"break":9,"byte":1,"case":6,"class":[6,7,9,12],"default":[0,1,2,3,4,5,6,10],"export":[2,7],"function":[6,9,12],"import":[2,7,8,11,12],"int":[1,12],"new":[1,2,5,6,8,9,10,12],"null":[1,5,6,12],"return":[1,3,4,5,6,9,10],"throw":[5,9],"true":[0,1,2,5,6,10,12],"try":5,"var":8,"void":1,AND:6,Age:12,And:[0,4,6,9,10],But:0,ERE:1,For:[0,3,4,6,8,10,11],IDs:4,Ids:4,NOT:6,One:[1,4],The:[1,3,4,5,6,9,10,11],There:6,These:4,Use:1,Used:6,With:[1,6,12],_all_db:4,_all_doc:6,_approx_count_distinct:1,_attach:1,_chang:4,_cluster_setup:8,_count:1,_delet:6,_design:5,_id:[1,6,9,12],_rev:[1,6,9,12],_stat:1,_sum:1,_view:5,about:[4,6,8,10,12],about_pscouchdb:8,about_sign:8,acatt:2,accept:9,access:[1,5,7,10],acnod:2,across:6,act:6,action:6,activ:[3,11,12],activedirectori:12,adatt:2,adcomput:12,add:[2,5,6,7,12],addadmin:1,addattach:1,addauthor:1,adddocid:[1,10],adddocu:[1,6],added:[1,5],addfield:[1,6,12],addindexi:1,addit:6,addition:6,addlogicaloper:[1,12],addmapfunct:1,addmemb:[1,9],addreducefunct:1,address:1,addselector:[1,6,12],addselectoroper:[1,6,12],addsortasc:1,addsortdesc:1,addsourceauthent:1,addtargetauthent:1,addvalid:1,addvi:1,addview:1,admin:[0,3,4,5,6,7,10,12],administr:[8,9],adopt:11,advanc:7,advantag:12,after:10,again:[1,6],against:6,age:[1,12],agent:10,alert:10,algorithm:6,alia:10,alias:7,alist:4,aliv:10,all:[4,5,6,8,9,10,11,12],allcomput:12,alldatabas:2,alldocu:2,allmatch:6,allow:[0,1,5,6,8],along:10,alreadi:4,also:[1,5,6],alwai:[5,6],analyz:10,ani:[4,6,10,12],answer:[1,6,11],anyon:11,api:[3,6,8],appeal:11,append:[1,10],appli:[1,6],applic:[4,5,10,12],appropri:1,argument:[1,6],argumentlist:[1,2,6,9,10,12],arrai:[1,2,6],arthur:[1,6],asc:6,ascend:[1,6],asjob:[2,6],ask:6,asplaintext:[0,1,9],assign:1,associ:[1,6,11],attach:[2,4,7],attachmentsinfo:[2,6],attachmentssinc:[2,6],attent:6,auth:1,authent:7,author:[0,2,3,4,5,6,9,10,12],autom:[1,12],automat:10,autos:8,avail:[5,6],avala:6,back:6,background:[4,6],backup:4,base:[5,6,10],basic:[1,6],batch:6,batchmod:[2,6],bdoc:[1,6],been:[5,6],befor:[1,4,5,6,8],begin:10,being:[1,5,6],below:[2,10,11,12],between:6,bindaddress:[2,3],bindport:2,black:11,bodi:6,bookmark:2,bool:1,boost:6,born:11,both:6,box:4,bre:1,browser:5,bug:11,build:[5,12],buildmapfunct:1,builmapfunct:1,bulk:7,busi:12,by_planet:5,by_titl:5,c2cefa18494e47182a125b11eccecd13:10,call:[6,8,10],can:[0,1,3,4,5,6,9,11,12],cannot:[4,6],categorynumb:12,ccdb:2,ccdd:2,ccdoc:2,ccview:2,cdb1:1,cdblog:2,certain:1,cfae778df80635ad15daa09e0264a988:5,cfae968df80635ad15a9709e0264a988:5,cfae968df80635ad15d5709e0264a988:5,chang:[1,3,6,7,10],check:[6,9,10,12],checkpoint:1,ciminst:12,clear:[0,2,6,7],clearcach:1,cli:7,clone:8,close:10,cluster:[7,10],cmdlet:[3,5,6,7,8,9,10],code:[10,12],color:10,com:[1,8],combin:6,come:11,command:8,commit:7,common:4,commonparamet:2,compact:[5,7],compani:11,compat:[1,6],complet:[6,10],complex:[1,6,12],compress:[1,2,4,6,7],comput:12,computercpu:12,computerdisk:12,computerhw:12,computerinventori:12,computernam:12,condit:[1,6],configur:[1,7,9,10],confirm:[2,8],conflict:[2,5,6],connect:[2,7,10,12],consid:6,construct:1,contain:[1,4,5,6,9],content:[5,6,7],content_typ:1,continu:[2,8,10],contribut:7,convertto:[0,1,9,12],cooki:0,copi:[2,7,8,10],core:[1,6,8],correspond:4,couchdb:[0,1,3,4,5,6,7,8,9,10,12],couchdbactivetask:[2,10],couchdbadmin:[2,9],couchdbanalyz:[2,10],couchdbattach:[2,6],couchdbbulkdocu:[2,6],couchdbcacheprefer:2,couchdbclust:[2,3],couchdbclustersetup:[2,10],couchdbconfigur:[2,3,10],couchdbdatabas:[0,2,4,9,10,12],couchdbdatabasechang:[2,4,10],couchdbdatabasedesigndocu:[2,5],couchdbdatabaseinfo:[2,10],couchdbdatabasepermiss:[2,9],couchdbdatabasepurgedlimit:[2,4],couchdbdatabasesecur:[2,9],couchdbdatabaseshard:[2,4],couchdbdatabaseupd:[2,10],couchdbdesigndocu:[1,2,5,9],couchdbdesigndocumentattach:[2,5],couchdbdocu:[1,2,5,6,12],couchdbfullcommit:[2,4,6],couchdbfulltext:[2,6],couchdbhelp:[2,8],couchdbindex:[1,2,4],couchdblog:[2,10],couchdbmissingrevis:[2,4,6],couchdbnod:[2,3,10],couchdbobject:[1,2],couchdbproxi:[2,10],couchdbrepl:[2,8,10],couchdbreplicationdocu:[2,10],couchdbreplicationschedul:[2,10],couchdbrequest:[2,10],couchdbreshard:[2,10],couchdbrevisiondiffer:[2,4],couchdbrevisionlimit:[2,4],couchdbsavecredentialprefer:[0,2],couchdbserv:[2,10],couchdbsess:[0,2],couchdbstatist:[2,10],couchdbus:[2,9],couchdbuuid:[2,10],couchdbview:[2,4],count:[2,10,12],cover:3,cpdoc:2,crash:10,creat:[7,12],createtarget:1,creation:10,credenti:[0,1,2,9,10],credoject:1,creq:[2,10],criteria:[6,12],criterion:1,critic:10,current:[0,4,8],currentus:8,daemon:1,dai:11,dare:11,data:[2,5,6,9,10,12],databas:[0,5,6,7,8,10,12],database_t:4,date:12,db1:1,db2:1,dbname:12,ddoc:[1,4,5,9],debug:10,declar:4,defin:[1,5,6,12],definit:5,delet:[1,4,5,7,9],deleted_conflict:6,deletedconflict:[2,6],dent:6,deploi:3,deprec:5,depth:[1,12],desc:6,descend:[1,2,4,5,6],describ:6,descript:[4,5,6,10],design:[4,6,7,9],designdoc:[2,4,5],destin:[2,4,6,10],detail:[6,10],deviceid:12,differ:[1,3,5,9],direct:6,directori:12,disabl:1,disablecach:1,disableupd:1,disconnect:[2,4],diseas:11,disk:[4,5,6],displai:[8,9,10],divisor:6,dnshostnam:12,doc120:1,doc121:1,doc122:1,doc1:1,doc2:1,doc:[1,5,12],doc_id:1,document:[4,8,9,10],doe:[0,6],doesn:6,dollar:6,don:9,donat:7,download:8,drivetyp:12,dure:9,e_s_t_a_m_p:4,each:[3,4,5,6,10],easi:12,eccl:2,ecdb:2,edg:10,edit:[9,12],effect:9,either:3,element:[2,5,6],elemmatch:6,els:[9,12],emerg:10,emit:[1,5],emitdoc:1,empti:[1,10],enabl:[1,2,3,6,8,9],enablecach:1,encod:6,end:[5,6],endkei:[2,4,5,6],endkeydocu:[2,5,6],endpoint:4,engin:1,english:10,enough:1,ensur:6,ensuredatabaseexist:2,enter:1,entir:[1,3,4,10],entri:10,entrytyp:12,equal:[1,6],equemit:1,equival:6,err:[2,10],error:[5,10],erroract:12,etc:10,event:10,eventid:12,eventlog:12,eventsourc:10,everi:[1,6,11],everyth:[6,12],exact:1,exampl:[3,6,10,12],excludeid:2,execut:[1,8],execution_stat:1,executionpolici:8,executionstat:[2,6],exist:[4,6,12],experi:11,explain:2,exportdb:2,express:[1,6,12],extend:[3,12],extern:10,extract:5,f6d66c4d70da66cded6bea889468eb14:[1,6],fail:10,fals:[0,1,2,4,5,6,10],favorit:5,fcdoc:2,feed:[2,10],femal:11,few:12,ffffffff:10,field1:1,field2:1,field3:1,field:[2,4,6,10,12],file:[4,5,6,10,12],filenam:1,filter:[1,2,12],find:[1,2,4,5,7,11,12],finddoc:2,first:[1,3,6,9,10,12],firstnam:6,folder:10,follow:[1,2,4,5,6,8,10],forbidden:[5,9],forc:[0,1,2,4,6,9],ford:6,foreach:12,fork:11,form:9,format:[0,3,4,6,8,9,10],found:[6,8,11],foundat:11,fqdn:1,from:[1,4,5,6,8,9,10,11,12],fromjson:1,full:[5,6,8,10],futur:11,gcadm:2,gcatt:2,gcbdoc:2,gcbpl:2,gcc:2,gcconf:2,gcdatt:2,gcdb:2,gcdbc:2,gcdbp:2,gcdbr:2,gcdbsh:2,gcdbu:2,gcddd:2,gcddoc:2,gcdoc:2,gcidx:2,gcmr:2,gcnode:2,gcrd:2,gcrl:2,gcrpdoc:2,gcrpl:2,gcsi:2,gctsk:2,gcusr:2,gener:6,get:[0,2,7,8,9,12],getadmin:1,getdata:1,getdocu:1,gethashcod:1,gethead:1,getjsonview:1,getmemb:1,getnativequeri:[1,6,12],getrawdata:1,getstatu:1,gettyp:[1,12],geturi:1,getview:1,github:8,give:12,given:[4,6,8],glanc:10,global:10,gplv3:11,grant:[2,9],greater:6,group:[2,6],group_level:6,grouplevel:[2,6],gte:6,guadrini:12,guid:6,hand:4,hardwar:12,has:[1,5,6,10,12],hashtabl:[1,6],have:[1,4,6,10,11],headlin:10,health:10,heart:[1,6],heartbeat:[2,10],help:[3,8,10],helpc:2,here:5,high:8,higher:6,himself:11,histor:[4,10],histori:2,hitchhik:[4,6,10],hitchhikers_guid:10,hour:12,howev:5,http:[1,5,8,10],human:11,hw_inventori:12,icdb:2,idea:12,identifi:[6,10],ids:1,idx:4,ignor:[5,6],impli:6,implicit:[1,6],importdb:2,improv:11,includ:[5,6,10],include_doc:5,includedocu:[2,5,6],inclusiveend:[2,5,6],increas:5,increment:[5,10],indefinit:10,index:[1,5,7,12],index_planet:6,indexof:9,indic:[5,6],individu:[3,4],info:[2,6,7,10,12],inform:[4,5,6,10],insert:1,insid:[0,9],instal:[7,9],instanc:[3,4,5,10,12],instanceid:12,instead:[1,6,7,10],instruct:6,int32:2,integ:6,interest:[6,10],interfac:[3,4,5],intern:4,interpret:1,interv:1,introduct:7,invalid:[1,4,5],invok:5,involv:10,isn:5,issu:7,item:6,its:[1,4,6,10],itself:5,javascript:5,job:[1,2,6,10],jobid:[2,10],jobnam:2,json:[4,6,10,12],just:[1,4,12],keep:[6,10],kei:[1,2,3,4,5,6,10],kept:6,keyword:5,know:[6,12],label:12,languag:[4,5],last:[1,6,10],latest:[2,5,6,8],lazi:6,lead:10,leaf:6,least:6,leav:6,lenghth:5,length:6,less:6,let:[0,8,9,10],level:[2,4,6],librari:6,licens:11,life:6,like:[1,6,10],limit:[2,5,7],line:[1,10,12],link:11,list:[2,3,4,5,10],listen:11,local:[1,2,3,4,7,8,10,12],localhost:[1,5],localsequ:[2,6],log:[1,7],logic:9,loglist:12,lognam:12,longer:4,longpol:10,look:[8,10],loop:12,lot:11,love:11,lte:6,lucen:10,machinenam:12,made:[4,9],magrathea:[1,5,6],mai:[1,5,10],main:[5,11,12],male:11,manag:[1,5],mandatori:12,mango:[4,6,12],mani:6,manual:[1,3],manufactur:12,map:5,mark:6,match:[1,5,6],matteo:12,matteoguadrini:8,matter:6,maxemit:1,maximum:[1,4,6],mcst:2,mean:3,measur:[2,10],member1:1,member2:1,member:7,member_us:9,memori:6,messag:[10,12],metadata:[2,6],method:[2,6],millisecond:[1,10],mind:11,minemit:1,minimum:1,ministri:11,minut:12,miscellan:6,mkadmin:2,mkdb:2,mkdoc:2,mkuser:2,mod:6,mode:6,model:12,modifi:[0,7,9],modul:[1,2,6,8,9,10,11,12],more:[1,3,5,6,10,12],most:[4,10],much:[6,12],multipl:6,must:[1,6,9],my_bookmark:6,mybookmark:1,mydesigndoc:[1,5,9],mydomain:1,myproxi:[1,10],myview:1,name:[1,2,4,5,6,8,10,12],nativ:6,natur:9,navig:5,ncadm:2,ncbd:2,ncdb:2,ncddoc:2,ncdoc:2,ncidx:2,ncrpl:2,ncusr:2,ncuuid:2,need:[6,9,10],neg:6,new_password:9,newdoc:[1,5,9],newvalu:1,next:6,nin:6,noconflict:2,node:[2,4,7,10],nodecount:2,non:[6,11],none:6,nor:6,normal:[6,10],noth:3,notic:10,noupdat:[2,6],now:[0,1,5,9,10],number:[4,5,6,10],numberofcor:12,numberoflogicalprocessor:12,numberofprocessor:12,obj:1,object:[2,3,6,7,9,10,12],obtain:[4,6],offer:6,offset:6,old:[3,5,9],olddoc:[1,5,9],omit:6,onc:0,one:[3,5,6,8,9,10,11,12],onli:[0,1,4,5,6,7,8,10,11],oop:7,opaqu:6,open:[10,11],openrevis:[2,6],oper:[2,5,7,12],option:[1,6,10],order:[4,5,6],organ:[3,11],other:[4,5,6,10,11],other_admin:9,otherwis:[6,10],our:1,out:[4,6,12],outfil:[2,5,6],overrid:10,overwrit:6,overwritten:6,own:10,page:6,pai:6,pair:6,param1:1,param:[0,1,2,12],paramat:1,paramet:[0,4,5,6,9,10,12],part:[6,10],parti:7,particular:[6,10],partit:[2,7],pass:[1,6],passion:11,passwd:1,password:[0,1,2,3,4,5,6,7,10,12],past:12,path:[1,2,4,8,10],patient:11,pattern:[2,6,8],pcre:6,peopl:11,per:10,percentcomplet:12,perform:[4,6],period:10,perl:6,perman:[4,6],permiss:[1,7],permit:1,person:12,persondocu:12,planet:[1,5,6],planet_view:5,point:9,poor:11,port:[2,3],posit:6,possibl:[1,4,5,6],post:1,potenti:12,powershel:[0,1,8,11],powershellgalleri:8,practic:4,prefect:6,prefer:[0,7],prefix:6,present:4,prevent:[1,5],previou:9,previous:[1,6],primari:[1,4],prior:6,privileg:10,process:[4,10],product:5,profil:12,profit:11,programfil:8,progress:12,project:11,prompt:0,properti:12,protect:[0,9],protocol:1,provid:[3,4,5,6],proxi:10,proxycredenti:2,proxyserv:2,proxyuri:1,ps1:12,pscouchdb:[0,6,8,9,10,12],pscouchdbattach:7,pscouchdbbulkdocu:[6,7],pscouchdbdesigndoc:[7,9],pscouchdbdocu:[7,12],pscouchdbqueri:[6,7,12],pscouchdbrepl:[7,10],pscouchdbrequest:7,pscouchdbsecur:[7,9],pscouchdbview:7,pscredenti:[0,1,2,9],psobject:1,pssession:12,purg:7,purged_infos_limit:4,purpos:[6,9,11],put:[1,12],pwd:4,queri:[3,4,7,12],question:6,quiet:12,rang:[2,4,10],rare:11,rather:4,rcadm:2,rcatt:2,rcdb:2,rcdbp:2,rcdbr:2,rcddoc:2,rcdoc:2,rcidx:2,rcnode:2,rcrpl:2,rcs:2,rcsrv:2,rcusr:2,rdatt:2,rdblog:2,reach:[4,5,6],read:[0,1,2,7],read_onli:9,readquorum:[2,6],real:[7,11],reason:[0,5],receiv:[1,5,6],recent:4,recogn:11,record:[5,6],red:11,reduc:[2,5,6],reduct:6,refer:6,reflect:[5,6,12],regardless:6,regex:[6,12],regular:[1,6],religi:11,remaind:6,remot:[3,4],remote_srv:4,remoteauthor:[2,4],remotenod:2,remotepassword:2,remoteport:2,remoteserv:[2,4],remotesign:8,remoteus:2,remov:[0,2,6,7,12],removeadminnam:1,removeadminrol:1,removeallattach:1,removeattach:1,removedocu:1,removeel:1,removefield:1,removeindexi:1,removemapfunct:1,removemembernam:1,removememberrol:1,removeproxi:1,removereducefunct:1,removerevis:[2,4],removeselector:1,removesort:1,removeview:1,rep:[1,10],repdb:1,repeat:4,replac:[2,6,12],replaceattach:1,replacemapfunct:1,replacementstr:12,replacereducefunct:1,replaceselector:1,replaceview:1,replic:[6,7,8],replica:[4,6,7],replicatordatabas:2,replicatordocu:2,report:[1,10],repres:12,represent:1,req:[1,5],request:[2,4,5,6,7,9],requestasjob:1,requir:[3,4,6,10],research:11,reset:[1,7],reshard:10,resourc:4,respect:11,respond:[6,11],respons:[4,5,6,10],restart:[2,10],restmethod:5,restor:[1,4],result:[1,4,5,6,10],retain:6,retri:5,retriev:[5,6],rev:6,revis:[2,5,7,9,12],revok:[2,7],revs_info:6,revs_limit:4,rich:11,rmadmin:2,rmdb:2,rmdoc:2,rmuser:2,role:[1,2,9],root:1,rotat:[2,10],row:6,run:[1,3,4,6,8,9,10],same:[3,4,5,6,10],sampl:10,save:[0,4,5,6,10],savedata:1,scadm:2,scconf:2,scd:2,scda:2,scdbpl:2,scdbr:2,scddoc:2,scdoc:2,scenario:12,scft:2,schedul:12,scientif:11,scope:8,script:[7,8],scrl:2,scrpl:2,scs:2,scusr:2,search:[1,2,5,8,10],searchcriteria:12,sec:[1,9],secobj:[1,5,9],second:[6,10,12],secstringpassword:1,section:[3,6,9],secur:[0,12],securestr:[0,1,2,9],see:[1,3,6,8,9,10],select:[3,5,9,12],selector:[2,12],semplifi:8,send:[1,2,10],sent:10,sequenc:[1,5,6,10],serv:11,server:[3,4,7,9],session:[0,2,8,10,12],set:[0,2,3,5,6,7,8,9,10,12],setbookmark:1,setcancel:1,setcheckpointinterv:1,setcontinu:[1,10],setdata:1,setdatabas:1,setdelet:1,setdocu:1,setdocumentid:1,setel:[1,12],setexecutionstat:1,setfilt:1,setlimit:1,setmethod:1,setparamet:1,setport:1,setproxi:1,setqueryparam:1,setreadquorum:1,setrevis:[1,10],setselector:1,setserv:1,setsincesequ:1,setskip:1,setsourceproxi:1,setsourceserv:1,setsourcessl:1,setssl:1,setstabl:1,setstal:1,settargetproxi:1,settargetserv:1,settargetssl:1,setup:7,setvalidatefunct:[1,9],sever:[4,6],shard:[2,6,7],share:8,should:[5,6,8],show:[5,6,10],sign:[6,7],significantli:5,silentlycontinu:12,similar:5,simpl:[1,9],simpli:[3,4],sinc:[1,2,4,6,10],singl:[1,6,7,9,10],singlenod:[2,3],situat:[5,10],size:[6,12],sizegb:12,skip:[2,4,5],slartibartfast:[5,6],slower:6,socket:10,some:[1,11,12],sort:[2,4],sourc:[1,10,11,12],space:[5,6],special:6,specif:[5,10,12],specifi:[0,1,4,5,6,9,10],specul:11,speed:5,split:10,sqlite:5,src:2,ssl:[2,3],stabl:2,stai:10,stale:2,star:11,start:[4,5,6,7,9,10],startkei:[2,4,5,6],startkeydocu:[2,5,6],startup:10,state:[2,10],statereason:[2,10],statist:[1,10],statu:[2,10,12],step:[3,12],stop:[4,5,6,10],storag:0,store:[0,1,4,5,6,12],str:1,strin:1,string:[0,1,2,5,6,9,10,12],structur:[3,6],stub:6,subfield:6,subset:4,suffer:11,summari:6,suppli:4,support:[1,6,7],surnam:[1,4,12],sync:2,synchron:4,syntax:6,system32:8,system:[1,2,5,10,12],tabl:[1,4,5,6,8,10],tail:[2,10],take:[6,10,12],target:1,task:[8,10,12],tcdb:2,technolog:11,telethon:11,templat:12,termin:9,test1:[1,6,10],test2:[1,5,10],test:[0,1,2,5,6,7,9,10,12],test_01:4,test_copi:4,test_dump:10,test_restor:4,test_test_dump:10,test_valid:5,test_view:1,text:[2,10],than:[1,3,4,6],thank:11,thei:11,them:[1,11,12],thi:[0,1,3,4,5,6,8,9,10,11,12],thing:[3,10],third:12,those:4,three:12,through:[5,6,8],time:[1,3,4,5,6,10],timeout:[2,10],timestamp:12,titl:[5,12],todai:11,togeth:12,tojson:[1,12],token:[0,10],tolow:12,tombston:6,tool:[1,12],topmost:6,tostr:1,total:10,total_row:6,totalphysicalmemori:12,totalphysicalmemorygb:12,track:4,two:[1,3,6,9,10],txt:[1,5,6],type:[2,4,6,10,12],typenam:[1,2,6,9,12],ultim:6,unauthor:[1,5,9],undefin:6,under:[6,8,11],underli:5,uniqu:10,univers:[6,10,11],unix:8,unless:[5,6],unrestrict:8,until:[6,10],unus:5,updat:[2,3,5,10],update_aft:6,update_seq:[5,6],updatesequ:[2,5,6],uribuild:1,usag:5,use:[0,1,4,5,6,7,8,9,12],use_index:1,usecheckpoint:1,used:[1,5,6,9,10],useful:6,useindex:[2,6],usequeri:2,user:[0,1,6,7,8],userctx:[1,5,9],userid:[0,2,9],usernam:[1,12],userpassword:1,userprofil:8,uses:7,using:[1,6,7,9,10,12],usr:8,utf8:4,uuid:10,vacuum:5,valid:[6,9],validate_doc_upd:[1,5],validateset:12,validationfunct:[2,5],valu:[1,2,3,5,6,12],value1:1,variabl:2,variou:[3,6,12],veri:[5,6,12],verifi:[0,1,3,4,8],version:[1,7,8,9,10],view:[6,7,12],viewmapfunct:[2,5],viewnam:[2,5],viewreducefunct:2,vogspher:1,voi:1,volumenam:12,wai:[1,5,10],want:[1,6,8,9,11,12],warn:10,wcfc:2,were:[1,11],what:6,whatif:2,when:[4,5,6],where:6,whether:[5,6],which:[1,4,5,6,10],white:11,who:11,win32_computersystem:12,win32_logicaldisk:12,win32_processor:12,windir:8,window:8,windowslog:12,windowspowershel:8,within:[3,4,5,6],without:[0,1,5,6,9],work:[4,8,11],world:12,wrap:4,write:[2,6,7,12],written:6,wrong:[1,10],year:11,yellow:11,you:[1,4,5,6,7,9,11,12],your:[1,5,8,12],your_domain_control:12,yyyy_hh_mm_ss:12},titles:["Authentication","Classes","Preferences","Setup","Databases","Design documents","Documents","Welcome to PSCouchDB\u2019s documentation!","Introduction","Permission","Server operation","Support","Real uses"],titleterms:{"class":1,"export":4,"function":[1,5],"import":4,"new":4,Use:6,access:9,add:[1,3],admin:[1,9],alias:2,all:1,allmatch:1,attach:[1,5,6],authent:[0,1,2],author:1,background:1,bookmark:[1,6],build:1,bulk:[1,6],cancel:1,chang:4,clear:[4,10],cluster:3,cmdlet:2,code:1,commit:4,compact:4,compress:5,configur:[2,3],connect:4,content:1,continu:1,contribut:11,copi:[4,6],creat:[1,4,5,6,9,10],custom:[5,12],data:1,databas:[1,2,4,9],delet:6,design:[1,2,5],differ:4,document:[1,2,5,6,7,12],donat:11,element:[1,3],elemmatch:1,execut:6,executionstat:1,exist:1,explain:6,field:1,file:1,find:6,flag:1,format:1,get:[1,3,4,5,6,10],git:8,gte:1,header:1,help:2,histori:6,index:[4,6],indexi:1,info:4,instal:8,introduct:8,inventori:12,issu:11,json:1,level:10,limit:[1,4,6,9],list:6,local:6,log:[10,12],logic:[1,6],lte:1,machin:12,mango:1,map:1,member:[1,9],method:1,miss:[4,6],mod:1,modifi:[1,3,5,6,10],nativ:1,nin:1,node:3,nor:1,object:1,one:1,onli:9,oop:12,oper:[1,6,10],other:1,paramet:1,parti:9,partit:[4,6],password:9,permiss:[2,9],port:1,prefer:2,properti:1,proxi:1,pscouchdb:[1,7],pscouchdbattach:1,pscouchdbbulkdocu:1,pscouchdbdesigndoc:1,pscouchdbdocu:1,pscouchdbqueri:1,pscouchdbrepl:1,pscouchdbrequest:1,pscouchdbsecur:1,pscouchdbview:1,purg:[4,6],queri:[1,6],quorum:6,read:[4,6,9,10],readquorum:1,real:12,reduc:1,regex:1,remov:[1,3,4,5,9,10],replac:1,replic:[1,2,10],replica:[1,10],request:[1,10],reset:9,revis:[1,4,6],revok:9,script:12,search:6,secur:1,selector:[1,6],server:[1,2,10],set:[1,4],setup:3,shard:4,sign:8,simpl:12,singl:3,size:1,skip:[1,6],sort:[1,6],specif:6,ssl:1,stabl:[1,6],stale:[1,6],start:8,statist:6,statu:1,storag:12,support:11,sync:4,test:4,type:1,updat:[1,6],uri:1,user:9,uses:12,valid:[1,5],view:[1,4,5],welcom:7,work:1,write:[4,9]}}) \ No newline at end of file +Search.setIndex({docnames:["auth","classes","cmdlets","config","databases","ddoc","documents","index","intro","permission","server","support","uses"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["auth.rst","classes.rst","cmdlets.rst","config.rst","databases.rst","ddoc.rst","documents.rst","index.rst","intro.rst","permission.rst","server.rst","support.rst","uses.rst"],objects:{},objnames:{},objtypes:{},terms:{"00000000":4,"001":10,"100":[6,12],"120":1,"121":1,"122":1,"127":[1,3],"1500":4,"1990":11,"1fffffff":4,"1gb":12,"2019_00_01_00":4,"2c903913030efb4d711db085b1f44107":[1,6],"300":1,"399796e5ce019e04311637e8a8a0f402":6,"400":4,"404":6,"412":4,"443":[1,3],"4705a219cdcca7c72aac4f623f5c46a8":9,"5984":[1,5],"5xx":10,"60000":10,"638b90b9acf73cbb113afdfdba458bec80da6a6be23599019fb7b051cedfcc93":10,"6984":[1,3],"7051cbe5c8faecd085a3fa619e6e6337":[4,6],"7bf1766d9a5f3e4a60b400e98d62f523":6,"80000000":10,"8080":[1,10],"825cb35de44c433bfb2df415563a19d":4,"85a961d0d9b235b7b4f07baed1a38fda":5,"88972423aac3fe5d474dd17d3ee18a8b":5,"9a68ee74a8276c7f11146245ba43676f":6,"boolean":[2,6],"break":9,"byte":1,"case":6,"class":[6,7,9,12],"default":[0,1,2,3,4,5,6,10],"export":[2,7],"function":[6,9,12],"import":[2,7,8,11,12],"int":[1,12],"new":[1,2,5,6,8,9,10,12],"null":[1,5,6,12],"return":[1,3,4,5,6,9,10],"throw":[5,9],"true":[0,1,2,5,6,10,12],"try":5,"var":8,"void":1,AND:6,Age:12,And:[0,4,6,9,10],But:0,ERE:1,For:[0,3,4,6,8,10,11],IDs:4,Ids:4,NOT:6,One:[1,4],The:[1,3,4,5,6,9,10,11],There:6,These:4,Use:1,Used:6,With:[1,6,12],_all_db:4,_all_doc:6,_approx_count_distinct:1,_attach:1,_chang:4,_cluster_setup:8,_count:1,_delet:6,_design:5,_id:[1,6,9,12],_rev:[1,6,9,12],_stat:1,_sum:1,_view:5,about:[4,6,8,10,12],about_pscouchdb:8,about_sign:8,acatt:2,accept:9,access:[1,5,7,10],acnod:2,across:6,act:6,action:6,activ:[3,11,12],activedirectori:12,adatt:2,adcomput:12,add:[2,5,6,7,12],addadmin:1,addattach:1,addauthor:1,adddocid:[1,10],adddocu:[1,6],added:[1,5],addfield:[1,6,12],addindexi:1,addit:6,addition:6,addlogicaloper:[1,12],addmapfunct:1,addmemb:[1,9],addreducefunct:1,address:1,addselector:[1,6,12],addselectoroper:[1,6,12],addsortasc:1,addsortdesc:1,addsourceauthent:1,addtargetauthent:1,addvalid:1,addvi:1,addview:1,admin:[0,3,4,5,6,7,10,12],administr:[8,9],adopt:11,advanc:7,advantag:12,after:10,again:[1,6],against:6,age:[1,12],agent:10,alert:10,algorithm:6,alia:10,alias:7,alist:4,aliv:10,all:[4,5,6,8,9,10,11,12],allcomput:12,alldatabas:2,alldocu:2,allmatch:6,allow:[0,1,5,6,8],along:10,alreadi:4,also:[1,5,6],alwai:[5,6],analyz:10,ani:[4,6,10,12],answer:[1,6,11],anyon:11,api:[3,6,8],appeal:11,append:[1,10],appli:[1,6],applic:[4,5,10,12],appropri:1,argument:[1,6],argumentlist:[1,2,6,9,10,12],arrai:[1,2,6],arthur:[1,6],asc:6,ascend:[1,6],asjob:[2,6],ask:6,asplaintext:[0,1,9],assign:1,associ:[1,6,11],attach:[2,4,7],attachmentsinfo:[2,6],attachmentssinc:[2,6],attent:6,auth:1,authent:7,author:[0,2,3,4,5,6,9,10,12],autom:[1,12],automat:10,autos:8,avail:[5,6],avala:6,back:6,background:[4,6],backup:4,base:[5,6,10],basic:[1,6],batch:6,batchmod:[2,6],bdoc:[1,6],been:[5,6],befor:[1,4,5,6,8],begin:10,being:[1,5,6],below:[2,10,11,12],between:6,bindaddress:[2,3],bindport:2,black:11,bodi:6,bookmark:2,bool:1,boost:6,born:11,both:6,box:4,bre:1,browser:5,bug:11,build:[5,12],buildmapfunct:1,builmapfunct:1,bulk:7,busi:12,by_planet:5,by_titl:5,c2cefa18494e47182a125b11eccecd13:10,call:[6,8,10],can:[0,1,3,4,5,6,9,11,12],cannot:[4,6],categorynumb:12,ccdb:2,ccdd:2,ccdoc:2,ccview:2,cdb1:1,cdblog:2,certain:1,cfae778df80635ad15daa09e0264a988:5,cfae968df80635ad15a9709e0264a988:5,cfae968df80635ad15d5709e0264a988:5,chang:[1,3,6,7,10],check:[6,9,10,12],checkpoint:1,ciminst:12,clear:[0,2,6,7],clearcach:1,cli:7,clone:8,close:10,cluster:[7,10],cmdlet:[3,5,6,7,8,9,10],code:[10,12],color:10,com:[1,8],combin:6,come:11,command:8,commit:7,common:4,commonparamet:2,compact:[5,7],compani:11,compat:[1,6],complet:[6,10],complex:[1,6,12],compress:[1,2,4,6,7],comput:12,computercpu:12,computerdisk:12,computerhw:12,computerinventori:12,computernam:12,condit:[1,6],configur:[1,7,9,10],confirm:[2,8],conflict:[2,5,6],connect:[2,7,10,12],consid:6,construct:1,contain:[1,4,5,6,9],content:[5,6,7],content_typ:1,continu:[2,8,10],contribut:7,convertto:[0,1,9,12],cooki:0,copi:[2,7,8,10],core:[1,6,8],correspond:4,couchdb:[0,1,3,4,5,6,7,8,9,10,12],couchdbactivetask:[2,10],couchdbadmin:[2,9],couchdbanalyz:[2,10],couchdbattach:[2,6],couchdbbulkdocu:[2,6],couchdbcacheprefer:2,couchdbclust:[2,3],couchdbclustersetup:[2,10],couchdbconfigur:[2,3,10],couchdbdatabas:[0,2,4,9,10,12],couchdbdatabasechang:[2,4,10],couchdbdatabasedesigndocu:[2,5],couchdbdatabaseinfo:[2,10],couchdbdatabasepermiss:[2,9],couchdbdatabasepurgedlimit:[2,4],couchdbdatabasesecur:[2,9],couchdbdatabaseshard:[2,4],couchdbdatabaseupd:[2,10],couchdbdesigndocu:[1,2,5,9],couchdbdesigndocumentattach:[2,5],couchdbdocu:[1,2,5,6,12],couchdbfullcommit:[2,4,6],couchdbfulltext:[2,6],couchdbhelp:[2,8],couchdbindex:[1,2,4],couchdblog:[2,10],couchdbmaintenancemod:[2,10],couchdbmissingrevis:[2,4,6],couchdbnod:[2,3,10],couchdbobject:[1,2],couchdbproxi:[2,10],couchdbrepl:[2,8,10],couchdbreplicationdocu:[2,10],couchdbreplicationschedul:[2,10],couchdbrequest:[2,10],couchdbreshard:[2,10],couchdbrevisiondiffer:[2,4],couchdbrevisionlimit:[2,4],couchdbsavecredentialprefer:[0,2],couchdbserv:[2,10],couchdbsess:[0,2],couchdbstatist:[2,10],couchdbus:[2,9],couchdbuuid:[2,10],couchdbview:[2,4],count:[2,10,12],cover:3,cpdoc:2,crash:10,creat:[7,12],createtarget:1,creation:10,credenti:[0,1,2,9,10],credoject:1,creq:[2,10],criteria:[6,12],criterion:1,critic:10,current:[0,4,8],currentus:8,daemon:1,dai:11,dare:11,data:[2,5,6,9,10,12],databas:[0,5,6,7,8,10,12],database_t:4,date:12,db1:1,db2:1,dbname:12,ddoc:[1,4,5,9],debug:10,declar:4,defin:[1,5,6,12],definit:5,delet:[1,4,5,7,9],deleted_conflict:6,deletedconflict:[2,6],dent:6,deploi:3,deprec:5,depth:[1,12],desc:6,descend:[1,2,4,5,6],describ:6,descript:[4,5,6,10],design:[4,6,7,9],designdoc:[2,4,5],destin:[2,4,6,10],detail:[6,10],deviceid:12,differ:[1,3,5,9],direct:6,directori:12,disabl:[1,7],disablecach:1,disableupd:1,disconnect:[2,4],diseas:11,disk:[4,5,6],displai:[8,9,10],divisor:6,dnshostnam:12,doc120:1,doc121:1,doc122:1,doc1:1,doc2:1,doc:[1,5,12],doc_id:1,document:[4,8,9,10],doe:[0,6],doesn:6,dollar:6,don:9,donat:7,download:8,drivetyp:12,dure:9,e_s_t_a_m_p:4,each:[3,4,5,6,10],easi:12,eccl:2,ecdb:2,edg:10,edit:[9,12],effect:9,either:3,element:[2,5,6],elemmatch:6,els:[9,12],emerg:10,emit:[1,5],emitdoc:1,empti:[1,10],enabl:[1,2,3,6,7,8,9],enablecach:1,encod:6,end:[5,6],endkei:[2,4,5,6],endkeydocu:[2,5,6],endpoint:4,engin:1,english:10,enough:1,ensur:6,ensuredatabaseexist:2,enter:1,entir:[1,3,4,10],entri:10,entrytyp:12,equal:[1,6],equemit:1,equival:6,err:[2,10],error:[5,10],erroract:12,etc:10,event:10,eventid:12,eventlog:12,eventsourc:10,everi:[1,6,11],everyth:[6,12],exact:1,exampl:[3,6,10,12],excludeid:2,execut:[1,8],execution_stat:1,executionpolici:8,executionstat:[2,6],exist:[4,6,12],experi:11,explain:2,exportdb:2,express:[1,6,12],extend:[3,12],extern:10,extract:5,f6d66c4d70da66cded6bea889468eb14:[1,6],fail:10,fals:[0,1,2,4,5,6,10],favorit:5,fcdoc:2,feed:[2,10],femal:11,few:12,ffffffff:10,field1:1,field2:1,field3:1,field:[2,4,6,10,12],file:[4,5,6,10,12],filenam:1,filter:[1,2,12],find:[1,2,4,5,7,11,12],finddoc:2,first:[1,3,6,9,10,12],firstnam:6,folder:10,follow:[1,2,4,5,6,8,10],forbidden:[5,9],forc:[0,1,2,4,6,9],ford:6,foreach:12,fork:11,form:9,format:[0,3,4,6,8,9,10],found:[6,8,11],foundat:11,fqdn:1,from:[1,4,5,6,8,9,10,11,12],fromjson:1,full:[5,6,8,10],futur:11,gcadm:2,gcatt:2,gcbdoc:2,gcbpl:2,gcc:2,gcconf:2,gcdatt:2,gcdb:2,gcdbc:2,gcdbp:2,gcdbr:2,gcdbsh:2,gcdbu:2,gcddd:2,gcddoc:2,gcdoc:2,gcidx:2,gcmr:2,gcnode:2,gcrd:2,gcrl:2,gcrpdoc:2,gcrpl:2,gcsi:2,gctsk:2,gcusr:2,gener:6,get:[0,2,7,8,9,12],getadmin:1,getdata:1,getdocu:1,gethashcod:1,gethead:1,getjsonview:1,getmemb:1,getnativequeri:[1,6,12],getrawdata:1,getstatu:1,gettyp:[1,12],geturi:1,getview:1,github:8,give:12,given:[4,6,8],glanc:10,global:10,gplv3:11,grant:[2,9],greater:6,group:[2,6],group_level:6,grouplevel:[2,6],gte:6,guadrini:12,guid:6,hand:4,hardwar:12,has:[1,5,6,10,12],hashtabl:[1,6],have:[1,4,6,10,11],headlin:10,health:10,heart:[1,6],heartbeat:[2,10],help:[3,8,10],helpc:2,here:5,high:8,higher:6,himself:11,histor:[4,10],histori:2,hitchhik:[4,6,10],hitchhikers_guid:10,hour:12,howev:5,http:[1,5,8,10],human:11,hw_inventori:12,icdb:2,idea:12,identifi:[6,10],ids:1,idx:4,ignor:[5,6],impli:6,implicit:[1,6],importdb:2,improv:11,includ:[5,6,10],include_doc:5,includedocu:[2,5,6],inclusiveend:[2,5,6],increas:5,increment:[5,10],indefinit:10,index:[1,5,7,12],index_planet:6,indexof:9,indic:[5,6],individu:[3,4],info:[2,6,7,10,12],inform:[4,5,6,10],insert:1,insid:[0,9],instal:[7,9],instanc:[3,4,5,10,12],instanceid:12,instead:[1,6,7,10],instruct:6,int32:2,integ:6,interest:[6,10],interfac:[3,4,5],intern:4,interpret:1,interv:1,introduct:7,invalid:[1,4,5],invok:5,involv:10,isn:5,issu:7,item:6,its:[1,4,6,10],itself:5,javascript:5,job:[1,2,6,10],jobid:[2,10],jobnam:2,json:[4,6,10,12],just:[1,4,12],keep:[6,10],kei:[1,2,3,4,5,6,10],kept:6,keyword:5,know:[6,12],label:12,languag:[4,5],last:[1,6,10],latest:[2,5,6,8],lazi:6,lead:10,leaf:6,least:6,leav:6,lenghth:5,length:6,less:6,let:[0,8,9,10],level:[2,4,6],librari:6,licens:11,life:6,like:[1,6,10],limit:[2,5,7],line:[1,10,12],link:11,list:[2,3,4,5,10],listen:11,local:[1,2,3,4,7,8,10,12],localhost:[1,5],localsequ:[2,6],log:[1,7],logic:9,loglist:12,lognam:12,longer:4,longpol:10,look:[8,10],loop:12,lot:11,love:11,lte:6,lucen:10,machinenam:12,made:[4,9],magrathea:[1,5,6],mai:[1,5,10],main:[5,11,12],mainten:[2,7],male:11,manag:[1,5],mandatori:12,mango:[4,6,12],mani:6,manual:[1,3],manufactur:12,map:5,mark:6,match:[1,5,6],matteo:12,matteoguadrini:8,matter:6,maxemit:1,maximum:[1,4,6],mcst:2,mean:3,measur:[2,10],member1:1,member2:1,member:7,member_us:9,memori:6,messag:[10,12],metadata:[2,6],method:[2,6],millisecond:[1,10],mind:11,minemit:1,minimum:1,ministri:11,minut:12,miscellan:6,mkadmin:2,mkdb:2,mkdoc:2,mkuser:2,mod:6,mode:[6,10],model:12,modifi:[0,7,9],modul:[1,2,6,8,9,10,11,12],more:[1,3,5,6,10,12],most:[4,10],much:[6,12],multipl:6,must:[1,6,9],my_bookmark:6,mybookmark:1,mydesigndoc:[1,5,9],mydomain:1,myproxi:[1,10],myview:1,name:[1,2,4,5,6,8,10,12],nativ:6,natur:9,navig:5,ncadm:2,ncbd:2,ncdb:2,ncddoc:2,ncdoc:2,ncidx:2,ncrpl:2,ncusr:2,ncuuid:2,need:[6,9,10],neg:6,new_password:9,newdoc:[1,5,9],newvalu:1,next:6,nin:6,noconflict:2,node:[2,4,7,10],nodecount:2,non:[6,11],none:6,nor:6,normal:[6,10],noth:3,notic:10,noupdat:[2,6],now:[0,1,5,9,10],number:[4,5,6,10],numberofcor:12,numberoflogicalprocessor:12,numberofprocessor:12,obj:1,object:[2,3,6,7,9,10,12],obtain:[4,6],offer:6,offset:6,old:[3,5,9],olddoc:[1,5,9],omit:6,onc:0,one:[3,5,6,8,9,10,11,12],onli:[0,1,4,5,6,7,8,10,11],oop:7,opaqu:6,open:[10,11],openrevis:[2,6],oper:[2,5,7,12],option:[1,6,10],order:[4,5,6],organ:[3,11],other:[4,5,6,10,11],other_admin:9,otherwis:[6,10],our:1,out:[4,6,12],outfil:[2,5,6],overrid:10,overwrit:6,overwritten:6,own:10,page:6,pai:6,pair:6,param1:1,param:[0,1,2,12],paramat:1,paramet:[0,4,5,6,9,10,12],part:[6,10],parti:7,particular:[6,10],partit:[2,7],pass:[1,6],passion:11,passwd:1,password:[0,1,2,3,4,5,6,7,10,12],past:12,path:[1,2,4,8,10],patient:11,pattern:[2,6,8],pcre:6,peopl:11,per:10,percentcomplet:12,perform:[4,6],period:10,perl:6,perman:[4,6],permiss:[1,7],permit:1,person:12,persondocu:12,planet:[1,5,6],planet_view:5,point:9,poor:11,port:[2,3],posit:6,possibl:[1,4,5,6],post:1,potenti:12,powershel:[0,1,8,11],powershellgalleri:8,practic:4,prefect:6,prefer:[0,7],prefix:6,present:4,prevent:[1,5],previou:9,previous:[1,6],primari:[1,4],prior:6,privileg:10,process:[4,10],product:5,profil:12,profit:11,programfil:8,progress:12,project:11,prompt:0,properti:12,protect:[0,9],protocol:1,provid:[3,4,5,6],proxi:10,proxycredenti:2,proxyserv:2,proxyuri:1,ps1:12,pscouchdb:[0,6,8,9,10,12],pscouchdbattach:7,pscouchdbbulkdocu:[6,7],pscouchdbdesigndoc:[7,9],pscouchdbdocu:[7,12],pscouchdbqueri:[6,7,12],pscouchdbrepl:[7,10],pscouchdbrequest:7,pscouchdbsecur:[7,9],pscouchdbview:7,pscredenti:[0,1,2,9],psobject:1,pssession:12,purg:7,purged_infos_limit:4,purpos:[6,9,11],put:[1,12],pwd:4,queri:[3,4,7,12],question:6,quiet:12,rang:[2,4,10],rare:11,rather:4,rcadm:2,rcatt:2,rcdb:2,rcdbp:2,rcdbr:2,rcddoc:2,rcdoc:2,rcidx:2,rcnode:2,rcrpl:2,rcs:2,rcsrv:2,rcusr:2,rdatt:2,rdblog:2,reach:[4,5,6],read:[0,1,2,7],read_onli:9,readquorum:[2,6],real:[7,11],reason:[0,5],receiv:[1,5,6],recent:4,recogn:11,record:[5,6],red:11,reduc:[2,5,6],reduct:6,refer:6,reflect:[5,6,12],regardless:6,regex:[6,12],regular:[1,6],religi:11,remaind:6,remot:[3,4],remote_srv:4,remoteauthor:[2,4],remotenod:2,remotepassword:2,remoteport:2,remoteserv:[2,4],remotesign:8,remoteus:2,remov:[0,2,6,7,12],removeadminnam:1,removeadminrol:1,removeallattach:1,removeattach:1,removedocu:1,removeel:1,removefield:1,removeindexi:1,removemapfunct:1,removemembernam:1,removememberrol:1,removeproxi:1,removereducefunct:1,removerevis:[2,4],removeselector:1,removesort:1,removeview:1,rep:[1,10],repdb:1,repeat:4,replac:[2,6,12],replaceattach:1,replacemapfunct:1,replacementstr:12,replacereducefunct:1,replaceselector:1,replaceview:1,replic:[6,7,8],replica:[4,6,7],replicatordatabas:2,replicatordocu:2,report:[1,10],repres:12,represent:1,req:[1,5],request:[2,4,5,6,7,9],requestasjob:1,requir:[3,4,6,10],research:11,reset:[1,7],reshard:10,resourc:4,respect:11,respond:[6,11],respons:[4,5,6,10],restart:[2,10],restmethod:5,restor:[1,4],result:[1,4,5,6,10],retain:6,retri:5,retriev:[5,6],rev:6,revis:[2,5,7,9,12],revok:[2,7],revs_info:6,revs_limit:4,rich:11,rmadmin:2,rmdb:2,rmdoc:2,rmuser:2,role:[1,2,9],root:1,rotat:[2,10],row:6,run:[1,3,4,6,8,9,10],same:[3,4,5,6,10],sampl:10,save:[0,4,5,6,10],savedata:1,scadm:2,scconf:2,scd:2,scda:2,scdbpl:2,scdbr:2,scddoc:2,scdoc:2,scenario:12,scft:2,schedul:12,scientif:11,scope:8,script:[7,8],scrl:2,scrpl:2,scs:2,scusr:2,search:[1,2,5,8,10],searchcriteria:12,sec:[1,9],secobj:[1,5,9],second:[6,10,12],secstringpassword:1,section:[3,6,9],secur:[0,12],securestr:[0,1,2,9],see:[1,3,6,8,9,10],select:[3,5,9,12],selector:[2,12],semplifi:8,send:[1,2,10],sent:10,sequenc:[1,5,6,10],serv:11,server:[3,4,7,9],session:[0,2,8,10,12],set:[0,2,3,5,6,7,8,9,10,12],setbookmark:1,setcancel:1,setcheckpointinterv:1,setcontinu:[1,10],setdata:1,setdatabas:1,setdelet:1,setdocu:1,setdocumentid:1,setel:[1,12],setexecutionstat:1,setfilt:1,setlimit:1,setmethod:1,setparamet:1,setport:1,setproxi:1,setqueryparam:1,setreadquorum:1,setrevis:[1,10],setselector:1,setserv:1,setsincesequ:1,setskip:1,setsourceproxi:1,setsourceserv:1,setsourcessl:1,setssl:1,setstabl:1,setstal:1,settargetproxi:1,settargetserv:1,settargetssl:1,setup:7,setvalidatefunct:[1,9],sever:[4,6],shard:[2,6,7],share:8,should:[5,6,8],show:[5,6,10],sign:[6,7],significantli:5,silentlycontinu:12,similar:5,simpl:[1,9],simpli:[3,4],sinc:[1,2,4,6,10],singl:[1,6,7,9,10],singlenod:[2,3],situat:[5,10],size:[6,12],sizegb:12,skip:[2,4,5],slartibartfast:[5,6],slower:6,socket:10,some:[1,11,12],sort:[2,4],sourc:[1,10,11,12],space:[5,6],special:6,specif:[5,10,12],specifi:[0,1,4,5,6,9,10],specul:11,speed:5,split:10,sqlite:5,src:2,ssl:[2,3],stabl:2,stai:10,stale:2,star:11,start:[4,5,6,7,9,10],startkei:[2,4,5,6],startkeydocu:[2,5,6],startup:10,state:[2,10],statereason:[2,10],statist:[1,10],statu:[2,10,12],step:[3,12],stop:[4,5,6,10],storag:0,store:[0,1,4,5,6,12],str:1,strin:1,string:[0,1,2,5,6,9,10,12],structur:[3,6],stub:6,subfield:6,subset:4,suffer:11,summari:6,suppli:4,support:[1,6,7],surnam:[1,4,12],sync:2,synchron:4,syntax:6,system32:8,system:[1,2,5,10,12],tabl:[1,4,5,6,8,10],tail:[2,10],take:[6,10,12],target:1,task:[8,10,12],tcdb:2,technolog:11,telethon:11,templat:12,termin:9,test1:[1,6,10],test2:[1,5,10],test:[0,1,2,5,6,7,9,10,12],test_01:4,test_copi:4,test_dump:10,test_restor:4,test_test_dump:10,test_valid:5,test_view:1,text:[2,10],than:[1,3,4,6],thank:11,thei:11,them:[1,11,12],thi:[0,1,3,4,5,6,8,9,10,11,12],thing:[3,10],third:12,those:4,three:12,through:[5,6,8],time:[1,3,4,5,6,10],timeout:[2,10],timestamp:12,titl:[5,12],todai:11,togeth:12,tojson:[1,12],token:[0,10],tolow:12,tombston:6,tool:[1,12],topmost:6,tostr:1,total:10,total_row:6,totalphysicalmemori:12,totalphysicalmemorygb:12,track:4,two:[1,3,6,9,10],txt:[1,5,6],type:[2,4,6,10,12],typenam:[1,2,6,9,12],ultim:6,unauthor:[1,5,9],undefin:6,under:[6,8,11],underli:5,uniqu:10,univers:[6,10,11],unix:8,unless:[5,6],unrestrict:8,until:[6,10],unus:5,updat:[2,3,5,10],update_aft:6,update_seq:[5,6],updatesequ:[2,5,6],uribuild:1,usag:5,use:[0,1,4,5,6,7,8,9,12],use_index:1,usecheckpoint:1,used:[1,5,6,9,10],useful:6,useindex:[2,6],usequeri:2,user:[0,1,6,7,8],userctx:[1,5,9],userid:[0,2,9],usernam:[1,12],userpassword:1,userprofil:8,uses:7,using:[1,6,7,9,10,12],usr:8,utf8:4,uuid:10,vacuum:5,valid:[6,9],validate_doc_upd:[1,5],validateset:12,validationfunct:[2,5],valu:[1,2,3,5,6,12],value1:1,variabl:2,variou:[3,6,12],veri:[5,6,12],verifi:[0,1,3,4,8],version:[1,7,8,9,10],view:[6,7,12],viewmapfunct:[2,5],viewnam:[2,5],viewreducefunct:2,vogspher:1,voi:1,volumenam:12,wai:[1,5,10],want:[1,6,8,9,11,12],warn:10,wcfc:2,were:[1,11],what:6,whatif:2,when:[4,5,6],where:6,whether:[5,6],which:[1,4,5,6,10],white:11,who:11,win32_computersystem:12,win32_logicaldisk:12,win32_processor:12,windir:8,window:8,windowslog:12,windowspowershel:8,within:[3,4,5,6],without:[0,1,5,6,9],work:[4,8,11],world:12,wrap:4,write:[2,6,7,12],written:6,wrong:[1,10],year:11,yellow:11,you:[1,4,5,6,7,9,11,12],your:[1,5,8,12],your_domain_control:12,yyyy_hh_mm_ss:12},titles:["Authentication","Classes","Preferences","Setup","Databases","Design documents","Documents","Welcome to PSCouchDB\u2019s documentation!","Introduction","Permission","Server operation","Support","Real uses"],titleterms:{"class":1,"export":4,"function":[1,5],"import":4,"new":4,Use:6,access:9,add:[1,3],admin:[1,9],alias:2,all:1,allmatch:1,attach:[1,5,6],authent:[0,1,2],author:1,background:1,bookmark:[1,6],build:1,bulk:[1,6],cancel:1,chang:4,clear:[4,10],cluster:3,cmdlet:2,code:1,commit:4,compact:4,compress:5,configur:[2,3],connect:4,content:1,continu:1,contribut:11,copi:[4,6],creat:[1,4,5,6,9,10],custom:[5,12],data:1,databas:[1,2,4,9],delet:6,design:[1,2,5],differ:4,disabl:10,document:[1,2,5,6,7,12],donat:11,element:[1,3],elemmatch:1,enabl:10,execut:6,executionstat:1,exist:1,explain:6,field:1,file:1,find:6,flag:1,format:1,get:[1,3,4,5,6,10],git:8,gte:1,header:1,help:2,histori:6,index:[4,6],indexi:1,info:4,instal:8,introduct:8,inventori:12,issu:11,json:1,level:10,limit:[1,4,6,9],list:6,local:6,log:[10,12],logic:[1,6],lte:1,machin:12,mainten:10,mango:1,map:1,member:[1,9],method:1,miss:[4,6],mod:1,modifi:[1,3,5,6,10],nativ:1,nin:1,node:3,nor:1,object:1,one:1,onli:9,oop:12,oper:[1,6,10],other:1,paramet:1,parti:9,partit:[4,6],password:9,permiss:[2,9],port:1,prefer:2,properti:1,proxi:1,pscouchdb:[1,7],pscouchdbattach:1,pscouchdbbulkdocu:1,pscouchdbdesigndoc:1,pscouchdbdocu:1,pscouchdbqueri:1,pscouchdbrepl:1,pscouchdbrequest:1,pscouchdbsecur:1,pscouchdbview:1,purg:[4,6],queri:[1,6],quorum:6,read:[4,6,9,10],readquorum:1,real:12,reduc:1,regex:1,remov:[1,3,4,5,9,10],replac:1,replic:[1,2,10],replica:[1,10],request:[1,10],reset:9,revis:[1,4,6],revok:9,script:12,search:6,secur:1,selector:[1,6],server:[1,2,10],set:[1,4],setup:3,shard:4,sign:8,simpl:12,singl:3,size:1,skip:[1,6],sort:[1,6],specif:6,ssl:1,stabl:[1,6],stale:[1,6],start:8,statist:6,statu:1,storag:12,support:11,sync:4,test:4,type:1,updat:[1,6],uri:1,user:9,uses:12,valid:[1,5],view:[1,4,5],welcom:7,work:1,write:[4,9]}}) \ No newline at end of file diff --git a/docs/build/html/server.html b/docs/build/html/server.html index 379d77f..ea236e3 100644 --- a/docs/build/html/server.html +++ b/docs/build/html/server.html @@ -105,6 +105,7 @@
  • Modify replica
  • Remove replica
  • Replication request
    • +
  • Enable/Disable Maintenance
  • Authentication
    • @@ -410,6 +411,17 @@

    Replication request +

    Enable/Disable Maintenance

    +

    Enable maintenance mode.

    +
    Set-CouchDBMaintenanceMode -Authorization "admin:password"
+
    +
    +

    Disable maintenance mode.

    +
    Set-CouchDBMaintenanceMode -Maintenance $false -Authorization "admin:password"
+
    +
    +

    diff --git a/docs/source/cmdlets.rst b/docs/source/cmdlets.rst index 2d49f15..25e236c 100644 --- a/docs/source/cmdlets.rst +++ b/docs/source/cmdlets.rst @@ -245,6 +245,12 @@ Server Remove-CouchDBReshards [[-Server] ] [[-Port] ] [-JobId] [[-Authorization] ] [-Ssl] [[-ProxyServer] ] [[-ProxyCredential] ] [] +**Set-CouchDBMaintenanceMode** + +.. code-block:: powershell + + Set-CouchDBMaintenanceMode [[-Server] ] [[-Port] ] [[-Node] ] [[-Maintenance] ] [[-Authorization] ] [-Ssl] [[-ProxyServer] ] [[-ProxyCredential] ] [] + Replication *********** diff --git a/docs/source/server.rst b/docs/source/server.rst index 674729d..06ab210 100644 --- a/docs/source/server.rst +++ b/docs/source/server.rst @@ -309,4 +309,19 @@ Request, configure, or stop, a replication operation. using module PSCouchDB $rep = New-Object PSCouchDBReplication -ArgumentList 'test','test_dump' $rep.AddDocIds(@("Hitchhikers","Hitchhikers_Guide")) - Request-CouchDBReplication -Data $rep -Authorization "admin:password" \ No newline at end of file + Request-CouchDBReplication -Data $rep -Authorization "admin:password" + +Enable/Disable Maintenance +__________________________ + +Enable maintenance mode. + +.. code-block:: powershell + + Set-CouchDBMaintenanceMode -Authorization "admin:password" + +Disable maintenance mode. + +.. code-block:: powershell + + Set-CouchDBMaintenanceMode -Maintenance $false -Authorization "admin:password" \ No newline at end of file