< Back
Set-CouchDBBulkDocument
Post
NAME Set-CouchDBBulkDocument
SYNOPSIS
Create a bulk document.
SYNTAX
Set-CouchDBBulkDocument [[-Server] <String>] [[-Port] <Int32>] [-Database] <String> [-Document] <Array>
[[-Revision] <Array>] [-IsDeleted] [[-Authorization] <String>] [-Ssl] [<CommonParameters>]
DESCRIPTION
This method can be called to allows you to create and update multiple documents at the same time (only id and
revision).
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 <Array>
Array of the CouchDB documents.
Required? true
Position? 4
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Revision <Array>
Array of the CouchDB revision documents.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IsDeleted [<SwitchParameter>]
Select only deleted 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? 6
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:
POST /{db}/_bulk_docs
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-CouchDBBulkDocument -Database test -Document "Hitchhikers","Hitchhikers_new","Hitchhikers Guide"
-Revision 4-7051cbe5c8faecd085a3fa619e6e6337,$null,3-399796e5ce019e04311637e8a8a0f402 -Authorization
"admin:password"
This example modify list of three document: "Hitchhikers","Hitchhikers_new","Hitchhikers Guide" on a database
"test".
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-CouchDBBulkDocument -Database test -Document "Hitchhikers","Hitchhikers_new","Hitchhikers Guide"
-Authorization "admin:password"
This example create list of three document: "Hitchhikers","Hitchhikers_new","Hitchhikers Guide" on a database
"test".
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Set-CouchDBBulkDocument -Database test -Document "Hitchhikers","Hitchhikers_new","Hitchhikers Guide"
-Revision 4-7051cbe5c8faecd085a3fa619e6e6337,$null,3-399796e5ce019e04311637e8a8a0f402 -IsDeleted -Authorization
"admin:password"
This example modify list of three deleted document: "Hitchhikers","Hitchhikers_new","Hitchhikers Guide" on a
database "test".
RELATED LINKS
https://pscouchdb.readthedocs.io/en/lat ... ts-in-bulk
SYNOPSIS
Create a bulk document.
SYNTAX
Set-CouchDBBulkDocument [[-Server] <String>] [[-Port] <Int32>] [-Database] <String> [-Document] <Array>
[[-Revision] <Array>] [-IsDeleted] [[-Authorization] <String>] [-Ssl] [<CommonParameters>]
DESCRIPTION
This method can be called to allows you to create and update multiple documents at the same time (only id and
revision).
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 <Array>
Array of the CouchDB documents.
Required? true
Position? 4
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Revision <Array>
Array of the CouchDB revision documents.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IsDeleted [<SwitchParameter>]
Select only deleted 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? 6
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:
POST /{db}/_bulk_docs
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-CouchDBBulkDocument -Database test -Document "Hitchhikers","Hitchhikers_new","Hitchhikers Guide"
-Revision 4-7051cbe5c8faecd085a3fa619e6e6337,$null,3-399796e5ce019e04311637e8a8a0f402 -Authorization
"admin:password"
This example modify list of three document: "Hitchhikers","Hitchhikers_new","Hitchhikers Guide" on a database
"test".
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-CouchDBBulkDocument -Database test -Document "Hitchhikers","Hitchhikers_new","Hitchhikers Guide"
-Authorization "admin:password"
This example create list of three document: "Hitchhikers","Hitchhikers_new","Hitchhikers Guide" on a database
"test".
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Set-CouchDBBulkDocument -Database test -Document "Hitchhikers","Hitchhikers_new","Hitchhikers Guide"
-Revision 4-7051cbe5c8faecd085a3fa619e6e6337,$null,3-399796e5ce019e04311637e8a8a0f402 -IsDeleted -Authorization
"admin:password"
This example modify list of three deleted document: "Hitchhikers","Hitchhikers_new","Hitchhikers Guide" on a
database "test".
RELATED LINKS
https://pscouchdb.readthedocs.io/en/lat ... ts-in-bulk