Get-CouchDBDesignDocumentAttachment

NAME Get-CouchDBDesignDocumentAttachment



SYNOPSIS

Get or save attachment from design document.





SYNTAX

Get-CouchDBDesignDocumentAttachment [-Server <String>] [-Port <Int32>] [-Database <String>] [-Document <String>]

[-Revision <String>] [-Attachment <String>] [-OutFile <String>] [-Authorization <String>] [-Ssl]

[<CommonParameters>]



Get-CouchDBDesignDocumentAttachment [-Server <String>] [-Port <Int32>] [-Database <String>] [-Document <String>]

[-Revision <String>] [-Info] [-Attachment <String>] [-Authorization <String>] [-Ssl] [<CommonParameters>]





DESCRIPTION

It??????????????????s possible to retrieve design document with all attached files content.





PARAMETERS

-Server <String>

The CouchDB server name. Default is localhost.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Port <Int32>

The CouchDB server port. Default is 5984.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Database <String>

The CouchDB database.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Document <String>

The CouchDB document.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Revision <String>

The CouchDB revision document.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Info [<SwitchParameter>]

The CouchDB attachment document infos.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Attachment <String>

The CouchDB attachment document.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OutFile <String>

The full path where save attachment document.



Required? false

Position? named

Default value

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? named

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:

GET /{db}/_design/{ddoc}/{attname}

HEAD /{db}/_design/{ddoc}/{attname}



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



PS C:\\>Get-CouchDBDesignDocumentAttachment -Database test -Document space -Attachment test.txt



This example get attachment "test.txt" on "space" design document on database "test".









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



PS C:\\>Get-CouchDBDesignDocumentAttachment -Database test -Document space -Attachment test.txt -OutFile C:\\test.txt



This example save attachment "test.txt" to C:\\test.txt on "space" design document on database "test".









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-CouchDBDesignDocumentAttachment -Database test -Document space -Attachment test.txt -Info



This example get attachment "test.txt" infos on "space" design document on database "test".











RELATED LINKS

https://pscouchdb.readthedocs.io/en/lat ... attachment