Set-CouchDBDocument

NAME Set-CouchDBDocument



SYNOPSIS

Modify a document.





SYNTAX

Set-CouchDBDocument [[-Server] <String>] [[-Port] <Int32>] [-Database] <String> [-Document] <String> [-Revision]

<String> [[-Data] <Object>] [-Replace] [-BatchMode] [-NoConflict] [[-Authorization] <String>] [-Ssl]

[<CommonParameters>]





DESCRIPTION

Creates a new revision of the existing document.





PARAMETERS

-Server <String>

The CouchDB server name. Default is localhost.



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Port <Int32>

The CouchDB server port. Default is 5984.



Required? false

Position? 2

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Database <String>

The CouchDB database.



Required? true

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Document <String>

The CouchDB document.



Required? true

Position? 4

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Revision <String>

The CouchDB revision document.



Required? true

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Data <Object>

The data in Json format or hastable.



Required? false

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Replace [<SwitchParameter>]

Overwrite data.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-BatchMode [<SwitchParameter>]

Write documents to the database at a higher rate by using the batch option.

Documents in the batch may be manually flushed by using the Write-CouchDBFullCommit cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-NoConflict [<SwitchParameter>]

No prevents insertion of a conflicting document.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Authorization <String>

The CouchDB authorization form; user and password.

Authorization format like this: user:password

ATTENTION: if the password is not specified, it will be prompted.



Required? false

Position? 7

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Ssl [<SwitchParameter>]

Set ssl connection on CouchDB server.

This modify protocol to https and port to 6984.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





CouchDB API:

PUT /{db}/{docid}



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>$data = @{"answer"=42; "ask"="Ultimate Question of Life, the Universe and Everything"}



Set-CouchDBDocument -Database test -Document "Hitchhikers" -Revision 1-2c903913030efb4d711db085b1f44107 -Data

$data -Authorization "admin:password"

The example modify document "Hitchhikers" with data $data; if the element of $data exists, overwrite, else adding

new element.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>$data = @{"answer"=42; "ask"="Ultimate Question of Life, the Universe and Everything"}



Set-CouchDBDocument -Database test -Document "Hitchhikers" -Revision 1-2c903913030efb4d711db085b1f44107 -Data

$data -Replace -Authorization "admin:password"

The example overwrite document "Hitchhikers" with data $data.











RELATED LINKS

https://pscouchdb.readthedocs.io/en/lat ... a-document